diff --git a/.rvmrc b/.rvmrc index 767b6336..247f11e2 100644 --- a/.rvmrc +++ b/.rvmrc @@ -12,7 +12,7 @@ rvm_gemset_create_on_use_flag=1 # First we specify our desired [@], the @gemset name is optional, # Only full ruby name is supported here, for short names use: # echo "rvm use 1.9.3" > .rvmrc -environment_id="ruby-1.9.3-p194@jekyll" +environment_id="ruby-1.9.3@jekyll" # First we attempt to load the desired environment directly from the environment diff --git a/README.md b/README.md index 8281bc15..abd775a6 100644 --- a/README.md +++ b/README.md @@ -12,10 +12,21 @@ files Jekyll. Our docs will be transformed into readable pages using Jekyll. Jekyll allows us to write our documentation in markdown, and host it as static pages in github. We are particularly using -jekyll-bootstrap. Learn more about jekyll-bootstrap at -http://www.jekyllbootstrap.com +jekyll-bootstrap. [Learn more about jekyll-bootstrap.](http://www.jekyllbootstrap.com) + ## Creating and editing documentation +You can write everything in markdown (see markdown_styleguide.md for more +information.) and do code highlighting inline with backticks `code` or +in blocks with the template: + + {% highlight java %} + block of code goes here + {% endhighlight %} + +Java in the above template can be any short name for a language from +[this list.](http://pygments.org/languages/) + To add a new file, find the user guide section or article you want and create a file named YYYY-MM-DD-title.md under the _posts directory, and write it using markdown syntax. In the file, you should include @@ -23,37 +34,32 @@ the following at the top of the file (include the dashes): --- layout: post - title: My Content Title - category: [userguide, schema, 1.0.0-rc1] or tutorial - tags: [doc_type] - description: A tutorial on computer stuff. + title: Delete Contacts + categories: [tutorials, phonebook-tutorial, 1.0.0-rc4] + tags: [article] + order: 8 + description: Examples of Point deletions. --- The above is YAML Front Matter syntax that instructs Jekyll what to do -with the file when compiling it into a static site. Set the 'doc_type' -is either 'article' or 'schema_ug'. The tag allows us to collate -articles and userguides. The ordering of these articles and userguides -is determined by the date in the filename. Janky, c'est la vie. -You can write everything in markdown (see markdown_styleguide.md for more -information.) and do code highlighting inline with backticks `code` or -in blocks with the template: +with the file when compiling it into a static site. The tag allows us to collate +articles and userguides. - {% highlight java %} - block of code goes here - {% endhighlight %} - -Java in the above template can be any short name for a language from -[this list.](http://pygments.org/languages/) ## Previewing Changes - In order to preview what your changes look like, you will need to have Ruby and Jekyll installed. It is highly recommended that you control your ruby version using rvm. Check out instructions at -http://github.com/mojombo/jekyll. Once Jekyll is installed `jekyll ---server --safe` will display the site corresponding to the -current state of the project at http://localhost:4000. Note that the -pygments highlighting of codeblocks will only work if you have +http://github.com/mojombo/jekyll. + + +To see how your local version of kiji-docs renders, run `rake preview`. This +command turns off google analytics, so as not to inflate our stats, and runs +`jekyll --no-auto --server --pygments --no-lsi --safe`. Since we use the no-auto +parameter, you will need to rerun preview to see new changes, but trust us, +it is better this way. + +Note that the pygments highlighting of codeblocks will only work if you have pygments installed. ## Contributing Documentation @@ -66,3 +72,25 @@ pygments installed. * Reference the jira in the commit message (e.g., "DOCS-1: Subscribe buttons to the mailing lists on the website are broken") * Push your branch: git push origin my_fix. * Use [pull requests](https://help.github.com/articles/using-pull-requests) to contribute your changes once you are done. + +## Maintaing Docs + + +In order to maintain the docs repo, you need to know: +* How Jekyll works. We use a particular framework called [Jekyll Bootstrap](http://jekyllbootstrap.com/) + Their docs are great, so use them. +* How we use front matter on posts. The most important(/hackiest uses) labels and their uses are: + ** categories : This defines the prefix of a url. For example a post with categories = [a, b, c] and + file name 2012-01-01-title, will have the full url of {{ site.BASE_URL }}/a/b/c/title. + ** order : Putting sections of the userguide in the correct order is tricky, and done in a very + silly way. See _includes/themes/twitter/post.html and _includes/side-toc.html for examples of + where the order label is used. Jekyll is not made for our use case, so we have some hilarious + ways of bending its behavior to our will. In the long run, the way we generate the side-toc is + going to slow down the generation of the site considerably. This is one reason that the current + Jekyll based docs site is going to need to be replaced with something more resilient in the future. +* The directory structure inside of the _posts doesn't affect the urls that get generated for posts, + but we make it match the urls as much as possible. Specificly, that means that if the overview + section of a userguide has the categories tag [userguides, schema, 1.0.0-rc4], then the markdown + file should be located in _posts/userguides/schema/1.0.0-rc4. This is just a convention that helps + with organization and navigation. +* Sometimes weird errors happen, adding whitespace will help, about half of the time. diff --git a/Rakefile b/Rakefile index 3abf4e91..a15b59d3 100644 --- a/Rakefile +++ b/Rakefile @@ -97,7 +97,7 @@ end # task :page desc "Launch preview environment" task :preview do - system "jekyll --auto --server" + system "./scripts/run-server.sh" end # task :preview # Public: Alias - Maintains backwards compatability for theme switching. diff --git a/_config.yml b/_config.yml index 1dbbc6fc..e4e634a8 100644 --- a/_config.yml +++ b/_config.yml @@ -12,10 +12,9 @@ pygments: true title : Kiji Community author : name : WibiData - email : blah@email.test - github : username - twitter : username - feedburner : feedname + email : admin@wibidata.com + github : kijiproject + twitter : kijiproject # URL of the kiji site. # @@ -30,9 +29,31 @@ kiji_url : http://www.kiji.org # Finally if you are pushing to a GitHub project page, include the project name at the end. # production_url : http://docs.kiji.org -userguide_url : /userguide/schema/1.0.0-rc1/ -tutorial_url : /tutorial/ -api_url : /apidocs/org/kiji/schema/ +api_url : /apidocs +userguide_url : /userguides +tutorial_url : /tutorials + +# rc1 +api_schema_rc1 : /apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema +userguide_schema_rc1 : /userguides/schema/1.0.0-rc1 + +# rc2 +api_schema_rc2 : /apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema +userguide_schema_rc2 : /userguides/schema/1.0.0-rc2 + +# rc3 +api_schema_rc3 : /apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema +tutorial_phonebook_rc3 : /tutorials/phonebook-tutorial/1.0.0-rc3 +userguide_schema_rc3 : /userguides/schema/1.0.0-rc3 + +# rc4 +api_schema_rc4 : /apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema +api_mr_rc4 : /apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce +api_mrlib_rc4 : /apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce +tutorial_phonebook_rc4 : /tutorials/phonebook-tutorial/1.0.0-rc4 +tutorial_music_rc4 : /tutorials/music-recommendation/1.0.0-rc4 +userguide_schema_rc4 : /userguides/schema/1.0.0-rc4 +userguide_mapreduce_rc4 : /userguides/mapreduce/1.0.0-rc4 # All Jekyll-Bootstrap specific configurations are namespaced into this hash # @@ -84,19 +105,19 @@ JB : # Set 'provider' to the comment provider you want to use. # Set 'provider' to false to turn commenting off globally. # - comments : - provider : disqus - disqus : - short_name : jekyllbootstrap - livefyre : - site_id : 123 - intensedebate : - account : 123abc - facebook : - appid : 123 - num_posts: 5 - width: 580 - colorscheme: light + #comments : + # provider : disqus + # disqus : + # short_name : jekyllbootstrap + # livefyre : + # site_id : 123 + # intensedebate : + # account : 123abc + # facebook : + # appid : 123 + # num_posts: 5 + # width: 580 + # colorscheme: light # Settings for analytics helper # Set 'provider' to the analytics provider you want to use. diff --git a/_includes/side-toc.html b/_includes/side-toc.html index 35c01955..2892d245 100644 --- a/_includes/side-toc.html +++ b/_includes/side-toc.html @@ -6,16 +6,27 @@

{{ title }}

{% assign index = forloop.index %} {% for subpage in pages %} {% if index == subpage.order %} -
  • - {% if subpage.url == page.url %} - {{ subpage.title }} - {% else %} - {{ subpage.title }} - {% endif %} -
    • + {% if subpage.categories == page.categories %} +
  • + {% if subpage.url == page.url %} + {{ subpage.title }} + {% else %} + {{ subpage.title }} + {% endif %} +
    • + {% endif %} {% endif %} {% endfor %} {% endfor %} +

    Need Help?

    + diff --git a/_includes/themes/twitter/default.html b/_includes/themes/twitter/default.html index 935f96e4..68f5475b 100644 --- a/_includes/themes/twitter/default.html +++ b/_includes/themes/twitter/default.html @@ -8,6 +8,9 @@ + + + @@ -70,15 +73,18 @@ Quick Start Guide
  • - Phonebook Tutorial + Tutorials
  • - - User Guide + + User Guides
  • - API Reference + API Reference +
    • +
  • + Wiki
    • diff --git a/_includes/themes/twitter/post.html b/_includes/themes/twitter/post.html index 55a30aa0..15c95164 100644 --- a/_includes/themes/twitter/post.html +++ b/_includes/themes/twitter/post.html @@ -1,5 +1,5 @@
    -
    +

    {{ page.title }}

    @@ -8,11 +8,19 @@

    {{ page.title }}

    -
    +
    {% if page.tags contains 'schema-ug' %} - {% assign title = 'User Guide' %} + {% assign title = 'KijiSchema User Guide' %} {% assign pages = site.tags.schema-ug %} - {% elsif page.tags contains 'article' %} + {% elsif page.tags contains 'mapreduce-ug' %} + {% assign title = 'KijiMR User Guide' %} + {% assign pages = site.tags.mapreduce-ug %} + {% elsif page.tags contains 'phonebook' %} {% assign title = 'Phonebook Tutorial' %} - {% assign pages = site.tags.article %} + {% assign pages = site.tags.phonebook %} + {% elsif page.tags contains 'music' %} + {% assign title = 'Music Recommendation Tutorial' %} + {% assign pages = site.tags.music %} {% endif %} {% include side-toc.html %}
    diff --git a/_posts/tutorials/music-recommendation/2012-01-01-bulk-importing.md b/_posts/tutorials/music-recommendation/2012-01-01-bulk-importing.md new file mode 100644 index 00000000..2e99a4c8 --- /dev/null +++ b/_posts/tutorials/music-recommendation/2012-01-01-bulk-importing.md @@ -0,0 +1,230 @@ +--- +layout: post +title : Bulk Importing +categories: [tutorials, music-recommendation, 1.0.0-rc4] +tags: [music] +order : 3 +description: Bulk importing data into a Kiji table. +--- + +In cases where there is a significant amount of existing data to load into a Kiji +table, it hardly makes sense to do it a row at a time. We will show you how to use MapReduce to efficiently import +such large amounts of data into Kiji. + +
    +

    SongMetadataBulkImporter.java

    +
    + +
    +

    JSONBulkImporter.java

    +
    + +
    +
    + +

    Custom Bulk Importers

    + +One of the ways to bulk import your data is to extend `KijiBulkImporter` and override its `produce()` method +to insert rows in a distributed manner into the Kiji table. In the example below, we use this method to populate the song +metadata. + +Input files contain JSON data representing song metadata, with one song per line. Below is the whitespace-augmented +example of a single row in our input file `song-metadata.json`. + +{% highlight js %} +{ + "song_id" : "0", + "song_name" : "song0", + "artist_name" : "artist1", + "album_name" : "album1", + "genre" : "awesome", + "tempo" : "140", + "duration" : "180" +} +{% endhighlight %} + +The `SongMetadataBulkImporter` class extends `KijiBulkImporter`. It expects a +[text input format]({{site.userguide_mapreduce_rc4}}/command-line-tools/#input) where the +input keys are the byte offsets of each line in the input file and the input values are the lines +of text described above. + +In the `produce()` method of the class, extract the JSON as follows: +{% highlight java %} +// Parse JSON: +final JSONObject json = (JSONObject) parser.parse(line.toString()); + +// Extract JSON fields: +final String songId = json.get("song_id").toString(); +{% endhighlight %} + +Use an Avro record called SongMetaData described below: +{% highlight java %} +record SongMetadata { + string song_name; + string artist_name; + string album_name; + string genre; + long tempo; + long duration; + } +{% endhighlight %} + +Then build an Avro metadata record from the parsed JSON. + +{% highlight java %} +final SongMetadata song = SongMetadata.newBuilder() + .setSongName(songName) + .setAlbumName(albumName) + .setArtistName(artistName) + .setGenre(genre) + .setTempo(tempo) + .setDuration(duration) + .build(); +{% endhighlight %} + +We create an [`EntityId`]({{site.api_schema_rc4}}/EntityId.html) object in order to use the song ID as the row key. +{% highlight java %} +final EntityId eid = context.getEntityId(songId); +{% endhighlight %} + +Finally, write this Avro record to a cell in our Kiji table with the song ID as the row key. +{% highlight java %} +context.put(eid, "info", "metadata", song); +{% endhighlight %} + +*As an aside, take care while using explicit timestamps when writing to Kiji. You can read about +[common pitfalls of timestamps in HBase](http://www.kiji.org/2013/02/13/common-pitfalls-of-timestamps-in-hbase/) on the Kiji blog +for more details.* + +### Running the Example + +Run the bulk import tool by specifying `SongMetadataBulkImporter` as the importer, the Kiji table `songs` as the output, and `song-metadata.json` as the input with the following command: + +
    +{% highlight bash %} +kiji bulk-import \ + --importer=org.kiji.examples.music.bulkimport.SongMetadataBulkImporter \ + --lib=${LIBS_DIR} \ + --output="format=kiji table=${KIJI}/songs nsplits=1" \ + --input="format=text file=kiji-mr-tutorial/song-metadata.json" +{% endhighlight %} +
    + +When the MapReduce bulk import job runs, KijiMR will warn you that jars are already added. +This is normal and not a cause for alarm. Once the MapReduce job actually starts, you will +receive periodic progress updates for the map and reduce phases of the job. When the job +completes, MapReduce will print a number of metrics describing the results of the job. You can also +examine the output of your job at (the JobTracker Web UI: [http://localhost:50030](http://localhost:50030)). + +#### Verify + +Verify that the `user` table records were added properly by executing: + +
    +{% highlight bash %} +kiji ls --kiji=${KIJI}/songs --max-rows=3 +{% endhighlight %} +
    + +Here's what the first three entries should look like (assuming you're using the pregenerated song data). + + entity-id='song-32' [1361561116668] info:metadata + {"song_name": "song name-32", "artist_name": "artist-2", "album_name": "album-0", "genre": "genre4.0", "tempo": 130, "duration": 120} + + entity-id='song-49' [1361561116737] info:metadata + {"song_name": "song name-49", "artist_name": "artist-3", "album_name": "album-1", "genre": "genre7.0", "tempo": 80, "duration": 240} + + entity-id='song-36' [1361561116684] info:metadata + {"song_name": "song name-36", "artist_name": "artist-2", "album_name": "album-0", "genre": "genre4.0", "tempo": 170, "duration": 120} + +### Bulk importing using table import descriptors + +In the example below, we use an import descriptor to bulk import our history of song plays from the `song-plays.json` into the +`user` table. This method of bulk import requires a table import descriptor, which is a JSON file containing: + +
      +
    • The table that is the destination of the import.
      • +
    • The table column families.
      • +
        +
      • The name of the destination column.
        • +
      • The name of the source field to import from.
        • +
      +
    • The source for the entity ID.
      • +
    • An optional timestamp to use instead of system timestamp.
      • +
    • The format version of the import descriptor.
      • +
    + +The import descriptor used for the `user` table is shown below: + +{% highlight bash %} +{ + name : "users", + families : [ { + name : "info", + columns : [ { + name : "track_plays", + source : "song_id" + } ] + } ], + entityIdSource : "user_id", + overrideTimestampSource : "play_time", + version : "import-1.0" +} +{% endhighlight %} + +We then use the pre-written `JSONBulkImporter` which expects a JSON file. Each line in this file +represents a separate JSON object to be imported into a row. The JSON object is described by an +import descriptor such as the one above. Target columns whose sources are not present in the JSON +object are skipped. + +This descriptor parametrizes a special MapReduce job, where every row of the input file is parsed, +and inserted into the `users` Kiji table. The value of `user_id` will +be used as the row key in the Kiji table, the timestamp will be retrieved from the `play_time` +field. The value of `song_id` will be extracted and inserted into the `info:track_plays` column. + +### Running the Example + +Copy the descriptor file into HDFS. + +
    +{% highlight bash %} +$ hadoop fs -copyFromLocal \ + $MUSIC_HOME/import/song-plays-import-descriptor.json \ + kiji-mr-tutorial/ +{% endhighlight %} +
    + +Run the bulk import tool by specifying `JSONBulkImporter` as the importer, the Kiji table `users` as the output, and `song-plays.json` as the input with the following command: + +
    +{% highlight bash %} +kiji bulk-import \ + -Dkiji.import.text.input.descriptor.path=kiji-mr-tutorial/song-plays-import-descriptor.json \ + --importer=org.kiji.mapreduce.lib.bulkimport.JSONBulkImporter \ + --output="format=kiji table=${KIJI}/users nsplits=1" \ + --input="format=text file=kiji-mr-tutorial/song-plays.json" \ + --lib=${LIBS_DIR} +{% endhighlight %} +
    + +#### Verify + +Verify that the `user` table records were added properly by executing: + +
    +{% highlight bash %} +kiji ls --kiji=${KIJI}/users --max-rows=3 +{% endhighlight %} +
    + +Here’s what the first three entries should look like: + + entity-id='user-41' [1325750820000] info:track_plays + song-43 + + entity-id='user-3' [1325756880000] info:track_plays + song-1 + + entity-id='user-13' [1325752080000] info:track_plays + song-23 + diff --git a/_posts/tutorials/music-recommendation/2012-01-01-followups.md b/_posts/tutorials/music-recommendation/2012-01-01-followups.md new file mode 100644 index 00000000..9b08b008 --- /dev/null +++ b/_posts/tutorials/music-recommendation/2012-01-01-followups.md @@ -0,0 +1,44 @@ +--- +layout: post +title : Follow Up +categories: [tutorials, music-recommendation, 1.0.0-rc4] +tags: [music] +order : 8 +description: Steps that build on what you know +--- + +Now that you have run through the tutorial, you have: + +* Efficiently imported data into a KijiTable in [Bulk Importing](../bulk-importing/). +* Manipulated data in and between Kiji and HDFS in [PlayCount](../play-count/). +* Use a gatherer to generate the next-song pairs, and use a generic MapReduce job to aggregate them + into counts and [SequentialPlayCount](../sequential-play-count/) +* Filtered the next song counts by popularity and wrote a list of the most popular to a Kiji table + in [NextTopSong](../next-songs/). +* Used a producer and joined together data sources, to generate the recommendations for our users in + [Music Recommendation Producer](../recommendation-producer/). + +Now that you understand how the mechanics work, you can begin to improve on the incredibly simple +recommendation algorithm we have implemented. It is worth noting that we have put thought into +our data generator, and you should be able to leverage patterns in what the users listen to. + +Have a look at the recommendations generated by the music recommendation producer. There are a few +problems to notice here: + +* Users can get recommended songs that they just listened to. + You can improve the logic of the recommend() method in the producer to avoid recommending recently + played songs. +* We only recommend songs that have been played immeadiately after eachother. + Our idea of songs that are similar enough to recommend is too narrow. In order to broaden our + definition, you can: + + ** Instead of looking back one song play, you can increase the "play radius" by incoporating + songs that have been played several song ahead of the song being analyzed. + ** Implement item-item collaborative filtering, perhaps using the [Mahout implementation](https://cwiki.apache.org/confluence/display/MAHOUT/Itembased+Collaborative+Filtering). + ** Cluster users together and use that information to enhance recommendations. + ** Once you have implemented another recommendation strategy, you can combine multiple startegies + in the recommendation producer by using multiple key-value stores and modifying the recommend method. + +Now that you have gotten your feet wet, you should join our [user group mailing list](https://groups.google.com/a/kiji.org/forum/?fromgroups#!forum/user). +It is great place to ask questions and talk about all the cool apps you are building with Kiji. + diff --git a/_posts/tutorials/music-recommendation/2012-01-01-music-overview.md b/_posts/tutorials/music-recommendation/2012-01-01-music-overview.md new file mode 100644 index 00000000..7e89d6fc --- /dev/null +++ b/_posts/tutorials/music-recommendation/2012-01-01-music-overview.md @@ -0,0 +1,56 @@ +--- +layout: post +title: Overview +categories: [tutorials, music-recommendation, 1.0.0-rc4] +tags: [music] +order: 1 +description: A tutorial to get you using MapReduce with Kiji Tables. +--- + +It’s the year 3000, and new music is being created at such a fast pace that your company Pandorify can no longer analyze and categorize music fast enough to recommend it to your users. Fortunately, technology has kept up! With KijiSchema and KijiMR, you can leverage all the song play data you have collected over the last thousand years to make recommendations for your users! + +We believe that past patterns are a good source for future recommendations. To impose structure on the data, we will use a layout in KijiSchema. To effectively use this gigantic flood of data, we can use MapReduce paradigms provided by KijiMR to analyze and provide recommendations. + +In this tutorial, we demonstrate how simple it is to use KijiMR to leverage your data effectively. You will: + +* Efficiently import data into a KijiTable. +* Manipulate data in and between Kiji and HDFS. +* Use a gatherer to generate the next-song pairs, and use a generic MapReduce job to aggregate them into counts. +* Use a producer and join together data sources, to generate the recommendations for our users. + +### How to Use this Tutorial + +* **Links to Javadoc** - Class names link to the relevant Javadoc: +[`EntityId`]({{site.api_schema_rc4}}/EntityId.html). + +* **Code Walkthrough** - Code snippets are in gray boxes with language specific syntax highlighting. + +{% highlight java %} +System.out.println("Hello Kiji"); +{% endhighlight %} + +* **Shell Commands** - Shell commands to run the above code will be in light blue boxes, and the results in grey. + +
    +{% highlight bash %} +echo "Hello Kiji" +{% endhighlight %} +
    + + Hello Kiji + +* **Expandable Code** - Larger sections of code are marked with headers in gray boxes that contain a ++. These can be expanded by clicking the header. + +
    +

    HelloWorld.java

    +
    +{% highlight java %} +public class HelloWorld { + public static void main(String[] args) { + System.out.println("Hello world!"); + } +} +{% endhighlight %} +
    +
    diff --git a/_posts/tutorials/music-recommendation/2012-01-01-music-setup.md b/_posts/tutorials/music-recommendation/2012-01-01-music-setup.md new file mode 100644 index 00000000..599e5b59 --- /dev/null +++ b/_posts/tutorials/music-recommendation/2012-01-01-music-setup.md @@ -0,0 +1,141 @@ +--- +layout: post +title: Setup +categories: [tutorials, music-recommendation, 1.0.0-rc4] +tags: [music] +order: 2 +description: Setup and compile instructions for the music recommendation tutorial. +--- +For this tutorial, we assume you are either using the standalone Kiji BentoBox or +have installed the individual components described [here](http://www.kiji.org/getstarted/). +If you don\'t have a working environment yet, you can install the standalone Kiji +BentoBox in [three quick steps!](http://www.kiji.org/#tryit) + +If you already installed BentoBox, make sure you have started it: + +
    +{% highlight bash %} +bento start +{% endhighlight %} +
    + +### Compiling + +If you have downloaded the standalone Kiji BentoBox, the code for this tutorial +is already compiled and located in the `$KIJI_HOME/examples/music/` directory. +Commands in this tutorial will depend on this location: + +
    +{% highlight bash %} +export $MUSIC_HOME = ${KIJI_HOME}/examples/music +{% endhighlight %} +
    + +If you are not using the Kiji BentoBox, set `MUSIC_HOME` to the path of your local +kiji-music repository. + +Once you have done this, if you are using Kiji BentoBox you can skip to +"Set your environment variables" if you want to get started playing with the example code. +Otherwise, follow these steps to compile it from source. + +The source code for this tutorial can be found in `$MUSIC_HOME`. +The source is included along with a Maven project. To get started using Maven, +consult [Getting started With Maven]({{site.kiji_url}}/get-started-with-maven) or +the [Apache Maven Homepage](http://maven.apache.org/). + +The following tools are required to compile this project: +* Maven 3.x +* Java 6 + +To compile, run `mvn package` from `$MUSIC_HOME`. The build +artifacts (.jar files) will be placed in the `$MUSIC_HOME/target/` +directory. This tutorial assumes you are using the pre-built jars included with +the music recommendation example under `$MUSIC_HOME/lib/`. If you wish to +use jars of example code that you have built, you should adjust the command +lines in this tutorial to use the jars in `$MUSIC_HOME/target/`. + +### Set your environment variables +After Bento starts, it will display ports you will need to complete this tutorial. It will be useful +to know the address of the MapReduce JobTracker webapp +([http://localhost:50030](http://localhost:50030) by default) while working through this tutorial. + +It will be useful to define an environment variable named `KIJI` that holds a Kiji URI to the Kiji +instance we'll use during this tutorial. + +
    +{% highlight bash %} +export KIJI=kiji://.env/kiji_music +{% endhighlight %} +
    + +To work through this tutorial, various Kiji tools will require that Avro data +type definitions particular to the working music recommendation example be on the +classpath. You can add your artifacts to the Kiji classpath by running: + +
    +{% highlight bash %} +export LIBS_DIR=$MUSIC_HOME/lib +export KIJI_CLASSPATH="${LIBS_DIR}/*" +{% endhighlight %} +
    + +### Install Kiji and Create Tables + +Install your Kiji instance: + +
    +{% highlight bash %} +kiji install --kiji=${KIJI} +{% endhighlight %} +
    + +Create the Kiji music tables that have layouts described in `music_schema.ddl`. + +
    +

    music_schema.ddl

    +
    + +
    +
    + + +
    +{% highlight bash %} +kiji-schema-shell --kiji=${KIJI} --file=$MUSIC_HOME/music_schema.ddl +{% endhighlight %} +
    + +This command uses [kiji-schema-shell](https://github.com/kijiproject/kiji-schema-shell) +to create the tables using the KijiSchema DDL, which makes specifying table layouts easy. +See [the KijiSchema DDL Shell reference]({{site.userguide_schema_rc4}}/schema-shell-ddl-ref) +for more information on the KijiSchema DDL. + +##### (Optional) Generate Data + +The music recommendation example comes with pregenerated song data in +`$MUSIC_HOME/example_data`. These .json files contain randomly-generated song information +and randomly-generated usage information for this tutorial. + +If you wish to generate new data, wipe the data directory, then use the python script provided. + +
    +{% highlight bash %} +rm $MUSIC_HOME/example_data/* +$MUSIC_HOME/bin/data_generator.py --output-dir=$MUSIC_HOME/example_data/ +{% endhighlight %} +
    + +This should generate 3 JSON files: `example_data/song-dist.json`, `example_data/song-metadata.json` +and `example_data/song-plays.json`. + +### Upload Data to HDFS + +Upload the data set to HDFS (this step is required, even if you did not generate new data): + +
    +{% highlight bash %} +hadoop fs -mkdir kiji-mr-tutorial +hadoop fs -copyFromLocal $MUSIC_HOME/example_data/*.json kiji-mr-tutorial/ +{% endhighlight %} +
    + diff --git a/_posts/tutorials/music-recommendation/2012-01-01-next-songs.md b/_posts/tutorials/music-recommendation/2012-01-01-next-songs.md new file mode 100644 index 00000000..8a547955 --- /dev/null +++ b/_posts/tutorials/music-recommendation/2012-01-01-next-songs.md @@ -0,0 +1,220 @@ +--- +layout: post +title : NextTopSong +categories: [tutorials, music-recommendation, 1.0.0-rc4] +tags: [music] +order : 6 +description: Outputing to a Kiji table in a MapReduce job. +--- + +This MapReduce job processes the result of the SequentialSong MapReduce job and writes a list of +the top songs played after each song (the key) to the corresponding row in the songs table. + +
    +

    IdentityMapper.java

    +
    + +
    +

    TopNextSongsReducer.java

    +
    + +
    +
    + +

    IdentityMapper.java

    +This is a stunning homage to Java boilerplate. This mapper is the identity function; it just +emits the same keys and values as it receives without changing them. + + +### TopNextSongsReducer.java +The keys passed into this reducer are song ids and the values are SongCount records. In order to +find the songs most frequently played after a given song, we need to identify the SongCount +records with the largest number of counts, for every key. + +To do this efficiently, we will maintain an ordered collection of SongCount records, that has a maximum +size. As we iterate through all the values, we will keep the top SongCount records seen so far +in our ordered collection. + +This reducer +* Creates an ordered collection that will maintain a list of the top SongCount records, for each key. +* Examines each value for a key, and maintains a running list of the top SongCount records seen so + far. +* Write a TopNextSongs record to the songs table. + + +#### Create an ordered Collection +In out setup method, we instantiate a TreeSet that will be reused. TreeSets use their comparator +(as opposed to a class' equals method) to determine if an element is already in the set. In order +for our TreeSet to contain multiple SongCount records with the same count, we must make sure +that our comparator differentiates SongCount records with the same number of counts, but with +different song ids. + +{% highlight java %} + public void setup(Context context) throws IOException, InterruptedException { + super.setup(context); // Any time you override setup, call super.setup(context); + mTopSongs = new TopSongs(); + // This TreeSet will keep track of the "largest" SongCount objects seen so far. Two SongCount + // objects, song1 and song2, can be compared and the object with the largest value in the field + // count will the declared the largest object. + mTopNextSongs = new TreeSet(new Comparator() { + @Override + public int compare(SongCount song1, SongCount song2) { + if (song1.getCount().compareTo(song2.getCount()) == 0) { + return song1.getSongId().toString().compareTo(song2.getSongId().toString()); + } else { + return song1.getCount().compareTo(song2.getCount()); + } + } + }); + } +{% endhighlight %} + +#### Maintain a collection of the top SongCount records +To find the top N songs, we iterate through the values associated with a given key, adding that +value to our set, and then removing the smallest value if our set is larger than the number of top +SongCount records we want to find. + +It is worth pointing out that when you call value.datum(), the *same* SongCount record, with +different fields, will be returned. Many Hadoop projects reuse objects, so be aware! To get around +the problem that this creates with trying to use a set, we create a new SongCount record for each +value using SongCount's builder method. + +{% highlight java %} + protected void reduce(AvroKey key, Iterable> values, + KijiTableContext context) throws IOException { + // We are reusing objects, so we should make sure they are cleared for each new key. + mTopNextSongs.clear(); + + // Iterate through the song counts and track the top ${mNumberOfTopSongs} counts. + for (AvroValue value : values) { + // Remove AvroValue wrapper. + SongCount currentSongCount = SongCount.newBuilder(value.datum()).build(); + + mTopNextSongs.add(currentSongCount); + // If we now have too many elements, remove the element with the smallest count. + if (mTopNextSongs.size() > mNumberOfTopSongs) { + mTopNextSongs.pollFirst(); + } + } + // Set the field of mTopSongs to be a list of SongCounts corresponding to the top songs played + // next for this key/song. + mTopSongs.setTopSongs(Lists.newArrayList(mTopNextSongs)); +{% endhighlight %} + +#### Write TopNextSongs to the songs table. +We can write the list of top next songs to the "info:top_next_songs" column using context.put(). The +only thing to remember witht his method, is that the first arguement is expected to be an entityId. +Luckily, context also contains methods for generating EntityIds. + +{% highlight java%} + ... + // Write this to the song table. + context.put(context.getEntityId(key.datum().toString()), "info", "top_next_songs", mTopSongs); + } +{% endhighlight %} + +
    +

    TestTopNextSongsPipeline.java

    +
    + +
    +
    + +

    TestTopNextSongsPipeline.java

    +Two jobs are constructed during this test and run one after another. The first job outputs to an +intermediate Avro container file (Add link to relevant userguide section) written to the local file system which is used as input by the +second job. Each of the jobs is configured using a job builder: + +{% highlight java %} + // Configure and run job. + final File outputDir = new File(getLocalTempDir(), "output.sequence_file"); + final Path path = new Path("file://" + outputDir); + // Configure first job. + final MapReduceJob mrjob1 = KijiGatherJobBuilder.create() + .withConf(getConf()) + .withGatherer(SequentialPlayCounter.class) + .withReducer(SequentialPlayCountReducer.class) + .withInputTable(mUserTableURI) + // Note: the local map/reduce job runner does not allow more than one reducer: + .withOutput(new AvroKeyValueMapReduceJobOutput(path, 1)) + .build(); + // Configure second job. + final MapReduceJobOutput tableOutput = new DirectKijiTableMapReduceJobOutput(mSongTableURI, 1); + final MapReduceJob mrjob2 = KijiMapReduceJobBuilder.create() + .withConf(getConf()) + .withInput(new AvroKeyValueMapReduceJobInput(path)) + .withMapper(IdentityMapper.class) + .withReducer(TopNextSongsReducer.class) + .withOutput(tableOutput).build(); + + // Run both jobs and confirm that they are successful. + assertTrue(mrjob1.run()); + assertTrue(mrjob2.run()); +{% endhighlight %} + +The results of these two jobs end up being written to a Kiji table. To validate the output data +a KijiTableReader is used to read the records in question. + +{% highlight java %} + mSongTable = getKiji().openTable(songTableName); + mSongTableReader = mSongTable.openTableReader(); + + // ... + + KijiDataRequest request = KijiDataRequest.builder() + .addColumns(ColumnsDef.create() + .withMaxVersions(Integer.MAX_VALUE) + .add("info", "top_next_songs")) + .build(); + + TopSongs valuesForSong1 = mSongTableReader.get(mSongTable.getEntityId("song-1"), request) + .getMostRecentValue("info", "top_next_songs"); + assertEquals("Wrong number of most popular songs played next for song-1", 3, + valuesForSong1.getTopSongs().size()); + + TopSongs valuesForSong2 = mSongTableReader.get(mSongTable.getEntityId("song-2"), request) + .getMostRecentValue("info", "top_next_songs"); + LOG.info("the list of song counts {}", valuesForSong2.getTopSongs().toString()); + assertEquals("Wrong number of most popular songs played next for song-2", 2, + valuesForSong2.getTopSongs().size()); + + TopSongs valuesForSong8 = mSongTableReader.get(mSongTable.getEntityId("song-8"), request) + .getMostRecentValue("info", "top_next_songs"); + LOG.info("the list of song counts {}", valuesForSong2.getTopSongs().toString()); + assertEquals("Wrong number of most popular songs played next for song-8", 1, + valuesForSong8.getTopSongs().size()); + assertEquals("The onyl song played aftert song-8 is song-1.", "song-1", + valuesForSong8.getTopSongs().get(0).getSongId().toString()); +{% endhighlight %} + +### Running the Example + +
    +{% highlight bash %} +kiji mapreduce \ + --mapper=org.kiji.examples.music.map.IdentityMapper \ + --reducer=org.kiji.examples.music.reduce.TopNextSongsReducer \ + --input="format=avrokv file=output.sequentialPlayCount" \ + --output="format=kiji table=${KIJI}/songs nsplits=1" \ + --lib=${LIBS_DIR} +{% endhighlight %} +
    + +#### Verify +Since we write TopNextSongs back to the Kiji table, we can use the Kiji command-line tools +to inspect our Kiji tables. + +
    +{% highlight bash %} +kiji ls --kiji=${KIJI}/songs --columns=info:top_next_songs --max-rows=3 +{% endhighlight %} +
    + + entity-id='song-32' [1361564627564] info:top_next_songs + {"topSongs": [{"song_id": "song-37", "count": 10}, {"song_id": "song-34", "count": 11}, {"song_id": "song-30", "count": 18}]} + + entity-id='song-49' [1361564627741] info:top_next_songs + {"topSongs": [{"song_id": "song-46", "count": 10}, {"song_id": "song-41", "count": 20}, {"song_id": "song-40", "count": 27}]} + + entity-id='song-36' [1361564627591] info:top_next_songs + {"topSongs": [{"song_id": "song-32", "count": 11}, {"song_id": "song-35", "count": 15}, {"song_id": "song-30", "count": 27}]} diff --git a/_posts/tutorials/music-recommendation/2012-01-01-play-count.md b/_posts/tutorials/music-recommendation/2012-01-01-play-count.md new file mode 100644 index 00000000..9c95c909 --- /dev/null +++ b/_posts/tutorials/music-recommendation/2012-01-01-play-count.md @@ -0,0 +1,235 @@ +--- +layout: post +title : PlayCount +categories: [tutorials, music-recommendation, 1.0.0-rc4] +tags: [music] +order : 4 +description: Like WordCount, for songs. +--- + +### The 'Hello World!' of MapReduce +To quote Scalding Developers +[Hadoop is a distributed system for counting words.](https://github.com/twitter/scalding) +Unfortunately, we here at Pandorify are fresh out of words, but we do have the play history of +millions of users listening to millions of different songs. + +This MapReduce job uses the listening history of our users that we have stored in the "users" Kiji +table to calculate the total number of times each song has been played. The result of this computation +is written to a text file in HDFS. + +
    +

    SongPlayCounter.java

    +
    + +
    +

    LongSumReducer.java

    +
    + +
    +
    + +

    SongPlayCounter

    + +The SongPlayCounter is an example of a [Gatherer]({{site.userguide_mapreduce_rc4}}/gatherers), which is essentially a +mapper that gets input from a [`KijiTable`]({{site.api_schema_rc4}}/KijiTable.html). SongPlayCounter proceeds through discrete stages: +* Setup reusable resources. +* Read all values from column: "info:track_plays". +* Process the data from "info:track_plays" and emit a key-value pair for each track ID each time + it occurs. + +#### Initialize Resources +First, SongPlayCounter prepares any resources that may be needed by the gatherer. In Hadoop, +reusable objects are commonly instantiated only once to protect against long garbage collection +pauses. This is particularly important with Kiji because long garbage collection pauses can cause +MR jobs to fail because various resources timeout or cannot be found. + +Since setup() is an overriden method, we call super.setup() to ensure that all resources are +initialized properly. If you open resources in setup(), be sure to close them in the corresponding +cleanup() method. + +{% highlight java %} + public void setup(GathererContext context) throws IOException { + super.setup(context); // Any time you override setup, call super.setup(context); + mText = new Text(); + } +{% endhighlight %} + +#### Read track play data from the table +A gatherer takes input from a table, so it must declare what data it will need. It does this in the +form of a [`KijiDataRequest`]({{site.api_schema_rc4}}/KijiDataRequest.html), which is defined in getDataRequest(). +For the song count job, we want to request all songs that have been played, for every user. In order +to get all of the values written to the "info:track_plays" column, we must specify that the maximum +number of versions we want is HConstants.ALL_VERSIONS. Otherwise, we will only get the most recent +version by default. + +{% highlight java %} +public KijiDataRequest getDataRequest() { + // This method is how we specify which columns in each row the gatherer operates on. + // In this case, we need all versions of the info:track_plays column. + final KijiDataRequestBuilder builder = KijiDataRequest.builder(); + builder.newColumnsDef() + .withMaxVersions(HConstants.ALL_VERSIONS) // Retrieve all versions. + .add("info", "track_plays"); + return builder.build(); +} +{% endhighlight %} + +#### Process track play data into key-value pairs for occurrences +Called once for each row in the Kiji table, gather() retrieves all the values in the +"info:track_plays" column, and for each value, sets the Text object we are resuing to contain the +current value, writes the key-value pairs using `context.write(mText, ONE)` and then clears the Text +object before the next call to gather. +{% highlight java %} + public void gather(KijiRowData row, GathererContext context) + throws IOException { + // The gather method operates on one row at a time. For each user, we iterate through + // all their track plays and emit a pair of the track ID and the number 1. + NavigableMap trackPlays = row.getValues("info", "track_plays"); + for (CharSequence trackId : trackPlays.values()) { + mText.set(trackId.toString()); + context.write(mText, ONE); + mText.clear(); + } + } +{% endhighlight %} + +### LongSumReducer +The key-value pairs emitted from the gatherer are shuffled and sorted by the MapReduce framework, +so each call to the reducer is given a key and an iterator of all values associated with +a key. The LongSumReducer calls reduce() for each key and sums all of the associated values to produce a +total play count for each song ID. The LongSumReducer has three stages: +* Setup reusable resources. +* Sum the values associated with a key. +* Output the key paired with the sum. + +Because summing values is such a common MapReduce operation, LongSumReducer is provided by the KijiMR +library. + +#### Initialize Resources +It is common practice to avoid instantiating new objects in map or reduce methods as +Hadoop developers have a (perhaps now outdated) skepticism of garbage collection in the JVM. + +{% highlight java %} + protected void setup(Context context) { + mValue = new LongWritable(); + } +{% endhighlight %} + +#### Sum Values and Output Total +Called once for each key, reduce() combines the +all of the values associated with a key by adding then together and writing the total for each key +to the output collector. + +{% highlight java %} + public void reduce(K key, Iterator values, + OutputCollector output, + Reporter reporter) + throws IOException { + + // sum all values for this key + long sum = 0; + while (values.hasNext()) { + sum += values.next().get(); + } + + // output sum + output.collect(key, new LongWritable(sum)); + } +{% endhighlight %} + +### TestSongPlayCounter +To verify that SongPlayCounter performs as expected, SongPlayCounter's test: +* Creates and populates an in-memory Kiji instance. +* Runs a MapReduce job with SongPlayCounter as the gatherer and LongSumReducer as the reducer. +* Verifies that the output is as expected. + +
    +

    TestSongPlayCounter.java

    +
    + +
    +
    + +

    Create an in-memory Kiji instance

    +The InstanceBuilder class provides methods for populating a test Kiji instance. Once the test +instance has been defined, its build method is called, creating the in-memory instance and +table. + +{% highlight java %} + public final void setup() throws Exception { + final KijiTableLayout layout = + KijiTableLayout.createFromEffectiveJsonResource("/layout/users.json"); + final String tableName = layout.getName(); + mTableURI = KijiURI.newBuilder(getKiji().getURI()).withTableName(tableName).build(); + + new InstanceBuilder(getKiji()) + .withTable(tableName, layout) + .withRow("user-1").withFamily("info").withQualifier("track_plays") + .withValue(1L, "song-1") + .withValue(2L, "song-2") + .withValue(3L, "song-3") + .withRow("user-2").withFamily("info").withQualifier("track_plays") + .withValue(1L, "song-1") + .withValue(2L, "song-3") + .withValue(3L, "song-4") + .withValue(4L, "song-1") + .withRow("user-3").withFamily("info").withQualifier("track_plays") + .withValue(1L, "song-5") + .build(); + } +{% endhighlight %} + +#### Run and verify SongPlayCounter +KijiGatherJobBuilder is used to create a test MapReduce job. This job builder can be used outside +the context of a test to configure and run jobs programmatically. The job is then run using Hadoop's +local job runner. The resulting output sequence file is then validated. + +{% highlight java %} + final File outputDir = new File(getLocalTempDir(), "output.sequence_file"); + final MapReduceJob mrjob = KijiGatherJobBuilder.create() + .withConf(getConf()) + .withGatherer(SongPlayCounter.class) + .withReducer(LongSumReducer.class) + .withInputTable(mTableURI) + // Note: the local map/reduce job runner does not allow more than one reducer: + .withOutput(new SequenceFileMapReduceJobOutput(new Path("file://" + outputDir), 1)) + .build(); + assertTrue(mrjob.run()); + + final Map counts = Maps.newTreeMap(); + readSequenceFile(new File(outputDir, "part-r-00000"), counts); + LOG.info("Counts map: {}", counts); + assertEquals(5, counts.size()); + assertEquals(3L, (long) counts.get("song-1")); + assertEquals(1L, (long) counts.get("song-2")); + assertEquals(2L, (long) counts.get("song-3")); + assertEquals(1L, (long) counts.get("song-4")); + assertEquals(1L, (long) counts.get("song-5")); +{% endhighlight %} + +### Running the Example + +
    +{% highlight bash %} +kiji gather \ + --gatherer=org.kiji.examples.music.gather.SongPlayCounter \ + --reducer=org.kiji.mapreduce.lib.reduce.LongSumReducer \ + --input="format=kiji table=${KIJI}/users" \ + --output="format=text file=output.txt_file nsplits=2" \ + --lib=${LIBS_DIR} +{% endhighlight %} +
    + +#### Verify + +To confirm that the gather job worked, examine the output using hadoop filesystem command line tools: + +
    +{% highlight bash %} +hadoop fs -text output.txt_file/part-r-00000 | head -3 +{% endhighlight %} +
    + + song-1 100 + song-10 272 + song-12 101 diff --git a/_posts/tutorials/music-recommendation/2012-01-01-recommendation-producer.md b/_posts/tutorials/music-recommendation/2012-01-01-recommendation-producer.md new file mode 100644 index 00000000..a3c6152b --- /dev/null +++ b/_posts/tutorials/music-recommendation/2012-01-01-recommendation-producer.md @@ -0,0 +1,182 @@ +--- +layout: post +title : Music Recommendation Producer +categories: [tutorials, music-recommendation, 1.0.0-rc4] +tags: [music] +order : 7 +description: Read and write to the same row of a table. +--- + +
    +

    NextSongRecommender.java

    +
    + +
    +
    + +

    NextSongRecommender

    +The NextSongRecommender is an example of a [KijiProducer]({{site.userguide_mapreduce_rc4}}/producers). +A producer operates on a single row of input data and generates new outputs that are written to the +same row. It can also refer to external sources of data via KeyValueStores in addition to the input from the row. +For every row this producer processes, it will: + +* Read the most recent value from the "info:track_plays" column of the users table. This is the song + ID of the most recently played song by the user. +* Look up a list of the songs most frequently played next from the songs table. +* Use external data sources (in this case the list of songs most frequently played next that we computed and wrote +to the "songs" table) to generate a recommendation for each user. +* Write that recommendation to the "info:next_song_rec" column of the users table. + +#### Get The Most Recent Song Played +Like in a gatherer, you specify the required columns for your producer in the `getDataRequest` method. We +only want the most recent value from this column, so we can use the `create()` convenience method. +{% highlight java %} + public KijiDataRequest getDataRequest() { + // Only request the most recent version from the "info:track_plays" column. + return KijiDataRequest.create("info", "track_plays"); + } +{% endhighlight %} + +In our `produce()` method, we then access our requested data through the [`KijiRowData`]({{site.api_schema_rc4}}/KijiRowData.html): + +{% highlight java %} + String mostRecentSong = input.getMostRecentValue("info", "track_plays") + .toString();// Avro strings get deserialized to CharSequences, so .toString() the result. +{% endhighlight %} + +#### Join External Data Sources +[KeyValueStores]({{site.userguide_mapreduce_rc4}}/key-value-stores) allow you to access external data sources in a MapReduce job. +This is a common pattern in MapReduce jobs, as it allows us to integrate two sources of data. In this case, we will use the +"top_next_songs" column of our "songs" table as a KeyValueStore. + +In order to access KeyValueStores in a KijiMR Job, the class that needs the external data must +implement KeyValueStoreClient. This interface requires that you implement getRequiredStores(). +The value that you must return from getRequiredStores is a map from the name of a KeyValueStore to +the default implementation. + +For reasons pertaining to [KijiMR-91](https://jira.kiji.org/browse/KIJIMR-91) we leave our default +implementation unconfigured. + +{% highlight java %} + public Map> getRequiredStores() { + return RequiredStores.just("nextPlayed", UnconfiguredKeyValueStore.builder().build()); + } +{% endhighlight %} + +This default implementation must be overriden when this producer is run. +In the unit test, it is programmatically overriden using a job builder. When we run it from the +command line, we will override the default implementation using the KVStoreConfig.xml file. + +#### Generate a Recommendation +To generate a recommendation from the list of songs that are most likely to be played next, we do +the simplest thing possible; choose the first element of the list. + +{% highlight java %} + private CharSequence recommend(List topNextSongs) { + return topNextSongs.get(0).getSongId(); // Do the simplest possible thing. + } +{% endhighlight %} + +#### Write the Output to a Column +To write our recommendation to the table, we need to declare what column we are writing to. + +{% highlight java %} + public String getOutputColumn() { + return "info:next_song_rec"; + } +{% endhighlight %} + +Since the column is already declared, to write a value to it, we simply call context.put() with +the value we want to write as the parameter. + +{% highlight java %} + context.put(recommend(popularNextSongs)); +{% endhighlight %} + +
    +

    TestNextSongRecommender.java

    +
    + +
    +
    + +

    TestNextSongRecommender

    +To test NextSongRecommender, we need specify which KijiTable we want to use to back our +KeyValueStore. We do this by constructing the KeyValueStore we want to use, via the KeyValueStore's +builder method. We then override the KeyValueStore binding in this job configuration by using the +withStore() method of JobBuilders. + +{% highlight java %} + KijiTableKeyValueStore.Builder kvStoreBuilder = KijiTableKeyValueStore.builder(); + kvStoreBuilder.withColumn("info", "top_next_songs").withTable(mSongTableURI); + + // Configure first job. + final MapReduceJob mrjob = KijiProduceJobBuilder.create() + .withStore("nextPlayed", kvStoreBuilder.build()) + + // ... +{% endhighlight %} + +### Running the Example +When we run this example, we again need to need specify which +[`KijiTable`]({{site.api_schema_rc4}}/KijiTable.html) we want to use to back our +KeyValueStore. This time, we will override the KeyValueStore binding from +the command line using an XML configuration file (located at $KIJI_HOME/examples/music/KVStoreConfig.xml). +The contents of the file are displayed below. If you are not using BentoBox, you may need to modify this +XML file so that the URI points to the songs table you would like to use. + + +{% highlight xml %} + + + + + +    table.uri + + kiji://.env/kiji_music/songs + + +  column +    info:top_next_songs +   +   + + +{% endhighlight %} + +Now, run the command: + +
    +{% highlight bash %} +kiji produce \ + --producer=org.kiji.examples.music.produce.NextSongRecommender \ + --input="format=kiji table=$KIJI/users" \ + --output="format=kiji table=$KIJI/users nsplits=2" \ + --lib=${LIBS_DIR} \ + --kvstores=$MUSIC_HOME/KVStoreConfig.xml +{% endhighlight %} +
    + +The input and output for the producer come from the Kiji table "users", +and the KeyValueStores are specified by the KVStoreConfig.xml file. + +#### Verify + +
    +{% highlight bash %} +kiji ls --kiji=$KIJI/users --columns=info:next_song_rec --max-rows=3 +{% endhighlight %} + +These are our recommendations for the next song to play for each user! +
    + + entity-id='user-41' [1361564713968] info:next_song_rec + song-41 + + entity-id='user-3' [1361564713980] info:next_song_rec + song-2 + + entity-id='user-13' [1361564713990] info:next_song_rec + song-27 + diff --git a/_posts/tutorials/music-recommendation/2012-01-01-sequential-play-count.md b/_posts/tutorials/music-recommendation/2012-01-01-sequential-play-count.md new file mode 100644 index 00000000..4a41d9c0 --- /dev/null +++ b/_posts/tutorials/music-recommendation/2012-01-01-sequential-play-count.md @@ -0,0 +1,246 @@ +--- +layout: post +title : SequentialPlayCount +categories: [tutorials, music-recommendation, 1.0.0-rc4] +tags: [music] +order : 5 +description: Includes info on working with Avro +--- + +Instead of recommending the most popular songs to everyone using our service, we want to tailor our +recommendations based on user's listening history. For every user, we will look up the most recent +song they have listened to and then recommend the song most frequently played after it. In order +to do that, we need to create an index so that for each song, we can quickly look up what the +most popular songs to listen to afterwards are. + +So, we need to count the number of times two songs have been played, one after another. The +`SequentialPlayCounter` and `SequentialPlayCountReducer` allow us to do that. + +
    +

    SequentialPlayCounter.java

    +
    + +
    +

    SequentialPlayCountReducer.java

    +
    + +
    +
    + +

    SequentialPlayCounter

    +`SequentialPlayCounter` operates in much the same way that `SongPlayCounter` does, but it +requires a more complex key structure to store both the song played and the song that followed. +The easiest way work with complex keys in Kiji is to use [Avro](http://avro.apache.org). +We define a `SongBiGram`, which will be our key, as a pair of songs played sequentially by a +single user. + +{% highlight js %} + /** Song play bigram. */ + record SongBiGram { + /** The ID of the first song played in a sequence. */ + string first_song_played; + + /** The ID of the song played immediately after it. */ + string second_song_played; + } +{% endhighlight %} + +Whereas `SongPlayCounter`'s output value class was `Text.class`, `SequentialPlayCounter` uses `AvroKey.class` +which requires that we also implement `AvroKeyWriter` and override `getAvroKeyWriterSchema()` to +fully define the Avro key format. + +`SequentialPlayCounter` executes the same basic stages as `SongPlayCounter`, but with a more complex +gather operation. + +#### Read track play data and compose complex keys +`SequentialPlayCounter` reads the same data as `SongPlayCounter`, but maintains a "sliding window" +of the most recent two track ids. For each song after the first, `gather()` emits a key-value pair +where the key is a `SongBiGram` of the two most recently played songs, and the value is one (1) as a +tally. + +{% highlight java %} + /** {@inheritDoc} */ + @Override + public void gather(KijiRowData input, GathererContext, LongWritable> context) + throws IOException { + CharSequence firstSong = null; + CharSequence nextSong = null; + NavigableMap trackPlays = input.getValues("info", "track_plays"); + for (CharSequence trackId : trackPlays.values()) { // Iterate through this user's track plays. + // Slide the window one song over. + firstSong = nextSong; + nextSong = trackId; + // If firstSong is null, we are at the beginning of the list and our sliding window + // only contains one song, so don't output it. Otherwise... + if (null != nextSong) { + // Create the bigram of these two songs. + mBiGram.setFirstSongPlayed(firstSong); + mBiGram.setSecondSongPlayed(nextSong); + // Emit the bigram of these two songs. + context.write(new AvroKey(mBiGram), ONE); + } + } + } +{% endhighlight %} + +### SequentialPlayCountReducer +This reducer takes in pairs of songs that have been played sequentially and the number one. +It then computes the number of times those songs have been played together, and emits the ID of +the first song as the key, and a `SongCount` record representing the song played after the first as +the value. A `SongCount` record has a field containing the ID of the subsequent song and a field +for the number of times it has been played after the initial song. + +This reducer takes `AvroKey` as input, and writes `AvroKey` and `AvroValue` as output, so it must +implement `AvroKeyReader`, `AvroKeyWriter`, and `AvroValueWriter`. The keys we are emitting are just strings +so we could use a [Text](link-to-text-key-docs) key. Instead, we made the choice to use an `AvroKey` +so that we could use the Kiji defined [AvroKeyValue output format]({{site.userguide_mapreduce_rc4}}/command-line-tools/#output), which +requires that you output `AvroKey` and `AvroValue`. + +The schema for our Avro key is so simple that we don't have to add a record to our avdl file +in order to return the correct schema in `getWriterSchema()`. Instead, we can use the static methods +avro provides for creating schemas of primitive types. + +{% highlight java %} + public Schema getAvroKeyWriterSchema() throws IOException { + // Programmatically retrieve the avro schema for a String. + return Schema.create(Schema.Type.STRING); + } +{% endhighlight %} + +#### Sum Sequential Plays +`SequentialPlayCountReducer` starts with the same reduction operation that `LongSumReducer` used to +count track plays in the `SongCount` example, but diverges when emitting key-value pairs. Instead +of passing the keys through the reducer, `SequentialPlayCountReducer` creates new keys based on the +track IDs in the `SongBiGram` keys. The new keys are simply the first track ID from each bi-gram, +while the second track ID becomes part the `SongCount` value. + +{% highlight java %} + protected void reduce(AvroKey key, Iterable values, Context context) + throws IOException, InterruptedException { + // Initialize sum to zero. + long sum = 0L; + // Add up all the values. + for (LongWritable value : values) { + sum += value.get(); + } + + // Set values for this count. + final SongBiGram songPair = key.datum(); + + final SongCount nextSongCount = SongCount.newBuilder() + .setCount(sum) + .setSongId(songPair.getSecondSongPlayed()) + .build(); + // Write out result for this song. + context.write( + new AvroKey(songPair.getFirstSongPlayed().toString()), + new AvroValue(nextSongCount)); + } +{% endhighlight %} + +### TestSequentialSongPlayCounter +To verify that `SequentialPlayCounter` and `SequentialPlayCountReducer` function as expected, their +test: +* Creates and populates an in-memory Kiji instance +* Runs a MapReduce job with `SequentialPlayCounter` as the gatherer and `SequentialPlayCountReducer` as the reducer +* Verifies that the output is as expected + +
    +

    TestSequentialSongPlayCounter.java

    +
    + +
    +
    + +

    Create an in-memory Kiji instance

    +The InstanceBuilder class provides methods for populating a test Kiji instance. Once the test +instance has been defined, its build method is called, creating the in-memory instance and +table. + +{% highlight java %} + public final void setup() throws Exception { + final KijiTableLayout userLayout = + KijiTableLayout.createFromEffectiveJsonResource("/layout/users.json"); + final String userTableName = userLayout.getName(); + mUserTableURI = KijiURI.newBuilder(getKiji().getURI()).withTableName(userTableName).build(); + + new InstanceBuilder(getKiji()) + .withTable(userTableName, userLayout) + .withRow("user-1").withFamily("info").withQualifier("track_plays") + .withValue(2L, "song-2") + .withValue(3L, "song-1") + .withRow("user-2").withFamily("info").withQualifier("track_plays") + .withValue(2L, "song-3") + .withValue(3L, "song-2") + .withValue(4L, "song-1") + .withRow("user-3").withFamily("info").withQualifier("track_plays") + .withValue(1L, "song-5") + .build(); + } +{% endhighlight %} + +#### Run and verify SequentialPlayCounter and SequentialPlayCountReducer +`KijiGatherJobBuilder` is used to create a test MapReduce job. This job builder can be used outside +the context of a test to configure and run jobs programatically. The job is then run using Hadoop's +local job runner. The resulting output sequence file is then validated. + +{% highlight java %} + // Configure and run job. + final File outputDir = new File(getLocalTempDir(), "output.sequence_file"); + final Path path = new Path("file://" + outputDir); + final MapReduceJob mrjob = KijiGatherJobBuilder.create() + .withConf(getConf()) + .withGatherer(SequentialPlayCounter.class) + .withReducer(SequentialPlayCountReducer.class) + .withInputTable(mUserTableURI) + // Note: the local map/reduce job runner does not allow more than one reducer: + .withOutput(new AvroKeyValueMapReduceJobOutput(new Path("file://" + outputDir), 1)) + .build(); + assertTrue(mrjob.run()); +{% endhighlight %} + +Reading back files is easy with normal file or table readers, currently avrokv files can be read +in a limited way using a KeyValueStoreReader. + +{% highlight java %} + AvroKVRecordKeyValueStore.Builder kvStoreBuilder = AvroKVRecordKeyValueStore.builder() + .withInputPath(path).withConfiguration(getConf()); + final AvroKVRecordKeyValueStore outputKeyValueStore = kvStoreBuilder.build(); + KeyValueStoreReader reader = outputKeyValueStore.open(); + + // Check that our results are correct. + assertTrue(reader.containsKey("song-1")); + SongCount song1Result = (SongCount) reader.get("song-1"); + assertEquals(2L, song1Result.getCount().longValue()); + // Avro strings are deserialized to CharSequences in Java, .toString() allows junit to correctly + // compare the expected and actual values. + + assertEquals("song-2", song1Result.getSongId().toString()); + assertTrue(reader.containsKey("song-2")); + SongCount song2Result = (SongCount) reader.get("song-2"); + assertEquals(1L, song2Result.getCount().longValue()); + // Avro strings are deserialized to CharSequences in Java, .toString() allows junit to correctly + // compare the expected and actual values. + assertEquals("song-3", song2Result.getSongId().toString()); +{% endhighlight %} + +### Running the Example + +
    +{% highlight bash %} +kiji gather \ + --gatherer=org.kiji.examples.music.gather.SequentialPlayCounter \ + --reducer=org.kiji.examples.music.reduce.SequentialPlayCountReducer \ + --input="format=kiji table=${KIJI}/users" \ + --output="format=avrokv file=output.sequentialPlayCount nsplits=2" \ + --lib=${LIBS_DIR} +{% endhighlight %} +
    + +#### Verify +Because this job outputs Avro key-value files, which are binary and hard to read directly, we can use the +Hadoop job tracker to verify the success of the job. Using your favorite browser, navigate to +the JobTracker page ([localhost:50030 by default](http://localhost:50030)). This is where you can +monitor all your Hadoop jobs. Locate the Kiji gather: `SequentialPlayCounter` / +`SequentialPlayCountReducer` job and navigate to the job page by clicking on the Job ID. On the +job page, check that Map output records number roughly 7000. diff --git a/_posts/tutorial/2012-01-01-phonebook-create.md b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-create.md similarity index 95% rename from _posts/tutorial/2012-01-01-phonebook-create.md rename to _posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-create.md index 61b434af..636f9f02 100644 --- a/_posts/tutorial/2012-01-01-phonebook-create.md +++ b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-create.md @@ -1,8 +1,8 @@ --- layout : post title : Create a Table -category : tutorial -tags : [article] +categories: [tutorials, phonebook-tutorial, 1.0.0-rc3] +tags : [phonebook] order : 3 description: To use a phonebook, you need a phonebook. --- @@ -19,7 +19,7 @@ consult the [Get Started](http://www.kiji.org/getstarted) section of the Kiji we We have provided the phonebook layout in the `$KIJI_HOME/examples/phonebook/layout.ddl` file. For more information about how to create this file, see the -[DDL Shell Reference]({{site.userguide_url}}schema-shell-ddl-ref/). +[DDL Shell Reference]({{site.userguide_schema_rc3}}/schema-shell-ddl-ref/).
    {% highlight bash %} @@ -95,7 +95,7 @@ schema> describe phonebook; Schema: "string" Column derived:zip (Address zip code.) - Schema: "string" + Schema: "int" Column family: stats Description: Statistics about a contact. @@ -112,7 +112,7 @@ schema> quit; ### Using JSON A low level way of providing the layout is by using JSON. To learn more about specifying -the layout in JSON, take a look at [Managing Data]({{site.userguide_url}}managing-data/). +the layout in JSON, take a look at [Managing Data]({{site.userguide_schema_rc3}}/managing-data/). But first, we need to delete the table we just created, just so that we can create it another time using JSON! Use the following command to delete the table: diff --git a/_posts/tutorial/2012-01-01-phonebook-delete.md b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-delete.md similarity index 89% rename from _posts/tutorial/2012-01-01-phonebook-delete.md rename to _posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-delete.md index 56c55faa..7503b714 100644 --- a/_posts/tutorial/2012-01-01-phonebook-delete.md +++ b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-delete.md @@ -1,8 +1,8 @@ --- layout: post title: Delete Contacts -category: tutorial -tags: [article] +categories: [tutorials, phonebook-tutorial, 1.0.0-rc3] +tags: [phonebook] order: 8 description: Examples of Point deletions. --- @@ -67,7 +67,7 @@ Next, to perform the deletion of this contact using DeleteEntry:
    {% highlight bash %} $KIJI_HOME/bin/kiji jar \ - $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc1.jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc3.jar \ org.kiji.examples.phonebook.DeleteEntry {% endhighlight %}
    @@ -97,7 +97,7 @@ sanitize your phonebook of any California contacts. ### DeleteEntriesByState.java -Deletions from within a MapReduce job are performed using a `ContextKijiTableWriter`. +Deletions from within a MapReduce job are also performed using a `KijiTableWriter`. The DeleteEntriesByState example runs a MapReduce job that reads through the contacts in the phonebook table and deletes any entry that has an address from the specified state. @@ -113,20 +113,16 @@ public void map(EntityId entityId, KijiRowData row, Context context) } final String victimState = context.getConfiguration().get(CONF_STATE, ""); - final Address address = row.getValue(Fields.INFO_FAMILY, Fields.ADDRESS, Address.class); + final Address address = row.getMostRecentValue(Fields.INFO_FAMILY, Fields.ADDRESS); {% endhighlight %} -A `ContextKijiTableWriter` is then used to delete the row if the state matches: +A `KijiTableWriter` we opened in the `setup()` method is then used to delete +the row if the state matches: {% highlight java %} if (victimState.equals(address.getState().toString())) { // Delete the entry. - final ContextKijiTableWriter writer = new ContextKijiTableWriter(context); - try { - writer.deleteRow(entityId); - } finally { - writer.close(); - } + mWriter.deleteRow(entityId); } } {% endhighlight %} @@ -138,7 +134,7 @@ You can run the DeleteEntriesByState MapReduce job by running:
    {% highlight bash %} $KIJI_HOME/bin/kiji jar \ - $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc1.jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc3.jar \ org.kiji.examples.phonebook.DeleteEntriesByState --state=CA {% endhighlight %}
    @@ -167,7 +163,7 @@ bento stop
    To learn more about Kiji, check out these other resources: - - [User Guide]({{site.userguide_url}}kiji-schema-overview) + - [User Guide]({{site.userguide_schema_rc3}}/kiji-schema-overview) - [API Docs](http://docs.kiji.org/apidocs) - [Source Code](http://github.com/kijiproject) diff --git a/_posts/tutorial/2012-01-01-phonebook-derived-columns.md b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-derived-columns.md similarity index 90% rename from _posts/tutorial/2012-01-01-phonebook-derived-columns.md rename to _posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-derived-columns.md index 221c99ba..01d238e3 100644 --- a/_posts/tutorial/2012-01-01-phonebook-derived-columns.md +++ b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-derived-columns.md @@ -1,8 +1,8 @@ --- layout: post title : Derive Data -category: tutorial -tags: [article] +categories: [tutorials, phonebook-tutorial, 1.0.0-rc3] +tags: [phonebook] order: 6 description: Decompose address into its individual fields. --- @@ -32,11 +32,11 @@ The AddressMapper extends Hadoop's Mapper class. The map function is run per row It extracts the address field from each row as follows: {% highlight java %} -Address address = row.getValue(Fields.INFO_FAMILY, Fields.ADDRESS, Address.class); +Address address = row.getMostRecentValue(Fields.INFO_FAMILY, Fields.ADDRESS); {% endhighlight %} Address is the same Avro type you read about on the -[Phonebook Importer]({{site.tutorial_url}}/phonebook-import/) page. The JSON +[Phonebook Importer]({{site.tutorial_phonebook_rc3}}/phonebook-import/) page. The JSON description for it can be found at `$KIJI_HOME/examples/phonebook/src/main/avro/Address.avsc`. More information about Avro types can be found @@ -57,7 +57,7 @@ You can execute this example using the `kiji jar` command with the class name:
    {% highlight bash %} $KIJI_HOME/bin/kiji jar \ - $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc1.jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc3.jar \ org.kiji.examples.phonebook.AddressFieldExtractor {% endhighlight %}
    diff --git a/_posts/tutorial/2012-01-01-phonebook-import.md b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-import.md similarity index 82% rename from _posts/tutorial/2012-01-01-phonebook-import.md rename to _posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-import.md index d8d70cb7..1c17addf 100644 --- a/_posts/tutorial/2012-01-01-phonebook-import.md +++ b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-import.md @@ -1,8 +1,8 @@ --- layout: post title: Import Data -category: tutorial -tags: [article] +categories: [tutorials, phonebook-tutorial, 1.0.0-rc3] +tags: [phonebook] order: 5 description: How to import data into the phonebook table. --- @@ -55,7 +55,7 @@ JsonDecoder decoder = Address streetAddr = datumReader.read(null, decoder); {% endhighlight %} -Next we create a unique [`EntityId`]({{site.api_url}}/EntityId.html) that will be used to reference this row. As before, we will use +Next we create a unique [`EntityId`]({{site.api_schema_rc3}}/EntityId.html) that will be used to reference this row. As before, we will use the combination of first and last name as a unique reference to this row: {% highlight java %} EntityId user = table.getEntityId(firstName + "," + lastName); @@ -78,7 +78,7 @@ example - using the `kiji jar` command.
    {% highlight bash %} $KIJI_HOME/bin/kiji jar \ - $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc1.jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc3.jar \ org.kiji.examples.phonebook.StandalonePhonebookImporter \ $KIJI_HOME/examples/phonebook/input-data.txt {% endhighlight %} @@ -111,24 +111,31 @@ The first thing we'll want to look at is the `setup()` method (which Hadoop will executing any map tasks): {% highlight java %} +/** {@inheritDoc} */ @Override -protected void setup(Context context) throws IOException, InterruptedException { - KijiConfiguration conf = new KijiConfiguration( - context.getConfiguration(), KijiConfiguration.DEFAULT_INSTANCE_NAME); - mKiji = Kiji.open(conf); +protected void setup(Context hadoopContext) + throws IOException, InterruptedException { + super.setup(hadoopContext); + final Configuration conf = hadoopContext.getConfiguration(); + KijiURI tableURI; + try { + tableURI = KijiURI.parse(conf.get(KijiConfKeys.OUTPUT_KIJI_TABLE_URI)); + } catch (KijiURIException kue) { + throw new IOException(kue); + } + mKiji = Kiji.open(tableURI, conf); mTable = mKiji.openTable(TABLE_NAME); - mWriter = new ContextKijiTableWriter(context); + mWriter = mTable.openTableWriter(); } {% endhighlight %} -This method sets up all the resources necessary for map tasks. Since this is a MapReduce job, we -initialize a `ContextKijiTableWriter` with the associated MapReduce `Context` in for our writing -to the phonebook Kiji table. Contrast this with the `KijiTableWriter` we used in the previous example. -`ContextKijiTableWriter` is constructed with a MapReduce context, and does not need to be closed -because it does not maintain any connections. +This method sets up all the resources necessary for map tasks. Note that we use a different +way to specify Kiji table and instance names here, a [`KijiURI`]({{site.api_schema_rc3}}/KijiURI.html). +This newer way to specify Kiji instance addresses is more robust than specifying the instance +name as a string. At the top of the map method, you'll see that we extract the fields from the lines as the above -example. Then using the `ContextKijiTableWriter` mWriter that is initialized earlier in setup, +example. Then using the `KijiTableWriter` mWriter that is initialized earlier in setup, we'll write all of the fields to the phonebook table: {% highlight java %} @@ -144,9 +151,12 @@ public void map(LongWritable byteOffset, Text line, Context context) } {% endhighlight %} +When the map task is complete, a `cleanup()` method will close the Kiji resources opened +in `setup()`. + The outer `PhonebookImporter` class contains a `run(...)` method that handles the setup of the MapReduce job. This is a typical MapReduce job setup. For detailed description -you can refer to [Accessing Data]({{site.userguide_url}}/accessing-data/). While the +you can refer to [Accessing Data]({{site.userguide_schema_rc3}}/accessing-data/). While the logic here closely resembles the non-MapReduce importer above, the heavy lifting of configuring the MapReduce job is done within the `run(...)` method. @@ -169,6 +179,13 @@ any reduce tasks to perform. job.setNumReduceTasks(0); {% endhighlight %} +Since we use the `KijiTableWriter` directly, and don't emit key-value pairs to an +OutputFormat, we disable this feature of MapReduce: + +{% highlight java %} +job.setOutputFormatClass(NullOutputFormat.class); +{% endhighlight %} + ### Running the Example First you'll need to put the text file of friends into hdfs. You can do this by using the hdfs `-copyFromLocal` command: @@ -187,7 +204,7 @@ path to the `input-data.txt` file in hdfs.
    {% highlight bash %} $KIJI_HOME/bin/kiji jar \ - $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc1.jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc3.jar \ org.kiji.examples.phonebook.PhonebookImporter \ /tmp/input-data.txt {% endhighlight %} diff --git a/_posts/tutorial/2012-01-01-phonebook-increment.md b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-increment.md similarity index 96% rename from _posts/tutorial/2012-01-01-phonebook-increment.md rename to _posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-increment.md index 4a9f525d..cde850f3 100644 --- a/_posts/tutorial/2012-01-01-phonebook-increment.md +++ b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-increment.md @@ -1,8 +1,8 @@ --- layout: post title : Use Counters -category: tutorial -tags: [article] +categories: [tutorials, phonebook-tutorial, 1.0.0-rc3] +tags: [phonebook] order : 7 description: Use atomic increment in the Phonebook example to calculate talktime. --- @@ -91,7 +91,7 @@ to the file in hdfs.
    {% highlight bash %} $KIJI_HOME/bin/kiji jar \ - $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc1.jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc3.jar \ org.kiji.examples.phonebook.IncrementTalkTime /tmp/input-phone-log.txt {% endhighlight %}
    diff --git a/_posts/tutorial/2012-01-01-phonebook-point-add.md b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-point-add.md similarity index 83% rename from _posts/tutorial/2012-01-01-phonebook-point-add.md rename to _posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-point-add.md index 817209e0..32dc0868 100644 --- a/_posts/tutorial/2012-01-01-phonebook-point-add.md +++ b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-point-add.md @@ -1,8 +1,8 @@ --- layout: post title : Read and Write in Kiji -category: tutorial -tags: [article] +categories: [tutorials, phonebook-tutorial, 1.0.0-rc3] +tags: [phonebook] order : 4 description: Add and lookup and single entry. --- @@ -13,7 +13,7 @@ and reading contacts. ## Writing to a Table Clearly, you need a way to add your ever-increasing set of friends to the phonebook. KijiSchema supports writing to Kiji tables with the -[`KijiTableWriter`]({{site.api_url}}KijiTableWriter.html) class. The phonebook example +[`KijiTableWriter`]({{site.api_schema_rc3}}/KijiTableWriter.html) class. The phonebook example includes code that uses a `KijiTableWriter` to write to the phonebook table. ### AddEntry.java @@ -70,7 +70,7 @@ You run the class `AddEntry` with the `kiji` command-line tool as follows:
    {% highlight bash %} $KIJI_HOME/bin/kiji jar \ - $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc1.jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc3.jar \ org.kiji.examples.phonebook.AddEntry {% endhighlight %}
    @@ -96,7 +96,19 @@ Zip: 94110
    #### Verify -Let's verify that our entry got into the phonebook table. +Now we can verify that our entry got into the phonebook table. + +Beforehand, you must tell `kiji ls` where the `org.kiji.examples.phonebook.Address` +Avro record class (mentioned in the DDL and used by `AddEntry`) is. +If you have not already done so, put the phonebook jar file on your Kiji classpath: + +
    +{% highlight bash %} +export KIJI_CLASSPATH=$KIJI_HOME/examples/phonebook/lib/kiji-phonebook-*.jar +{% endhighlight %} +
    + +Now use `kiji ls`:
    {% highlight bash %} @@ -119,7 +131,7 @@ $KIJI_HOME/bin/kiji ls --table=phonebook ## Reading From a Table Now that we've added a contact to your phonebook, we should be able to read this contact from the table. KijiSchema supports reading from Kiji tables with the -[`KijiTableReader`]({{site.api_url}}KijiTableReader.html) class. We have included an +[`KijiTableReader`]({{site.api_schema_rc3}}/KijiTableReader.html) class. We have included an example of retrieving a single contact from the Kiji table using the contact's first and last names. @@ -134,13 +146,13 @@ table = kiji.openTable(TABLE_NAME); // TABLE_NAME is "phonebook" {% endhighlight %} Since we are interested in reading from our table, we open a -[`KijiTableReader`]({{site.api_url}}KijiTableReader.html). +[`KijiTableReader`]({{site.api_schema_rc3}}/KijiTableReader.html). {% highlight java %} reader = table.openTableReader(); {% endhighlight %} #### Looking up the requested entry -Create an [`EntityId`]({{site.api_url}}/EntityId.html) to retrieve a contact +Create an [`EntityId`]({{site.api_schema_rc3}}/EntityId.html) to retrieve a contact using the contact's first and last name: {% highlight java %} final EntityId entityId = table.getEntityId(mFirst + "," + mLast); @@ -157,8 +169,8 @@ final KijiDataRequest dataReq = new KijiDataRequest() {% endhighlight %} We now retrieve our result by passing the -[`EntityId`]({{site.api_url}}/EntityId.html) and data request to our table reader. -Doing so results in a [`KijiRowData`]({{site.api_url}}/KijiRowData.html) containing +[`EntityId`]({{site.api_schema_rc3}}/EntityId.html) and data request to our table reader. +Doing so results in a [`KijiRowData`]({{site.api_schema_rc3}}/KijiRowData.html) containing the data read from the table. {% highlight java %} @@ -171,7 +183,7 @@ You can run the following command to perform a lookup using the `Lookup.java` ex
    {% highlight bash %} $KIJI_HOME/bin/kiji jar \ - $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc1.jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc3.jar \ org.kiji.examples.phonebook.Lookup --first=Renuka --last=Apte {% endhighlight %}
    diff --git a/_posts/tutorial/2012-01-01-phonebook-setup.md b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-setup.md similarity index 68% rename from _posts/tutorial/2012-01-01-phonebook-setup.md rename to _posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-setup.md index 205c4a33..6b0efc42 100644 --- a/_posts/tutorial/2012-01-01-phonebook-setup.md +++ b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-setup.md @@ -1,8 +1,8 @@ --- layout: post title: Setup -category: tutorial -tags: [article] +categories: [tutorials, phonebook-tutorial, 1.0.0-rc3] +tags: [phonebook] order: 2 description: Setup and compile instructions for the phonebook tutorial. --- @@ -24,7 +24,7 @@ bento start If you have downloaded the Kiji Standalone BentoBox, the code for this tutorial is already compiled and located in the `$KIJI_HOME/examples/phonebook/lib/` directory. -You can skip to [Create a Table]({{site.tutorial_url}}phonebook-create) +You can skip to [Create a Table]({{site.tutorial_phonebook_rc3}}/phonebook-create) if you want to get started playing with the example code. @@ -44,3 +44,22 @@ the phonebook example under `$KIJI_HOME/examples/phonebook/lib/`. If you wish to use jars of example code that you have built, you should adjust the command lines in this tutorial to use the jars in `$KIJI_HOME/examples/phonebook/target/`. +If you are using the Bento Box, `kiji-env.sh` will have set `$KIJI_HOME` for you +already. If not, you should set that yourself in your environment: + +
    +{% highlight bash %} +export KIJI_HOME=/path/to/kiji-schema +{% endhighlight %} +
    + +To work through this tutorial, various Kiji tools will require that Avro data +type definitions particular to the working phonebook example be on the +classpath. You can add your artifacts to the Kiji classpath by running: + +
    +{% highlight bash %} +export KIJI_CLASSPATH=$KIJI_HOME/examples/phonebook/lib/kiji-phonebook-*.jar +{% endhighlight %} +
    + diff --git a/_posts/tutorial/2012-01-01-phonebook-tutorial.md b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-tutorial.md similarity index 87% rename from _posts/tutorial/2012-01-01-phonebook-tutorial.md rename to _posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-tutorial.md index a2fcada5..fc54bdd9 100644 --- a/_posts/tutorial/2012-01-01-phonebook-tutorial.md +++ b/_posts/tutorials/phonebook/1.0.0-rc3/2012-01-01-phonebook-tutorial.md @@ -1,8 +1,8 @@ --- layout: post title: Overview -category: tutorial -tags: [article] +categories: [tutorials, phonebook-tutorial, 1.0.0-rc3] +tags: [phonebook] order: 1 description: Quick tutorial to get up and running with Kiji Tables. --- @@ -17,12 +17,12 @@ to bulk load this into your Kiji table. Example code for a more in depth look at these use cases exist in the directory `$KIJI_HOME/examples/phonebook/src/main/java`. Instructions for how to build and use this example code can be found in the next section of this tutorial, -[Setup]({{site.tutorial_url}}phonebook-setup). +[Setup]({{site.tutorial_phonebook_rc3}}/phonebook-setup). ### How to Use this Tutorial * **Links to Javadoc** - Class names link to the relevant Javadoc: -[`EntityId`]({{site.api_url}}EntityId.html). +[`EntityId`]({{site.api_schema_rc3}}/EntityId.html). * **Code Walkthrough** - Code snippets are in gray boxes with language specific syntax highlighting: diff --git a/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-create.md b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-create.md new file mode 100644 index 00000000..3da8855b --- /dev/null +++ b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-create.md @@ -0,0 +1,162 @@ +--- +layout : post +title : Create a Table +categories: [tutorials, phonebook-tutorial, 1.0.0-rc4] +tags : [phonebook] +order : 3 +description: To use a phonebook, you need a phonebook. +--- + +We need to create a table to store your bajillion phonebook contacts. +Creating a table in Kiji amounts to specifying a layout and registering +that layout with Kiji. Layouts can be specified using the Kiji +Data Definition Language, *DDL*, or in a JSON form. + +### Using the DDL + +We assume that you have `kiji-schema-shell` installed. If not, you should +consult the [Get Started](http://www.kiji.org/getstarted) section of the Kiji website. + +We have provided the phonebook layout in the `$KIJI_HOME/examples/phonebook/layout.ddl` file. +For more information about how to create this file, see the +[DDL Shell Reference]({{site.userguide_schema_rc4}}/schema-shell-ddl-ref/). + +
    +{% highlight bash %} +$KIJI_HOME/schema-shell/bin/kiji-schema-shell \ + --file=$KIJI_HOME/examples/phonebook/layout.ddl +{% endhighlight %} +
    + + OK. + +#### Verify +Enter the KijiSchema shell using the following command: + +
    +{% highlight bash %} +$KIJI_HOME/schema-shell/bin/kiji-schema-shell +{% endhighlight %} +
    + +Use the `show tables` and `describe` commands to see your newly created table. + +
    +{% highlight bash %} +schema> show tables; +{% endhighlight %} +
    + + Table Description + ========= ================================== + phonebook A collection of phone book entries + +
    +{% highlight bash %} +schema> describe phonebook; +{% endhighlight %} +
    + + Table: phonebook (A collection of phone book entries) + Column family: info + Description: basic information + + Column info:firstname (First name) + Schema: "string" + + Column info:lastname (Last name) + Schema: "string" + + Column info:email (Email address) + Schema: "string" + + Column info:telephone (Telephone number) + Schema: "string" + + Column info:address (Street address) + Schema: "org.kiji.examples.phonebook.Address" + + Column family: derived + Description: Information derived from an individual's address. + + Column derived:addr1 (Address line one.) + Schema: "string" + + Column derived:apt (Address Apartment number.) + Schema: [ "string", "null" ] + + Column derived:addr2 (Address line two.) + Schema: "string" + + Column derived:city (Address city.) + Schema: "string" + + Column derived:state (Address state.) + Schema: "string" + + Column derived:zip (Address zip code.) + Schema: "int" + + Column family: stats + Description: Statistics about a contact. + + Column stats:talktime (Time spent talking with this person) + Schema: (counter) + +
    +{% highlight bash %} +schema> quit; +{% endhighlight %} +
    + +### Using JSON + +A low level way of providing the layout is by using JSON. To learn more about specifying +the layout in JSON, take a look at [Managing Data]({{site.userguide_schema_rc4}}/managing-data/). + +But first, we need to delete the table we just created, just so that we can create it +another time using JSON! Use the following command to delete the table: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji delete --target=kiji://.env/default/phonebook +{% endhighlight %} +
    + + Deleting kiji table: kiji://localhost:2181/default/phonebook/ + Are you sure? This action will remove this table and all its data from kiji and cannot be undone! + Please answer yes or no. + yes + 00/11/00 20:33:16 INFO org.apache.hadoop.hbase.client.HBaseAdmin: Started disable of kiji.default.table.phonebook + 00/11/00 20:33:18 INFO org.apache.hadoop.hbase.client.HBaseAdmin: Disabled kiji.default.table.phonebook + 00/11/00 20:33:19 INFO org.apache.hadoop.hbase.client.HBaseAdmin: Deleted kiji.default.table.phonebook + Deleted kiji table: kiji://localhost:2181/default/phonebook/ + +The command below creates the same phonebook table with the layout specified in the `layout.json` file in your +`$KIJI_HOME/examples/phonebook` directory. + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji create-table --table=kiji://.env/default/phonebook \ + --layout=$KIJI_HOME/examples/phonebook/layout.json +{% endhighlight %} +
    + +{% highlight bash %} +Parsing table layout: $KIJI_HOME/examples/phonebook/layout.json +Creating kiji table: kiji://localhost:2181/default/phonebook/... +{% endhighlight %} + + +#### Verify + +To ensure that your table exists, use the `kiji ls` command to show the available +tables in your Kiji instance. + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji ls +{% endhighlight %} +
    + +The above command should list `phonebook` as a table. diff --git a/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-delete.md b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-delete.md new file mode 100644 index 00000000..e991d313 --- /dev/null +++ b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-delete.md @@ -0,0 +1,188 @@ +--- +layout: post +title: Delete Contacts +categories: [tutorials, phonebook-tutorial, 1.0.0-rc4] +tags: [phonebook] +order: 8 +description: Examples of Point deletions. +--- + +Deletions of Kiji table cells can be performed both within a MapReduce job and from +non-distributed java programs. Both types of programs use [`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html)s to +delete data. + +## Point Deletions + +You realize one of your frenemies, Renuka Apte (any resemblance to real persons, living or dead, +is purely coincidental), has somehow made it to your contact list. To remedy this we will +perform a point deletion on the row with Renuka's contact information. To permit deletions +from the phonebook, we will create a tool that will let us specify contacts that we want +to delete. + +### DeleteEntry.java + +DeleteEntry uses a [`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html) to perform point deletions on a kiji table: + +{% highlight java %} +// Open a table writer. +KijiTableWriter writer = table.openTableWriter(); +{% endhighlight %} + +The deletion is then performed by specifying the row ID for the entry, in this case +a string of the format `firstname,lastname`: + +{% highlight java %} +// Create a row ID with the first and last name. +EntityId user = table.getEntityId(first + "," + last); + +// Attempt to delete row for the specified user. +writer.deleteRow(user); +{% endhighlight %} + +### Running the Example + +This example interactively queries the user for the first and last names of the contact +to delete. First, verify that the contact entry for Renuka Apte exists in your phonebook +table: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji ls --kiji=kiji://.env/default/phonebook --entity-id="Renuka,Apte" +{% endhighlight %} +
    + + \x17\xDC\xE7\x85\x0F{\xB6SF\x9A\xB5&\xA5\x8C\x81[ [1352864000121] info:firstname + Renuka + \x17\xDC\xE7\x85\x0F{\xB6SF\x9A\xB5&\xA5\x8C\x81[ [1352864000121] info:lastname + Apte + \x17\xDC\xE7\x85\x0F{\xB6SF\x9A\xB5&\xA5\x8C\x81[ [1352864000121] info:email + ra@wibidata.com + \x17\xDC\xE7\x85\x0F{\xB6SF\x9A\xB5&\xA5\x8C\x81[ [1352864000121] info:telephone + 415-111-2222 + \x17\xDC\xE7\x85\x0F{\xB6SF\x9A\xB5&\xA5\x8C\x81[ [1352864000121] info:address + {"addr1": "375 Alabama St", "apt": null, "addr2": null, "city": "SF", "state": "CA", "zip": 94110} + +Next, to perform the deletion of this contact using DeleteEntry: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc4.jar \ + org.kiji.examples.phonebook.DeleteEntry +{% endhighlight %} +
    + + First name: Renuka + Last name: Apte + +#### Verify +To verify that the row has been deleted, run the following command ensuring that the phonebook +entry for Renuka does not get printed: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji ls --kiji=kiji://.env/default/phonebook --entity-id="Renuka,Apte" +{% endhighlight %} +
    + + Looking up entity: \x17\xDC\xE7\x85\x0F{\xB6SF\x9A\xB5&\xA5\x8C\x81[ from kiji table: kiji://localhost:2181/default/phonebook/ + +## Deleting from a MapReduce Job + +
    +
     
    +
    +

    Deprecation Warning

    +

    + The DeleteEntriesByState MapReduce class refers to classes in the + org.kiji.schema.mapreduce package + that may be removed in the future. You should use the KijiMR library to manage + MapReduce jobs that interoperate with Kiji tables. +

    +
    +
    + +You’re tired of all your San Francisco friends bragging about their startups. +You’ve decided to clean your phonebook of anyone from the state of California. Since +you have so many contacts, it would take too long to use the point deletion tool +we created in the previous example. Instead, we will write a MapReduce job to +sanitize your phonebook of any California contacts. + +### DeleteEntriesByState.java + +Deletions from within a MapReduce job are also performed using a [`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html). +The DeleteEntriesByState example runs a MapReduce job that reads through the contacts +in the phonebook table and deletes any entry that has an address from the specified +state. + +First, the contact's address is extracted from the row: + +{% highlight java %} +public void map(EntityId entityId, KijiRowData row, Context context) + throws IOException, InterruptedException { + if (!row.containsColumn(Fields.INFO_FAMILY, Fields.ADDRESS)) { + // Ignore the row if there is no address. + return; + } + + final String victimState = context.getConfiguration().get(CONF_STATE, ""); + final Address address = row.getMostRecentValue(Fields.INFO_FAMILY, Fields.ADDRESS); +{% endhighlight %} + +A [`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html) we opened in the `setup()` method is then used to delete +the row if the state matches: + +{% highlight java %} + if (victimState.equals(address.getState().toString())) { + // Delete the entry. + mWriter.deleteRow(entityId); + } +} +{% endhighlight %} + +### Running the Example + +You can run the DeleteEntriesByState MapReduce job by running: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc4.jar \ + org.kiji.examples.phonebook.DeleteEntriesByState --state=CA +{% endhighlight %} +
    + +#### Verify +To verify that the contacts have been deleted, run the following command ensuring that no +phonebook entries from California get printed. + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji ls --kiji=kiji://.env/default/phonebook --columns="derived:state" +{% endhighlight %} +
    + + Scanning kiji table: kiji://localhost:2181/default/phonebook/ + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352831738599] derived:state + DC + +## Wrapping up +If you started your BentoBox to do this tutorial, now would be a good time to stop it. + +
    +{% highlight bash %} +bento stop +{% endhighlight %} +
    + +To learn more about Kiji, check out these other resources: + - [User Guide]({{site.userguide_schema_rc4}}/kiji-schema-overview) + - [API Docs](http://docs.kiji.org/apidocs) + - [Source Code](http://github.com/kijiproject) + +For information about the Kiji Project and user-to-user support: +Sign up for user@kiji.org + +Hungry for more? To learn about KijiMR, Kiji's MapReduce integration library, +check out the +[Music recommendation tutorial](/tutorials/music-recommendation/1.0.0-rc4/music-overview/). diff --git a/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-derived-columns.md b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-derived-columns.md new file mode 100644 index 00000000..d291e4b7 --- /dev/null +++ b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-derived-columns.md @@ -0,0 +1,100 @@ +--- +layout: post +title : Derive Data +categories: [tutorials, phonebook-tutorial, 1.0.0-rc4] +tags: [phonebook] +order: 6 +description: Decompose an address into its individual fields. +--- + +
    +

    This page is deprecated.

    +

    + For a more up-to-date look at how to derive data using Producers, see the + Music + recommendation tutorial. + This section is preserved for your reference, but the APIs referenced herein + are deprecated and may be removed in a future release of KijiSchema. +

    +

    + Note that later sections of this tutorial rely on you running the commands + in this section. But you should not model your future MapReduce analyses on + the code in AddressFieldExtractor. +

    +
    + +Your friends have been terribly disorganized about giving you their contact details. +Being the perfectionist you are, you would like to be able to, at any given point, know +how many friends you have in a certain zip code... because obviously, such questions +need answering. + +We'll show you a way to decompose your contacts’ addresses into their street address, city, +and zip code (the derived columns) to make it easier for you to get this information quickly. + +### AddressFieldExtractor.java + +The run function begins by creating an HBase configuration, and configuring the MapReduce task. +Note that we need to ship certain jars that we depend on during the *map* task. Here\'s how we +do this: + +{% highlight java %} +GenericTableMapReduceUtil.addAllDependencyJars(job); +DistributedCacheJars.addJarsToDistributedCache(job, + new File(System.getenv("KIJI_HOME"), "lib")); +job.setUserClassesTakesPrecedence(true); +{% endhighlight %} + +The AddressMapper extends Hadoop's Mapper class. The map function is run per row of the Kiji table. +It extracts the address field from each row as follows: + +{% highlight java %} +Address address = row.getMostRecentValue(Fields.INFO_FAMILY, Fields.ADDRESS); +{% endhighlight %} + +Address is the same Avro type you read about on the +[Phonebook Importer](../phonebook-import/) page. The JSON +description for it can be found at +`$KIJI_HOME/examples/phonebook/src/main/avro/Address.avsc`. More information +about Avro types can be found +[here](http://avro.apache.org/docs/current/spec.html). + +We decompose and write the individual fields into a derived column using `writer.put(...)`. For +example, the zip code can be extracted from the Address object and written as follows: + +{% highlight java %} +writer.put(entityId, Fields.DERIVED_FAMILY, Fields.ZIP, address.getZip()); +{% endhighlight %} + +### Running the Example +We assume that you have already imported the contacts from +`$KIJI_HOME/examples/phonebook/input-data.txt` into the phonebook Kiji table by this point. +You can execute this example using the `kiji jar` command with the class name: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc4.jar \ + org.kiji.examples.phonebook.AddressFieldExtractor +{% endhighlight %} +
    + +#### Verify +You can use the following command to see if your contacts' address data was successfully extracted: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji ls --kiji=kiji://.env/default/phonebook --columns=derived +{% endhighlight %} +
    + + Scanning kiji table: kiji://localhost:2181/default/phonebook/ + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352750122019] derived:addr1 + 1600 Pennsylvania Ave + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352750122020] derived:city + Washington + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352750122021] derived:state + DC + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352750122022] derived:zip + 99999 + + ... diff --git a/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-import.md b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-import.md new file mode 100644 index 00000000..4ef22de1 --- /dev/null +++ b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-import.md @@ -0,0 +1,254 @@ +--- +layout: post +title: Import Data +categories: [tutorials, phonebook-tutorial, 1.0.0-rc4] +tags: [phonebook] +order: 5 +description: How to import data into the phonebook table. +--- + +At this point, you should be worried about wearing out your keyboard +by manually running an add command for each of your (incredibly large set of) +friends. First, we will discuss and give examples of the naive way of extending `AddEntry` +to load a table, and then present the recommended MapReduce approach. + +### StandalonePhonebookImporter.java +An example of writing puts in order to load a table is given in +`StandalonePhonebookImporter`. This approach is easier than running the add command +for every user, but is still suboptimal because you are using one machine to perform every put. + +#### Parsing the Delimited Phonebook Entries +First, let's take a closer look at the data we want to import. In +`$KIJI_HOME/examples/phonebook/input-data.txt` you will see records like: + +> John|Doe|johndoe@gmail.com|202-555-9876|{"addr1":"1600 Pennsylvania Ave","apt":null,"addr2":null,"city":"Washington","state":"DC","zip":99999} + +The fields in each record are delimited by a `|` character. The last field is actually +a complete JSON Avro record representing an address. + +At the top of the `importLine(...)` method in `StandalonePhonebookImporter`, you'll +see we're using a delimiter to split up the record into its specific fields: +{% highlight java %} +String[] fields = value.toString().split("\\|"); +//... + +String firstName = fields[0]; +String lastName = fields[1]; +String email = fields[2]; +String telephone = fields[3]; +String addressJson = fields[4]; +{% endhighlight %} + +Since our last field is a complex Avro type represented in JSON, we use a JSON decoder +with an Avro schema (in this case `Address`), to decode the field into a complete Avro Address +object. + +{% highlight java %} +// addressJson contains a JSON-encoded Avro "Address" record. Parse this into +// an object and write it to the person's record. +// The Address record type is generated from src/main/avro/Address.avsc as part +// of the build process (see avro-maven-plugin in pom.xml). +SpecificDatumReader
    datumReader = + new SpecificDatumReader
    (Address.SCHEMA$); +JsonDecoder decoder = + DecoderFactory.get().jsonDecoder(Address.SCHEMA$, addressJson); +Address streetAddr = datumReader.read(null, decoder); +{% endhighlight %} + +Next we create a unique [`EntityId`]({{site.api_schema_rc4}}/EntityId.html) that will be used to reference this row. As before, we will use +the combination of first and last name as a unique reference to this row: +{% highlight java %} +EntityId user = table.getEntityId(firstName + "," + lastName); +{% endhighlight %} + +Finally we just retrieve the current system timestamp and write these record fields. +{% highlight java %} +long timestamp = System.currentTimeMillis(); +writer.put(user, Fields.INFO_FAMILY, Fields.FIRST_NAME, timestamp, firstName); +writer.put(user, Fields.INFO_FAMILY, Fields.LAST_NAME, timestamp, lastName); +writer.put(user, Fields.INFO_FAMILY, Fields.EMAIL, timestamp, email); +writer.put(user, Fields.INFO_FAMILY, Fields.TELEPHONE, timestamp, telephone); +writer.put(user, Fields.INFO_FAMILY, Fields.ADDRESS, timestamp, streetAddr); +{% endhighlight %} + +### Running the Example +You can execute `StandalonePhonebookImporter` just like you would the `AddEntry` +example - using the `kiji jar` command. + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc4.jar \ + org.kiji.examples.phonebook.StandalonePhonebookImporter \ + $KIJI_HOME/examples/phonebook/input-data.txt +{% endhighlight %} +
    + +You now have data in your phonebook table! + +#### Verify +Verify that the user records were added properly by executing: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji ls --kiji=kiji://.env/default/phonebook +{% endhighlight %} +
    + +## Importing Data using MapReduce +While the above example does import the requisite data, it doesn't scale to large +data sets, because it doesn't take advantage of the cluster you are writing to. +Instead of generating all puts locally like we did above, we will write a MapReduce +job that reads from text file in HDFS and writes to your Kiji table by generating +puts in a distributed fashion. + +### PhonebookImporter.java +Our example of importing data into a table with MapReduce can be found in the class +`PhonebookImporter`. PhonebookImporter defines a special type of MapReduce job called a +Kiji bulk import job that reads each line of our input file, parses it, and writes it to a table. +Kiji bulk import jobs are created by implementing a [`KijiBulkImporter`]({{site.api_mr_rc4}}/bulkimport/KijiBulkImporter.html), +not a `Mapper` and `Reducer`. This API is provided by KijiMR. The +[Music recommendation tutorial](/tutorials/music-recommendation/1.0.0-rc4/music-overview/) +covers KijiMR in much greater detail, but we will take a look at using the +[`KijiBulkImporter`]({{site.api_mr_rc4}}/bulkimport/KijiBulkImporter.html) API below. + +Instead of a `map()` method, we provide a `produce()` method definition; this method processes +an input record from a file like an ordinary mapper, except its `context` argument is +specifically targeted to output to a row in a Kiji table. + +At the top of the `produce()` method, you'll see that we extract the fields from +the lines as in the above example. Then using the +[`KijiTableContext`]({{site.api_mr_rc4}}/KijiTableContext.html) context argument, +we'll write all of the fields to the phonebook table: + +{% highlight java %} +@Override +public void produce(LongWritable byteOffset, Text line, KijiTableContext context) + throws IOException { + ... + context.put(user, Fields.INFO_FAMILY, Fields.FIRST_NAME, firstName); + context.put(user, Fields.INFO_FAMILY, Fields.LAST_NAME, lastName); + context.put(user, Fields.INFO_FAMILY, Fields.EMAIL, email); + context.put(user, Fields.INFO_FAMILY, Fields.TELEPHONE, telephone); + context.put(user, Fields.INFO_FAMILY, Fields.ADDRESS, streetAddr); +} +{% endhighlight %} + +The `context.put()` calls are identical in form to using a +[`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html). + +If you are writing a custom bulk importer and require specialized setup and teardown steps, +these can be placed in `setup()` and `cleanup()` methods like in a Mapper. We don't need +any in this example. + +The outer `PhonebookImporter` class contains `configureJob(...)` and `run(...)` methods +that handle the setup and execution +of the MapReduce job. Instead of constructing a Hadoop `Job` object directly, we use a +`KijiBulkImportJobBuilder`. This builder object lets us specify Kiji-specific arguments, +and construct a [`MapReduceJob`]({{site.api_mr_rc4}}/MapReduceJob.html) (A Kiji-specific wrapper around `Job`): + +{% highlight java %} +MapReduceJob configureJob(Path inputPath, KijiURI tableUri) throws IOException { + return KijiBulkImportJobBuilder.create() + .withConf(getConf()) + .withInput(new TextMapReduceJobInput(inputPath)) + .withOutput(new DirectKijiTableMapReduceJobOutput(tableUri)) + .withBulkImporter(PhonebookBulkImporter.class) + .build(); +} +{% endhighlight %} + +The HDFS file path to the sample input data is set to the first command line argument. +A [`KijiURI`]({{site.api_schema_rc4}}/KijiURI.html) is constructed that specifies the `phonebook` table as the target: + +{% highlight java %} +public int run(String[] args) throws Exception { + final KijiURI tableUri = + KijiURI.newBuilder(String.format("kiji://.env/default/%s", TABLE_NAME)).build(); + final MapReduceJob job = configureJob(new Path(args[0]), tableUri); +} +{% endhighlight %} + +The [`TextMapReduceJobInput`]({{site.api_mr_rc4}}/input/TextMapReduceJobInput.html) and +[`DirectKijiTableMapReduceJobOutput`]({{site.api_mr_rc4}}/output/DirectKijiTableMapReduceJobOutput.html) +classes are abstractions that, under the hood, configure an `InputFormat` and `OutputFormat` +for the MapReduce job. Different KijiMR job types (bulk importer, producer, or gatherer) +support different subsets of available formats (files, tables, etc). These classes allow the +system to ensure that the correct type is used. For example, bulk import jobs require that the +target is a table. "Regular" MapReduce jobs configured through +[`KijiMapReduceJobBuilder`]({{site.api_mr_rc4}}/KijiMapReduceJobBuilder.html) can use +any [`MapReduceJobInput`]({{site.api_mr_rc4}}/MapReduceJobInput.html) and +[`MapReduceJobOutput`]({{site.api_mr_rc4}}/MapReduceJobOutput.html) that makes sense +in the context of the application. + +### Running the Example +First you'll need to put the text file containing your friends' contact info into HDFS. +You can do this by using the HDFS `-copyFromLocal` command: + +
    +{% highlight bash %} +$HADOOP_HOME/bin/hadoop fs -copyFromLocal \ + $KIJI_HOME/examples/phonebook/input-data.txt /tmp +{% endhighlight %} +
    + +You can then use the `kiji jar` command to execute the MapReduce job. To use +the jar command, specify the jar file the `PhonebookImporter` class and the +path to the `input-data.txt` file in HDFS. + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc4.jar \ + org.kiji.examples.phonebook.PhonebookImporter \ + /tmp/input-data.txt +{% endhighlight %} +
    + +You now have data in your phonebook table! + + +#### Running with the bulkimport Command + +The `BulkImportJobBuilder` allows you to programmatically configure and launch +a bulk import MapReduce job. KijiMR extends Kiji with a `bulkimport` command-line +tool that can perform substantially the same steps. The following command would +run the same bulk import job without requiring that you write a "`main()`" method: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji bulk-import \ + --importer='org.kiji.examples.phonebook.PhonebookImporter$PhonebookBulkImporter' \ + --input="format=text file=/tmp/input-data.txt" \ + --output="format=kiji nsplits=1 table=kiji://.env/default/phonebook" \ + --lib=$KIJI_HOME/examples/phonebook/lib +{% endhighlight %} +
    + +The `--input` and `--output` arguments specify in text form the same +[`MapReduceJobInput`]({{site.api_mr_rc4}}/MapReduceJobInput.html) and +[`MapReduceJobOutput`]({{site.api_mr_rc4}}/MapReduceJobOutput.html) +objects as are created programmatically in this example. + +#### Verify +Verify that the user records were added properly by executing: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji ls --kiji=kiji://.env/default/phonebook +{% endhighlight %} +
    + +Here's what the first entry should look like: + + Scanning kiji table: kiji://localhost:2181/default/phonebook/ + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352513223503] info:firstname + John + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352513223504] info:lastname + Doe + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352513223505] info:email + johndoe@gmail.com + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352513223505] info:telephone + 202-555-9876 + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352513223506] info:address + {"addr1": "1600 Pennsylvania Ave", "apt": null, "addr2": null, "city": "Washington", "state": "DC", "zip": 99999} diff --git a/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-increment.md b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-increment.md new file mode 100644 index 00000000..75a77ec1 --- /dev/null +++ b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-increment.md @@ -0,0 +1,127 @@ +--- +layout: post +title : Use Counters +categories: [tutorials, phonebook-tutorial, 1.0.0-rc4] +tags: [phonebook] +order : 7 +description: Use atomic increment in the Phonebook example to calculate talktime. +--- + +You have just run out of minutes on your phone plan and want to find the person responsible +for inconveniencing you this way. Luckily, we have provided you with a phone log with the +time spent per phone call at `$KIJI_HOME/examples/phonebook/input-phone-log.txt`. You want to +be able to get the total time spent talking to each of your contacts this month. + +To support operations like this Kiji provides atomic counter type cells like HBase that +permit multiple sources to be simultaneously incrementing the cell without conflict. In +this example, we will use the `stats:talktime` column of counters to count the total +talktime for each of your contacts. + +Running the `describe phonebook;` command within the kiji-schema-shell should print the +`stats:talktime` as a column of counter cells: + + ... + + Column family: stats + Description: Statistics about a contact. + + Column stats:talktime (Time spent talking with this person) + Schema: (counter) + +We'll show you a way to use counters to get the amount of time that each of your contacts has +spent calling you with the IncrementTalkTime example. + +### IncrementTalkTime.java + + +
    +
     
    +
    +

    Deprecation Warning

    +

    + This section refers to classes in the org.kiji.schema.mapreduce package + that may be removed in the future. You should use the KijiMR library to manage + MapReduce jobs that interoperate with Kiji tables. In particular, the + KijiMapReduceJobBuilder takes care of lots of things you'd have to do + manually here (e.g., use GenericTableMapReduceUtil and + DistributedCacheJars). +

    +
    +
    + +The `stats:talktime` column of the phonebook table is of the type COUNTER. You can see this by +looking at the layout files. As Kiji tables are based on Hbase, they also provide the ability to +treat columns as counters. + +IncrementTalkTime uses MapReduce to calculate the talk time per person in the call log by +extending the Hadoop Mapper class. You can find more information about Hadoop MapReduce [here](http://hadoop.apache.org/). + +The application starts by configuring a Hadoop job. Note that we need to ship certain jars +that we depend on during the *map* task. Here\'s how we do this: + +{% highlight java %} +GenericTableMapReduceUtil.addAllDependencyJars(job); +DistributedCacheJars.addJarsToDistributedCache(job, + new File(System.getenv("KIJI_HOME"), "lib")); +job.setUserClassesTakesPrecedence(true); +{% endhighlight %} + +The map function is run once per each line in the phone log file. The input to the function +is a line of the form: + +> firstname | lastname | call_duration + +The `setup` function is called once per mapper. It opens the phonebook kiji table and creates +a context to be able to write to it. Specifically, the calculated total talk time per contact +will be written to the contact's record. + +The map task breaks the input line up into its individual components. It then generates a row ID +for this user in the Kiji table as follows: + +{% highlight java %} +EntityId user = mKijiTable.getEntityId(firstName + "," + lastName); +{% endhighlight %} + +The following code increments the existing value of the `stats:talktime` column by the call +duration in the call log. + +{% highlight java %} +mWriter.increment(user, "stats", "talktime", talkTime); +{% endhighlight %} + +### Running the Example + +First you need to add the phone log to hdfs. You can do this by using the `hdfs -copyFromLocal` +command. + +
    +{% highlight bash %} +$HADOOP_HOME/bin/hadoop fs -copyFromLocal \ + $KIJI_HOME/examples/phonebook/input-phone-log.txt /tmp +{% endhighlight %} +
    + +You can then run the `kiji jar` command, much like the previous examples, providing the path +to the file in hdfs. + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc4.jar \ + org.kiji.examples.phonebook.IncrementTalkTime /tmp/input-phone-log.txt +{% endhighlight %} +
    + +#### Verify +Now we can look up the derived talktime value from the stats column for the user John Doe using the `kiji ls` command: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji ls --kiji=kiji://.env/default/phonebook \ + --entity-id="John,Doe" --columns="stats" +{% endhighlight %} +
    + + Looking up entity: U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB from kiji table: kiji://localhost:2181/default/phonebook/ + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352838746735] stats:talktime + 15 diff --git a/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-point-add.md b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-point-add.md new file mode 100644 index 00000000..b2aee481 --- /dev/null +++ b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-point-add.md @@ -0,0 +1,229 @@ +--- +layout: post +title : Read and Write in Kiji +categories: [tutorials, phonebook-tutorial, 1.0.0-rc4] +tags: [phonebook] +order : 4 +description: Add and lookup and single entry. +--- + +Now that KijiSchema is managing your phonebook table, the next step is to start writing +and reading contacts. + +## Writing to a Table +Clearly, you need a way to add your ever-increasing set of friends to the phonebook. +KijiSchema supports writing to Kiji tables with the +[`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html) class. The phonebook example +includes code that uses a [`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html) to +write to the phonebook table. + +### AddEntry.java +The class `AddEntry.java` is included in the phonebook example source (located under +`$KIJI_HOME/examples/phonebook/src/main/java`). It implements a command-line tool +that asks a user for contact information and then uses that information to populate +the columns in a row in the Kiji table `phonebook` for that contact. +To start, `AddEntry.java` loads an HBase configuration. + +{% highlight java %} +setConf(HBaseConfiguration.addHbaseResources(getConf())); +{% endhighlight %} + +The code then connects to Kiji and opens the phonebook table for writing. A [`Kiji`]({{site.api_schema_rc4}}/Kiji.html) +instance is specified by a [`KijiURI`]({{site.api_schema_rc4}}/KijiURI.html). A Kiji URI specifies an HBase cluster to +connect to (identified by its Zookeeper quorum) and a Kiji instance name. +The value of `KConstants.DEFAULT_INSTANCE_NAME` is `"default"`. +For example, if ZooKeeper is running on `zkhost:2181`, the name of the default +Kiji instance on the cluster would be `kiji://zkhost:2181/default`. + +Rather than specify a ZooKeeper cluster yourself, you can rely on the quorum +specified in your `hbase-site.xml` file by using the "hostname" of `.env`, like +this: `kiji://.env/default`. + +To create a [`KijiURI`]({{site.api_schema_rc4}}/KijiURI.html), you use a +[`KijiURI.KijiURIBuilder`]({{site.api_schema_rc4}}/KijiURI.KijiURIBuilder.html) +instance. By default, this will use the `".env"` pseudo-host so that you connect +to your normal HBase cluster. + +{% highlight java %} +kiji = Kiji.Factory.open( + KijiURI.newBuilder().withInstanceName(KConstants.DEFAULT_INSTANCE_NAME).build(), + getConf()); +table = kiji.openTable(TABLE_NAME); // TABLE_NAME is "phonebook" +writer = table.openTableWriter(); +{% endhighlight %} + +#### Adding the phonebook entry +We then create an [`EntityId`]({{site.api_schema_rc4}}/EntityId.html) using the contact's first +and last name. The [`EntityId`]({{site.api_schema_rc4}}/EntityId.html) uniquely identifies the +row for the contact in the Kiji table. + +{% highlight java %} +EntityId user = table.getEntityId(first + "," + last); +{% endhighlight %} + +We write the contact information gained from the user to the appropriate columns +in the contact's row of the Kiji table `phonebook`. +The column names are specified as constants in the `Fields.java` class. For example, +the first name is written as: + +{% highlight java %} +writer.put(user, Fields.INFO_FAMILY, Fields.FIRST_NAME, timestamp, first); +{% endhighlight %} + +#### Finalization +We are done with the Kiji instance, table and writer we opened earlier. +We close these objects to free resources (for example, connections to HBase) +that they use. We close these objects in the reverse order we opened them in. + +{% highlight java %} +ResourceUtils.closeOrLog(writer); +ResourceUtils.closeOrLog(table); +ResourceUtils.releaseOrLog(kiji); +{% endhighlight %} + +Something important to note is that the Kiji instance is _released_ rather than closed. +Kiji instances are often long-lived objects that many aspects of your system may hold +reference to. Rather than require that you define a single "owner" of this object who +closes it when the system is finished using it, you can use reference counting to manage +this object's lifetime. + +When a [`Kiji`]({{site.api_schema_rc4}}/Kiji.html) instance is created with `Kiji.Factory.open()`, +it has an automatic reference count of 1. You should call `kiji.release()` or +[`ResourceUtils`]({{site.api_schema_rc4}}/util/ResourceUtils.html)`.releaseOrLog(kiji)` to discard this reference. + +If another class or method gets a reference to an already-opened Kiji instance, +you should call `kiji.retain()` to increment its reference count. That same +class or method is responsible for calling `kiji.release()` when it no longer +holds the reference. + +A [`Kiji`]({{site.api_schema_rc4}}/Kiji.html) object will close itself and free its underlying resources when its +reference count drops to 0. + +### Running the Example +You run the class `AddEntry` with the `kiji` command-line tool as follows: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc4.jar \ + org.kiji.examples.phonebook.AddEntry +{% endhighlight %} +
    + +__The syntax shown here is the preferred mechanism to run your own `main(...)` +method with Kiji and its dependencies properly on the classpath.__ + +The interactive prompts (with sample responses) should look like: + +
    +{% highlight bash %} +First name: Renuka +Last name: Apte +Email address: ra@wibidata.com +Telephone: 415-111-2222 +Address line 1: 375 Alabama St +Apartment: +Address line 2: +City: SF +State: CA +Zip: 94110 +{% endhighlight %} +
    + +#### Verify +Now we can verify that our entry got into the phonebook table. + +Beforehand, you must tell `kiji ls` where the `org.kiji.examples.phonebook.Address` +Avro record class (mentioned in the DDL and used by `AddEntry`) is. +If you have not already done so, put the phonebook jar file on your Kiji classpath: + +
    +{% highlight bash %} +export KIJI_CLASSPATH=$KIJI_HOME/examples/phonebook/lib/kiji-phonebook-*.jar +{% endhighlight %} +
    + +Now use `kiji ls`: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji ls --kiji=kiji://.env/default/phonebook +{% endhighlight %} +
    + + Scanning kiji table: kiji://localhost:2181/default/phonebook/ + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352831108322] info:firstname + Renuka + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352831108322] info:lastname + Apte + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352831108322] info:email + ra@wibidata.com + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352831108322] info:telephone + 415-111-2222 + U\x1EP\xC1\xF2c$7\xCC\xBA\xCB\x16\x10\x0F\x11\xDB [1352831108322] info:address + {"addr1": "375 Alabama St", "apt": null, "addr2": null, "city": "SF", "state": "CA", "zip": 94110} + +## Reading From a Table +Now that we've added a contact to your phonebook, we should be able to read this +contact from the table. KijiSchema supports reading from Kiji tables with the +[`KijiTableReader`]({{site.api_schema_rc4}}/KijiTableReader.html) class. We have included an +example of retrieving a single contact from the Kiji table using the contact's first +and last names. + +### Lookup.java +We connect to Kiji and our phonebook table in the same way we did above. + +{% highlight java %} +setConf(HBaseConfiguration.create(getConf())); +kiji = Kiji.Factory.open( + KijiURI.newBuilder().withInstanceName(KConstants.DEFAULT_INSTANCE_NAME).build(), + getConf()); +table = kiji.openTable(TABLE_NAME); // TABLE_NAME is "phonebook" +{% endhighlight %} + +Since we are interested in reading from our table, we open a +[`KijiTableReader`]({{site.api_schema_rc4}}/KijiTableReader.html). +{% highlight java %} +reader = table.openTableReader(); +{% endhighlight %} + +#### Looking up the requested entry +Create an [`EntityId`]({{site.api_schema_rc4}}/EntityId.html) to retrieve a contact +using the contact's first and last name: +{% highlight java %} +final EntityId entityId = table.getEntityId(mFirst + "," + mLast); +{% endhighlight %} + +Create a data request to specify the desired columns from the Kiji Table. +{% highlight java %} +final KijiDataRequestBuilder reqBuilder = KijiDataRequest.builder(); +reqBuilder.newColumnsDef() + .add(Fields.INFO_FAMILY, Fields.FIRST_NAME) + .add(Fields.INFO_FAMILY, Fields.LAST_NAME) + .add(Fields.INFO_FAMILY, Fields.EMAIL) + .add(Fields.INFO_FAMILY, Fields.TELEPHONE) + .add(Fields.INFO_FAMILY, Fields.ADDRESS); +final KijiDataRequest dataRequest = reqBuilder.build(); +{% endhighlight %} + +We now retrieve our result by passing the +[`EntityId`]({{site.api_schema_rc4}}/EntityId.html) and data request to our table reader. +Doing so results in a [`KijiRowData`]({{site.api_schema_rc4}}/KijiRowData.html) containing +the data read from the table. + +{% highlight java %} +final KijiRowData rowData = reader.get(entityId, dataRequest); +{% endhighlight %} + +### Running the Example +You can run the following command to perform a lookup using the `Lookup.java` example: + +
    +{% highlight bash %} +$KIJI_HOME/bin/kiji jar \ + $KIJI_HOME/examples/phonebook/lib/kiji-phonebook-1.0.0-rc4.jar \ + org.kiji.examples.phonebook.Lookup --first=Renuka --last=Apte +{% endhighlight %} +
    + + Renuka Apte: email=ra@wibidata.com, tel=415-111-2222, addr={"addr1": "375 Alabama St", "apt": null, "addr2": null, "city": "SF", "state": "CA", "zip": 94110} diff --git a/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-setup.md b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-setup.md new file mode 100644 index 00000000..610557fd --- /dev/null +++ b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-setup.md @@ -0,0 +1,73 @@ +--- +layout: post +title: Setup +categories: [tutorials, phonebook-tutorial, 1.0.0-rc4] +tags: [phonebook] +order: 2 +description: Setup and compile instructions for the phonebook tutorial. +--- + +For this tutorial, we assume you are either using the Kiji Standalone BentoBox or +have installed the individual components described [here](http://www.kiji.org/getstarted/). +If you don\'t have a working environment yet, you can install the Kiji +Standalone Bento box in [three quick steps!](http://www.kiji.org/#tryit). + +If you already installed the BentoBox, make sure you have started it: + +
    +{% highlight bash %} +bento start +{% endhighlight %} +
    + +### Compiling + +If you have downloaded the Kiji Standalone BentoBox, the code for this tutorial +is already compiled and located in the `$KIJI_HOME/examples/phonebook/lib/` directory. +You can skip to [Create a Table]({{site.tutorial_phonebook_rc4}}/phonebook-create) +if you want to get started playing with the example code. + + +The source code for this tutorial can be found in `$KIJI_HOME/examples/phonebook`. +The source is included along with a Maven project. To get started using Maven, +consult [Getting started With Maven]({{site.kiji_url}}/get-started-with-maven) or +the [Apache Maven Homepage](http://maven.apache.org/). + +The following tools are required to compile this project: +* Maven 3.x +* Java 6 + +To compile, run `mvn package` from `$KIJI_HOME/examples/phonebook`. The build +artifacts (jars) will be placed in the `$KIJI_HOME/examples/phonebook/target/` +directory. This tutorial assumes you are using the pre-built jars included with +the phonebook example under `$KIJI_HOME/examples/phonebook/lib/`. If you wish to +use jars of example code that you have built, you should adjust the command +lines in this tutorial to use the jars in `$KIJI_HOME/examples/phonebook/target/`. + +If you are using the Bento Box, `kiji-env.sh` will have set `$KIJI_HOME` for you +already. If not, you should set that yourself in your environment: + +
    +{% highlight bash %} +export KIJI_HOME=/path/to/kiji-schema +{% endhighlight %} +
    + +Install your Kiji instance. Running `kiji install` with no `--kiji` flag installs the default instance: + +
    +{% highlight bash %} +kiji install +{% endhighlight %} +
    + +To work through this tutorial, various Kiji tools will require that Avro data +type definitions particular to the working phonebook example be on the +classpath. You can add your artifacts to the Kiji classpath by running: + +
    +{% highlight bash %} +export KIJI_CLASSPATH=$KIJI_HOME/examples/phonebook/lib/* +{% endhighlight %} +
    + diff --git a/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-tutorial.md b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-tutorial.md new file mode 100644 index 00000000..475f7072 --- /dev/null +++ b/_posts/tutorials/phonebook/1.0.0-rc4/2012-01-01-phonebook-tutorial.md @@ -0,0 +1,41 @@ +--- +layout: post +title: Overview +categories: [tutorials, phonebook-tutorial, 1.0.0-rc4] +tags: [phonebook] +order: 1 +description: Quick tutorial to get up and running with Kiji Tables. +--- + +We assume that our incredibly popular user, **you**, needs a big-data solution +for your phone book. We will thus walk you through the process of defining a +layout for your phone book, creating a Kiji table with this layout and looking +up an entry. The current text file you have been using to store your contacts +resides at `$KIJI_HOME/examples/phonebook/input-data.txt` and we also show you how +to bulk load this into your Kiji table. + +Example code for a more in depth look at these use cases exist in the directory +`$KIJI_HOME/examples/phonebook/src/main/java`. Instructions for how to build and use this +example code can be found in the next section of this tutorial, +[Setup]({{site.tutorial_phonebook_rc4}}/phonebook-setup). + +### How to Use this Tutorial + +* **Links to Javadoc** - Class names link to the relevant Javadoc: +[`EntityId`]({{site.api_schema_rc4}}/EntityId.html). + +* **Code Walkthrough** - Code snippets are in gray boxes with language specific syntax highlighting: + +{% highlight java %} +System.out.println("Hello Kiji"); +{% endhighlight %} + +* **Shell Commands** - Shell commands to run the above code will be in light blue boxes, and the results in grey. + +
    +{% highlight bash %} +echo "Hello Kiji" +{% endhighlight %} +
    + + Hello Kiji diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-bulk-importers.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-bulk-importers.md new file mode 100644 index 00000000..24027478 --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-bulk-importers.md @@ -0,0 +1,169 @@ +--- +layout: post +title: Bulk Importers +categories: [userguides, mapreduce, 1.0.0-rc4] +tags : [mapreduce-ug] +version: 1.0.0-rc4 +order : 2 +description: Bulk Importers. +--- + +Before we can analyze any data in a Kiji table, we have to get that data into the Kiji table. + +Using KijiSchema alone, you can load data into a Kiji table from a single machine using a simple +program looping over the input. For very small jobs the speed of one machine may be sufficient, but +for larger jobs a distributed approach is needed. With a little elaboration, the simple program's +work can be distributed in the form of a MapReduce job whose mappers write to the Kiji table in +parallel. However, writing directly to KijiSchema's underlying HBase from a MapReduce job can +introduce heavy load to a cluster making things sluggish or even unstable. + +To more efficiently import data into Kiji tables, KijiMR includes _Bulk Importers_. A bulk importer +is a MapReduce job that processes its input into files that can that can be loaded +directly into Kiji. The format of the input and how it translates into Kiji table entity ids and +columns are details particular to each concrete subclass of +[`KijiBulkImporter`]({{site.api_mr_rc4}}/bulkimport/KijiBulkImporter.html). + +### Classes Overview + +Kiji bulk importers rely on two classes: all bulk importers extend the abstract class +`org.kiji.mapreduce.bulkimport.KijiBulkImporter` and override its abstract methods as described +below. Clients should be familiar with the `org.kiji.mapreduce.KijiTableContext` class, which is +used to output key-value pairs from the bulk importer. Finally, while bulk import jobs can be +launched from the command line with `kiji bulk-import`, the class +`org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder` can be used to programatically construct +and launch a bulk import job. + +### Using the API + +All bulk importers must extend the parameterized class +[`KijiBulkImporter`]({{site.api_mr_rc4}}/bulkimport/KijiBulkImporter.html) with the types of the key +and value of their input. Concrete bulk importers must implement the following method: + +* `void produce(K key, V value, KijiTableContext context)` contains the logic to produce the content +for the output Kiji table from the input. It will be called once per key-value pair from the +input (for many input text file types this is once per line). The `produce()` method can use its +`context` argument to output to Kiji table columns as detailed below. + +Optionally, bulk importers can override the `setup()` and `cleanup()` methods to initialize and +finalize resources that can be reused during the bulk import job. These methods will be called once +by each task: `setup()` before processing any input and `cleanup()` after the task is done +processing. + +As mentioned above, a bulk importer's `produce()` method has an `org.kiji.mapreduce.KijiTableContext` +argument. This class has methods needed to write data to Kiji: + +* `EntityId getEntityId(String kijiRowKey)` returns the + [`EntityId`]({{site.api_schema_rc4}}/EntityId.html) for a row in a Kiji table given a string + identifier. + +* `void put(EntityId entityId, String family, String qualifier, T value)` writes data to a column + (identified with a family and qualifier) in the row with a particular entity id. The data is + written with a timestamp equal to the time `put` is called. The type of `value` must be compatible + with the output column's schema as declared in the table layout. + +* `void put(EntityId entityId, String family, String qualifier, long timestamp , T value)` similar + to the put call above, but writes data with the specified timestamp. This is only recommended for + doing the initial import of data as this affects HBase's internal workings. See Common Pitfalls of + Timestamps in HBase for more information. + +### Example + +{% highlight java %} +/** + * Example of a bulk importer class. + * + * Reads a text file formatted as "rowKey;integerValue", + * and emits the integer value in the specified row into the column: + * "imported_family:int_value_column" + * + * Each line from the input text file is converted into an input key/value pair + * by the Hadoop text input format, where: + *
  • the key is the offset of the line in the input file, + * as a LongWritable named 'filePos'; + *
  • the value is the line content, as a Text object named 'value'. + */ +public class BulkImporterExample extends KijiBulkImporter { + public static enum Counters { + INVALID_INPUT_LINE, + INVALID_INTEGER, + } + + /** {@inheritDoc} */ + @Override + public void produce(LongWritable filePos, Text value, KijiTableContext context) + throws IOException { + // Process one line from the input file (filePos is not used in this example): + final String line = value.toString(); + + // Line is expected to be formatted as "rowKey;integerValue": + final String[] split = line.split(";"); + if (split.length != 2) { + // Record the invalid line and move on: + context.incrementCounter(Counters.INVALID_INPUT_LINE); + return; + } + final String rowKey = split[0]; + try { + final int integerValue = Integer.parseInt(split[1]); + + // Write a cell in row named 'rowKey', at column 'imported:int_value': + final EntityId eid = context.getEntityId(rowKey); + context.put(eid, "imported_family", "int_value_column", integerValue); + + } catch (NumberFormatException nfe) { + // Record the invalid integer and move on: + context.incrementCounter(Counters.INVALID_INTEGER); + return; + } + } +} +{% endhighlight %} + +This bulk importer may be run from the console with a command like the following. This command +assumes that our input lives as a text file in HDFS and that our output table, named `number_table` +here, has already been created with the correct layout in the default Kiji instance. + +{% highlight bash %} +kiji bulk-import \ + --importer=my.application.package.BulkImporterExample \ + --input="format=text file=hdfs://cluster/path/to/text-input-file \ + --output="format=kiji table=kiji://.env/default/number_table nsplits=1" \ +{% endhighlight %} + +This will launch a MapReduce job to bulk import data into the table. + +See the command line section of this userguide for a more comprehensive list of options available +when running bulk import jobs from the command line. + +### Provided Library Classes + +Within the `org.kiji.mapreduce.lib.bulkimport` package of the KijiMR Library, there is a variety of +useful parsers for building your own bulk importer: + +* [`CSVParser`]({{site.api_mrlib_rc4}}/util/CSVParser.html) - parses delimited CSV (Comma Separated + Value) data into component fields. This parser also handles TSV (Tab Separated Value) data. + +* [`CommonLogParser`]({{site.api_mrlib_rc4}}/util/CommonLogParser.html) - parses Common Log Format + data (used by Apache web server) into the relevant fields for each request in the log. + +There are several associated bulk importers that parse data into rows: + +* [`CSVBulkImporter`]({{site.api_mrlib_rc4}}/bulkimport/CSVBulkImporter.html) - takes in CSV files + and writes a row for each line in the file. + +* [`CommonLogBulkImporter`]({{site.api_mrlib_rc4}}/bulkimport/CommonLogBulkImporter.html) - takes in + an Apache web server log and produces a row for each client request. + +* [`JSONBulkImporter`]({{site.api_mrlib_rc4}}/bulkimport/JSONBulkImporter.html) - takes in a text + file with a JSON object on each line and produces a row for each object. + +All of these bulk importers extend +[`DescribedInputTextBulkImporter`]({{site.api_mrlib_rc4}}/bulkimport/DescribedInputTextBulkImporter.html) +which contains helper functions and can be configured via a +[`KijiTableImportDescriptor`]({{site.api_mrlib_rc4}}/bulkimport/KijiTableImportDescriptor.html). +[`KijiTableImportDescriptor`]({{site.api_mrlib_rc4}}/bulkimport/KijiTableImportDescriptor.html) is +an Avro-based specification that maps data in input files onto an existing Kiji table layout. + +See the javadoc for these classes for instructions and examples on using them. + diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-command-line-tools.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-command-line-tools.md new file mode 100644 index 00000000..1b4398dc --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-command-line-tools.md @@ -0,0 +1,108 @@ +--- +layout: post +title: Command Line Tools +categories: [userguides, mapreduce, 1.0.0-rc4] +tags : [mapreduce-ug] +version: 1.0.0-rc4 +order : 7 +description: Command Line Tools. +--- + +The KijiMR framework provides command line tools to submit and monitor MapReduce jobs. + +## Overview of available tools + +KijiMR provides the following command line tools: +* `kiji bulk-import`: runs a bulk-importer job that imports data from an external data source into a Kiji table. +* `kiji produce`: runs a producer job. +* `kiji gather`: runs a gatherer job that processes the rows from a Kiji table and writes files, optionally using a reducer. +* `kiji bulk-load`: bulk-loads the HFile output of a job into a KijiTable. +* `kiji mapreduce`: runs an arbitrary Map/Reduce job using Kiji mappers and reducers. +* `kiji job-history`: retrieve information about jobs previously run through kiji if enabled. + +## Using common-flags + +Kiji commands bulk-import, produce and gather all recognize the following flags: + +* `--kvstores=/path/to/store-specifications.xml`: specifies the path of XML file describing the key/value stores used by the job. + +* `--lib=/path/to/jars-directory/`: specifies a directory of jar files that contain user code. + + +* `--start-row=`: specifies the HBase row to start scanning at (inclusive). + Example: `--start-row=hex:0088deadbeef`, or `--start-row="utf8:the row key in UTF8"`. + +* `--limit-row=`: specifies the HBase row to stop scanning at (exclusive). + Example: `--limit-row=hex:0088deadbeef`, or `--limit-row=:utf8:the row key in UTF8"`. + + +Bulk importers must specify the name of the class providing the bulk-import logic: + +* `--importer=java.package.BulkImporterClassName`: specifies the [`KijiBulkImporter`]({{site.api_mr_rc4}}/bulkimport/KijiBulkImporter.html) class to use. + +Producers must specify the name of the class providing the producers logic: + +* `--producer=java.package.ProducerClassName`: specifies the [`KijiProducer`]({{site.api_mr_rc4}}/produce/KijiProducer.html) class to use. + +Gatherer must specify the name of the class providing the gathering logic, and optionally a reducing logic: + +* `--gatherer=java.package.GathererClassName`: specifies the [`KijiGatherer`]({{site.api_mr_rc4}}/gather/KijiGatherer.html) class to use. + +* `--combiner=java.package.CombinerClassName`: optionally specifies a Combiner class to use. + +* `--reducer=java.package.ReducerClassName`: optionally specifies a Reducer class to use. + +## Input/output formats + +Jobs inputs and outputs are specified with the following flags: + +* `--input=...`: specifies the input of the job. + + The job input specification is formatted as `--input="format= ..."`. + Kiji recognizes the following job input formats: + + * `avro`: job input is an Avro container file, each input record is a pair (Avro key, NullWritable). + + * `avrokv`: job input is an Avro container file for key/value generic records. + + * `htable`: job input is an HTable, each input record is a pair (HBase row key, HBase Result). + The address of the HBase cluster is pull from the local job configuration (ie. from the HBase configuration available on the classpath). + Example: `--input="format=htable htable=htable-table-name"`. + + * `kiji`: job input is a Kiji table, each input record is a pair (row entity ID, KijiRowData). + Example: `--input="format=kiji table=kiji://.env/default/input_table"`. + + * `seq`: job input is a Hadoop sequence file. + Example: `--input="format=seq file=hdfs://dfsmaster:9000/path/to/sequence-file/"`. + + * `small-text-files`: job input is a set of small text files, each input record is a pair (text file path, text file content). + Example: `--input="format=small-text-files file=hdfs://dfsmaster:9000/path/to/text-files/"`. + + * `text`: job input is a text file, each input record is a pair (position in the text file, line of text). + Example: `--input="format=text file=hdfs://dfsmaster:9000/path/to/text-file/"`. + +* `--output=...`: specifies the output of the job. + + The job specification is formatted as: `--output="format= nsplits=N ..."`. + Kiji recognizes the following job output formats: + + * `avro`: job output is an Avro container file, each output record is a pair (Avro key, NullWritable). + + * `avrokv`: job output is an Avro container file with key/value generic records. + + * `hfile`: job output is an HFile that will be bulk-loaded into a Kiji table. + Example: `--output="format=hfile nsplits=10 table=kiji://.env/default/target_table file=hdfs://dfsmaster:9000/path/to/hfile/"`. + + * `kiji`: job output is a Kiji table. + The use of this job output should be limited to development only and should not be used in production as it may incur high load on the target HBase cluster. The exception is producers, whose input and output must be the same kiji table. + Example: `--output="format=kiji nsplits=10 table=kiji://.env/default/target_table"`. + + * `map`: job output is a Hadoop map file. + Example: `--output="format=map nsplits=10 file=hdfs://dfsmaster:9000/path/to/map-file/"`. + + * `seq`: job output is a Hadoop sequence file. + Example: `--output="format=seq nsplits=10 file=hdfs://dfsmaster:9000/path/to/sequence-file/"`. + + * `text`: job output is a text file; each (key, value) record is written to a text file with a separator + (via the configuration parameter "mapred.textoutputformat.separator", which defaults to TAB) and a new line. + Example: `--output="format=text nsplits=10 file=hdfs://dfsmaster:9000/path/to/text-file/"`. diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-gatherers.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-gatherers.md new file mode 100644 index 00000000..91b4a624 --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-gatherers.md @@ -0,0 +1,150 @@ +--- +layout: post +title: Gatherers +categories: [userguides, mapreduce, 1.0.0-rc4] +tags : [mapreduce-ug] +version: 1.0.0-rc4 +order : 4 +description: Gatherers. +--- + +### Motivation + +A Kiji Gatherer scans over the rows of a Kiji table using the MapReduce framework and output key-value pairs. Gatherers are a flexible job type and can be used to extract or aggregate information into a variety of formats based on the output specification and reducer used. +Common tasks for gatherers include calculating sums across an entire table, extracting features to train a model, and pivoting information from one table into another. You should use a gatherer when you need to pull data out of a Kiji table into another format or to feed it into a Reducer. + +### Classes Overview + +There are three classes for an application that wants to use gatherers: + +All gatherers extend the abstract class +`org.kiji.mapreduce.gather.KijiGatherer` and override its abstract methods as +described below. Clients should be familiar with the +`org.kiji.mapreduce.gather.GatherContext` class, which is used to output the +Gatherer's key-value pairs. Finally, while gather jobs can be launched from the +command line with `kiji gather`, +`org.kiji.mapreduce.gather.KijiGatherJobBuilder` can be used to construct a +MapReduce job that runs a given gather with configured input, output, and +reducer. The job can then be launched programmatically. + +## Using the API + +All gatherers must extend the parameterized class [`KijiGatherer`]({{site.api_mr_rc4}}/gather/KijiGatherer.html) with the types +of the key and value of their output. Concrete gatherers must implement these methods: + + * `Class getOutputKeyClass()` and `Class getOutputValueClass()`. These methods should return the +classes of the output keys and values emitted by the gatherer. + * `KijiDataRequest getDataRequest()`. This methods specifies the columns retrieved while scanning rows from the input table. It should construct and return a [`KijiDataRequest`]({{site.api_schema_rc4}}/KijiDataRequest.html). + * `void gather(KijiRowData input, GathererContext context)`. This methods contains the gatherer's logic that translates its input into key-value pairs. It will be called once per row processed by the gatherer task. `input` will contain the columns from the row as requested by the [`KijiDataRequest`]({{site.api_schema_rc4}}/KijiDataRequest.html) returned by `getDataRequest()`. The gatherer should use its `context` parameter to emit key-value pairs as detailed below. + +While processing a row, a gatherer may access data from external stores through [`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html)s by implementing `Map> getRequiredStores()`. This method should construct and return a map specifying all the [`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html)s that the gatherer wants to access. The [`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html)s may then later be accessed from the `gather()` method through the [`GathererContext`]({{site.api_mr_rc4}}/gather/GathererContext.html). For more details, you may check the [KeyValue Stores]({{site.userguide_mapreduce_rc4}}/key-value-stores) section in this guide. + +Optionally, a gatherer may implement `setup()` and `cleanup()` to initialize and +finalize resources that can be reused during the gather task. These methods +will be called once by each task, `setup()` before processing input rows and +`cleanup()` after the task is done processing. If you wish to use a +[`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html), it should be opened once with `context.getStore(storeName)` in +`setup()`, saved in a member variable, and closed in `cleanup()`. + +The class of a gatherer's output key and value may have restrictions +depending on the output format used with this gatherer. For example, if used with a sequence file output format, classes must either be Avro types +or implement the `org.apache.hadoop.io.Writable` interface. See the Command Line Tools section of this guide for more about output format options. + +As mentioned above, a gatherer's `gather` method has a `org.kiji.mapreduce.gather.GatherContext` argument. This class has a number of methods which are relevant to a gatherer author: + + * `void write(K key, V value)`. Emits a key-value pair. The key-value pair will be later processed by +the reduce step of this MapReduce job. The type of `key` and `value` should match the +parameter types of the gatherer's class. + * `void incrementCounter(Enum counter)`. Increments a mapreduce job counter. This can be useful for calculating aggregate counts about the full MapReduce job (for example, you can use a counter to calculate the total number of input rows containing malformed data). This method is common to all KijiContexts. + +### Example + +{% highlight java %} +/** + * Example of a gatherer class that extracts the size of households per zip-code. + * + * Processes entities from an input table that contains households with: + *
  • a column 'info:zip_code' with the zip code of a household; + *
  • a column 'members:*' with the household's members names; + * and emits one key/value pair per household to a sequence file on HDFS, where: + *
  • the key is the zip code of the household, as an IntWritable, + *
  • the value is the number of persons in the household, as an IntWritable. + */ +public class FamilySizeGatherer extends KijiGatherer { + public static enum Counters { + MISSING_ZIP_CODE, + } + + /** {@inheritDoc} */ + @Override + public Class getOutputKeyClass() { + // Zip code encoded as an IntWritable: + return IntWritable.class; + } + + /** {@inheritDoc} */ + @Override + public Class getOutputValueClass() { + // Family size (number of persons) encoded as an IntWritable: + return IntWritable.class; + } + + /** {@inheritDoc} */ + @Override + public KijiDataRequest getDataRequest() { + // Fetch columns 'info:zip_code' and map-family 'members': + return KijiDataRequest.builder() + .addColumns(ColumnsDef.create() + .add("info", "zip_code") + .addFamily("members")) + .build(); + } + + /** {@inheritDoc} */ + @Override + public void gather(KijiRowData input, GathererContext context) + throws IOException { + // Extract the required data from the input row: + final Integer zipCode = input.getMostRecentValue("info", "zip_code"); + if (zipCode == null) { + // Zip code is missing from the input row, report the bad input and move on: + context.incrementCounter(Counters.MISSING_ZIP_CODE); + return; + } + + // Since we only care about the size of the family, + // rather than the data stored for each member, + // we only extract the qualifiers for the "members" family. + final Set members = input.getQualifiers("members"); + + // Some computation: for this simple example, + // we compute the family size from the set of its members: + final int familySize = members.size(); + + // Emit a pair (zip code, family size) to the configured output through the context: + context.write(new IntWritable(zipCode), new IntWritable(familySize)); + } +} +{% endhighlight %} + +The gatherer described above may be used on the command line as follows. +It expects a Kiji input table whose rows represent households, +with a column `'info:zip_code'` that contains the Zip code of each household +and with a column family `'members'` that lists the household members. + +{% highlight bash %} +kiji gather \ + --gatherer=my.application.package.FamilySizePerZipCodeGatherer \ + --input="format=kiji table=kiji://.env/default/household_table_name" \ + --output="format=seq file=hdfs://cluster/path/to/sequence-file nsplits=1" +{% endhighlight %} + +With this command, the gather job will write its output key-value pairs to sequence files +in the directory `hdfs://cluster/path/to/sequence-file/`. Each entry in the sequence file +will correspond to one household and will contain the household Zip code as a key and +the number of household members as a value. + +Each gather task will produce a single sequence file `hdfs://cluster/path/to/sequence-file/part-m-`. +The number of gatherer tasks is currently set to be the number of regions in the input table: each gather task +processes one region from the input table. +Therefore, the `nsplits` parameter of the job output specification is not used in this context when no reducer is specified. diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-hfiles.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-hfiles.md new file mode 100644 index 00000000..3a410276 --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-hfiles.md @@ -0,0 +1,151 @@ +--- +layout: post +title: HFiles +categories: [userguides, mapreduce, 1.0.0-rc4] +tags : [mapreduce-ug] +version: 1.0.0-rc4 +order : 6 +description: HFiles. +--- + +Bulk-importers and producers write their outputs to Kiji tables. +Gatherers and reducer may also direct their outputs to Kiji tables. + +## Direct Writes + +The most natural way to write to a Kiji table from a MapReduce job is through direct writes. +This is what the `format=kiji` job output specification achieves on the command line, +eg. when running a job with `--output="format=kiji table=kiji://.env/default/table nsplits=1"`. +Using the job builder API, this is what the job output class [`DirectKijiTableMapReduceJobOutput`]({{site.api_mr_rc4}}/output/DirectKijiTableMapReduceJobOutput.html) +implements, eg. when specifying the output of a job with `jobBuilder.withOutput(new DirectKijiTableMapReduceJobOutput(tableURI))`. + +Under the hood, the output format used by each MapReduce tasks will open a [`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html) +and issue `put()` operations that will be sent to the live Kiji table as the MapReduce job progresses. + +Following is a bulk-import command line example that uses direct writes to the output Kiji table: +{% highlight bash %} +kiji bulk-import \ + --importer=my.application.package.BulkImporterExample \ + --input="format=seq file=hdfs://cluster/path/to/input-seq-file/" \ + --output="format=kiji table=kiji://.env/default/table nsplits=1" \ +{% endhighlight %} + +When using direct writes, the `nsplits` parameter is ignored (although required). +The number of bulk-import tasks depends on the input format used. +In the previous example, the number of bulk-import tasks is the number of input sequence files in the directory `hdfs://cluster/path/to/input-seq-file/`. +Each bulk-import task will send writes directly to the output Kiji table `kiji://.env/default/table`. + + + +## Writing to HFiles + +Another approach for writing to Kiji tables is for the MapReduce jobs to write HFiles. +An HFile is the underlying file format used by HBase region servers to store the cells for a table. +Cells written to an HFile must first be ordered by increasing row key, then by increasing HBase +column names, and finally according to their timestamps. The shuffle-sort-reduce phase of a +MapReduce job is used to order the cells properly before writing them to the HFiles. +HFiles can then be efficiently loaded into a live Kiji table through _bulk-loading_ operations. +A bulk-load operation can be initiated with the `kiji bulk-load` command line tool. + +KijiMR jobs are configured to write HFiles through the `format=hfile` job output specification on the command line, +as in `--output="format=hfile table=kiji://.env/default/table file=hdfs://cluster/path/to/hfile/ nsplits=1"`. +Using the job builder API, the HFile job output is implemented by the [`HFileMapReduceJobOutput`]({{site.api_mr_rc4}}/output/HFileMapReduceJobOutput.html) job output class, +as in `jobBuilder.withOutput(new HFileMapReduceJobOutput(tableURI, hfilePath))`. + +Below is the same example of a bulk-import command line as in the [Direct Writes](#ref.direct_writes) section, +with the job output specification updated to generate HFiles instead of writing directly to the output Kiji table. + +{% highlight bash %} +# Run the bulk importer configured to write HFiles: +kiji bulk-import \ + --importer=my.application.package.BulkImporterExample \ + --input="format=seq file=hdfs://cluster/path/to/input-seq-file/" \ + --output="format=hfile table=kiji://.env/default/output_table + file=hdfs://cluster/path/to/output-hfile/ nsplits=10" +{% endhighlight %} + +The first command line runs the bulk-importer job and generates HFiles in HDFS in the directory +`hdfs://cluster/path/to/output-hfile/`. Because the bulk-importer job is configured to write HFiles, +the job builder added an identity reducer phase to sort the cells. +The above-mentioned command line will generate 10 sets of HFiles, one per reducer (`nsplits=10`) +in directories named `hdfs://cluster/path/to/output-hfile/part-r-`. +Each reducer writes separate HFiles for each column family in directories named after the HBase column names. +Ideally, each generated HFile fits entirely in a region in the target Kiji table so that no +additional processing is required to have the HFile loaded by a region server serving the Kiji table. + +Once the HFiles are generated, we can then bulk-loaded via the `kiji bulk-load` command. + +{% highlight bash%} +# Bulk-load the generated HFiles into the live Kiji table: +kiji bulk-load \ + --table=kiji://.env/default/output_table \ + --hfile=hdfs://cluster/path/to/output-hfile/ +{% endhighlight %} + +### Writing HFiles with Custom Reducers. + +Writing HFiles relies on the MapReduce shuffle-sort phase to order the cells correctly in the generated HFiles. +If you need to run a mapper or gatherer with a custom table reducer and want to generate HFiles, +another extra MapReduce is required to sort the cells before actually writing the HFiles. + +This scenario is not fully supported yet. +The helper MapReduce job `org.kiji.mapreduce.testlib.HFileReduceJob` is not included yet in the KijiMR distribution. +See [KIJIMR-100](https://jira.kiji.org/browse/KIJIMR-100) for more details on this work. + +Below is an example of the workflow required when writing HFiles from a table reducer: + +{% highlight bash %} +# Run the bulk importer configured to write HFiles. +# Because this uses a custom table reducer, this actually writes a sequence file +# containing HBase cells instead of an HFile: +kiji gather \ + --gatherer=my.application.package.MyGatherer \ + --reducer=my.application.package.MyTableReducer \ + --input="format=kiji table=kiji://.env/default/input_table" \ + --output="format=hfile table=kiji://.env/default/output_table + file=hdfs://cluster/path/to/output-seq-file/ nsplits=10" + +# Sorts the HBase cells from the output sequence file and write HFiles: +# Note: The following class is currently NOT available in the KijiMR release jar +# However, you may find it in the KijiMR test jar. +java -classpath $(kiji classpath) org.kiji.mapreduce.testlib.HFileReduceJob \ + --input-path=hdfs://cluster/path/to/output-seq-file/ \ + --output-path=hdfs://cluster/path/to/output-hfile/ \ + --output-table=kiji://.env/default/output_table \ + --nsplits=10 + +# Bulk-load the generated HFiles into the live Kiji table: +kiji bulk-load \ + --table=kiji://.env/default/output_table \ + --hfile=hdfs://cluster/path/to/output-hfile/ +{% endhighlight %} + +## Should I use direct writes or HFiles? + +### Workflow complexity + +Working with direct writes is generally simpler to set up, as this mode requires no additional +MapReduce pass and no bulk-loading operation. +Direct writes are usually fine with small amounts of data or for testing. + +Writing HFiles adds some complexity to the MapReduce workflow with an extra bulk-loading operation +and potentially an extra MapReduce job to sort the HBase cells. + +### Atomicity + +One advantage of HFiles over direct writes is the level of atomicity it provides. +A MapReduce job that fails while writing directly to a Kiji table will leave the output table in a +disheveled state, with partial updates. Whereas a MapReduce job that fails while writing HFiles will +leave the output table unmodified - the HFile output of the MapReduce becomes visible once the HFiles are bulk loaded. + +### Performance + +Writing significant amounts of data to a Kiji table through direct writes requires careful tuning of +the underlying HBase cluster to avoid performance issues. As the writes are accumulated in the table +regions, they might trigger region compactions or splits. In some circumstances, this may affect the availability of the HBase cluster. + +HFiles, on the other hand, can be loaded by region servers directly with very little overhead. +However, this approach might also lead to region compaction issues, as these described in +[HBASE-3404](https://issues.apache.org/jira/browse/HBASE-3404), [HBASE-3690](https://issues.apache.org/jira/browse/HBASE-3690). + +For greater details on this topic, you might have a look at the HBase book section [«Writing to HBase»](http://hbase.apache.org/book/perf.writing.html). diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-job-history.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-job-history.md new file mode 100644 index 00000000..f62337f4 --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-job-history.md @@ -0,0 +1,55 @@ +--- +layout: post +title: Job History +categories: [userguides, mapreduce, 1.0.0-rc4] +tags : [mapreduce-ug] +version: 1.0.0-rc4 +order : 9 +description: Job History Table. +--- + +### Motivation + +While Hadoop’s job tracker provides detailed information about jobs that have been run in the cluster, it is not a persistent data store for such information.  After installation of the `job_history` table, Kiji automatically tracks information into the job_history table which can be accessed later. This information includes an xml dump of the full job configuration, start times, end times, and all job counters. +/ + +### Setup +The job history tables can be installed into the default Kiji instance with the job-history command: + +{% highlight bash %} +kiji job-history --kiji=kiji://.env/default --install +{% endhighlight %} + +If you would like to install the job history table into a different instance, pass in the relevant URI into the --kiji parameter. + +You can verify that the table was installed properly using the ls command: + +{% highlight bash %} +kiji ls --kiji=kiji://.env/default/job_history +{% endhighlight %} + +Any new MapReduce jobs that are run within Kiji will now save relevant job related metadata into this table. + +### Classes Overview + +The `org.kiji.mapreduce.JobHistoryKijiTable` is the main class responsible for providing access to the job_history table.  Currently it provides the ability to record and retrieve job metadata. This is a framework-audience class and subject to change between minor versions + +### Using the API + +The [`JobHistoryKijiTable`]({{site.api_mr_rc4}}/framework/JobHistoryKijiTable.html) class surfaces the call `getJobDetails` for retrieving the recorded metadata. + +Jobs that are created using [`KijiMapReduceJob`]({{site.api_mr_rc4}}/framework/KijiMapReduceJob.html) will automatically record metadata to the `job_history` table if it has been installed. Any MapReduce jobs using the job builders in Kiji for bulk importers, producers, or gatherers fall under this category and will report data. + +### Example + +The job_history table is a Kiji table under the hood, and can thus be inspected using the `kiji ls` tool. The [`EntityId`]({{site.api_schema_rc4}}/EntityId.html) associated with the job_history table is the jobId.  For example, to look at all of the jobIds that have been recorded: + +{% highlight bash %} +kiji ls --kiji=kiji://.env/default/job_history --columns=info:jobId +{% endhighlight %} + +There is also a job_history tool, which displays the job history data in a more human readable format.  For example, to look up job data for the job ‘job_20130221123621875_0001’ + +{% highlight bash %} +kiji job-history --kiji=kiji://.env/default --job-id=job_20130221123621875_0001 +{% endhighlight %} diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-key-value-stores.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-key-value-stores.md new file mode 100644 index 00000000..512d6990 --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-key-value-stores.md @@ -0,0 +1,201 @@ +--- +layout: post +title: Key-Value Stores +categories: [userguides, mapreduce, 1.0.0-rc4] +tags : [mapreduce-ug] +version: 1.0.0-rc4 +order : 8 +description: Key-Value Stores. +--- + +### Motivation + +KeyValueStores are used to provide MapReduce programs and other operators processing Kiji datasets with the ability to join datasets. One data set can be specified as a key-value store using the KeyValueStore API. The program can use a KeyValueStoreReader to look up values associated with keys. These keys are often driven by records of a dataset being processed by MapReduce. + +This can be used, for example, to provide a [`KijiProducer`]({{site.api_mr_rc4}}/produce/KijiProducer.html) with the means to apply the results of a trained machine learning model to the main data set. The output of a machine learning model might be expressed as (key, value) pairs stored in files in HDFS, or in a secondary Kiji table. For each user in a users table, you may want to compute a new recommendation for the user by applying the model to the information in the user's row. A value in the user's row may be a key into some arbitrary key-value store representing the model; the returned value is the recommendation. + +You may also need to perform "ordinary" map-side joins in a MapReduce program, e.g., for denormalization of data. The smaller dataset can be held in RAM in each map task in the form of a KeyValueStore. For each record in the larger dataset, you can look up the corresponding small-side record, and emit the concatenation of the two to the reducer. + +`KeyValueStores` also allow non-MapReduce applications to read key-value pairs from HDFS-backed datasets in a file-format-agnostic fashion. For example, you may run a MapReduce program that emits output as a `SequenceFile` that your frontend application needs to consume. You could use a `SequenceFile.Reader` directly, but if you ever change your MapReduce pipeline to emit to text files or Avro files, you will need to rewrite your client-side logic. Using the KeyValueStoreReader API in your client allows you to decouple the act of using a key-value map from what format you need to use to read the data. + +### Classes Overview + +The main classes in the KeyValueStore API are `org.kiji.mapreduce.kvstore.KeyValueStore` and `org.kiji.mapreduce.kvstore.KeyValueStoreReader`. + +A [`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html) specifies all the resources needed to surface key-value pairs from some backing store. This may be defined on files, a Kiji table, or some other resource like a different NoSQL database. + +Several KeyValueStore implementations are made available in the `org.kiji.mapreduce.kvstore.lib` package that cover common use cases for file- or Kiji-backed datasets. You could write your own [`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html) implementation that accesses a foreign system (e.g., a Redis database). + +A [`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html) class specifies how to read data into the store. For example, [`TextFileKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/TextFileKeyValueStore.html) expects to parse delimited text files, while [`SeqFileKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/SeqFileKeyValueStore.html) reads SequenceFiles. Both of these stores are configured with an HDFS path to read from. A [`KijiTableKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/KijiTableKeyValueStore.html) requires different configuration. + +The KeyValueStore implementations provided in the library are immutable; they’re all created through builder classes. They each have a method named `builder()` that returns a new instance of the associated builder class. + +The [`KeyValueStoreReader`]({{site.api_mr_rc4}}/kvstore/KeyValueStoreReader.html) API is used to actually look up values by key, from some KeyValueStore. You cannot directly instantiate any concrete implementations of [`KeyValueStoreReader`]({{site.api_mr_rc4}}/kvstore/KeyValueStoreReader.html) yourself; use a given KeyValueStore's `open()` method to open an associated reader object. The client is agnostic to the backing store; one [`KeyValueStoreReader`]({{site.api_mr_rc4}}/kvstore/KeyValueStoreReader.html) should act the same as the next, given equivalent backing data. + +By default, a KeyValueStoreReader's data is presented to you as a read-only, non-iterable map. Only `get()` requests for an explicit key are supported by default, though some implementations may offer iteration. + +An opened KeyValueStoreReader may contain state or connect to external resources; you should call the `close()` method when you are finished using it. + +#### Simple Example for Opening a KeyValueStore + +{% highlight java %} + final KeyValueStore csvKeyValues = TextFileKeyValueStore.builder() + .withInputPath(new Path("some-file.txt")) + .withDistributedCache(false) + .build(); + + final KeyValueStoreReader reader = csvKeyValues.open(); + try { + String theValue = reader.get("some-key"); + System.out.println("Contained a mapping: some-key -> " + theValue); + } finally { + reader.close(); + } +{% endhighlight %} + +### Using the API + +The distinction between KeyValueStore and KeyValueStoreReader is intentional. A given MapReduce program may need to access some set of KeyValueStoreReaders. When the job is configured, you must configure it with any associated KeyValueStores. For example, file-backed stores often use the DistributedCache to efficiently copy files to all map tasks. This must be configured before the job begins. + +Your MapReduce task class (KijiMapper, KijiReducer, KijiProducer, KijiGatherer, etc) can implement [`KeyValueStoreClient`]({{site.api_mr_rc4}}/kvstore/KeyValueStoreClient.html) to help specify to a Kiji job builder (e.g., [`KijiGatherJobBuilder`]({{site.api_mr_rc4}}/gather/KijiGatherJobBuilder.html)) that it requires stores. This will require that you implement a method named `getRequiredStores()` that returns a mapping from names to KeyValueStores. These are the default _bindings_ for KeyValueStores. + +The use of Java generic types makes constructing the return value from your `getRequiredStores()` method to be cumbersome. Some static factory methods have been added for your convenience in the [`RequiredStores`]({{site.api_mr_rc4}}/kvstore/RequiredStores.html) class. For example, to require no stores: + +{% highlight java %} + @Override Map> getRequiredStores() { + return RequiredStores.none(); + } +{% endhighlight %} + +To require one empty store named `"mystore"`: + +{% highlight java %} + @Override Map> getRequiredStores() { + RequiredStores.just("mystore", EmptyKeyValueStore.get()); + } +{% endhighlight %} + +The `RequiredStores.with()` method will return a `Map` object augmented with a `with(String, KeyValueStore)` method, so you can call `RequiredStores.with("foo", store1).with("bar", store2);`. + +Within the `KijiGatherer.gather()` method, the [`KijiContext`]({{site.api_mr_rc4}}/KijiContext.html) object provided as an argument will provide you with access to KeyValueStoreReaders. Since you may need multiple KeyValueStores, you can refer to each by the name you bound it to in `getRequiredStores()`. + +Since each call to `gather()` is likely to require the same stores, it would be high-overhead to open and close a KeyValueStoreReader in every call. The KijiContext itself uses a class called [`KeyValueStoreReaderFactory`]({{site.api_mr_rc4}}/kvstore/KeyValueStoreReaderFactory.html), which is responsible for instantiating KeyValueStores from the `Configuration` associated with the job, and maintaining a pool of lazily-opened KeyValueStoreReader instances organized by name binding. The gatherer itself does not close individual KeyValueStoreReader instances. The KeyValueStoreReaderFactory will close all of them as the task is being torn down. + +#### Overriding Default Bindings in Job Builders + +While the `getRequiredStores()` method allows you to define bindings between names and implementations, specific invocations of the MapReduce job may require that you override these implementations. For example, you may want to use one HDFS path as input in production, but a different HDFS path in local tests. + +The [`MapReduceJobBuilder`]({{site.api_mr_rc4}}/framework/MapReduceJobBuilder.html) subclasses all support a method called `withStore(String name, KeyValueStore store)`. This method allows you to specify a different KeyValueStore implementation for that particular job. You will need to override a store name that the job will expect to read; i.e., if `getRequiredStores()` returned a binding from `"mystore"` to a particular [`TextFileKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/TextFileKeyValueStore.html), you should call `myJobBuilder.withStore("mystore", myDifferentKeyValueStore);`. + +#### Overriding Default Bindings on the Command Line + +You can also override KeyValueStore bindings on the command line with the `--kvstores` argument. This argument specifies an XML file that should look like the following: + +{% highlight xml %} + + + + + paths + /path/to/foo.txt,/path/to/bar.txt + + + delim + , + + + + +{% endhighlight %} + + +This example defines a delimited-text-file store, bound to the name `"mystore"`. It reads from `foo.txt` and `bar.txt` and expects a comma between the key and value fields on each line. + +You can define multiple name-to-store bindings with different `` blocks with unique names. The properties available within each store's configuration is specified in the Javadoc for each KeyValueStore class. + +#### Requiring Runtime Configuration of KeyValueStores + +If you know that your KijiProducer requires a store named `"mystore"`, but do not know at compile time where the physical resource that backs it will be, you may want to force your clients to specify this at runtime using one of the above two methods. A mapping of `RequiredStores.just("mystore", UnconfiguredKeyValueStore.get());` will throw an exception when it is serialized to the `Configuration`, which ensures that your job cannot start unless you override the definition with an XML file or a binding in a job builder. + + +### Example + +In this example, suppose we have computed a set of movie sequels, which we will use to naively recommend to users on our web site that if they've watched the first one, they watch the sequel. Suppose we stored the movie sequel dataset in pipe-delimited text files in HDFS, that look something like: + + Star Wars: A New Hope|Star Wars: The Empire Strikes Back + Raiders of the Lost Ark|Indiana Jones and the Temple of Doom + ... + +We could write a KijiProducer that read from the `info:recently_watched` column and produce a field named `info:recommended_movie` as follows: + +{% highlight java %} + import java.io.IOException; + + import org.apache.hadoop.fs.Path; + + import org.kiji.mapreduce.*; + import org.kiji.mapreduce.kvstore.*; + import org.kiji.mapreduce.kvstore.lib.*; + import org.kiji.schema.*; + + /** + * Produce a movie recommendation based on the theory that if they liked + * the first one, they should watch the sequel. + */ + public class MoveRecProducer extends KijiProducer { + @Override public Map> getRequiredStores() { + // Note that it's ok to specify a path to an HDFS dir, not just one file. + return RequiredStores.just("sequels", TextFileKeyValueStore.builder() + .withDelimiter("|") + .withInputPath(new Path("/path/to/movie-sequels.txt")).build()); + } + + @Override KijiDataRequest getDataRequest() { + return KijiDataRequest.create("info", "recently_watched"); + } + + @Override String getOutputColumn() { + return "info:recommended_movie"; + } + + @Override void produce(KijiRowData input, ProducerContext context) + throws IOException { + + if (!input.containsColumn("info", "recently_watched")) { + // No basis for recommendation. + return; + } + + // Note that we don't call our own getRequiredStores() method. That was used + // in the configuration phase of the job, not within each task. Its output may have + // been overridden at run-time by the user. We take the deserialized store from the + // ProducerContext instead. + KeyValueStoreReader sequelStore = context.getStore("sequels"); + + String lastWatched = input.getMostRecentValue("info", "recently_watched").toString(); + String nextMovie = sequelStore.get(lastWatched); + if (null != nextMovie) { + // We found a match! Write to info:recommended_movie + context.write(nextMovie); + } + } + } +{% endhighlight %} + + +### Provided Library Classes + +Several implementations of KeyValueStore are available in the `org.kiji.mapreduce.kvstore.lib` package: + +Several file-backed KeyValueStore implementations provide access to stores in different file formats: + +* [`AvroKVRecordKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/AvroKVRecordKeyValueStore.html) - Key-Value pairs specified in Avro records containing two fields, `key` and `value` +* [`AvroRecordKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/AvroRecordKeyValueStore.html) - Avro records in an Avro file, to be indexed by a configurable field of each record. +* [`SeqFileKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/SeqFileKeyValueStore.html) - Key-Value pairs in SequenceFiles +* [`TextFileKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/TextFileKeyValueStore.html) - string key-value pairs in delimited text files + +You can also access a specific column of a Kiji table by the row's entityId using the [`KijiTableKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/KijiTableKeyValueStore.html). + +If you want to declare a name binding on a KeyValueStore whose exact configuration cannot be determined before runtime, use the [`UnconfiguredKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/UnconfiguredKeyValueStore.html). It will throw an IOException in its `storeToConf()` method, ensuring that your [`MapReduceJobBuilder`]({{site.api_mr_rc4}}/framework/MapReduceJobBuilder.html) must call `withStore()` to override the definition before launching the job. + +The [`EmptyKeyValueStore`]({{site.api_mr_rc4}}/kvstore/lib/EmptyKeyValueStore.html) is a good default choice when you plan to override the configuration at runtime, but find it acceptable to operate without this information. diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-kiji-mr-overview.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-kiji-mr-overview.md new file mode 100644 index 00000000..e32f695c --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-kiji-mr-overview.md @@ -0,0 +1,52 @@ +--- +layout: post +title: What is KijiMR? +categories: [userguides, mapreduce, 1.0.0-rc4] +tags : [mapreduce-ug] +version: 1.0.0-rc4 +order : 1 +description: Overview. +--- + +KijiMR allows KijiSchema users to employ MapReduce-based techniques to develop many kinds of +applications, including those using machine learning and other complex analytics. + +KijiMR is organized around three core MapReduce job types: _Bulk Importers_, _Producers_ and +_Gatherers_. + + * _Bulk Importers_ make it easy to efficiently load data into Kiji tables from a variety of + formats, such as JSON or CSV files stored in HDFS. + * _Producers_ are entity-centric operations that use an entity's existing data to generate new + information and store it back in the entity's row. One typical use-case for producers is to + generate new recommendations for a user based on the user's history. + * _Gatherers_ provide flexible MapReduce computations that scan over Kiji table rows and output + key-value pairs. By using different outputs and reducers, gatherers can export data in a variety + of formats (such as text or Avro) or into other Kiji tables. + +Finally, KijiMR allows any of these jobs to combine the data they operate on with external +_KeyValueStores_. This allows the user to join data sets stored in HDFS and Kiji. + +Unlike KijiSchema, where the classes most relevant to application developers were usually concrete, +these core job types exist in KijiMR as abstract classes (such as +[`KijiProducer`]({{site.api_mr_rc4}}/produce/KijiProducer.html)). It is typically up to the +application developer to subclass the appropriate class in their application and implement their +application's analysis logic in a few methods (such as +[`KijiProducer`]({{site.api_mr_rc4}}/produce/KijiProducer.html)'s `produce()` and +`getDataRequest()`). They can then point the job at the appropriate Kiji table using either the +`kiji` command line tools or programmatically using one of the framework's JobBuilders (such as +[`KijiProduceJobBuilder`]({{site.api_mr_rc4}}/produce/KijiProduceJobBuilder.html)) that make +launching these jobs easy. Kiji can also record metadata about jobs run using KijiMR to provide +a historical view. + +The KijiMR Library provides a growing repository of implemented solutions to many common use-cases. +These solutions can be used directly or as example code. Both KijiMR and the KijiMR Library are +included with distributions of Kiji BentoBox. + +In the sections of this guide that follow, the core job types will be explained in greater detail. +Motiviation, example code snippets, and (where appropriate) a description of reference +implementations in the KijiMR Library will be given for each. This guide also contains an in-depth +description of how to use _KeyValueStores_ to expose side-data stored in HDFS and Kiji through a +consistent interface to your MapReduce jobs. Finally, this guide contains a description of the +command line tools included with KijiMR and facilities that make it easier to test KijiMR +application code. + diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-producers.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-producers.md new file mode 100644 index 00000000..bf72292a --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-producers.md @@ -0,0 +1,189 @@ +--- +layout: post +title: Producers +categories: [userguides, mapreduce, 1.0.0-rc4] +tags : [mapreduce-ug] +version: 1.0.0-rc4 +order : 3 +description: Producers. +--- + +### Motivation + +A [`KijiProducer`]({{site.api_mr_rc4}}/produce/KijiProducer.html) executes a function over a subset +of the columns in a table row and produces output to be injected back into a column of that row. +Producers can be run in a MapReduce job that operates over a range of rows from a Kiji table. +Common tasks for producers include parsing, profiling, recommending, predicting, and classifying. +For example, you might run a LocationIPProducer to compute and store the location of each user into +a new column, or a PersonalizationProfileProducer to compute a personalization profile. + +Whereas gatherers generally run over the rows of a Kiji table to generate key-value pairs for the +purposes of conversion, analysis, or filling in information in a different table, producers can only +write back information directly into the row they're presently processing. Producers are the most +appropriate tool when you want to update a row with information calculated from the existing +contents of that row and KeyValueStores. + +### Classes Overview + +There are three important classes for an application that wants to use producers. All producers must +extend the abstract class `org.kiji.mapreduce.produce.KijiProducer` and override its abstract +methods as described below. Clients should be familiar with the +`org.kiji.mapreduce.producer.ProducerContext` class, which is the interface producers use to output +data. Finally, while produce jobs can be launched with `kiji produce` from the command line, +`org.kiji.mapreduce.produce.KijiProduceJobBuilder` can be used to construct and launch produce jobs +programatically. + +### Using the API + +Each producer must extend [`KijiProducer`]({{site.api_mr_rc4}}/produce/KijiProducer.html) and must +implement the following three methods: + + * `KijiDataRequest getDataRequest()`. This method specifies the columns retrieved while scanning + from the input table. It should construct and return a + [`KijiDataRequest`]({{site.api_schema_rc4}}/KijiDataRequest.html). + * `String getOutputColumn()`. This method specifies the fully-qualified column or the column family + being produced. It should return a string of the form "family:qualifier" or "family". + Family-only output columns are only valid for map-type families (see the KijiSchema user guide). + * `void produce(KijiRowData input, ProducerContext context)`. This method contains the logic to + produce the content for the output column for each input row. It will be called once per row + processed by the task. `input` contains columns from the row as requested by the + [`KijiDataRequest`]({{site.api_schema_rc4}}/KijiDataRequest.html) returned from + `getDataRequest()`. The `produce()` method can use its `context` argument to output to this + column as detailed below. + +When producing new content for a row, the producer may combine the input row data with data from +external stores through [`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html)s by +implementing `Map> getRequiredStores()`. This method should construct +and return a map specifying all the +[`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html)s that the producer wants to +access. The [`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html)s may then be accessed +from the `produce()` method through the +[`ProducerContext`]({{site.api_mr_rc4}}/produce/ProducerContext.html). For more details, you may +check the [Key-Value Stores]({{site.userguide_mapreduce_rc4}}/key-value-stores) section in this +guide. + +Optionally, a producer may implement `setup()` and `cleanup()` to initialize and finalize resources +that can be reused during the produce task. These methods will be called once by each task, +`setup()` before processing any rows and `cleanup()` after the task is done processing. If you wish +to use a [`KeyValueStore`]({{site.api_mr_rc4}}/kvstore/KeyValueStore.html), it should be opened once +with `context.getStore(storeName)` in `setup()`, saved in a member variable, and closed in +`cleanup()`. + +As mentioned above, a Producer's `produce()` method has a +`org.kiji.mapreduce.producer.ProducerContext` argument. This class has a number of methods which are +important to a producer author: + +* `void put(T value)`, `void put(long timestamp, T value)`, `void put(String qualifier, T value)`, + and `void put(String qualifier, long timestamp, T value)`. Each of these calls put data into the + current row in the column specified by the producer's `getOutputColumn()`. The type of `value` + must be compatible with the output column's schema as declared in the table layout. The `timestamp` + parameter is optional; if ommitted the current time will be used. A `qualifier` argument should + only be used if the producer's `getOutputColumn()` specified a map-type family. +* `void incrementCounter(Enum counter)`. Increments a MapReduce job counter. This can be useful + for calculating aggregate counts about the full MapReduce job (for example, you can use a counter + to calculate the total number of input rows containing malformed data). This method is common to + all KijiContexts. + +### Example + +The following is a minimal example of a Kiji producer class. This producer is designed to calculate +and save the zodiac signs of people in a user table, and could be part of something like a horoscope +application. We assume the user table has a column `info:birthday` containing the user's birthdate +as a string and a map-type family of strings, `produced`. Our example producer will output the +zodiac sign as a string into `produced:zodiac_sign`. + +For brevity, the calculation of a zodiac sign from a birthday string has been omitted. + +{% highlight java %} +/** + * Example of a producer class. Calculates zodiac signs. + */ +public static class ZodiacProducer extends KijiProducer { + public static enum Counters { + MISSING_BIRTHDAY, + } + + /** {@inheritDoc} */ + @Override + public KijiDataRequest getDataRequest() { + // Fetch all columns in family 'info' from the input table: + return KijiDataRequest.create("info"); + } + + /** {@inheritDoc} */ + @Override + public String getOutputColumn() { + // Configure the producer to emit to a single column 'produced:zodiac_sign': + return "produced:zodiac_sign"; + } + + /** Compute the zodiac sign from a birthday. */ + private String zodiacSignFromBirthday(String birthday) { + // Implementation left to the reader + // … + } + + /** {@inheritDoc} */ + @Override + public void produce(KijiRowData row, ProducerContext context) throws IOException { + // Extract the required data from the input row: + final CharSequence birthday = input.getMostRecentValue("info", "birthday"); + if (birthday == null) { + // Input row contains no birthday, report and move on: + context.incrementCounter(Counters.MISSING_BIRTHDAY); + return; + } + + // Some computation: + final String zodiacSign = zodiacSignFromBirthday(birthday.toString()); + + // Emits the generated content to the configured output column: + context.put(zodiacSign); + } +} +{% endhighlight %} + +Our example producer may be used on the command line with something like the following. This assumes +that our table is named `user_table` on the default Kiji instance + +{% highlight bash %} +kiji produce \ + --producer=my.application.package.ZodiacProducer \ + --input="format=kiji table=kiji://.env/default/user_table" \ + --output="format=kiji table=kiji://.env/default/usertable nsplits=1" +{% endhighlight %} + +Note: the output table of a producer must match the input table. The `nsplits` parameter is ignored +for producers. + +### Provided Library Classes + +The `org.kiji.mapreduce.lib.produce` package of the KijiMR Library contains a number of +producer implementations that might be of use to application developers: + +* [`AllVersionsSingleInputProducer`]({{site.api_mrlib_rc4}}/produce/AllVersionsSingleInputProducer.html) + and [`SingleInputProducer`]({{site.api_mrlib_rc4}}/produce/SingleInputProducer.html) are + convenience classes. Subclasses of these abstract classes only have to implement `String + getInputColumn()` instead of constructing an entire + [`KijiDataRequest`]({{site.api_schema_rc4}}/KijiDataRequest.html) in `getDataRequest()`. The + `produce()` method will receive all the versions of that column (if the parent class is + [`AllVersionsSingleInputProducer`]({{site.api_mrlib_rc4}}/produce/AllVersionsSingleInputProducer.html)) + or the most recent (if the parent class is + [`SingleInputProducer`]({{site.api_mrlib_rc4}}/produce/SingleInputProducer.html)). +* [`RegexProducer`]({{site.api_mrlib_rc4}}/produce/RegexProducer.html) is an abstract subclass of + [`SingleInputProducer`]({{site.api_mrlib_rc4}}/produce/SingleInputProducer.html). Subclasses must + implement `String getInputColumn()` to specify a column and `String getRegex()`, which should be a + regular expression that matches the contents of the input column. The regex should have one + capturing group. [`RegexProducer`]({{site.api_mrlib_rc4}}/produce/RegexProducer.html) contains a + `produce()` method which will write that group to the output column. Both input and output should + be strings. +* [`ConfiguredRegexProducer`]({{site.api_mrlib_rc4}}/produce/ConfiguredRegexProducer.html) is a + concrete implementation of [`RegexProducer`]({{site.api_mrlib_rc4}}/produce/RegexProducer.html) + which uses Configuration keys to specify its input, output, and regular expression. You can use + this class to copy substrings from one column to another without writing Java code. +* [`IdentityProducer`]({{site.api_mrlib_rc4}}/produce/IdentityProducer.html) is another concrete + producer. It copies data directly from its input column to its output column, both of which may be + specified using configuration keys on the command line. This can be useful for clients who want to + copy one column's data to another without writing code. + +See the javadoc of these classes for more information about using them. diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-reducers.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-reducers.md new file mode 100644 index 00000000..c1fe301d --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-reducers.md @@ -0,0 +1,211 @@ +--- +layout: post +title: Reducers +categories: [userguides, mapreduce, 1.0.0-rc4] +tags : [mapreduce-ug] +version: 1.0.0-rc4 +order : 5 +description: Reducers. +--- + +### Motivation + +The key-value pairs generated by mapper or gatherer tasks can be aggregated according to their keys by the MapReduce framework. +All the values associated with a given key can be processed by a reducer task to emit final, aggregated key-value pairs. + +This makes reducers an important component of the KijiMR workflow: +A gatherer can output key-value pairs for each row processed in isolation, +but to compute aggregate statistics for the entire table, +gatherers must be complemented with appropriate reducers. + +### Classes Overview + +The Kiji framework provides two abstract base classes for reducers: +`org.kiji.reducer.KijiReducer` is the base class to use when implementing a reducer that emits key-value pairs. +`org.kiji.reducer.KijiTableReducer` is the base class to use when implementing a reducer that writes cells to a Kiji table. + +### Using the API + +All Kiji reducers extend the base class [`KijiReducer`]({{site.api_mr_rc4}}/KijiReducer.html) and must implement three methods: +* `Class getOutputKeyClass()` and `Class getOutputValueClass()` to specify the classes of the output keys and values it emits; +* `void reduce(InputKey key, Iterable values, Context context)` to implement the logic to reduce the set of input values for one input key in. + The type of the input keys and input values are specific to each reducer. + The `reduce()` method emits reduced (key, value) pairs using the reducer context with `context.write(key, value)`. + +Optionally, a reducer may use `setup()` and `cleanup()` to initialize and finalize resources that can be reused during the reduce task. +These methods will be called once by each task, `setup()` before processing input records and `cleanup()` after the task is done processing input. + +### Example + +Here is a simplistic example of a reducer class that may be chained with the `FamilySizeGatherer` described in the gatherer section: + +{% highlight java %} +/** + * Example of a reducer class that, for every zip code, calculates + * the number of families per family size. + * + * For its input, this reducer expects the output from the FamilySizeGatherer + * presented in the gatherer section of the user guide. + * This gatherer emits a key-value pair for every household with: + *
  • the household zip code as a key; + *
  • the number of members in the household as a value. + * + * For its output, this reducer emits key-value pairs where: + *
  • keys are strings encoded as "zip-code:family-size"; + *
  • values are the number of families in the zip code with the size encoded in the key. + */ +public class FamilySizeReducer + extends KijiReducer + implements Configurable { + + /** {@inheritDoc} */ + @Override + public Class getOutputKeyClass() { + // Pair (zip code, family size) encoded as a Text formatted "zip-code:family-size": + return Text.class; + } + + /** {@inheritDoc} */ + @Override + public Class getOutputValueClass() { + // Number of families whose size if the size encoded in the key: + return IntWritable.class; + } + + /** {@inheritDoc} */ + @Override + protected void reduce(IntWritable zipCode, Iterable familySizes, Context context) + throws IOException, InterruptedException { + // Map: family size -> number of families with this size + final Map sizeMap = Maps.newHashMap(); + + // Count the number of families with : + for (IntWritable familySize : familySizes) { + AtomicInteger count = sizeMap.get(familySize.get()); + if (count == null) { + count = new AtomicInteger(0); + sizeMap.put(familySize.get(), count); + } + + // Increment the counter for this family size: + count.incrementAndGet(); + } + + // Emit the generated family size map for zipCode: + for (Map.Entry entry : sizeMap.entrySet()) { + final int familySize = entry.getKey(); + final int familyCount = entry.getValue().get(); + context.write( + new Text(String.format("%s:%s", zipCode, familySize)), + new IntWritable(familyCount)); + } + } +} +{% endhighlight %} + +This reducer may be chained to the FamilySizeGatherer described in the gatherer section of this user guide as follows: + +{% highlight bash %} +kiji gather \ + --gatherer=my.application.package.FamilySizeGatherer \ + --reducer=my.application.package.FamilySizeReducer \ + --input="format=kiji table=kiji://.env/default/household_table_name" \ + --output="format=seq file=hdfs://localhost:9000/reducer_output.seq nsplits=3" +{% endhighlight %} + +This command line run a gatherer with the reducer described above. +The output of the job will be written as 3 Hadoop sequence files in HDFS in the directory specified with `hdfs://localhost:9000/reducer_output.seq/`. +Each reducer task will write a sequence file named `hdfs://localhost:9000/reducer_output.seq/part-r-`. +The number of gatherer tasks is currently set to be the number of regions in the input table. +The number of reducer tasks, hence the number of `part` files, is configurable via the `nsplits` job output parameter. + + +### Provided Library Classes + +The `org.kiji.mapreduce.lib.reduce` package of the KijiMR Library comes with a number of reducers. +The most immediately useful ones for an application developer include `org.kiji.mapreduce.lib.reduce.IntSumReducer`, +`org.kiji.mapreduce.lib.reduce.LongSumReducer` and `org.kiji.mapreduce.lib.reduce.DoubleSumReducer`. +These are [`KijiReducer`]({{site.api_mr_rc4}}/KijiReducer.html) versions of reducers that compute the sums of all the values associated with each key. + +These reducers are examples of subclasses of the abstract class `org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer`, +which is a convenience superclass for KijiReducers that use the same keys as the map phase. + +See the KijiMR Library JavaDoc for more information on these classes. + +### Table reducers + +`org.kiji.mapreduce.KijiTableReducer` is a specialization of a [`KijiReducer`]({{site.api_mr_rc4}}/KijiReducer.html) that writes cells +into an output Kiji table. +A table reduce must implement the logic to reduce the input values for an input key in +`reduce(InputKey key, Iterable values, KijiTableContext context)`, +using the table reducer `context` to write cells to the configured output table. + +Below is an minimal example of a table reducer. This reducer is very similar to the +`FamilySizeReducer` above, but inherits from [`KijiTableReducer`]({{site.api_mr_rc4}}/KijiTableReducer.html), and is designed to output +to hfiles or directly into a Kiji table. + +{% highlight java %} +/** + * Example of a table reducer class that, for every zip code, calculates + * the number of families per family size. + * + * For its input, this reducer expects the output from the FamilySizeGatherer + * presented in the gatherer section of the user guide. + * This gatherer emits a key-value pair for every household with: + *
  • the household zip code as a key; + *
  • the number of members in the household as a value. + * + * The output of this reducer is a table whose row keys are zip codes. + * The reducer writes cells to a map-type family named 'sizes'. + * Each cell is written to the column 'sizes:' and contains + * the number of families with the size encoded in the column qualifier. + */ +public class FamilySizeTableReducer + extends KijiTableReducer { + + /** {@inheritDoc} */ + @Override + protected void reduce( + IntWritable zipCode, Iterable familySizes, KijiTableContext context) + throws IOException { + // Map: family size -> number of families with this size + final Map sizeMap = Maps.newHashMap(); + + // Count the number of families with : + for (IntWritable familySize : familySizes) { + AtomicInteger count = sizeMap.get(familySize.get()); + if (count == null) { + count = new AtomicInteger(0); + sizeMap.put(familySize.get(), count); + } + + // Increment the counter for this family size: + count.incrementAndGet(); + } + + // Emit the generated family size map in the entity whose ID is zipCode: + final EntityId eid = context.getEntityId(zipCode.toString()); + + for (Map.Entry entry : sizeMap.entrySet()) { + final Integer familySize = entry.getKey(); + final int familyCount = entry.getValue().get(); + context.put(eid, "sizes", familySize.toString(), familyCount); + } + } +} +{% endhighlight %} + +This reducer may be chained to the FamilySizeGatherer described in the gatherer section of this user guide as follows: + +{% highlight bash %} +kiji gather \ + --gatherer=my.application.package.FamilySizeGatherer \ + --reducer=my.application.package.FamilySizeTableReducer \ + --input="format=kiji table=kiji://.env/default/households_table_name" \ + --output="format=kiji table=kiji://.env/default/family_size_table_name nsplits=3" +{% endhighlight %} + +This command line runs a gatherer chained with the table reducer presented above. +The output of the job is written to the live Kiji table specified with `kiji://.env/default/family_size_table_name`. +The number of gatherer tasks is currenlty set to be the number of regions in the input table. +The number of reducer tasks is controlled by the `nsplits` job output parameter, 3 in this example. diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-testing.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-testing.md new file mode 100644 index 00000000..925e7f0a --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-testing.md @@ -0,0 +1,139 @@ +--- +layout: post +title: Testing +categories: [userguides, mapreduce, 1.0.0-rc4] +tags : [mapreduce-ug] +version: 1.0.0-rc4 +order : 11 +description: Testing. +--- + +### Motivation + +Kiji comes with a testing framework that makes it very easy to ensure that code you have written works as expected. + +### Setup + +To use the Kiji testing framework, you must depend on the Kiji testing artifact: `org.kiji.schema:kiji-schema::test-jar`. + +{% highlight xml %} + + org.kiji.schema + kiji-schema + ${kiji-schema.version} + test-jar + test + +{% endhighlight %} + +### Classes Overview + +Kiji provides two base classes for unit and integration tests that depend on Kiji instances. +For unit tests, the Kiji framework provides `org.kiji.schema.KijiClientTest`. +For integration tests, the Kiji framework provides `org.kiji.schema.testutil.AbstractKijiIntegrationTest`. + +Finally, Kiji comes with a helper builder to setup testing environments: +`org.kiji.schema.util.InstanceBuilder` allows one to easily create test Kiji instances +and populate them with tables and cells with minimal effort. + +Note: in the future, as part of [SCHEMA-166](https://jira.kiji.org/browse/SCHEMA-166), +`KijiClientTest` and `AbstractKijiIntegrationTest` are likely to merge into a single base class `KijiTest`. + +### Using the API + +The two base classes `KijiClientTest` and `AbstractKijiIntegrationTest` provide very similar sets of functionality. +The first one targets unit tests that may use a fake Kiji instance, +ie. Kiji instance entirely backed by an in-memory HBase implementation; +whereas the second one is designed for integration tests that must run against real Kiji instances. + +Kiji unit tests inherit from the base class `KijiClientTest` which provides an environment suitable for tests of Kiji schema logic and MapReduce logic. +It provides a testing Hadoop configuration accessible through `KijiClientTest.getConf()`. +This configuration includes a default Hadoop FileSystem URI that is living in the local file system and an in-process MapReduce job tracker. +The KijiClientTest base class keeps track of Kiji instances created for testing and cleans them up after each test. +In particular, it provides a default Kiji instance accessible with `KijiClientTest.getKiji()`. +Other Kiji instances may be created on demand with `KijiClientTest.createKiji()`. + +Should you need to create files for the purpose of your test, you may use the temporary directory `KijiClientTest.getLocalTempDir()`. +This directory is unique for each test and automatically deleted after each test. + +#### Kiji instance and table builder + +The Kiji framework provides the `InstanceBuilder` helper class to define and populate testing Kiji environments. +`InstanceBuilder` may create new Kiji instances with `new InstanceBuilder().withX(...).build()` +or populate an existing Kiji instance with `new InstanceBuilder(kiji).withX(...).build()`: +* `InstanceBuilder` creates a table using the `.withTable(tableName, tableLayout)` statement; +* Within a table declaration, new rows are created using the `.withRow(rowKey)` statement; +* Within a row declaration, new families are added using `.withFamily(family)`; +* Within a family declaration, new columns are specified using `.withQualifier(qualifier)`; +* Finally, within a column definition, cell versions are specified using `.withValue(value)` or `.withValue(timestamp, value)`; + +### Example + +Below is an example of a unit test that uses a fake in-memory Kiji instance, +populates it with one table and some cells using the `InstanceBuilder`, +and runs a gatherer with a reducer on it. + +{% highlight java %} +public class SomeTests extends KijiClientTest { + @Test + public void testSomeFeature() throws Exception { + // Use the default testing Kiji instance managed by KijiClientTest. + // Do not release this instance, KijiClientTest will clean it up automatically: + final Kiji kiji = getKiji(); + + // Create or load a table layout: + final KijiTableLayout tableLayout = ...; + final String tableName = tableLayout.getName(); + + // Populate the existing Kiji instance 'kiji': + new InstanceBuilder(kiji) + // Declare a table + .withTable(tableName, tableLayout) + // Declare a row for the entity "Marsellus Wallace": + .withRow("Marsellus Wallace") + .withFamily("info") + .withQualifier("first_name").withValue("Marsellus") + .withQualifier("last_name").withValue("Wallace") + // Declare another row for the entity "Vincent Vega": + .withRow("Vincent Vega") + .withFamily("info") + .withQualifier("first_name").withValue("Vincent") + .withQualifier("last_name").withValue("Vega") + .build(); + + // Run a gatherer/reducer on the test table: + + final KijiURI inputTableURI = + KijiURI.newBuilder(kiji.getURI).withTable(tableName).build(); + + final File outputDir = File.createTempFile("gatherer-output", ".dir", getLocalTempDir()); + Preconditions.checkState(outputDir.delete()); + + // In-process MapReduce are currently limited to one reducer: + final int numSplits = 1; + + // Run gatherer: + final MapReduceJob job = KijiGatherJobBuilder.create() + .withConf(getConf()) + .withGatherer(GathererClassToTest.class) + .withReducer(ReducerClassToTest.class) + .withInputTable(inputTableURI) + .withOutput(new TextMapReduceJobOutput(new Path(outputDir.toString()), numSplits)) + .build(); + assertTrue(job.run()); + } +} +{% endhighlight %} + +This test assumes a fictitious input table whose rows describe people +with columns such as `info:first_name` and `info:last_name`; +it also assumes the usage of a gatherer named `GathererClassToTest` and a reducer named `ReducerClassToTest`. + +The gatherer and the reducer will run in-process and write output files +to the temporary directory `outputDir`. + +Note: the Hadoop MapReduce local job runner that runs MapReduce jobs in-process does currently not allow running jobs with more than one reducer. +See [MAPREDUCE-434](https://issues.apache.org/jira/browse/MAPREDUCE-434) for more details. + + +You may find additional concrete examples of unit tests and integration tests in the Kiji code base. diff --git a/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-working-with-avro.md b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-working-with-avro.md new file mode 100644 index 00000000..b01c0ae6 --- /dev/null +++ b/_posts/userguides/mapreduce/1.0.0-rc4/2013-01-01-working-with-avro.md @@ -0,0 +1,58 @@ +--- +title: Working with Avro +layout: post +categories: [userguides, mapreduce, 1.0.0-rc4] +tags: [mapreduce-ug] +version: 1.0.0-rc4 +order : 10 +description: Working with Avro +--- + +All data stored in Kiji cells are serialized and deserialized using Apache Avro. Each logical unit of data in Avro has a type. The type of a datum is called a `schema`. A schema may be a simple primitive such as an integer or string, or it may be a composition of other schemas such as an array or record. + +Avro data can be serialized and deserialized by several programming languages into types appropriate for that language. In Java, for example, data with an Avro INT schema is manifested as a java.lang.Integer object. A MAP schema is manifested as a `java.util.Map`. The full mapping from Avro schemas to Java types can be found in the Avro documentation. + +## Using Avro with KijiRowData +When implementing a gatherer's gather() method or a producer or bulk importer's produce() method, use the [`KijiRowData`]({{site.api_schema_rc4}}/KijiRowData.html) object to read data from the current Kiji table row. Avro serialization is taken care of for you; the call to `getValue()` or `getMostRecentValue()` will automatically return the type specified in the table layout. For example, to read an Avro string value from the most recent value of the `info:name` column, call `KijiRowData.getMostRecentValue("info", "name")`. It will be returned to you as a `java.lang.CharSequence`. If you are reading a cell with a complex compound schema, KijiSchema will return the corresponding Avro generated Java object type. + +To write typed data into a Kiji cell from your producer or bulk importer's `produce()` method, use the context passed into [`KijiProducer`]({{site.api_mr_rc4}}/produce/KijiProducer.html)'s `produce()` method. The `put()` method is overloaded to accept a variety of Java types, including primitives and Avro types. Serialization is handled for you, so you can pass a complex Avro object directly to `put()`. For example, to write custom Address complex Avro type: + +{% highlight java %} + final EntityId user = table.getEntityId("Abraham Lincoln"); + final Address addr = new Address(); + addr.setAddr1("1600 Pennsylvania Avenue"); + addr.setCity("Washington"); + addr.setState("DC"); + addr.setZip("20500"); + + context.put(user, "info", "address", addr); +{% endhighlight %} + +Note that the type of the value passed to `put()` must be compatible with the schema registered for the column in the Kiji table layout. + +## Using Avro in MapReduce + +You may find it useful to read and write Avro data between your mappers and reducers. Jobs run by Kiji can use Avro data for MapReduce keys and values. To use Avro data as your gatherer, mapper, or reducer's output key, use the `org.apache.mapred.AvroKey` class. You must also specify the writer schema for your key by implementing the `org.kiji.mapreduce.AvroKeyWriter` interface. For example, to output an Integer key from a gatherer: + +{% highlight java %} +public class MyAvroGatherer + extends KijiGatherer, Text> + implements AvroKeyWriter { + // ... + + @Override + protected void gather(KijiRowData input, GathererContext context) + throws IOException, InterruptedException { + // ... + context.write(new AvroKey(5), new Text("myvalue")); + } + + @Override + public Schema getAvroKeyWriterSchema(Configuration conf) throws IOException { + return Schema.create(Schema.Type.INTEGER); + } +} +{% endhighlight %} + +Likewise, an `org.apache.mapred.AvroValue` may be used for Avro data as the output value. Implement the [`AvroValueWriter`]({{site.api_mr_rc4}}/avro/AvroValueWriter.html) interface to specify the writer schema. To use Avro data as your bulk importer, mapper, or reducer's input key or value, wrap it in an `AvroKey` (or `AvroValue` for values) and implement [`AvroKeyReader`]({{site.api_mr_rc4}}/avro/AvroKeyReader.html) (or [`AvroValueReader`]({{site.api_mr_rc4}}/avro/AvroValueReader.html)) to specify the reader schema. + diff --git a/_posts/userguide/2011-12-27-schema-shell-ddl-ref.md b/_posts/userguides/schema/1.0.0-rc1/2011-12-27-schema-shell-ddl-ref.md similarity index 99% rename from _posts/userguide/2011-12-27-schema-shell-ddl-ref.md rename to _posts/userguides/schema/1.0.0-rc1/2011-12-27-schema-shell-ddl-ref.md index 835b9311..fc9060ea 100644 --- a/_posts/userguide/2011-12-27-schema-shell-ddl-ref.md +++ b/_posts/userguides/schema/1.0.0-rc1/2011-12-27-schema-shell-ddl-ref.md @@ -2,7 +2,7 @@ layout: post title: DDL Shell Reference id: userguide/ddl-ref -category: [userguide, schema, 1.0.0-rc1] +categories: [userguides, schema, 1.0.0-rc1] component: schema version: 1.0.0-rc1 order : 6 diff --git a/_posts/userguide/2012-01-01-accessing-data.md b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-accessing-data.md similarity index 59% rename from _posts/userguide/2012-01-01-accessing-data.md rename to _posts/userguides/schema/1.0.0-rc1/2012-01-01-accessing-data.md index 5e8c2908..cc3ff41f 100644 --- a/_posts/userguide/2012-01-01-accessing-data.md +++ b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-accessing-data.md @@ -1,20 +1,21 @@ --- title: Accessing Data layout: post -categories: [userguide, schema, 1.0.0-rc1] +categories: [userguides, schema, 1.0.0-rc1] tags: [schema-ug] +version: 1.0.0-rc1 order : 4 description: How to access data using KijiSchema. --- -The [`KijiTableReader`]({{site.api_url}}KijiTableReader.html) class provides a `get(...)` method to read typed data from a Kiji table row. -The row is addressed by its [`EntityId`]({{site.api_url}}EntityId.html) (which can be retrieved from the [`KijiTable`]({{site.api_url}}KijiTable.html) instance using the [`getEntityId()`]({{site.api_url}}KijiTable.html#getEntityId%28java.lang.String%29) method). -Specify the desired cells from the rows with a [`KijiDataRequest`]({{site.api_url}}KijiDataRequest.html). See the -[`KijiDataRequest`]({{site.api_url}}KijiDataRequest.html) documentation for details. +The [`KijiTableReader`]({{site.api_schema_rc1}}/KijiTableReader.html) class provides a `get(...)` method to read typed data from a Kiji table row. +The row is addressed by its [`EntityId`]({{site.api_schema_rc1}}/EntityId.html) (which can be retrieved from the [`KijiTable`]({{site.api_schema_rc1}}/KijiTable.html) instance using the [`getEntityId()`]({{site.api_schema_rc1}}/KijiTable.html#getEntityId%28java.lang.String%29) method). +Specify the desired cells from the rows with a [`KijiDataRequest`]({{site.api_schema_rc1}}/KijiDataRequest.html). See the +[`KijiDataRequest`]({{site.api_schema_rc1}}/KijiDataRequest.html) documentation for details. -In general, [`Kiji`]({{site.api_url}}Kiji.html) and [`KijiTable`]({{site.api_url}}KijiTable.html) instances should only be opened once over the life of an -application. ([`EntityIdFactory`]({{site.api_url}}EntityIdFactory.html)s should also be reused). [`KijiTablePool`]({{site.api_url}}KijiTablePool.html) can be used to maintain a -pool of opened [`KijiTable`]({{site.api_url}}KijiTable.html) objects for reuse. To initially open a [`KijiTable`]({{site.api_url}}KijiTable.html): +In general, [`Kiji`]({{site.api_schema_rc1}}/Kiji.html) and [`KijiTable`]({{site.api_schema_rc1}}/KijiTable.html) instances should only be opened once over the life of an +application. ([`EntityIdFactory`]({{site.api_schema_rc1}}/EntityIdFactory.html)s should also be reused). [`KijiTablePool`]({{site.api_schema_rc1}}/KijiTablePool.html) can be used to maintain a +pool of opened [`KijiTable`]({{site.api_schema_rc1}}/KijiTable.html) objects for reuse. To initially open a [`KijiTable`]({{site.api_schema_rc1}}/KijiTable.html): {% highlight java %} Configuration conf = HBaseConfiguration.create(); @@ -23,8 +24,8 @@ Kiji kiji = Kiji.open(kijiConf); KijiTable table = kiji.openTable("the-table-name"); {% endhighlight %} -To read from an existing [`KijiTable`]({{site.api_url}}KijiTable.html) instance, create a [`KijiDataRequest`]({{site.api_url}}KijiDataRequest.html) specifying the columns of data to -return. Then, query for the desired [`EntityId`]({{site.api_url}}EntityId.html), using a [[`KijiTableReader`]({{site.api_url}}KijiTableReader.html)]({{site.api_url}}KijiTableReader.html). You can get a [`KijiTableReader`]({{site.api_url}}KijiTableReader.html) for a [`KijiTable`]({{site.api_url}}KijiTable.html) using the [`openTableReader()`]({{site.api_url}}KijiTable.html#openTableReader%28%29) method. For example: +To read from an existing [`KijiTable`]({{site.api_schema_rc1}}/KijiTable.html) instance, create a [`KijiDataRequest`]({{site.api_schema_rc1}}/KijiDataRequest.html) specifying the columns of data to +return. Then, query for the desired [`EntityId`]({{site.api_schema_rc1}}/EntityId.html), using a [[`KijiTableReader`]({{site.api_schema_rc1}}/KijiTableReader.html)]({{site.api_schema_rc1}}/KijiTableReader.html). You can get a [`KijiTableReader`]({{site.api_schema_rc1}}/KijiTableReader.html) for a [`KijiTable`]({{site.api_schema_rc1}}/KijiTable.html) using the [`openTableReader()`]({{site.api_schema_rc1}}/KijiTable.html#openTableReader%28%29) method. For example: {% highlight java %} KijiTableReader reader = table.openTableReader(); @@ -43,15 +44,15 @@ KijiRowData rowData = reader.get(entityId, dataRequest); reader.close(); {% endhighlight %} -The [[`KijiTableReader`]({{site.api_url}}KijiTableReader.html)]({{site.api_url}}KijiTableReader.html) also implements a `bulkGet(...)` method for retrieving data for a list -of [`EntityId`]({{site.api_url}}EntityId.html)s. This is more efficient than a series of calls to `get(...)` because it uses a single +The [[`KijiTableReader`]({{site.api_schema_rc1}}/KijiTableReader.html)]({{site.api_schema_rc1}}/KijiTableReader.html) also implements a `bulkGet(...)` method for retrieving data for a list +of [`EntityId`]({{site.api_schema_rc1}}/EntityId.html)s. This is more efficient than a series of calls to `get(...)` because it uses a single RPC instead of one for each get. ## Modifying Data -The [`KijiTableWriter`]({{site.api_url}}KijiTableWriter.html) class provides a `put(...)` method to write/update cells to a Kiji table. The -cell is addressed by its entity ID, column family, column qualifier, and timestamp. Use the [`KijiCell`]({{site.api_url}}KijiCell.html) -class to describe the typed cell data to be written. You can get a [`KijiTableWriter`]({{site.api_url}}KijiTableWriter.html) for a [`KijiTable`]({{site.api_url}}KijiTable.html) using the [`openTableWriter()`]({{site.api_url}}KijiTable.html#openTableWriter%28%29) method. +The [`KijiTableWriter`]({{site.api_schema_rc1}}/KijiTableWriter.html) class provides a `put(...)` method to write/update cells to a Kiji table. The +cell is addressed by its entity ID, column family, column qualifier, and timestamp. Use the [`KijiCell`]({{site.api_schema_rc1}}/KijiCell.html) +class to describe the typed cell data to be written. You can get a [`KijiTableWriter`]({{site.api_schema_rc1}}/KijiTableWriter.html) for a [`KijiTable`]({{site.api_schema_rc1}}/KijiTable.html) using the [`openTableWriter()`]({{site.api_schema_rc1}}/KijiTable.html#openTableWriter%28%29) method. {% highlight java %} KijiTableWriter writer = table.openTableWriter(); @@ -70,10 +71,10 @@ Incrementing a counter value stored in a Kiji cell would normally require a locks can cause contention, Kiji exposes a feature of HBase to do this more efficiently by pushing the work to the server side. To increment a counter value in a Kiji cell, the column must be declared with a schema of type -"counter". See [Managing Data]({{site.userguide_url}}/managing-data#layouts) +"counter". See [Managing Data]({{site.userguide_schema_rc1}}/managing-data#layouts) for details on how to declare a counter in your table layout. -The [`KijiTableWriter`]({{site.api_url}}KijiTableWriter.html) class provides methods for incrementing +The [`KijiTableWriter`]({{site.api_schema_rc1}}/KijiTableWriter.html) class provides methods for incrementing counter values. Non-counter columns can not be incremented, and counter columns support only the increment operation. In other words, attempting to increment a column value that is not declared to be a counter will throw an exception. Likewise, @@ -95,8 +96,8 @@ writer.close(); ## MapReduce -The [`KijiTableInputFormat`]({{site.api_url}}mapreduce/KijiTableInputFormat.html) provides the necessary functionality to read from a Kiji table in a -MapReduce job. To configure a job to read from a Kiji table, use [`KijiTableInputFormat`]({{site.api_url}}mapreduce/KijiTableInputFormat.html)'s +The [`KijiTableInputFormat`]({{site.api_schema_rc1}}/mapreduce/KijiTableInputFormat.html) provides the necessary functionality to read from a Kiji table in a +MapReduce job. To configure a job to read from a Kiji table, use [`KijiTableInputFormat`]({{site.api_schema_rc1}}/mapreduce/KijiTableInputFormat.html)'s static `setOptions` method. For example: {% highlight java %} @@ -121,7 +122,7 @@ job.setInputFormatClass(KijiTableInputFormat.class); The code contained within "// \*" is responsible for shipping Kiji resources to the DistributedCache. This is so that all nodes within your hadoop cluster will have access to Kiji dependencies. -[`KijiTableInputFormat`]({{site.api_url}}mapreduce/KijiTableInputFormat.html) outputs keys of type [`EntityId`]({{site.api_url}}EntityId.html) and values of type [`KijiRowData`]({{site.api_url}}KijiRowData.html). This +[`KijiTableInputFormat`]({{site.api_schema_rc1}}/mapreduce/KijiTableInputFormat.html) outputs keys of type [`EntityId`]({{site.api_schema_rc1}}/EntityId.html) and values of type [`KijiRowData`]({{site.api_schema_rc1}}/KijiRowData.html). This data can be accessed from within a mapper: {% highlight java %} @@ -131,8 +132,8 @@ public void map(EntityId entityId, KijiRowData row, Context context) { } {% endhighlight %} -[`KijiTableOutputFormat`]({{site.api_url}}mapreduce/KijiTableOutputFormat.html) provides the ability to write to Kiji tables from a MapReduce job using [`KijiMutation`]({{site.api_url}}mapreduce/KijiMutation.html)s. -To configure a job to write to a Kiji table, use [`KijiTableOutputFormat`]({{site.api_url}}mapreduce/KijiTableOutputFormat.html)'s static `setOptions` +[`KijiTableOutputFormat`]({{site.api_schema_rc1}}/mapreduce/KijiTableOutputFormat.html) provides the ability to write to Kiji tables from a MapReduce job using [`KijiMutation`]({{site.api_schema_rc1}}/mapreduce/KijiMutation.html)s. +To configure a job to write to a Kiji table, use [`KijiTableOutputFormat`]({{site.api_schema_rc1}}/mapreduce/KijiTableOutputFormat.html)'s static `setOptions` method. For example: {% highlight java %} @@ -153,8 +154,8 @@ job.setOutputValueClass(KijiOutput.class); job.setOutputFormatClass(KijiTableOutputFormat.class); {% endhighlight %} -The [`ContextKijiTableWriter`]({{site.api_url}}mapreduce/ContextKijiTableWriter.html) class provides the ability to write to Kiji tables from within a -MapReduce job. This class provides the the same methods provided by the [`KijiTableWriter`]({{site.api_url}}KijiTableWriter.html) +The [`ContextKijiTableWriter`]({{site.api_schema_rc1}}/mapreduce/ContextKijiTableWriter.html) class provides the ability to write to Kiji tables from within a +MapReduce job. This class provides the the same methods provided by the [`KijiTableWriter`]({{site.api_schema_rc1}}/KijiTableWriter.html) described above. For example (from within a mapper): {% highlight java %} diff --git a/_posts/userguide/2012-01-01-data-model.md b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-data-model.md similarity index 96% rename from _posts/userguide/2012-01-01-data-model.md rename to _posts/userguides/schema/1.0.0-rc1/2012-01-01-data-model.md index 2b6984fa..8b244d7b 100644 --- a/_posts/userguide/2012-01-01-data-model.md +++ b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-data-model.md @@ -1,9 +1,10 @@ --- layout: post title: Data Model -categories: [userguide, schema, 1.0.0-rc1] +categories: [userguides, schema, 1.0.0-rc1] tags : [schema-ug] order : 2 +version: 1.0.0-rc1 description: KijiSchema's underlying data model. --- @@ -27,7 +28,7 @@ columns. Unlike HBase, each cell in a Kiji table has a schema associated with it. Schemas in KijiSchema are versioned. The schema and layout system is -described in greater detail in [Managing Data]({{site.userguide_url}}managing-data) +described in greater detail in [Managing Data]({{site.userguide_schema_rc1}}/managing-data) ### Entity-Centric Data Model KijiSchema’s data model is *entity-centric*. Each row typically holds diff --git a/_posts/userguide/2012-01-01-faq.md b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-faq.md similarity index 94% rename from _posts/userguide/2012-01-01-faq.md rename to _posts/userguides/schema/1.0.0-rc1/2012-01-01-faq.md index 99b6b52d..c8ac3eea 100644 --- a/_posts/userguide/2012-01-01-faq.md +++ b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-faq.md @@ -1,8 +1,9 @@ --- layout: post title: FAQ -categories: [userguide, schema, 1.0.0-rc1] +categories: [userguides, schema, 1.0.0-rc1] tags : [schema-ug] +version: 1.0.0-rc1 order : 8 description: A collection of commonly asked questions and answers. --- @@ -35,7 +36,7 @@ $ java -cp myapp.jar:`kiji classpath` com.myorg.MyApp Check the retention policy for the cells in the locality group you are writing to. The locality groups of your Kiji table are configured in your table's layout. -See [Managing Data]({{site.userguide_url}}managing-data#layouts) for details. +See [Managing Data]({{site.userguide_schema_rc1}}/managing-data#layouts) for details. In particular, check to make sure the timestamps of the new cells you are writing are in milliseconds, and that they fall within the bounds of your @@ -66,7 +67,7 @@ Java classes that represent the record type. This makes working with these objects easier in your mapper and reducers. For complete information on Avro, visit http://avro.apache.org. -See [Managing Data]({{site.userguide_url}}managing-data#layouts) for more +See [Managing Data]({{site.userguide_schema_rc1}}/managing-data#layouts) for more details on Kiji cell schemas. ## How does data in Kiji map to Java types? diff --git a/_posts/userguide/2012-01-01-for-administrators.md b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-for-administrators.md similarity index 99% rename from _posts/userguide/2012-01-01-for-administrators.md rename to _posts/userguides/schema/1.0.0-rc1/2012-01-01-for-administrators.md index 5762c0ca..bfdb0007 100644 --- a/_posts/userguide/2012-01-01-for-administrators.md +++ b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-for-administrators.md @@ -1,8 +1,9 @@ --- layout: post title: For Administrators -categories: [userguide, schema, 1.0.0-rc1] +categories: [userguides, schema, 1.0.0-rc1] tags : [schema-ug] +version: 1.0.0-rc1 order : 5 description: Installation and maintenance of kiji-schema. --- diff --git a/_posts/userguide/2012-01-01-kiji-schema-overview.md b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-kiji-schema-overview.md similarity index 93% rename from _posts/userguide/2012-01-01-kiji-schema-overview.md rename to _posts/userguides/schema/1.0.0-rc1/2012-01-01-kiji-schema-overview.md index 387edbc2..87d4a168 100644 --- a/_posts/userguide/2012-01-01-kiji-schema-overview.md +++ b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-kiji-schema-overview.md @@ -1,8 +1,9 @@ --- layout: post title: What is KijiSchema? -categories: [userguide, schema, 1.0.0-rc1] +categories: [userguides, schema, 1.0.0-rc1] tags : [schema-ug] +version: 1.0.0-rc1 order : 1 description: Overview. --- diff --git a/_posts/userguide/2012-01-01-managing-data.md b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-managing-data.md similarity index 99% rename from _posts/userguide/2012-01-01-managing-data.md rename to _posts/userguides/schema/1.0.0-rc1/2012-01-01-managing-data.md index f45fe0ac..46f65c92 100644 --- a/_posts/userguide/2012-01-01-managing-data.md +++ b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-managing-data.md @@ -1,8 +1,9 @@ --- layout: post title: Managing Data -categories: [userguide, schema, 1.0.0-rc1] +categories: [userguides, schema, 1.0.0-rc1] tags: [schema-ug] +version: 1.0.0-rc1 order: 3 description: How to manage data with KijiSchema. --- diff --git a/_posts/userguide/2012-01-01-tool-reference.md b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-tool-reference.md similarity index 99% rename from _posts/userguide/2012-01-01-tool-reference.md rename to _posts/userguides/schema/1.0.0-rc1/2012-01-01-tool-reference.md index e57f116b..eb97b1e8 100644 --- a/_posts/userguide/2012-01-01-tool-reference.md +++ b/_posts/userguides/schema/1.0.0-rc1/2012-01-01-tool-reference.md @@ -1,7 +1,7 @@ --- layout: post title: Command-Line Tool Reference -category: userguide +categories: [userguides, schema, 1.0.0-rc1] component: schema version: 1.0.0-rc1 tags : [schema-ug] @@ -165,7 +165,7 @@ This command has two mandatory arguments: It is an error for this table to already exist. * `--layout=` - Path to a file a JSON file containing the table layout specification, - as described in [Managing Data]({{site.userguide_url}}managing-data#layouts). + as described in [Managing Data]({{site.userguide_schema_rc1}}/managing-data#layouts). The following arguments are optional: diff --git a/_posts/userguides/schema/1.0.0-rc2/2011-12-27-schema-shell-ddl-ref.md b/_posts/userguides/schema/1.0.0-rc2/2011-12-27-schema-shell-ddl-ref.md new file mode 100644 index 00000000..496056b3 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc2/2011-12-27-schema-shell-ddl-ref.md @@ -0,0 +1,340 @@ +--- +layout: post +title: DDL Shell Reference +id: userguide/ddl-ref +categories: [userguides, schema, 1.0.0-rc2] +component: schema +version: 1.0.0-rc2 +order : 6 +tags: [schema-ug] +description: An introduction to the DDL that manipulates table layouts. +--- + +The KijiSchema DDL Shell implements a _data definition language_ (DDL) that +allows you to create, modify, inspect, and delete kiji table layouts. A +_table layout_ is the KijiSchema data dictionary element that defines a set +of column families, qualifiers, etc. and associates these columns with +Avro schemas. + +With this shell, you can quickly create tables to use in your KijiSchema +applications. You can add, drop, or modify columns quickly too. These +modifications can be performed without any downtime associated with the +table; the only exception is that modifying a locality group causes +the table to be taken offline while applying changes. But locality group +changes should be rare in running applications. + +Finally, this shell allows you to quickly understand the layout of an +existing table. The `DESCRIBE` command will pretty-print the layout of a +table, eliminating the guesswork as to where your coworker has stashed an +important piece of data. + + +## Running + +* Export `$KIJI_HOME` to point to your KijiSchema installation. +* Run `bin/kiji-schema-shell` + +This command takes a few options (e.g., to load a script out of a file). +See `bin/kiji-schema-shell --help` for all the available options. + +### An Example + +The following commands could be entered at the DDL shell prompt to create +a table, add another column family, describe its layout, and then remove the +table. + + CREATE TABLE foo WITH DESCRIPTION 'some data' + ROW KEY FORMAT HASHED + WITH LOCALITY GROUP default WITH DESCRIPTION 'main storage' ( + MAXVERSIONS = INFINITY, + TTL = FOREVER, + INMEMORY = false, + COMPRESSED WITH GZIP, + FAMILY info WITH DESCRIPTION 'basic information' ( + name "string" WITH DESCRIPTION 'The user\'s name', + email "string", + age "int"), + MAP TYPE FAMILY integers COUNTER WITH DESCRIPTION 'metric tracking data' + ); + + ALTER TABLE foo ADD MAP TYPE FAMILY strings { "type" : "string" } + WITH DESCRIPTION 'ad-hoc string data' TO LOCALITY GROUP default; + + SHOW TABLES; + DESCRIBE EXTENDED foo; + DROP TABLE foo; + SHOW TABLES; + + +## The Layout Definition Language + +This section defines the layout definition language. + +### General Language Notes and Style + +All statements in the language must end with a semi-colon character. +Statements may wrap across multiple lines. + +Keywords are case insensitive. The following are equivalent: + + schema> DESCRIBE foo; + schema> describe foo; + +Names for tables and columns are case sensitive. The following are _different_: + + schema> DESCRIBE FOO; + schema> DESCRIBE foo; + +Lines beginning with '#' are treated as comments and ignored. + + schema> # this is a comment line and will be ignored. + schema> # the next line will not be ignored. + schema> show tables; + + +Table and column names can be provided either as identifiers or +`'in single quotes'`. The following are equivalent: + + schema> DESCRIBE foo; + schema> DESCRIBE 'foo'; + +If you have a table whose name is a keyword (e.g., "SHOW" or "tables"), +you can wrap them `'in single quotes'` to protect them. e.g.: + + schema> CREATE TABLE 'WITH' WITH DESCRIPTION 'A table with a silly name'; + +By contrast, strings used to specify table or column descriptions, or other +string "values" must always be single quoted. + +Quoted strings may contain `'internally \'escaped quotes\', as well as escaped slashes:\\'`. + +The escape sequences `'\t'` and `'\n'` work as you'd hope, representing a tab +character and a newline character respectively. Everything else escapes to itself. + +`INFINITY` and `FOREVER` are both synonyms for Int.MaxValue wherever an integer +may be specified. + +Avro schemas are specified with the Avro JSON schema syntax. JSON uses "double quotes" +to enclose strings; this is respected in this shell as well. JSON can be entered directly +into the command. For example: + + ALTER TABLE foo ADD MAP TYPE FAMILY strings { "type" : "string" } + WITH DESCRIPTION 'ad-hoc string data' TO LOCALITY GROUP default; + + +For more information, see +[The Avro 1.7 specification](http://avro.apache.org/docs/1.7.2/spec.html). + +## Layout Definition Language Statements + +### Working with Kiji Instances + +A kiji instance is a collection of kiji tables. You can list the available +instances: + + schema> SHOW INSTANCES; + +The currently selected instance will have an asterisk next to it. + +You can also select an instance: + + schema> USE foo; + +The default instance is named `default`; in addition to `USE default;`, +you can also select that with the more readable (and more verbose) syntax: + + schema> USE DEFAULT INSTANCE; + + +### Listing and Describing Tables + +You can list the available tables with: + + schema> SHOW TABLES; + +You can pretty-print the layout of a table with: + + schema> DESCRIBE foo; + +This will not print locality group information or hidden columns. To include +this information, use: + + schema> DESCRIBE EXTENDED foo; + + +### Creating Tables + +This shell will allow you to create tables and define their locality groups, +column families, and column qualifiers. Each map-type family or qualifier in a +group-type family has a schema associated with it. + +#### Schemas + +There are three possible kinds of schemas that can be associated with a +column: + +* JSON schemas are declared inline. e.g. `"string"` or `{ "type" : "int" }` +* Avro SpecificRecord class names are declared as `CLASS com.example.FooRecord` +* A special type `COUNTER` can define an HBase counter column that can be + atomically incremented. + +#### Names + +Table, locality group, family, and column names must have the following +format: + + [a-zA-Z_][a-zA-Z0-9_]* + +The following are legal names: + + foo + meep123 + wom_bat + _aard_vark + users2 + +The following are not allowed: + + 42 + 2users + some-dashed-name + this$uses!special(characters_) + +#### `CREATE TABLE` Syntax + + CREATE TABLE t [WITH DESCRIPTION 'd'] + [ROW KEY FORMAT { HASHED | RAW | HASH PREFIXED(int) }] + WITH locality_group [ , locality_group ...]*; + +This creates a table, sets its description, defines how row keys are formatted, +and defines a list of locality groups. + +Row keys may be literal string values (`ROW KEY FORMAT RAW`), or they may be +the hash of the string value (`ROW KEY FORMAT HASHED`). They may also be a +composite of the two (`ROW KEY FORMAT HASH PREFIXED(n)`), where `n` is an +integer between 1 and 16 specifying the number of hash bytes to retain as +the prefix size (e.g: `ROW KEY FORMAT HASH PREFIXED(2)` will use raw keys +with two bytes of the key hash as a prefix.) If no ROW KEY FORMAT clause is +given, it is assumed to be `HASHED`. + +Each locality group is defined as follows: + + LOCALITY GROUP foo [WITH DESCRIPTION 'd'] [ ( property, property... ) ] + +This defines a locality group named `foo` with one or more properties set. The +valid properties are: + + MAXVERSIONS = int + INMEMORY = bool + TTL = int + COMPRESSED WITH (GZIP | LZO | SNAPPY | NONE) + +Remember that you can use `INFINITY` and `FOREVER` when specifying integer +values for `MAXVERSIONS` and `TTL` to make your statements more readable. + +You can also specify map- and group-type column families in the properties +list: + + [GROUP TYPE] FAMILY f [WITH DESCRIPTION 'd'] [( column, column... )] + MAP TYPE FAMILY f [WITH SCHEMA] schema [WITH DESCRIPTION 'd'] + + +Within a group-type family, individual column qualifiers are specified with: + + [COLUMN] foo [WITH SCHEMA] schema [WITH DESCRIPTION 'd'] + + +#### `CREATE TABLE Example` + +The following is an example that puts together all of the different syntax +elements described in the previous section: + + schema> CREATE TABLE foo WITH DESCRIPTION 'some data' + -> ROW KEY FORMAT HASHED + -> WITH LOCALITY GROUP default WITH DESCRIPTION 'main storage' ( + -> MAXVERSIONS = INFINITY, + -> TTL = FOREVER, + -> INMEMORY = false, + -> COMPRESSED WITH GZIP, + -> FAMILY info WITH DESCRIPTION 'basic information' ( + -> name "string" WITH DESCRIPTION 'The user\'s name', + -> email "string", + -> addr CLASS com.example.AddressRecord, + -> age "int"), + -> MAP TYPE FAMILY integers COUNTER WITH DESCRIPTION 'metric tracking data' + -> ); + +### Deleting Tables + +You can delete a table with the command: + + schema> DROP TABLE foo; + +Warning: THIS WILL DELETE ALL THE DATA IN THE TABLE. + +### Changing Table Properties + +All table properties that can be set (descriptions, columns & schemas, +locality group properties, etc) when a table is created, can also be changed +after the fact. + +Keywords or clauses in \[square brackets\] are optional in the examples below: + + + ALTER TABLE t ADD COLUMN info:foo [WITH SCHEMA] schema [WITH DESCRIPTION 'd']; + ALTER TABLE t RENAME COLUMN info:foo [AS] info:bar; + ALTER TABLE t DROP COLUMN info:foo; + + ALTER TABLE t ADD [GROUP TYPE] FAMILY f [WITH DESCRIPTION 'd'] TO [LOCALITY GROUP] lg; + + ALTER TABLE t ADD MAP TYPE FAMILY f [WITH SCHEMA] schema + [WITH DESCRIPTION 'd'] TO [LOCALITY GROUP] lg; + + ALTER TABLE t DROP FAMILY f; + ALTER TABLE t RENAME FAMILY f [AS] f2; + + ALTER TABLE t CREATE LOCALITY GROUP lg [WITH DESCRIPTION 'd'] + [( property, property... )] + + ... Where 'property' is one of: + MAXVERSIONS = int + | INMEMORY = bool + | TTL = int + | COMPRESSED WITH { GZIP | LZO | SNAPPY | NONE } + ... or a FAMILY definition (see the earlier section on the CREATE TABLE syntax) + + ALTER TABLE t RENAME LOCALITY GROUP lg [AS] lg2; + ALTER TABLE t DROP LOCALITY GROUP lg; + + ALTER TABLE t SET DESCRIPTION = 'desc' FOR FAMILY f; + ALTER TABLE t SET SCHEMA = schema FOR [MAP TYPE] FAMILY f; + + ALTER TABLE t SET DESCRIPTION = 'desc' FOR COLUMN info:foo; + ALTER TABLE t SET SCHEMA = schema FOR COLUMN info:foo; + + ALTER TABLE t SET DESCRIPTION = 'desc'; + + ALTER TABLE t SET DESCRIPTION = 'desc' FOR LOCALITY GROUP lg; + ALTER TABLE t SET property FOR LOCALITY GROUP lg; + ... where 'property' is one of MAXVERSIONS, INMEMORY, TTL, or COMPRESSED WITH. + + +### Working With Scripts + +You can write scripts that contain DDL statements to define tables or whole +instances. If you put a sequence of DDL statements in a file, you can run +this file with: + + schema> LOAD FROM FILE '/path/to/foo.ddl'; + +You can print the DDL that would create a whole instance or a specific table +to the screen: + + schema> DUMP DDL; + schema> DUMP DDL FOR TABLE foo; + +Or you can save the output to a file: + + schema> DUMP DDL TO FILE '/path/to/foo.ddl'; + schema> DUMP DDL FOR TABLE foo TO FILE '/path/to/foo.ddl'; + diff --git a/_posts/userguides/schema/1.0.0-rc2/2012-01-01-accessing-data.md b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-accessing-data.md new file mode 100644 index 00000000..364ff84f --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-accessing-data.md @@ -0,0 +1,190 @@ +--- +title: Accessing Data +layout: post +categories: [userguides, schema, 1.0.0-rc2] +tags: [schema-ug] +version: 1.0.0-rc2 +order : 4 +description: How to access data using KijiSchema. +--- + +The [`KijiTableReader`]({{site.api_schema_rc2}}/KijiTableReader.html) class provides a `get(...)` method to read typed data from a Kiji table row. +The row is addressed by its [`EntityId`]({{site.api_schema_rc2}}/EntityId.html) (which can be retrieved from the [`KijiTable`]({{site.api_url}}/KijiTable.html) instance using the [`getEntityId()`]({{site.api_url}}/KijiTable.html#getEntityId%28java.lang.String%29) method). +Specify the desired cells from the rows with a [`KijiDataRequest`]({{site.api_schema_rc2}}/KijiDataRequest.html). See the +[`KijiDataRequest`]({{site.api_schema_rc2}}/KijiDataRequest.html) documentation for details. + +In general, [`Kiji`]({{site.api_schema_rc2}}/Kiji.html) and [`KijiTable`]({{site.api_url}}/KijiTable.html) instances should only be opened once over the life of an +application. ([`EntityIdFactory`]({{site.api_schema_rc2}}/EntityIdFactory.html)s should also be reused). [`KijiTablePool`]({{site.api_url}}/KijiTablePool.html) can be used to maintain a +pool of opened [`KijiTable`]({{site.api_schema_rc2}}/KijiTable.html) objects for reuse. To initially open a [`KijiTable`]({{site.api_url}}/KijiTable.html): + +{% highlight java %} +Configuration conf = HBaseConfiguration.create(); +KijiConfiguration kijiConf = new KijiConfiguration(conf, "your-kiji-instance-name"); +Kiji kiji = Kiji.open(kijiConf); +KijiTable table = kiji.openTable("the-table-name"); +{% endhighlight %} + +To read from an existing [`KijiTable`]({{site.api_schema_rc2}}/KijiTable.html) instance, create a [`KijiDataRequest`]({{site.api_url}}/KijiDataRequest.html) specifying the columns of data to +return. Then, query for the desired [`EntityId`]({{site.api_schema_rc2}}/EntityId.html), using a [[`KijiTableReader`]({{site.api_url}}/KijiTableReader.html)]({{site.api_url}}/KijiTableReader.html). You can get a [`KijiTableReader`]({{site.api_url}}/KijiTableReader.html) for a [`KijiTable`]({{site.api_url}}/KijiTable.html) using the [`openTableReader()`]({{site.api_url}}/KijiTable.html#openTableReader%28%29) method. For example: + +{% highlight java %} +KijiTableReader reader = table.openTableReader(); + +// Select which columns you want to read. +KijiDataRequest dataRequest = new KijiDataRequest() + .addColumn(new KijiDataRequest.Column("your-family", "your-qualifier")); + +// Try to reuse EntityIds when possible. +// If a need for this entityId comes up again, reuse +// this same entityId object. +EntityId entityId = table.getEntityId("your-row"); +KijiRowData rowData = reader.get(entityId, dataRequest); + +// Make sure to close the reader once you're finished. +reader.close(); +{% endhighlight %} + +The [[`KijiTableReader`]({{site.api_schema_rc2}}/KijiTableReader.html)]({{site.api_url}}/KijiTableReader.html) also implements a `bulkGet(...)` method for retrieving data for a list +of [`EntityId`]({{site.api_schema_rc2}}/EntityId.html)s. This is more efficient than a series of calls to `get(...)` because it uses a single +RPC instead of one for each get. + +## Modifying Data + +The [`KijiTableWriter`]({{site.api_schema_rc2}}/KijiTableWriter.html) class provides a `put(...)` method to write/update cells to a Kiji table. The +cell is addressed by its entity ID, column family, column qualifier, and timestamp. You can get a [`KijiTableWriter`]({{site.api_schema_rc2}}/KijiTableWriter.html) for a [`KijiTable`]({{site.api_url}}/KijiTable.html) using the [`openTableWriter()`]({{site.api_url}}/KijiTable.html#openTableWriter%28%29) method. + +{% highlight java %} +KijiTableWriter writer = table.openTableWriter(); + +long timestamp = System.currentTimeMillis(); +writer.put(table.getEntityId("your-row"), "your-family", "your-qualifier", timestamp, + "your-string-value"); +writer.flush(); +writer.close(); +{% endhighlight %} + +## Counters + +Incrementing a counter value stored in a Kiji cell would normally require a +"read-modify-write" transaction using a client-side row lock. Since row +locks can cause contention, Kiji exposes a feature of HBase to do this more +efficiently by pushing the work to the server side. To increment a counter value in +a Kiji cell, the column must be declared with a schema of type +"counter". See [Managing Data]({{site.userguide_schema_rc2}}/managing-data#layouts) +for details on how to declare a counter in your table layout. + +The [`KijiTableWriter`]({{site.api_schema_rc2}}/KijiTableWriter.html) class provides methods for incrementing +counter values. Non-counter columns can not be incremented, and counter columns +support only the increment operation. In other words, attempting to increment a +column value that is not declared to be a counter will throw an exception. Likewise, +attempting to `put(...)` a value into a column that is declared +to be a counter will also throw an exception. The `setCounter(...)` method should be used when +setting a counter value. + +{% highlight java %} +KijiTableWriter writer = table.openTableWriter(); + +// Incrementing a counter type column by 1. +// The column represented by counter-type-qualifier must +// of type counter otherwise an exception will be thrown. +writer.increment(table.getEntityId("your-row"), "your-family", "counter-type-qualifier", 1); + +writer.flush(); +writer.close(); +{% endhighlight %} + +## MapReduce + +The [`KijiTableInputFormat`]({{site.api_schema_rc2}}/mapreduce/KijiTableInputFormat.html) provides the necessary functionality to read from a Kiji table in a +MapReduce job. To configure a job to read from a Kiji table, use [`KijiTableInputFormat`]({{site.api_schema_rc2}}/mapreduce/KijiTableInputFormat.html)'s +static `setOptions` method. For example: + +{% highlight java %} +Configuration conf = HBaseConfiguration.create(); +Job job = new Job(conf); + +// * Setup jars to ship to the hadoop cluster. +job.setJarByClass(YourClassHere.class); +GenericTableMapReduceUtil.addAllDependencyJars(job); +DistributedCacheJars.addJarsToDistributedCache(job, + new File(System.getenv("KIJI_HOME"), "lib")); +job.setUserClassesTakesPrecedence(true); +// * + +KijiDataRequest request = new KijiDataRequest() + .addColumn(new KijiDataRequest.Column("your-family", "your-qualifier")); + +// Setup the InputFormat. +KijiTableInputFormat.setOptions(job, "your-kiji-instance-name", "the-table-name", request); +job.setInputFormatClass(KijiTableInputFormat.class); +{% endhighlight %} +The code contained within "// \*" is responsible for shipping Kiji resources to the DistributedCache. +This is so that all nodes within your hadoop cluster will have access to Kiji dependencies. + +[`KijiTableInputFormat`]({{site.api_schema_rc2}}/mapreduce/KijiTableInputFormat.html) outputs keys of type [`EntityId`]({{site.api_url}}/EntityId.html) and values of type [`KijiRowData`]({{site.api_url}}/KijiRowData.html). This +data can be accessed from within a mapper: + +{% highlight java %} +@Override +public void map(EntityId entityId, KijiRowData row, Context context) { + // ... +} +{% endhighlight %} + +To write to a Kiji table from a MapReduce job, you should use +[`KijiTableWriter`]({{site.api_schema_rc2}}/KijiTableWriter.html) as before. You should also set +your OutputFormat class to `NullOutputFormat`, so MapReduce doesn't expect to create +a directory full of text files on your behalf. + +To configure a job to write to a Kiji table, refer to the following example: + +{% highlight java %} +Configuration conf = HBaseConfiguration.create(); +Job job = new Job(conf); + +// Setup jars to ship to the hadoop cluster. +job.setJarByClass(YourClassHere.class); +GenericTableMapReduceUtil.addAllDependencyJars(job); +DistributedCacheJars.addJarsToDistributedCache(job, + new File(System.getenv("KIJI_HOME"), "lib")); +job.setUserClassesTakesPrecedence(true); + +// Setup the OutputFormat. +job.setOutputKeyClass(NullWritable.class); +job.setOutputValueClass(NullWritable.class); +job.setOutputFormatClass(NullOutputFormat.class); +{% endhighlight %} + +And then, from within a Mapper: + +{% highlight java %} +public class MyMapper extends Mapper { + private KijiTableWriter writer; + private Kiji kiji; + private KijiTable table; + + @Override + public void setup(Context context) { + // Open a KijiTable for generating EntityIds. + kiji = Kiji.open("your-kiji-instance-name"); + table = kiji.openTable("the-table-name"); + + // Create a KijiTableWriter that writes to a MapReduce context. + writer = table.openTableWriter(); + } + + @Override + public void map(LongWritable key, Text value, Context context) { + // ... + + writer.put(table.getEntityId("your-row"), "your-family, "your-qualifier", value.toString()); + } + + @Override + public void cleanup(Context context) { + writer.close(); + kiji.close(); + table.close(); + } +} +{% endhighlight %} diff --git a/_posts/userguides/schema/1.0.0-rc2/2012-01-01-data-model.md b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-data-model.md new file mode 100644 index 00000000..0d33c8f5 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-data-model.md @@ -0,0 +1,54 @@ +--- +layout: post +title: Data Model +categories: [userguides, schema, 1.0.0-rc2] +tags : [schema-ug] +order : 2 +version: 1.0.0-rc2 +description: KijiSchema's underlying data model. +--- + +KijiSchema’s data model is an extension of HBase’s columnar storage +model. Like HBase, KijiSchema’s tables contain many rows; each row +contains many columns. A given *cell* identified by a row and column can +hold many different timestamped values, representing the changing values +of the cell over time. Columns are grouped together into column +*families*, which provide namespacing for columns that store related +data. Families are grouped into *locality groups*, which help store +related families physically close to one another. + +> What Kiji calls a "locality group", HBase calls a "family". The Kiji +> column "family" allows you to choose the logical grouping and namespace +> of columns separately from the physical configuration of how the data is stored. + +As in HBase, rows in Kiji tables can have an arbitrary number of +columns. Individual rows may have hundreds or thousands (or more) +columns. Different rows may not necessarily have the same set of +columns. + +Unlike HBase, each cell in a Kiji table has a schema associated with it. +Schemas in KijiSchema are versioned. The schema and layout system is +described in greater detail in [Managing Data]({{site.userguide_schema_rc2}}/managing-data) + +### Entity-Centric Data Model +KijiSchema’s data model is *entity-centric*. Each row typically holds +information about a single *entity* in your information scheme. As an +example, a consumer e-commerce web site may have a row representing each +user of their site. The entity-centric data model enables easier analysis +of individual entities. For example, to recommend products to a user, +information such as the user’s past purchases, previously viewed items, +search queries, etc. all need to be brought together. The entity-centric +model stores all of these attributes of the user in the same row, +allowing for efficient access to relevant information. + +The entity-centric data model stands in comparison to a more typical +log-based approach to data collection. Many MapReduce systems import log +files for analysis. Logs are *action-centric*; each action performed by +a user (adding an item to a shopping cart, checking out, performing a +search, viewing a product) generates a new log entry. Collecting all the +data required for a per-user analysis thus requires a scan of many logs. +The entity-centric model is a “pivoted” form of this same information. +By pivoting the information as the data is loaded into KijiSchema, later +analysis can be run more efficiently, either in a MapReduce job +operating over all users, or in a more narrowly-targeted fashion if +individual rows require further computation. diff --git a/_posts/userguides/schema/1.0.0-rc2/2012-01-01-faq.md b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-faq.md new file mode 100644 index 00000000..9287584c --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-faq.md @@ -0,0 +1,93 @@ +--- +layout: post +title: FAQ +categories: [userguides, schema, 1.0.0-rc2] +tags : [schema-ug] +version: 1.0.0-rc2 +order : 8 +description: A collection of commonly asked questions and answers. +--- + +## What license is KijiSchema under? + +KijiSchema is under the Apache License, Version 2.0 + +## How do I add Kiji and its dependencies to my application's classpath? + +Like `hadoop`, the `kiji` binary supports a `jar` operation. If your program is +packaged as a single jar and you want to run it with Kiji on the classpath, you +can run: + +{% highlight bash %} +$ kiji jar myapp.jar com.myorg.MyApp [args...] +{% endhighlight %} + +If your application constructs a more complex classpath, then you can also add +Kiji to your application's classpath explicitly. Like `hadoop` and `hbase`, the +`kiji` binary has a `classpath` command which will print a string that you can +use directly in your `$CLASSPATH` environment variable or on the `java` command +line as the `-cp` option. For example: + +{% highlight bash %} +$ java -cp myapp.jar:`kiji classpath` com.myorg.MyApp +{% endhighlight %} + +## I'm confident that I'm writing data to my Kiji table correctly. Why don't I see the new cells when I try to read them back? + +Check the retention policy for the cells in the locality group you are writing +to. The locality groups of your Kiji table are configured in your table's layout. +See [Managing Data]({{site.userguide_schema_rc2}}/managing-data#layouts) for details. + +In particular, check to make sure the timestamps of the new cells you are +writing are in milliseconds, and that they fall within the bounds of your +locality group's `ttl_seconds` setting. + +## How do I specify the schema of a column in my Kiji table? + +Kiji uses Avro for data type definitions and serialization within cells of Kiji +tables. Avro can define simple types like `"int"` and `"string"` as well as +complex record types, composed of scalars or other records, arrays, maps, etc. +Every column (or map-type family) in Kiji has a type (or «schema» in Avro +parlance) associated with it. + +For primitives types like, eg. `"int"`, use the following in your column layout +descriptor: + +{% highlight js %} +column_schema: {type: "INLINE", value = '"int"'} +{% endhighlight %} + +For complex record types, you may instead specify a generated record class: +{% highlight js %} +column_schema: {type: "CLASS", value = "org.package.GeneratedRecordClass"} +{% endhighlight %} + +You can write Avro schemas `.avsc` or `.avdl` files. These can be compiled into +Java classes that represent the record type. This makes working with these +objects easier in your mapper and reducers. For complete information on Avro, +visit http://avro.apache.org. + +See [Managing Data]({{site.userguide_schema_rc2}}/managing-data#layouts) for more +details on Kiji cell schemas. + +## How does data in Kiji map to Java types? + +Kiji uses Avro for data type management and serialization. Each cell of typed +data has an associated Avro schema. When reading or writing data from Kiji, the +Java type must be compatible with the Avro schema. For example, if a Kiji +column has the Avro schema `"string"`, data read from cells of the column will +implement the Java CharSequence interface. For +record schemas that have been compiled into Java classes using the Avro +compiler, the Java type corresponding to the schema is the compiled class. + +The full list of mappings between Avro schemas and Java types are documented in +the Avro Java API documentation. See the package documentation for +org.apache.avro.specific +and +org.apache.avro.generic. + +Are there restrictions on the characters I use in table names, family names, and +column names? Yes. All table names, column family names, and column qualifier +names may only contain numbers, letters and underscores +(`[A-Za-z_][A-Za-z0-9_]*`). However, the qualifiers of a map-type column family +may contain any printable characters. diff --git a/_posts/userguides/schema/1.0.0-rc2/2012-01-01-for-administrators.md b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-for-administrators.md new file mode 100644 index 00000000..3a8ee660 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-for-administrators.md @@ -0,0 +1,158 @@ +--- +layout: post +title: For Administrators +categories: [userguides, schema, 1.0.0-rc2] +tags : [schema-ug] +version: 1.0.0-rc2 +order : 5 +description: Installation and maintenance of kiji-schema. +--- + +In this chapter, you will learn how to install and configure all aspects +of the KijiSchema system. + +## Installation Guide + +Kiji has been tested on GNU/Linux (Ubuntu 12.04, 12.10 and CentOS-6.3) +and Mac OS X (10.8.x, 10.7.x, 10.6.x). + +Kiji is a Java-based system. To run Kiji applications, you will need to +[download the Oracle Java JRE](http://www.oracle.com/technetwork/java/javase/downloads/index.html). +To develop Kiji applications, you will +need the Oracle Java JDK. We have tested this system with the Oracle +Java “Hotspot” JVM, version 6. Other JVMs are not supported at this +time. If you are running OS X, this is installed by default. + +Kiji is built on top of Hadoop and HBase. Our system depends on +[Cloudera's Distribution including Apache Hadoop](https://ccp.cloudera.com/display/SUPPORT/Downloads), version 4 (CDH4). +If you downloaded the BentoBox, a zero-configuration development/test +cluster is included in the package. If you downloaded KijiSchema, you +will need to install and configure Hadoop and HBase separately. + +### Installing and Configuring Kiji Clients + +After downloading either the BentoBox +(`kiji-bento-version-release.tar.gz`) or KijiSchema +(`kiji-schema-version-release.tar.gz`), unzip the archive with the +command `tar vzxf filename`. This will create to a directory named +`kiji-bento-version/` or `kiji-schema-version/`. + +For convenience, `$KIJI_HOME` should be set to this directory. For +example: + +{% highlight bash %} +$ export KIJI_HOME=/path/to/kiji-bento-(version) +{% endhighlight %} + +You should edit your `.bashrc` file to contain this line so that it's +incorporated in your environment for future bash sessions. + +If you're using the BentoBox edition, you can set up your environment as +follows: + +{% highlight bash %} +$ source $KIJI_HOME/bin/kiji-env.sh +$ bento start +{% endhighlight %} + +This starts the bento mini cluster and updates your environment variables +to use it. After a few seconds you should be able to view the status +page of your own mini HBase cluster at [http://localhost:60010/](http://localhost:60010/). (If +you don't see it right away, wait 10 seconds and reload the page.) +You're now ready to proceed with installing Kiji onto your cluster. + +If you installed only KijiSchema (not the BentoBox), you should instead +set `$HADOOP_HOME` and `$HBASE_HOME` and make sure the Hadoop HDFS and +HBase services are running. + +For help configuring CDH, see Cloudera's CDH4 Installation Guide. + +## Installing Kiji System Tables + +Kiji will manage tables for you on top of your HBase cluster. Each Kiji +table corresponds to a physical HBase table. There are also a number of +system tables that hold metadata maintained by Kiji itself. Before you +can use Kiji, you must run its install command and create these system +tables. + +Issue the following command from your Kiji release directory to install +a Kiji instance with the name `default`: + +{% highlight bash %} +$ bin/kiji install +{% endhighlight %} + +You should see output like the following: + + Creating kiji instance: kiji://localhost:2181/default/ + Creating meta tables for kiji instance in hbase... + 12/11/06 19:48:44 INFO org.kiji.schema.KijiInstaller: Installing a kiji instance named 'default'... + 12/11/06 19:48:50 INFO org.kiji.schema.KijiInstaller: Installed kiji 'default' + Successfully created kiji instance: kiji://localhost:2181/default/ + +Now you can create some tables in the DDL `schema-shell`, explore the Phonebook +`example`, and get started +[building a Maven project](http://www.kiji.org/get-started-with-maven) with +Kiji. See the +[quickstart guide](http://www.kiji.org/getstarted/#Quick_Start_Guide) to get +acquainted with the tools. + +## Maintenance Guide + +Due to the fault-tolerant nature of Hadoop and HBase, your Kiji instance +should not require much on-going maintenance. The following list of +recommended practices describe what maintenance should be performed to +ensure uninterrupted operation. + ++ Remove old logs - If log files fill a disk, Hadoop and HBase services may be + disrupted. Make sure to archive or delete old log files in `$HADOOP_HOME/logs` + and `$HBASE_HOME/logs` on a regular basis. + ++ Flush KijiSchema metadata tables - KijiSchema metadata tables are not frequently + updated. When an update happens, it is only recorded in the write-ahead logs + for the table. Periodically, you should run `bin/kiji flush-table --meta` to + flush metadata tables. This should be scheduled to run during a period of + low activity, nightly or weekly. + +## Troubleshooting Guide + +### Missing HBase Regions + +If HBase shuts down incorrectly or HDFS issues cause data loss, HBase's own +metadata tables `-ROOT-` and `.META.` may have inconsistent data. You can verify +that your HBase metadata tables are in good order by running `hbase hbck`. + +If `hbase hbck` prints `Status: INCONSISTENT`, +the advice in this section may help you restore functionality. + +Some problems can be fixed by running `hbase hbck -fix`. +This should be your first attempt. + +One particular kind of issue is a "hole" in the region chain for a table. Each +row stored in a table is assigned a region based on its row key. Each region is +responsible for a slice of the row key space. There should be no gaps between +these slices. If you run `hbase hbck -details`, it will print an error similar +to the following if it detects a hole in the region chain: + +{% highlight bash %} +$ hbase hbck -details +... + +Chain of regions in table kiji..table.tablename is broken; edges does not contain key +Table kiji..table.tablename is inconsistent. +... +Status: INCONSISTENT +{% endhighlight %} + +If the files for a missing region are present in HDFS, then no data has been +lost. HBase has simply lost track of the metadata for the region. The +following command can be used to scan your HBase root directory in HDFS for +region data, and add any regions back to tables that are missing from the HBase +metadata: + +{% highlight bash %} +$ hbase hbck -repairHoles +{% endhighlight %} + +See [hbck in depth](http://hbase.apache.org/book/hbck.in.depth.html) for more +details. diff --git a/_posts/userguides/schema/1.0.0-rc2/2012-01-01-kiji-schema-overview.md b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-kiji-schema-overview.md new file mode 100644 index 00000000..51375007 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-kiji-schema-overview.md @@ -0,0 +1,29 @@ +--- +layout: post +title: What is KijiSchema? +categories: [userguides, schema, 1.0.0-rc2] +tags : [schema-ug] +version: 1.0.0-rc2 +order : 1 +description: Overview. +--- + +## What is KijiSchema? + +KijiSchema provides a simple Java API and command line interface for +importing, managing and retrieving data from HBase. + + +## Key Features + +- Set-up HBase layouts using user-friendly tools including a DDL +- Implement HBase best practices in table management +- Use evolving Avro schema management to serialize complex data +- Perform both short-request and batch processing on data in HBase +- Import data from HDFS into structured HBase tables + +KijiSchema promotes the use of entity-centric data modeling, where +all information about a given entity, including both dimensional and +transaction data, is encoded within the same row. This approach is +particularly valuable for user-based analytics such as targeting, +recommendations, and personalization. diff --git a/_posts/userguides/schema/1.0.0-rc2/2012-01-01-managing-data.md b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-managing-data.md new file mode 100644 index 00000000..d3c578d4 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-managing-data.md @@ -0,0 +1,484 @@ +--- +layout: post +title: Managing Data +categories: [userguides, schema, 1.0.0-rc2] +tags: [schema-ug] +version: 1.0.0-rc2 +order: 3 +description: How to manage data with KijiSchema. +--- + +Every table in Kiji has an associated layout. The layout of a table contains a +baseline schema definition which can be used to access the majority of the +information in the table without further special knowledge. Each table's layout +describes the set of columns which can exist in any given row. For each column, +a minimal "reader" schema is specified; this provides multiple team members +working with a large data set with a common data dictionary; it also enables +validation of cell data against a reference schema. The layout also describes +some additional properties of the table; these are discussed in this section as +well. + +Every data element in Kiji is stored in a Kiji cell, which is uniquely +identified by an entity ID, column name, and timestamp. The column name is itself +two components: a family name and a qualifier. As in HBase, these are written +`family:qualifier`. Data written to a Kiji cell is serialized to a byte array +according to an Avro schema. The writer schema used for the particular write +operation is stored alongside the cell data, so the input data can be +deserialized exactly by subsequent read requests. But this schema must be +compatible with the expected reader schema specified in the layout for the cell. + +A JSON layout descriptor is a specification for the locality groups, +columns, and data types that comprise a table, written as a JSON +document whose elements are described in the following subsections. We will +refer to the following example layout file throughout this section: + +{% highlight js %} +{ + name: "users", + description: "A bunch of made-up users", + version: "kiji-1.0", + keys_format: {encoding: "HASH"}, + locality_groups: [ { + name: "default", + description: "The default locality group", + in_memory: false, + max_versions: 1, + ttl_seconds: 7776000, + compression_type: "NONE", + families: [ { + name: "info", + description: "A bunch of fields", + columns: [ { + name: "id", + description: "user id hash", + column_schema: {type: "INLINE", value: '"string"'} + }, { + name: "name", + description: "The person's name", + column_schema: {type: "INLINE", value: '"string"'} + }, { + name: "email", + description: "The person's email", + column_schema: {type: "INLINE", value: '"string"'} + } ] + }, { + name: "searches", + description: "The recent search queries the user has made", + map_schema: {type: "CLASS", value: "com.search.avro.Search"} + } ] + } ] +} +{% endhighlight %} + +The schema of the table layout descriptor is available in the KijiSchema source tree at +[Layout.avdl](#ref.table_layout_desc). + +### Overall structure of a table layout + +At the top-level, a table contains: + +* the table name and description; +* a description of the row keys encoding; +* the table locality groups. + +Each locality group has: + +* a primary name, unique within the table, a description and optionally some name aliases; +* whether the data is to be stored in memory or on disk; +* data retention lifetime; +* maximum number of versions to keep; +* type of compression; +* column families stored in this locality group. + +Each column family has: + +* a primary name, unique within the table, a description and optionally some name aliases; +* for map-type families, the Avro schema of the cell values; +* for group-type families, the collection of columns in the group. + +Each column in a group-type family has: + +* a primary name, unique within the family, a description and optionally some name aliases; +* an Avro schema. + +All names must start with a letter and may only use letters, numbers, and underscores. + +### Group-type and map-type families + +In KijiSchema, there are two kinds of column families: + +* Group-type families define a fixed set of named columns. In the example + layout above, there is a single group-type family named `info`, containing + the columns `info:id`, `info:name`, and `info:email`, each with their own + Avro schema. Each row may contain any subset of these three columns, but may + not contain any additional columns. + +* Map-type families define a family where the cell column qualifiers are not + explicitly defined. In the example layout above, the map-type family named + `searches` may be used to store every search performed by a user, each with + their own column qualifier; cell columns would have names of the form + `searches:`; the contents of each cell might be a compound Avro + record containing the list of products returned by the query specified in the + cell's qualifier, as well as a boolean for each indicating whether the user + actually clicked that search result. A map-type column specifies a single Avro + schema for all its column. Note that the column qualifiers used in a map-type + family must be valid UTF-8 strings (rather than arbitrary byte arrays). + +### Kiji cell schema + +Within a table, Kiji cells are encoded according to their declared schema. +There are three types of Kiji cell schemas, specified using the `type` field: + +* `INLINE` - field `value` contains an the JSON representation of an Avro + schema. In the earlier example, all three columns contain a single Avro + `"string"` field, but a column could also contain an array, record or other + complex Avro data type. +* `CLASS` - field `value` contains the fully-qualified name of a Java class + mapped by an Avro data type, like an implementation of `SpecificRecord`. The + user must ensure that the class is available on the classpath of any Kiji + tools accessing the cell. +* `COUNTER` - cells are encoded as long integers and support atomic increment + or decrement operations. + +The schema of cells in a group-type family is specified by the `column_schema` +field (see columns `info:id`, `info:name`, `info:email` in the example layout). +The schema of cells in a map-type family is specified by the `map_schema` field +(see map-type family `searches` in the example layout). + +### Locality groups + +All families within a locality group are stored together in HBase. It is +usually a good idea to put families that are often read and written together +into the same locality group. + +Locality groups control the physical properties of the underlying storage: + +* `in_memory` - when this boolean flag is set, Kiji configures HBase to keep as + much of this locality group in memory as possible. +* `ttl_seconds` - cells' time to live : cells older that this number of seconds + may be automatically discarded. +* `max_versions` - maximum number of timestamped versions of cells to retain : + as new versions of a cell are written, older versions are deleted to not + exceed this limit. +* `compression` - one of `NONE`, `GZ`, `LZO` or `SNAPPY`. + +### Names + +Locality groups, families, and columns are identified by their primary names. +The primary name may be changed with the help of the `renamed_from` field. +For example, to rename the `default` locality group into `new_name`, one may +update the table layout with a locality group descriptor as follows: + +{% highlight js %} +locality_groups: [ { + name: "new_name", + renamed_from: "default", + ... +} ] +{% endhighlight %} + +Table names may not be changed. + + +### Layout record descriptor + +For reference, the Avro descriptor for table layout records is defined in +`src/main/avro/Layout.avdl` within the kiji-schema git project as follows: + +{% highlight java %} +/** + * (c) Copyright 2012 WibiData, Inc. + * + * See the NOTICE file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Kiji table layout. + +@namespace("org.kiji.schema.avro") +protocol KijiTableLayoutRecords { + + /** Type of compression for the data within a locality group. */ + enum CompressionType { + NONE, + GZ, + LZO, + SNAPPY + } + + /** Type of schema for column data. */ + enum SchemaType { + /** Column contains data encoded as specified inline. */ + INLINE, + + /** Column contains Avro records with the specified class name. */ + CLASS, + + /** Column contains counters. */ + COUNTER + } + + /** How schemas get encoded in cells. */ + enum SchemaStorage { + /** Data is prepended with the schema hash. */ + HASH, + + /** Data is prepended with the schema unique ID. */ + UID, + + /** Schema is immutable and not stored in the cell. */ + FINAL + } + + /** Schema of a Kiji cell. */ + record CellSchema { + /** Schema encoding in cells. Unused if type is COUNTER. */ + SchemaStorage storage = "HASH"; + + /** Type of schema. */ + SchemaType type; + + /** + * Schema value, whose interpretation depends on the schema type: + * - inline : immediate Avro schema description, eg. "string"; + * - class : Avro schema class name, eg. "org.kiji.avro.Node"; + * - counter : unused, must the empty. + */ + union { null, string } value = null; + } + + /** Column descriptor. */ + record ColumnDesc { + /** Column ID. Not visible to the user. 0 means unset. */ + int @internal("true") id = 0; + + /** Column primary name (A-Z, a-z, 0-9, -, _). */ + string name; + + /** Column name aliases. */ + array aliases = []; + + /** When false, the column is not visible or usable. */ + boolean enabled = true; + + /** User description of the column. */ + string description = ""; + + /** Schema for the cell values. */ + CellSchema column_schema; + + // Fields below are used to apply a diff against a reference family layout: + + /** When true, applying this layout deletes the column. */ + boolean @diff("true") delete = false; + + /** Reference primary name of the column, when renaming the column. */ + union { null, string } @diff("true") renamed_from = null; + } + + /** Descriptor for a group of columns. */ + record FamilyDesc { + /** Family ID. Not visible to the user. 0 means unset. */ + int @internal("true") id = 0; + + /** Column family primary name (A-Z, a-z, 0-9, -, _). */ + string name; + + /** Column family name aliases. */ + array aliases = []; + + /** When false, the family and its columns are not visible/usable. */ + boolean enabled = true; + + /** User description of the column family. */ + string description = ""; + + /** Cell schema for map-type families. Null for group-type families. */ + union { null, CellSchema } map_schema = null; + + /** Columns, for group-type families only. Empty for map-type families. */ + array columns = []; + + // Fields below are used to apply a diff against a reference family layout: + + /** When true, applying this layout deletes the family. */ + boolean @diff("true") delete = false; + + /** Reference primary name of the family, when renaming the family. */ + union { null, string } @diff("true") renamed_from = null; + } + + /** A group of Kiji column families stored together in a table. */ + record LocalityGroupDesc { + /** Locality group ID. Not visible to the user. 0 means unset. */ + int @internal("true") id = 0; + + /** Locality group primary name (A-Z, a-z, 0-9, -, _). */ + string name; + + /** Locality group name aliases. */ + array aliases = []; + + /** When false, the locality group and its families are not visible. */ + boolean enabled = true; + + /** User description of the locality group. */ + string description = ""; + + /** Reduce latency by forcing all data to be kept in memory. */ + boolean in_memory; + + /** Maximum number of the most recent cell versions to retain. */ + int max_versions; + + /** Length of time in seconds to retain cells. */ + int ttl_seconds; + + /** Data compression type. */ + CompressionType compression_type; + + /** Column family descriptors. */ + array families = []; + + // Fields below are used against a reference locality group layout: + + /** When true, applying this layout deletes the locality group. */ + boolean @diff("true") delete = false; + + /** Reference primary name of the locality group, when renaming. */ + union { null, string } @diff("true") renamed_from = null; + } + + + /** Hashing methods. */ + enum HashType { + /** MD5 hashing (16 bytes). */ + MD5 + } + + /** Row keys encoding. */ + enum RowKeyEncoding { + /** Row keys are managed by the user. */ + RAW, + + /** Row keys are hashed. */ + HASH, + + /** Row keys are prefixed by a hash. */ + HASH_PREFIX + } + + record RowKeyFormat { + /** Encoding of the row key. */ + RowKeyEncoding encoding; + + /** Type of hashing used, if any. */ + union { null, HashType } hash_type = null; + + /** + * Size of the hash, in bytes. + * - unused when encoding is RAW. + * - smaller than the hash size used for HASH or HASH_PREFIX. + */ + int hash_size = 0; + } + + /** Layout of a Kiji table. */ + record TableLayoutDesc { + /** Name of the table (A-Z, a-z, 0-9, -, _). */ + string name; + + /** User description of the table. */ + string description = ""; + + /** Whether row key hashing should be managed by Kiji. */ + RowKeyFormat keys_format; + + /** Locality groups in the table. */ + array locality_groups = []; + + /** Data layout version (eg. "kiji-1.0"). */ + string version; + + /** ID of the layout. */ + union { null, string } layout_id = null; + + /** Reference to the base layout this descriptor builds on. */ + union { null, string } reference_layout = null; + } + + // --------------------------------------------------------------------------- + // Backup records + + /** An MD5 hash. */ + fixed MD5Hash(16); + + /** An entry from the SchemaTable inside a metadata backup file. */ + record SchemaTableEntry { + /** Schema ID: positive integers only. */ + long id; + + /** 128 bits (16 bytes) hash of the schema JSON representation. */ + MD5Hash hash; + + /** JSON representation of the schema. */ + string avro_schema; + } + + /** Entry to backup a table layout update. */ + record TableLayoutBackupEntry { + /** Update timestamp, in ms. */ + long timestamp; + + /** + * Table layout update, as specified by the submitter/user. + * Except for the first one, the update builds on the previous layout. + */ + union { TableLayoutDesc, null } update = null; + + /** Effective table layout, after applying the update. */ + TableLayoutDesc layout; + } + + /** Table backup, ie. everything needed to restore a table. */ + record TableBackup { + /** Table name. */ + string name; + + /** Sequence of layouts, in order. */ + array layouts = []; + } + + /** Record that encapsulates all Kiji metadata, for backup purposes. */ + record MetadataBackup { + /** Layout version (eg. "kiji-1.0"). */ + string layout_version; + + /** Schema entries. */ + array schema_table = []; + + /** Map from table names to table backup records. */ + map meta_table = {}; + } + +} +{% endhighlight %} + + diff --git a/_posts/userguides/schema/1.0.0-rc2/2012-01-01-tool-reference.md b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-tool-reference.md new file mode 100644 index 00000000..be632d1e --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc2/2012-01-01-tool-reference.md @@ -0,0 +1,368 @@ +--- +layout: post +title: Command-Line Tool Reference +categories: [userguides, schema, 1.0.0-rc2] +component: schema +version: 1.0.0-rc2 +tags : [schema-ug] +order : 7 +description: A reference of commands available for the schema command line tool. +--- + +Running kiji with no arguments will list all the available tools: + +{% highlight bash %} +$ kiji COMMAND [FLAG]... +{% endhighlight %} + +## Commands + +* `help` - Display this help message. +* `install` - [Install KijiSchema onto a running HBase instance](#ref.install) +* `uninstall` - [Uninstall KijiSchema from a running HBase instance](#ref.uninstall) +* `version` - Print the version of KijiSchema. +* `classpath` - Print the classpath used to build or run KijiSchema +* `jar` - [Run a main class from the specified jar](#ref.jar) + Use: `kiji jar [args...]` +* `ls` - [List, describe, or scan Kiji tables](#ref.ls) +* `create-table` - [Create a Kiji table](#ref.create-table) +* `delete` - [Delete a Kiji table, row, or cell](#ref.delete) +* `flush-table` - [Flush table write-ahead logs](#ref.flush-table) +* `layout` - [Manage table layouts](#ref.layout) +* `increment` - [Increment a counter cell](#ref.increment) +* `put` - [Set the value of a single cell](#ref.put) +* `synthesize-user-data` - [Synthesize user data into a table](#ref.synthdata) + +## Targeting a KijiSchema instance: Kiji URI + +Most commands accept an optional parameter `--kiji=` that specifies a +KijiSchema instance to interact with. +The format for this parameter is a URI generally formatted as: +`kiji://zookeeper_host:2181/kiji_instance_name`, and includes: + +* The address of the HBase instance KijiSchema has been installed on. + This is the address of the ZooKeeper quorum used by the HBase instance. + The default is `.env`, which tells KijiSchema to use the HBase instance + identified by the HBase configuration files in `$HBASE_HOME`. +* And the name of the KijiSchema instance. + The default KijiSchema instance name is `default`. + +The default value for this parameter is `--kiji=kiji://.env/default`, which +references the KijiSchema instance named "default" and installed on the HBase +instance identified in the HBase configuration files in `$HBASE_HOME`. + +The URI for KijiSchema instance named "the_instance" and installed on a mini +HBase cluster running locally on a laptop is +`--kiji=kiji://localhost:2181/the_instance`. + +## Installation: `install` + +The `kiji install` command will create the initial metadata tables +`kiji..meta`, `kiji..status`, +`kiji..schema_id` and `kiji..schema_hash` +required by the KijiSchema system. +This should be run once during initial setup of KijiSchema. + +A different HBase instance or KijiSchema instance name may be specified using the +[`--kiji` parameter](#ref.kiji_uri). + +## Removal: `uninstall` + +The `kiji uninstall` command removes an installed KijiSchema instance, and deletes +all the user tables it contains. +The KijiSchema instance to remove is specified through the +[`--kiji` parameter](#ref.kiji_uri). + +This command accepts an optional parameter: +* `--confirm` + - Must be set to perform the instance removal without interactive confirmation. + +## Listing Information: `ls` + +The `kiji ls` command is the basic tool used to explore a KijiSchema repository. +It can drill down into KijiSchema-based data sets at many levels. + +When run with `--instances`, this command lists the Kiji instances installed on the +HBase instance specified with `--kiji=` (by default, `kiji://.env`): + +{% highlight bash %} +$ kiji ls --instances +default +{% endhighlight %} + +When run with no arguments, this command lists the tables in the Kiji instance +specified with `--kiji=` (by default, `kiji://.env/default`): + +{% highlight bash %} +$ kiji ls +users +products +{% endhighlight %} + +The `ls` command can also be used to list the contents of a table. +`kiji ls --table=` displays the contents of a Kiji table. +Each record appears as a set of lines, set apart by blank lines. +Each cell appears on two lines: +the first line contains the row key (a hashed representation of a primary key), +a timestamp (expressed in milliseconds since the UNIX epoch), +and the cell name (`family:qualifier`). +The second line contains the string representation of the cell data itself. +For example, running `kiji ls --table=users` on a table generated with the `synthdata` +command (see [Generating Sample Data](#ref.synthdata)) displays rows like: + +{% highlight bash %} +$ kiji ls --table=users +\xA6t\xCEIm\xB7A\x88\x7F\xD1\xA9n\xB0\xEC\x16\xDB [1305851507300] info:name + Olga Jefferson +\xA6t\xCEIm\xB7A\x88\x7F\xD1\xA9n\xB0\xEC\x16\xDB [1305851507301] info:email + Olga.Jefferson@hotmail.com + +\xf8\x8f\xe2\xb2,E\x8b\xea\xd5\x08\xf8\x8a\xee`\x91y [1305851507425] info:name + Sidney Tijuana +\xf8\x8f\xe2\xb2,E\x8b\xea\xd5\x08\xf8\x8a\xee`\x91y [1305851507427] info:email + Sidney.Tijuana@hotmail.com +… +{% endhighlight %} + +Providing just the `--table` argument is not particularly useful; +you will typically want to restrict the set of data printed to the terminal. +The following options will do just that: + +* `--columns=family:qualifier,family:qualifier...` + - Display a subset of the available columns. `--columns=*` will include all columns. + +* `--start-row=row-key` and `--limit-row=row-key` + - Restrict the row range to print. + +* `--max-rows=` + - Display at most this many rows of data. + +* `--max-versions=` + - Display at most this many versions of each cell. + +* `--min-timestamp=` and `--max-timestamp=` + - Display only cells whose timestamps fall within the given range. + Timestamps are expressed in milliseconds since the Epoch. + +* `--entity-hash=` + - Display only cells from a single row; ignores `--start-row` and `--limit-row`. + The string argument is the hexadecimal representation of the pre-hashed row id. + +* `--entity-id=` + - Display only cells from a single row; ignores `--start-row` and `--limit-row`. + The string is the human-readable value representing the row id, encoded as UTF8. + +## Creating Tables: `create-table` + +The `kiji create-table` command creates a new +Kiji table. This is stored in an underlying HBase table with the name +`kiji..table.`. + +This command has two mandatory arguments: + +* `--table=` + - Name of the table to create. + It is an error for this table to already exist. +* `--layout=` + - Path to a file a JSON file containing the table layout specification, + as described in [Managing Data]({{site.userguide_schema_rc2}}/managing-data#layouts). + +The following arguments are optional: + +* `--kiji=` + - Address of the Kiji instance to interact with. + +* `--num-regions=` + - The number of initial regions to create in the table. + This may only be specified if the table uses row key hashing. + It may not be used in conjunction with `--split-key-file`. + +* `--split-key-file=` + - Path to a file containing the row keys to use as initial boundaries between regions. + This may only be specified if the table uses row key hashing. + It may not be used in conjunction with `--num-regions`. + + + +## Deleting tables, rows, and cells: `delete` + +The `delete` command will delete a KijiSchema +table, row, or cell, and drop all values which were in them. +This command has one mandatory argument: + +* `--table=` + - The name of the table from which to delete. If specified without --row, the entire table + will be deleted. + +And several optional arguments: + +* `--row=` + - The name of the row from which to delete values. If specified without --family, all + values in the row will be deleted. + +* `--family=` + - The name of the family from which to delete values. If specified without --qualifier, all + values in the row and family will be deleted. (requires a specified row) + +* `--qualifier=` + - The name of a column qualifier from which to delete values. If specified without a + timestamp or --most-recent, all values in the cell will be deleted. + (requires a specified family) + +* `--upto-timestamp=` + - The timestamp at or before which all values will be deleted. (requires a specified row) + +* `--exact-timestamp=` + - The timestamp at which to delete a value. + (requires a specified row, family, and qualifier) + +* `--most-recent` + - Set to delete the most recent value of a cell. + (requires a specified row, family, and qualifier) + +* `--confirm` + - Set to perform the deletions without interactive confirmation. + +## Flushing tables: `flush-table` +-------------------------------------------------------- + +The `flush-table` command will instruct HBase to +flush the contents of a table to HDFS. When HBase receives new data, it +is recorded in a write-ahead log (WAL). But this WAL is not merged with +existing table files until the table is flushed or compacted. This +happens more frequently if more data is written to a table. But you can +force data to be written to table files with this command. If a table is +not frequently updated, flushing the data with this command may improve +recovery time in the event that HBase experiences a failure. + +You must use one or both of the following arguments to specify what +to flush: + +* `--table=` + - Specifies the table name to flush. +* `--meta` + - If set, flushes KijiSchema metadata tables. + +It also accepts an optional `--kiji=` argument to +specify the address of the installed Kiji instance in which to find +the table to flush. + +You should only flush tables during a period of relative inactivity. +Flushing while a large number of operations are ongoing may adversely +affect performance. The flush operation is also asynchronous; the +command may return before the actual flush operation is complete. + +Managing layouts: `layout` +------------------------------------------------ + +The `kiji layout` command displays or modifies +the layout associated with a table. + +When run with `--table=`, this displays the current layout +associated with a given table: + +{% highlight bash %} +$ kiji layout --table=users +{ + name: "users", + description: "The user table", + keys_format : {encoding : "RAW"}, + locality_groups : [ + … + ], + layout_id : "3", +} +{% endhighlight %} + +When run with the `--do=set --layout=/path/to/layout.json` +argument, this sets the layout for a table to match the specified +layout JSON file. + +The `--dry-run` argument specifies that `--do=set` +should not actually update the layout; it simply prints out +a message stating whether or not the update would succeed (i.e., whether or not +the layout is valid) and what locality groups would be updated by the new layout. + +When run with the `--do=history --max-versions=`, this command dumps the most +recent versions of the table layout. + +Running an Application Jar with KijiSchema: `jar` +-------------------------------------------------------------------- + +If your application requires KijiSchema and its dependencies, you +can use the `kiji jar` command to launch your program's +main method with KijiSchema present on the classpath. + +This command requires two unlabeled arguments: the jar filename, and the +main class to run: + +{% highlight bash %} +$ kiji jar myapp.jar com.pkg.MyApp [args...] +{% endhighlight %} + +Incrementing counters: `increment` +--------------------------------------------------------------- + +The `kiji increment` command may be used to increment +(or decrement) a KijiSchema counter. + +The following arguments are required: + +* `--table=` - Target table +* `--column=family:qualifier` - Target column +* `--entity-hash=entity` - Target row id (the actual pre-hashed entity string) +* `--entity-id=entity` - Target row id (an unhashed, human-readable string) +* `--value=amount` - The value to increment by. + +Exactly one of `--entity-id` or `--entity-hash` must be used. + +Setting Individual Cells: `put` +-------------------------------------------------- + +To aid in the insertion of small data sets, debugging, and testing, the +`kiji put` command may be used to insert individual values in a Kiji table. + +The following arguments are required: + +* `--table=` - Target table +* `--column=family:qualifier` - Target column +* `--entity-hash=entity` - Target row id (the actual pre-hashed entity string) +* `--entity-id=entity` - Target row id (an unhashed, human-readable string) +* `--value=` - The value to insert. The value is specified as a + JSON string according to [the Avro JSON encoding specification](http://avro.apache.org/docs/current/spec.html#json_encoding) + +Exactly one of `--entity-id` or `--entity-hash` must be used. + +The following arguments are optional: + +* `--schema=Avro schema` - By default, KijiSchema will use the reader schema + attached to a column in its layout to decode the JSON and encode the binary + data for insertion in the table. This argument allows you to use an alternate + writer schema. +* `--timestamp=long` - Specifies a timestamp (in milliseconds since the Epoch) other than "now". +* `--kiji=` - Address of the Kiji instance to interact with. + +Generating Sample Data: `synthesize-user-data` +--------------------------------------------------------------------------- + +In the interest of enabling quick experimentation with KijiSchema, +the `kiji synthesize-user-data` tool will +generate a number of semi-random rows for you. + +The tool creates a set of rows which contain columns `info:id`, `info:name`, and +`info:email`; these are pseudo-randomly generated first and last names, with +plausible email addresses with gmail, hotmail, etc. accounts based on the +generated names. These columns can be used with mappers and reducers. + +To use this tool, first create a table with the layout in +`${KIJI_HOME}/examples/synthdata-layout.xml`. +Then invoke `bin/kiji synthesize-user-data --table=`. +This will generate 100 rows of data. +You can create a different number of records by specifying +`--num-users=`. + +You can specify a different list of names with the `--name-dict=filename` argument. + +It also accepts an optional `--kiji=` argument to specify the address of the Kiji instance. diff --git a/_posts/userguides/schema/1.0.0-rc3/2011-12-27-schema-shell-ddl-ref.md b/_posts/userguides/schema/1.0.0-rc3/2011-12-27-schema-shell-ddl-ref.md new file mode 100644 index 00000000..288da8d6 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc3/2011-12-27-schema-shell-ddl-ref.md @@ -0,0 +1,340 @@ +--- +layout: post +title: DDL Shell Reference +id: userguide/ddl-ref +categories: [userguides, schema, 1.0.0-rc3] +component: schema +version: 1.0.0-rc3 +order : 6 +tags: [schema-ug] +description: An introduction to the DDL that manipulates table layouts. +--- + +The KijiSchema DDL Shell implements a _data definition language_ (DDL) that +allows you to create, modify, inspect, and delete kiji table layouts. A +_table layout_ is the KijiSchema data dictionary element that defines a set +of column families, qualifiers, etc. and associates these columns with +Avro schemas. + +With this shell, you can quickly create tables to use in your KijiSchema +applications. You can add, drop, or modify columns quickly too. These +modifications can be performed without any downtime associated with the +table; the only exception is that modifying a locality group causes +the table to be taken offline while applying changes. But locality group +changes should be rare in running applications. + +Finally, this shell allows you to quickly understand the layout of an +existing table. The `DESCRIBE` command will pretty-print the layout of a +table, eliminating the guesswork as to where your coworker has stashed an +important piece of data. + + +## Running + +* Export `$KIJI_HOME` to point to your KijiSchema installation. +* Run `bin/kiji-schema-shell` + +This command takes a few options (e.g., to load a script out of a file). +See `bin/kiji-schema-shell --help` for all the available options. + +### An Example + +The following commands could be entered at the DDL shell prompt to create +a table, add another column family, describe its layout, and then remove the +table. + + CREATE TABLE foo WITH DESCRIPTION 'some data' + ROW KEY FORMAT HASHED + WITH LOCALITY GROUP default WITH DESCRIPTION 'main storage' ( + MAXVERSIONS = INFINITY, + TTL = FOREVER, + INMEMORY = false, + COMPRESSED WITH GZIP, + FAMILY info WITH DESCRIPTION 'basic information' ( + name "string" WITH DESCRIPTION 'The user\'s name', + email "string", + age "int"), + MAP TYPE FAMILY integers COUNTER WITH DESCRIPTION 'metric tracking data' + ); + + ALTER TABLE foo ADD MAP TYPE FAMILY strings { "type" : "string" } + WITH DESCRIPTION 'ad-hoc string data' TO LOCALITY GROUP default; + + SHOW TABLES; + DESCRIBE EXTENDED foo; + DROP TABLE foo; + SHOW TABLES; + + +## The Layout Definition Language + +This section defines the layout definition language. + +### General Language Notes and Style + +All statements in the language must end with a semi-colon character. +Statements may wrap across multiple lines. + +Keywords are case insensitive. The following are equivalent: + + schema> DESCRIBE foo; + schema> describe foo; + +Names for tables and columns are case sensitive. The following are _different_: + + schema> DESCRIBE FOO; + schema> DESCRIBE foo; + +Lines beginning with '#' are treated as comments and ignored. + + schema> # this is a comment line and will be ignored. + schema> # the next line will not be ignored. + schema> show tables; + + +Table and column names can be provided either as identifiers or +`'in single quotes'`. The following are equivalent: + + schema> DESCRIBE foo; + schema> DESCRIBE 'foo'; + +If you have a table whose name is a keyword (e.g., "SHOW" or "tables"), +you can wrap them `'in single quotes'` to protect them. e.g.: + + schema> CREATE TABLE 'WITH' WITH DESCRIPTION 'A table with a silly name'; + +By contrast, strings used to specify table or column descriptions, or other +string "values" must always be single quoted. + +Quoted strings may contain `'internally \'escaped quotes\', as well as escaped slashes:\\'`. + +The escape sequences `'\t'` and `'\n'` work as you'd hope, representing a tab +character and a newline character respectively. Everything else escapes to itself. + +`INFINITY` and `FOREVER` are both synonyms for Int.MaxValue wherever an integer +may be specified. + +Avro schemas are specified with the Avro JSON schema syntax. JSON uses "double quotes" +to enclose strings; this is respected in this shell as well. JSON can be entered directly +into the command. For example: + + ALTER TABLE foo ADD MAP TYPE FAMILY strings { "type" : "string" } + WITH DESCRIPTION 'ad-hoc string data' TO LOCALITY GROUP default; + + +For more information, see +[The Avro 1.7 specification](http://avro.apache.org/docs/1.7.2/spec.html). + +## Layout Definition Language Statements + +### Working with Kiji Instances + +A kiji instance is a collection of kiji tables. You can list the available +instances: + + schema> SHOW INSTANCES; + +The currently selected instance will have an asterisk next to it. + +You can also select an instance: + + schema> USE foo; + +The default instance is named `default`; in addition to `USE default;`, +you can also select that with the more readable (and more verbose) syntax: + + schema> USE DEFAULT INSTANCE; + + +### Listing and Describing Tables + +You can list the available tables with: + + schema> SHOW TABLES; + +You can pretty-print the layout of a table with: + + schema> DESCRIBE foo; + +This will not print locality group information or hidden columns. To include +this information, use: + + schema> DESCRIBE EXTENDED foo; + + +### Creating Tables + +This shell will allow you to create tables and define their locality groups, +column families, and column qualifiers. Each map-type family or qualifier in a +group-type family has a schema associated with it. + +#### Schemas + +There are three possible kinds of schemas that can be associated with a +column: + +* JSON schemas are declared inline. e.g. `"string"` or `{ "type" : "int" }` +* Avro SpecificRecord class names are declared as `CLASS com.example.FooRecord` +* A special type `COUNTER` can define an HBase counter column that can be + atomically incremented. + +#### Names + +Table, locality group, family, and column names must have the following +format: + + [a-zA-Z_][a-zA-Z0-9_]* + +The following are legal names: + + foo + meep123 + wom_bat + _aard_vark + users2 + +The following are not allowed: + + 42 + 2users + some-dashed-name + this$uses!special(characters_) + +#### `CREATE TABLE` Syntax + + CREATE TABLE t [WITH DESCRIPTION 'd'] + [ROW KEY FORMAT { HASHED | RAW | HASH PREFIXED(int) }] + WITH locality_group [ , locality_group ...]*; + +This creates a table, sets its description, defines how row keys are formatted, +and defines a list of locality groups. + +Row keys may be literal string values (`ROW KEY FORMAT RAW`), or they may be +the hash of the string value (`ROW KEY FORMAT HASHED`). They may also be a +composite of the two (`ROW KEY FORMAT HASH PREFIXED(n)`), where `n` is an +integer between 1 and 16 specifying the number of hash bytes to retain as +the prefix size (e.g: `ROW KEY FORMAT HASH PREFIXED(2)` will use raw keys +with two bytes of the key hash as a prefix.) If no ROW KEY FORMAT clause is +given, it is assumed to be `HASHED`. + +Each locality group is defined as follows: + + LOCALITY GROUP foo [WITH DESCRIPTION 'd'] [ ( property, property... ) ] + +This defines a locality group named `foo` with one or more properties set. The +valid properties are: + + MAXVERSIONS = int + INMEMORY = bool + TTL = int + COMPRESSED WITH (GZIP | LZO | SNAPPY | NONE) + +Remember that you can use `INFINITY` and `FOREVER` when specifying integer +values for `MAXVERSIONS` and `TTL` to make your statements more readable. + +You can also specify map- and group-type column families in the properties +list: + + [GROUP TYPE] FAMILY f [WITH DESCRIPTION 'd'] [( column, column... )] + MAP TYPE FAMILY f [WITH SCHEMA] schema [WITH DESCRIPTION 'd'] + + +Within a group-type family, individual column qualifiers are specified with: + + [COLUMN] foo [WITH SCHEMA] schema [WITH DESCRIPTION 'd'] + + +#### `CREATE TABLE Example` + +The following is an example that puts together all of the different syntax +elements described in the previous section: + + schema> CREATE TABLE foo WITH DESCRIPTION 'some data' + -> ROW KEY FORMAT HASHED + -> WITH LOCALITY GROUP default WITH DESCRIPTION 'main storage' ( + -> MAXVERSIONS = INFINITY, + -> TTL = FOREVER, + -> INMEMORY = false, + -> COMPRESSED WITH GZIP, + -> FAMILY info WITH DESCRIPTION 'basic information' ( + -> name "string" WITH DESCRIPTION 'The user\'s name', + -> email "string", + -> addr CLASS com.example.AddressRecord, + -> age "int"), + -> MAP TYPE FAMILY integers COUNTER WITH DESCRIPTION 'metric tracking data' + -> ); + +### Deleting Tables + +You can delete a table with the command: + + schema> DROP TABLE foo; + +Warning: THIS WILL DELETE ALL THE DATA IN THE TABLE. + +### Changing Table Properties + +All table properties that can be set (descriptions, columns & schemas, +locality group properties, etc) when a table is created, can also be changed +after the fact. + +Keywords or clauses in \[square brackets\] are optional in the examples below: + + + ALTER TABLE t ADD COLUMN info:foo [WITH SCHEMA] schema [WITH DESCRIPTION 'd']; + ALTER TABLE t RENAME COLUMN info:foo [AS] info:bar; + ALTER TABLE t DROP COLUMN info:foo; + + ALTER TABLE t ADD [GROUP TYPE] FAMILY f [WITH DESCRIPTION 'd'] TO [LOCALITY GROUP] lg; + + ALTER TABLE t ADD MAP TYPE FAMILY f [WITH SCHEMA] schema + [WITH DESCRIPTION 'd'] TO [LOCALITY GROUP] lg; + + ALTER TABLE t DROP FAMILY f; + ALTER TABLE t RENAME FAMILY f [AS] f2; + + ALTER TABLE t CREATE LOCALITY GROUP lg [WITH DESCRIPTION 'd'] + [( property, property... )] + + ... Where 'property' is one of: + MAXVERSIONS = int + | INMEMORY = bool + | TTL = int + | COMPRESSED WITH { GZIP | LZO | SNAPPY | NONE } + ... or a FAMILY definition (see the earlier section on the CREATE TABLE syntax) + + ALTER TABLE t RENAME LOCALITY GROUP lg [AS] lg2; + ALTER TABLE t DROP LOCALITY GROUP lg; + + ALTER TABLE t SET DESCRIPTION = 'desc' FOR FAMILY f; + ALTER TABLE t SET SCHEMA = schema FOR [MAP TYPE] FAMILY f; + + ALTER TABLE t SET DESCRIPTION = 'desc' FOR COLUMN info:foo; + ALTER TABLE t SET SCHEMA = schema FOR COLUMN info:foo; + + ALTER TABLE t SET DESCRIPTION = 'desc'; + + ALTER TABLE t SET DESCRIPTION = 'desc' FOR LOCALITY GROUP lg; + ALTER TABLE t SET property FOR LOCALITY GROUP lg; + ... where 'property' is one of MAXVERSIONS, INMEMORY, TTL, or COMPRESSED WITH. + + +### Working With Scripts + +You can write scripts that contain DDL statements to define tables or whole +instances. If you put a sequence of DDL statements in a file, you can run +this file with: + + schema> LOAD FROM FILE '/path/to/foo.ddl'; + +You can print the DDL that would create a whole instance or a specific table +to the screen: + + schema> DUMP DDL; + schema> DUMP DDL FOR TABLE foo; + +Or you can save the output to a file: + + schema> DUMP DDL TO FILE '/path/to/foo.ddl'; + schema> DUMP DDL FOR TABLE foo TO FILE '/path/to/foo.ddl'; + diff --git a/_posts/userguides/schema/1.0.0-rc3/2012-01-01-accessing-data.md b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-accessing-data.md new file mode 100644 index 00000000..c5909180 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-accessing-data.md @@ -0,0 +1,190 @@ +--- +title: Accessing Data +layout: post +categories: [userguides, schema, 1.0.0-rc3] +tags: [schema-ug] +version: 1.0.0-rc3 +order : 4 +description: How to access data using KijiSchema. +--- + +The [`KijiTableReader`]({{site.api_schema_rc3}}/KijiTableReader.html) class provides a `get(...)` method to read typed data from a Kiji table row. +The row is addressed by its [`EntityId`]({{site.api_schema_rc3}}/EntityId.html) (which can be retrieved from the [`KijiTable`]({{site.api_schema_rc3}}/KijiTable.html) instance using the [`getEntityId()`]({{site.api_schema_rc3}}/KijiTable.html#getEntityId%28java.lang.String%29) method). +Specify the desired cells from the rows with a [`KijiDataRequest`]({{site.api_schema_rc3}}/KijiDataRequest.html). See the +[`KijiDataRequest`]({{site.api_schema_rc3}}/KijiDataRequest.html) documentation for details. + +In general, [`Kiji`]({{site.api_schema_rc3}}/Kiji.html) and [`KijiTable`]({{site.api_schema_rc3}}/KijiTable.html) instances should only be opened once over the life of an +application. ([`EntityIdFactory`]({{site.api_schema_rc3}}/EntityIdFactory.html)s should also be reused). [`KijiTablePool`]({{site.api_schema_rc3}}/KijiTablePool.html) can be used to maintain a +pool of opened [`KijiTable`]({{site.api_schema_rc3}}/KijiTable.html) objects for reuse. To initially open a [`KijiTable`]({{site.api_schema_rc3}}/KijiTable.html): + +{% highlight java %} +Configuration conf = HBaseConfiguration.create(); +KijiConfiguration kijiConf = new KijiConfiguration(conf, "your-kiji-instance-name"); +Kiji kiji = Kiji.open(kijiConf); +KijiTable table = kiji.openTable("the-table-name"); +{% endhighlight %} + +To read from an existing [`KijiTable`]({{site.api_schema_rc3}}/KijiTable.html) instance, create a [`KijiDataRequest`]({{site.api_schema_rc3}}/KijiDataRequest.html) specifying the columns of data to +return. Then, query for the desired [`EntityId`]({{site.api_schema_rc3}}/EntityId.html), using a [[`KijiTableReader`]({{site.api_schema_rc3}}/KijiTableReader.html)]({{site.api_schema_rc3}}/KijiTableReader.html). You can get a [`KijiTableReader`]({{site.api_schema_rc3}}/KijiTableReader.html) for a [`KijiTable`]({{site.api_schema_rc3}}/KijiTable.html) using the [`openTableReader()`]({{site.api_schema_rc3}}/KijiTable.html#openTableReader%28%29) method. For example: + +{% highlight java %} +KijiTableReader reader = table.openTableReader(); + +// Select which columns you want to read. +KijiDataRequest dataRequest = new KijiDataRequest() + .addColumn(new KijiDataRequest.Column("your-family", "your-qualifier")); + +// Try to reuse EntityIds when possible. +// If a need for this entityId comes up again, reuse +// this same entityId object. +EntityId entityId = table.getEntityId("your-row"); +KijiRowData rowData = reader.get(entityId, dataRequest); + +// Make sure to close the reader once you're finished. +reader.close(); +{% endhighlight %} + +The [[`KijiTableReader`]({{site.api_schema_rc3}}/KijiTableReader.html)]({{site.api_schema_rc3}}/KijiTableReader.html) also implements a `bulkGet(...)` method for retrieving data for a list +of [`EntityId`]({{site.api_schema_rc3}}/EntityId.html)s. This is more efficient than a series of calls to `get(...)` because it uses a single +RPC instead of one for each get. + +## Modifying Data + +The [`KijiTableWriter`]({{site.api_schema_rc3}}/KijiTableWriter.html) class provides a `put(...)` method to write/update cells to a Kiji table. The +cell is addressed by its entity ID, column family, column qualifier, and timestamp. You can get a [`KijiTableWriter`]({{site.api_schema_rc3}}/KijiTableWriter.html) for a [`KijiTable`]({{site.api_schema_rc3}}/KijiTable.html) using the [`openTableWriter()`]({{site.api_schema_rc3}}/KijiTable.html#openTableWriter%28%29) method. + +{% highlight java %} +KijiTableWriter writer = table.openTableWriter(); + +long timestamp = System.currentTimeMillis(); +writer.put(table.getEntityId("your-row"), "your-family", "your-qualifier", timestamp, + "your-string-value"); +writer.flush(); +writer.close(); +{% endhighlight %} + +## Counters + +Incrementing a counter value stored in a Kiji cell would normally require a +"read-modify-write" transaction using a client-side row lock. Since row +locks can cause contention, Kiji exposes a feature of HBase to do this more +efficiently by pushing the work to the server side. To increment a counter value in +a Kiji cell, the column must be declared with a schema of type +"counter". See [Managing Data]({{site.userguide_schema_rc3}}/managing-data#layouts) +for details on how to declare a counter in your table layout. + +The [`KijiTableWriter`]({{site.api_schema_rc3}}/KijiTableWriter.html) class provides methods for incrementing +counter values. Non-counter columns can not be incremented, and counter columns +support only the increment operation. In other words, attempting to increment a +column value that is not declared to be a counter will throw an exception. Likewise, +attempting to `put(...)` a value into a column that is declared +to be a counter will also throw an exception. The `setCounter(...)` method should be used when +setting a counter value. + +{% highlight java %} +KijiTableWriter writer = table.openTableWriter(); + +// Incrementing a counter type column by 1. +// The column represented by counter-type-qualifier must +// of type counter otherwise an exception will be thrown. +writer.increment(table.getEntityId("your-row"), "your-family", "counter-type-qualifier", 1); + +writer.flush(); +writer.close(); +{% endhighlight %} + +## MapReduce + +The [`KijiTableInputFormat`]({{site.api_schema_rc3}}/mapreduce/KijiTableInputFormat.html) provides the necessary functionality to read from a Kiji table in a +MapReduce job. To configure a job to read from a Kiji table, use [`KijiTableInputFormat`]({{site.api_schema_rc3}}/mapreduce/KijiTableInputFormat.html)'s +static `setOptions` method. For example: + +{% highlight java %} +Configuration conf = HBaseConfiguration.create(); +Job job = new Job(conf); + +// * Setup jars to ship to the hadoop cluster. +job.setJarByClass(YourClassHere.class); +GenericTableMapReduceUtil.addAllDependencyJars(job); +DistributedCacheJars.addJarsToDistributedCache(job, + new File(System.getenv("KIJI_HOME"), "lib")); +job.setUserClassesTakesPrecedence(true); +// * + +KijiDataRequest request = new KijiDataRequest() + .addColumn(new KijiDataRequest.Column("your-family", "your-qualifier")); + +// Setup the InputFormat. +KijiTableInputFormat.setOptions(job, "your-kiji-instance-name", "the-table-name", request); +job.setInputFormatClass(KijiTableInputFormat.class); +{% endhighlight %} +The code contained within "// \*" is responsible for shipping Kiji resources to the DistributedCache. +This is so that all nodes within your hadoop cluster will have access to Kiji dependencies. + +[`KijiTableInputFormat`]({{site.api_schema_rc3}}/mapreduce/KijiTableInputFormat.html) outputs keys of type [`EntityId`]({{site.api_schema_rc3}}/EntityId.html) and values of type [`KijiRowData`]({{site.api_schema_rc3}}/KijiRowData.html). This +data can be accessed from within a mapper: + +{% highlight java %} +@Override +public void map(EntityId entityId, KijiRowData row, Context context) { + // ... +} +{% endhighlight %} + +To write to a Kiji table from a MapReduce job, you should use +[`KijiTableWriter`]({{site.api_schema_rc3}}/KijiTableWriter.html) as before. You should also set +your OutputFormat class to `NullOutputFormat`, so MapReduce doesn't expect to create +a directory full of text files on your behalf. + +To configure a job to write to a Kiji table, refer to the following example: + +{% highlight java %} +Configuration conf = HBaseConfiguration.create(); +Job job = new Job(conf); + +// Setup jars to ship to the hadoop cluster. +job.setJarByClass(YourClassHere.class); +GenericTableMapReduceUtil.addAllDependencyJars(job); +DistributedCacheJars.addJarsToDistributedCache(job, + new File(System.getenv("KIJI_HOME"), "lib")); +job.setUserClassesTakesPrecedence(true); + +// Setup the OutputFormat. +job.setOutputKeyClass(NullWritable.class); +job.setOutputValueClass(NullWritable.class); +job.setOutputFormatClass(NullOutputFormat.class); +{% endhighlight %} + +And then, from within a Mapper: + +{% highlight java %} +public class MyMapper extends Mapper { + private KijiTableWriter writer; + private Kiji kiji; + private KijiTable table; + + @Override + public void setup(Context context) { + // Open a KijiTable for generating EntityIds. + kiji = Kiji.open("your-kiji-instance-name"); + table = kiji.openTable("the-table-name"); + + // Create a KijiTableWriter that writes to a MapReduce context. + writer = table.openTableWriter(); + } + + @Override + public void map(LongWritable key, Text value, Context context) { + // ... + + writer.put(table.getEntityId("your-row"), "your-family, "your-qualifier", value.toString()); + } + + @Override + public void cleanup(Context context) { + writer.close(); + kiji.close(); + table.close(); + } +} +{% endhighlight %} diff --git a/_posts/userguides/schema/1.0.0-rc3/2012-01-01-data-model.md b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-data-model.md new file mode 100644 index 00000000..b5cc53b9 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-data-model.md @@ -0,0 +1,54 @@ +--- +layout: post +title: Data Model +categories: [userguides, schema, 1.0.0-rc3] +tags : [schema-ug] +order : 2 +version: 1.0.0-rc3 +description: KijiSchema's underlying data model. +--- + +KijiSchema’s data model is an extension of HBase’s columnar storage +model. Like HBase, KijiSchema’s tables contain many rows; each row +contains many columns. A given *cell* identified by a row and column can +hold many different timestamped values, representing the changing values +of the cell over time. Columns are grouped together into column +*families*, which provide namespacing for columns that store related +data. Families are grouped into *locality groups*, which help store +related families physically close to one another. + +> What Kiji calls a "locality group", HBase calls a "family". The Kiji +> column "family" allows you to choose the logical grouping and namespace +> of columns separately from the physical configuration of how the data is stored. + +As in HBase, rows in Kiji tables can have an arbitrary number of +columns. Individual rows may have hundreds or thousands (or more) +columns. Different rows may not necessarily have the same set of +columns. + +Unlike HBase, each cell in a Kiji table has a schema associated with it. +Schemas in KijiSchema are versioned. The schema and layout system is +described in greater detail in [Managing Data]({{site.userguide_schema_rc3}}/managing-data) + +### Entity-Centric Data Model +KijiSchema’s data model is *entity-centric*. Each row typically holds +information about a single *entity* in your information scheme. As an +example, a consumer e-commerce web site may have a row representing each +user of their site. The entity-centric data model enables easier analysis +of individual entities. For example, to recommend products to a user, +information such as the user’s past purchases, previously viewed items, +search queries, etc. all need to be brought together. The entity-centric +model stores all of these attributes of the user in the same row, +allowing for efficient access to relevant information. + +The entity-centric data model stands in comparison to a more typical +log-based approach to data collection. Many MapReduce systems import log +files for analysis. Logs are *action-centric*; each action performed by +a user (adding an item to a shopping cart, checking out, performing a +search, viewing a product) generates a new log entry. Collecting all the +data required for a per-user analysis thus requires a scan of many logs. +The entity-centric model is a “pivoted” form of this same information. +By pivoting the information as the data is loaded into KijiSchema, later +analysis can be run more efficiently, either in a MapReduce job +operating over all users, or in a more narrowly-targeted fashion if +individual rows require further computation. diff --git a/_posts/userguides/schema/1.0.0-rc3/2012-01-01-faq.md b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-faq.md new file mode 100644 index 00000000..b1999d09 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-faq.md @@ -0,0 +1,93 @@ +--- +layout: post +title: FAQ +categories: [userguides, schema, 1.0.0-rc3] +tags : [schema-ug] +version: 1.0.0-rc3 +order : 8 +description: A collection of commonly asked questions and answers. +--- + +## What license is KijiSchema under? + +KijiSchema is under the Apache License, Version 2.0 + +## How do I add Kiji and its dependencies to my application's classpath? + +Like `hadoop`, the `kiji` binary supports a `jar` operation. If your program is +packaged as a single jar and you want to run it with Kiji on the classpath, you +can run: + +{% highlight bash %} +$ kiji jar myapp.jar com.myorg.MyApp [args...] +{% endhighlight %} + +If your application constructs a more complex classpath, then you can also add +Kiji to your application's classpath explicitly. Like `hadoop` and `hbase`, the +`kiji` binary has a `classpath` command which will print a string that you can +use directly in your `$CLASSPATH` environment variable or on the `java` command +line as the `-cp` option. For example: + +{% highlight bash %} +$ java -cp myapp.jar:`kiji classpath` com.myorg.MyApp +{% endhighlight %} + +## I'm confident that I'm writing data to my Kiji table correctly. Why don't I see the new cells when I try to read them back? + +Check the retention policy for the cells in the locality group you are writing +to. The locality groups of your Kiji table are configured in your table's layout. +See [Managing Data]({{site.userguide_schema_rc3}}/managing-data#layouts) for details. + +In particular, check to make sure the timestamps of the new cells you are +writing are in milliseconds, and that they fall within the bounds of your +locality group's `ttl_seconds` setting. + +## How do I specify the schema of a column in my Kiji table? + +Kiji uses Avro for data type definitions and serialization within cells of Kiji +tables. Avro can define simple types like `"int"` and `"string"` as well as +complex record types, composed of scalars or other records, arrays, maps, etc. +Every column (or map-type family) in Kiji has a type (or «schema» in Avro +parlance) associated with it. + +For primitives types like, eg. `"int"`, use the following in your column layout +descriptor: + +{% highlight js %} +column_schema: {type: "INLINE", value = '"int"'} +{% endhighlight %} + +For complex record types, you may instead specify a generated record class: +{% highlight js %} +column_schema: {type: "CLASS", value = "org.package.GeneratedRecordClass"} +{% endhighlight %} + +You can write Avro schemas `.avsc` or `.avdl` files. These can be compiled into +Java classes that represent the record type. This makes working with these +objects easier in your mapper and reducers. For complete information on Avro, +visit http://avro.apache.org. + +See [Managing Data]({{site.userguide_schema_rc3}}/managing-data#layouts) for more +details on Kiji cell schemas. + +## How does data in Kiji map to Java types? + +Kiji uses Avro for data type management and serialization. Each cell of typed +data has an associated Avro schema. When reading or writing data from Kiji, the +Java type must be compatible with the Avro schema. For example, if a Kiji +column has the Avro schema `"string"`, data read from cells of the column will +implement the Java CharSequence interface. For +record schemas that have been compiled into Java classes using the Avro +compiler, the Java type corresponding to the schema is the compiled class. + +The full list of mappings between Avro schemas and Java types are documented in +the Avro Java API documentation. See the package documentation for +org.apache.avro.specific +and +org.apache.avro.generic. + +Are there restrictions on the characters I use in table names, family names, and +column names? Yes. All table names, column family names, and column qualifier +names may only contain numbers, letters and underscores +(`[A-Za-z_][A-Za-z0-9_]*`). However, the qualifiers of a map-type column family +may contain any printable characters. diff --git a/_posts/userguides/schema/1.0.0-rc3/2012-01-01-for-administrators.md b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-for-administrators.md new file mode 100644 index 00000000..2e9b8a09 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-for-administrators.md @@ -0,0 +1,158 @@ +--- +layout: post +title: For Administrators +categories: [userguides, schema, 1.0.0-rc3] +tags : [schema-ug] +version: 1.0.0-rc3 +order : 5 +description: Installation and maintenance of kiji-schema. +--- + +In this chapter, you will learn how to install and configure all aspects +of the KijiSchema system. + +## Installation Guide + +Kiji has been tested on GNU/Linux (Ubuntu 12.04, 12.10 and CentOS-6.3) +and Mac OS X (10.8.x, 10.7.x, 10.6.x). + +Kiji is a Java-based system. To run Kiji applications, you will need to +[download the Oracle Java JRE](http://www.oracle.com/technetwork/java/javase/downloads/index.html). +To develop Kiji applications, you will +need the Oracle Java JDK. We have tested this system with the Oracle +Java “Hotspot” JVM, version 6. Other JVMs are not supported at this +time. If you are running OS X, this is installed by default. + +Kiji is built on top of Hadoop and HBase. Our system depends on +[Cloudera's Distribution including Apache Hadoop](https://ccp.cloudera.com/display/SUPPORT/Downloads), version 4 (CDH4). +If you downloaded the BentoBox, a zero-configuration development/test +cluster is included in the package. If you downloaded KijiSchema, you +will need to install and configure Hadoop and HBase separately. + +### Installing and Configuring Kiji Clients + +After downloading either the BentoBox +(`kiji-bento-version-release.tar.gz`) or KijiSchema +(`kiji-schema-version-release.tar.gz`), unzip the archive with the +command `tar vzxf filename`. This will create to a directory named +`kiji-bento-version/` or `kiji-schema-version/`. + +For convenience, `$KIJI_HOME` should be set to this directory. For +example: + +{% highlight bash %} +$ export KIJI_HOME=/path/to/kiji-bento-(version) +{% endhighlight %} + +You should edit your `.bashrc` file to contain this line so that it's +incorporated in your environment for future bash sessions. + +If you're using the BentoBox edition, you can set up your environment as +follows: + +{% highlight bash %} +$ source $KIJI_HOME/bin/kiji-env.sh +$ bento start +{% endhighlight %} + +This starts the bento mini cluster and updates your environment variables +to use it. After a few seconds you should be able to view the status +page of your own mini HBase cluster at [http://localhost:60010/](http://localhost:60010/). (If +you don't see it right away, wait 10 seconds and reload the page.) +You're now ready to proceed with installing Kiji onto your cluster. + +If you installed only KijiSchema (not the BentoBox), you should instead +set `$HADOOP_HOME` and `$HBASE_HOME` and make sure the Hadoop HDFS and +HBase services are running. + +For help configuring CDH, see Cloudera's CDH4 Installation Guide. + +## Installing Kiji System Tables + +Kiji will manage tables for you on top of your HBase cluster. Each Kiji +table corresponds to a physical HBase table. There are also a number of +system tables that hold metadata maintained by Kiji itself. Before you +can use Kiji, you must run its install command and create these system +tables. + +Issue the following command from your Kiji release directory to install +a Kiji instance with the name `default`: + +{% highlight bash %} +$ bin/kiji install +{% endhighlight %} + +You should see output like the following: + + Creating kiji instance: kiji://localhost:2181/default/ + Creating meta tables for kiji instance in hbase... + 12/11/06 19:48:44 INFO org.kiji.schema.KijiInstaller: Installing a kiji instance named 'default'... + 12/11/06 19:48:50 INFO org.kiji.schema.KijiInstaller: Installed kiji 'default' + Successfully created kiji instance: kiji://localhost:2181/default/ + +Now you can create some tables in the DDL `schema-shell`, explore the Phonebook +`example`, and get started +[building a Maven project](http://www.kiji.org/get-started-with-maven) with +Kiji. See the +[quickstart guide](http://www.kiji.org/getstarted/#Quick_Start_Guide) to get +acquainted with the tools. + +## Maintenance Guide + +Due to the fault-tolerant nature of Hadoop and HBase, your Kiji instance +should not require much on-going maintenance. The following list of +recommended practices describe what maintenance should be performed to +ensure uninterrupted operation. + ++ Remove old logs - If log files fill a disk, Hadoop and HBase services may be + disrupted. Make sure to archive or delete old log files in `$HADOOP_HOME/logs` + and `$HBASE_HOME/logs` on a regular basis. + ++ Flush KijiSchema metadata tables - KijiSchema metadata tables are not frequently + updated. When an update happens, it is only recorded in the write-ahead logs + for the table. Periodically, you should run `bin/kiji flush-table --meta` to + flush metadata tables. This should be scheduled to run during a period of + low activity, nightly or weekly. + +## Troubleshooting Guide + +### Missing HBase Regions + +If HBase shuts down incorrectly or HDFS issues cause data loss, HBase's own +metadata tables `-ROOT-` and `.META.` may have inconsistent data. You can verify +that your HBase metadata tables are in good order by running `hbase hbck`. + +If `hbase hbck` prints `Status: INCONSISTENT`, +the advice in this section may help you restore functionality. + +Some problems can be fixed by running `hbase hbck -fix`. +This should be your first attempt. + +One particular kind of issue is a "hole" in the region chain for a table. Each +row stored in a table is assigned a region based on its row key. Each region is +responsible for a slice of the row key space. There should be no gaps between +these slices. If you run `hbase hbck -details`, it will print an error similar +to the following if it detects a hole in the region chain: + +{% highlight bash %} +$ hbase hbck -details +... + +Chain of regions in table kiji..table.tablename is broken; edges does not contain key +Table kiji..table.tablename is inconsistent. +... +Status: INCONSISTENT +{% endhighlight %} + +If the files for a missing region are present in HDFS, then no data has been +lost. HBase has simply lost track of the metadata for the region. The +following command can be used to scan your HBase root directory in HDFS for +region data, and add any regions back to tables that are missing from the HBase +metadata: + +{% highlight bash %} +$ hbase hbck -repairHoles +{% endhighlight %} + +See [hbck in depth](http://hbase.apache.org/book/hbck.in.depth.html) for more +details. diff --git a/_posts/userguides/schema/1.0.0-rc3/2012-01-01-kiji-schema-overview.md b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-kiji-schema-overview.md new file mode 100644 index 00000000..d0cf1f0c --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-kiji-schema-overview.md @@ -0,0 +1,29 @@ +--- +layout: post +title: What is KijiSchema? +categories: [userguides, schema, 1.0.0-rc3] +tags : [schema-ug] +version: 1.0.0-rc3 +order : 1 +description: Overview. +--- + +## What is KijiSchema? + +KijiSchema provides a simple Java API and command line interface for +importing, managing and retrieving data from HBase. + + +## Key Features + +- Set-up HBase layouts using user-friendly tools including a DDL +- Implement HBase best practices in table management +- Use evolving Avro schema management to serialize complex data +- Perform both short-request and batch processing on data in HBase +- Import data from HDFS into structured HBase tables + +KijiSchema promotes the use of entity-centric data modeling, where +all information about a given entity, including both dimensional and +transaction data, is encoded within the same row. This approach is +particularly valuable for user-based analytics such as targeting, +recommendations, and personalization. diff --git a/_posts/userguides/schema/1.0.0-rc3/2012-01-01-managing-data.md b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-managing-data.md new file mode 100644 index 00000000..d2821c50 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-managing-data.md @@ -0,0 +1,484 @@ +--- +layout: post +title: Managing Data +categories: [userguides, schema, 1.0.0-rc3] +tags: [schema-ug] +version: 1.0.0-rc3 +order: 3 +description: How to manage data with KijiSchema. +--- + +Every table in Kiji has an associated layout. The layout of a table contains a +baseline schema definition which can be used to access the majority of the +information in the table without further special knowledge. Each table's layout +describes the set of columns which can exist in any given row. For each column, +a minimal "reader" schema is specified; this provides multiple team members +working with a large data set with a common data dictionary; it also enables +validation of cell data against a reference schema. The layout also describes +some additional properties of the table; these are discussed in this section as +well. + +Every data element in Kiji is stored in a Kiji cell, which is uniquely +identified by an entity ID, column name, and timestamp. The column name is itself +two components: a family name and a qualifier. As in HBase, these are written +`family:qualifier`. Data written to a Kiji cell is serialized to a byte array +according to an Avro schema. The writer schema used for the particular write +operation is stored alongside the cell data, so the input data can be +deserialized exactly by subsequent read requests. But this schema must be +compatible with the expected reader schema specified in the layout for the cell. + +A JSON layout descriptor is a specification for the locality groups, +columns, and data types that comprise a table, written as a JSON +document whose elements are described in the following subsections. We will +refer to the following example layout file throughout this section: + +{% highlight js %} +{ + name: "users", + description: "A bunch of made-up users", + version: "kiji-1.0", + keys_format: {encoding: "HASH"}, + locality_groups: [ { + name: "default", + description: "The default locality group", + in_memory: false, + max_versions: 1, + ttl_seconds: 7776000, + compression_type: "NONE", + families: [ { + name: "info", + description: "A bunch of fields", + columns: [ { + name: "id", + description: "user id hash", + column_schema: {type: "INLINE", value: '"string"'} + }, { + name: "name", + description: "The person's name", + column_schema: {type: "INLINE", value: '"string"'} + }, { + name: "email", + description: "The person's email", + column_schema: {type: "INLINE", value: '"string"'} + } ] + }, { + name: "searches", + description: "The recent search queries the user has made", + map_schema: {type: "CLASS", value: "com.search.avro.Search"} + } ] + } ] +} +{% endhighlight %} + +The schema of the table layout descriptor is available in the KijiSchema source tree at +[Layout.avdl](#ref.table_layout_desc). + +### Overall structure of a table layout + +At the top-level, a table contains: + +* the table name and description; +* a description of the row keys encoding; +* the table locality groups. + +Each locality group has: + +* a primary name, unique within the table, a description and optionally some name aliases; +* whether the data is to be stored in memory or on disk; +* data retention lifetime; +* maximum number of versions to keep; +* type of compression; +* column families stored in this locality group. + +Each column family has: + +* a primary name, unique within the table, a description and optionally some name aliases; +* for map-type families, the Avro schema of the cell values; +* for group-type families, the collection of columns in the group. + +Each column in a group-type family has: + +* a primary name, unique within the family, a description and optionally some name aliases; +* an Avro schema. + +All names must start with a letter and may only use letters, numbers, and underscores. + +### Group-type and map-type families + +In KijiSchema, there are two kinds of column families: + +* Group-type families define a fixed set of named columns. In the example + layout above, there is a single group-type family named `info`, containing + the columns `info:id`, `info:name`, and `info:email`, each with their own + Avro schema. Each row may contain any subset of these three columns, but may + not contain any additional columns. + +* Map-type families define a family where the cell column qualifiers are not + explicitly defined. In the example layout above, the map-type family named + `searches` may be used to store every search performed by a user, each with + their own column qualifier; cell columns would have names of the form + `searches:`; the contents of each cell might be a compound Avro + record containing the list of products returned by the query specified in the + cell's qualifier, as well as a boolean for each indicating whether the user + actually clicked that search result. A map-type column specifies a single Avro + schema for all its column. Note that the column qualifiers used in a map-type + family must be valid UTF-8 strings (rather than arbitrary byte arrays). + +### Kiji cell schema + +Within a table, Kiji cells are encoded according to their declared schema. +There are three types of Kiji cell schemas, specified using the `type` field: + +* `INLINE` - field `value` contains an the JSON representation of an Avro + schema. In the earlier example, all three columns contain a single Avro + `"string"` field, but a column could also contain an array, record or other + complex Avro data type. +* `CLASS` - field `value` contains the fully-qualified name of a Java class + mapped by an Avro data type, like an implementation of `SpecificRecord`. The + user must ensure that the class is available on the classpath of any Kiji + tools accessing the cell. +* `COUNTER` - cells are encoded as long integers and support atomic increment + or decrement operations. + +The schema of cells in a group-type family is specified by the `column_schema` +field (see columns `info:id`, `info:name`, `info:email` in the example layout). +The schema of cells in a map-type family is specified by the `map_schema` field +(see map-type family `searches` in the example layout). + +### Locality groups + +All families within a locality group are stored together in HBase. It is +usually a good idea to put families that are often read and written together +into the same locality group. + +Locality groups control the physical properties of the underlying storage: + +* `in_memory` - when this boolean flag is set, Kiji configures HBase to keep as + much of this locality group in memory as possible. +* `ttl_seconds` - cells' time to live : cells older that this number of seconds + may be automatically discarded. +* `max_versions` - maximum number of timestamped versions of cells to retain : + as new versions of a cell are written, older versions are deleted to not + exceed this limit. +* `compression` - one of `NONE`, `GZ`, `LZO` or `SNAPPY`. + +### Names + +Locality groups, families, and columns are identified by their primary names. +The primary name may be changed with the help of the `renamed_from` field. +For example, to rename the `default` locality group into `new_name`, one may +update the table layout with a locality group descriptor as follows: + +{% highlight js %} +locality_groups: [ { + name: "new_name", + renamed_from: "default", + ... +} ] +{% endhighlight %} + +Table names may not be changed. + + +### Layout record descriptor + +For reference, the Avro descriptor for table layout records is defined in +`src/main/avro/Layout.avdl` within the kiji-schema git project as follows: + +{% highlight java %} +/** + * (c) Copyright 2012 WibiData, Inc. + * + * See the NOTICE file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Kiji table layout. + +@namespace("org.kiji.schema.avro") +protocol KijiTableLayoutRecords { + + /** Type of compression for the data within a locality group. */ + enum CompressionType { + NONE, + GZ, + LZO, + SNAPPY + } + + /** Type of schema for column data. */ + enum SchemaType { + /** Column contains data encoded as specified inline. */ + INLINE, + + /** Column contains Avro records with the specified class name. */ + CLASS, + + /** Column contains counters. */ + COUNTER + } + + /** How schemas get encoded in cells. */ + enum SchemaStorage { + /** Data is prepended with the schema hash. */ + HASH, + + /** Data is prepended with the schema unique ID. */ + UID, + + /** Schema is immutable and not stored in the cell. */ + FINAL + } + + /** Schema of a Kiji cell. */ + record CellSchema { + /** Schema encoding in cells. Unused if type is COUNTER. */ + SchemaStorage storage = "HASH"; + + /** Type of schema. */ + SchemaType type; + + /** + * Schema value, whose interpretation depends on the schema type: + * - inline : immediate Avro schema description, eg. "string"; + * - class : Avro schema class name, eg. "org.kiji.avro.Node"; + * - counter : unused, must the empty. + */ + union { null, string } value = null; + } + + /** Column descriptor. */ + record ColumnDesc { + /** Column ID. Not visible to the user. 0 means unset. */ + int @internal("true") id = 0; + + /** Column primary name (A-Z, a-z, 0-9, -, _). */ + string name; + + /** Column name aliases. */ + array aliases = []; + + /** When false, the column is not visible or usable. */ + boolean enabled = true; + + /** User description of the column. */ + string description = ""; + + /** Schema for the cell values. */ + CellSchema column_schema; + + // Fields below are used to apply a diff against a reference family layout: + + /** When true, applying this layout deletes the column. */ + boolean @diff("true") delete = false; + + /** Reference primary name of the column, when renaming the column. */ + union { null, string } @diff("true") renamed_from = null; + } + + /** Descriptor for a group of columns. */ + record FamilyDesc { + /** Family ID. Not visible to the user. 0 means unset. */ + int @internal("true") id = 0; + + /** Column family primary name (A-Z, a-z, 0-9, -, _). */ + string name; + + /** Column family name aliases. */ + array aliases = []; + + /** When false, the family and its columns are not visible/usable. */ + boolean enabled = true; + + /** User description of the column family. */ + string description = ""; + + /** Cell schema for map-type families. Null for group-type families. */ + union { null, CellSchema } map_schema = null; + + /** Columns, for group-type families only. Empty for map-type families. */ + array columns = []; + + // Fields below are used to apply a diff against a reference family layout: + + /** When true, applying this layout deletes the family. */ + boolean @diff("true") delete = false; + + /** Reference primary name of the family, when renaming the family. */ + union { null, string } @diff("true") renamed_from = null; + } + + /** A group of Kiji column families stored together in a table. */ + record LocalityGroupDesc { + /** Locality group ID. Not visible to the user. 0 means unset. */ + int @internal("true") id = 0; + + /** Locality group primary name (A-Z, a-z, 0-9, -, _). */ + string name; + + /** Locality group name aliases. */ + array aliases = []; + + /** When false, the locality group and its families are not visible. */ + boolean enabled = true; + + /** User description of the locality group. */ + string description = ""; + + /** Reduce latency by forcing all data to be kept in memory. */ + boolean in_memory; + + /** Maximum number of the most recent cell versions to retain. */ + int max_versions; + + /** Length of time in seconds to retain cells. */ + int ttl_seconds; + + /** Data compression type. */ + CompressionType compression_type; + + /** Column family descriptors. */ + array families = []; + + // Fields below are used against a reference locality group layout: + + /** When true, applying this layout deletes the locality group. */ + boolean @diff("true") delete = false; + + /** Reference primary name of the locality group, when renaming. */ + union { null, string } @diff("true") renamed_from = null; + } + + + /** Hashing methods. */ + enum HashType { + /** MD5 hashing (16 bytes). */ + MD5 + } + + /** Row keys encoding. */ + enum RowKeyEncoding { + /** Row keys are managed by the user. */ + RAW, + + /** Row keys are hashed. */ + HASH, + + /** Row keys are prefixed by a hash. */ + HASH_PREFIX + } + + record RowKeyFormat { + /** Encoding of the row key. */ + RowKeyEncoding encoding; + + /** Type of hashing used, if any. */ + union { null, HashType } hash_type = null; + + /** + * Size of the hash, in bytes. + * - unused when encoding is RAW. + * - smaller than the hash size used for HASH or HASH_PREFIX. + */ + int hash_size = 0; + } + + /** Layout of a Kiji table. */ + record TableLayoutDesc { + /** Name of the table (A-Z, a-z, 0-9, -, _). */ + string name; + + /** User description of the table. */ + string description = ""; + + /** Whether row key hashing should be managed by Kiji. */ + RowKeyFormat keys_format; + + /** Locality groups in the table. */ + array locality_groups = []; + + /** Data layout version (eg. "kiji-1.0"). */ + string version; + + /** ID of the layout. */ + union { null, string } layout_id = null; + + /** Reference to the base layout this descriptor builds on. */ + union { null, string } reference_layout = null; + } + + // --------------------------------------------------------------------------- + // Backup records + + /** An MD5 hash. */ + fixed MD5Hash(16); + + /** An entry from the SchemaTable inside a metadata backup file. */ + record SchemaTableEntry { + /** Schema ID: positive integers only. */ + long id; + + /** 128 bits (16 bytes) hash of the schema JSON representation. */ + MD5Hash hash; + + /** JSON representation of the schema. */ + string avro_schema; + } + + /** Entry to backup a table layout update. */ + record TableLayoutBackupEntry { + /** Update timestamp, in ms. */ + long timestamp; + + /** + * Table layout update, as specified by the submitter/user. + * Except for the first one, the update builds on the previous layout. + */ + union { TableLayoutDesc, null } update = null; + + /** Effective table layout, after applying the update. */ + TableLayoutDesc layout; + } + + /** Table backup, ie. everything needed to restore a table. */ + record TableBackup { + /** Table name. */ + string name; + + /** Sequence of layouts, in order. */ + array layouts = []; + } + + /** Record that encapsulates all Kiji metadata, for backup purposes. */ + record MetadataBackup { + /** Layout version (eg. "kiji-1.0"). */ + string layout_version; + + /** Schema entries. */ + array schema_table = []; + + /** Map from table names to table backup records. */ + map meta_table = {}; + } + +} +{% endhighlight %} + + diff --git a/_posts/userguides/schema/1.0.0-rc3/2012-01-01-tool-reference.md b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-tool-reference.md new file mode 100644 index 00000000..03ba92aa --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc3/2012-01-01-tool-reference.md @@ -0,0 +1,368 @@ +--- +layout: post +title: Command-Line Tool Reference +categories: [userguides, schema, 1.0.0-rc3] +component: schema +version: 1.0.0-rc3 +tags : [schema-ug] +order : 7 +description: A reference of commands available for the schema command line tool. +--- + +Running kiji with no arguments will list all the available tools: + +{% highlight bash %} +$ kiji COMMAND [FLAG]... +{% endhighlight %} + +## Commands + +* `help` - Display this help message. +* `install` - [Install KijiSchema onto a running HBase instance](#ref.install) +* `uninstall` - [Uninstall KijiSchema from a running HBase instance](#ref.uninstall) +* `version` - Print the version of KijiSchema. +* `classpath` - Print the classpath used to build or run KijiSchema +* `jar` - [Run a main class from the specified jar](#ref.jar) + Use: `kiji jar [args...]` +* `ls` - [List, describe, or scan Kiji tables](#ref.ls) +* `create-table` - [Create a Kiji table](#ref.create-table) +* `delete` - [Delete a Kiji table, row, or cell](#ref.delete) +* `flush-table` - [Flush table write-ahead logs](#ref.flush-table) +* `layout` - [Manage table layouts](#ref.layout) +* `increment` - [Increment a counter cell](#ref.increment) +* `put` - [Set the value of a single cell](#ref.put) +* `synthesize-user-data` - [Synthesize user data into a table](#ref.synthdata) + +## Targeting a KijiSchema instance: Kiji URI + +Most commands accept an optional parameter `--kiji=` that specifies a +KijiSchema instance to interact with. +The format for this parameter is a URI generally formatted as: +`kiji://zookeeper_host:2181/kiji_instance_name`, and includes: + +* The address of the HBase instance KijiSchema has been installed on. + This is the address of the ZooKeeper quorum used by the HBase instance. + The default is `.env`, which tells KijiSchema to use the HBase instance + identified by the HBase configuration files in `$HBASE_HOME`. +* And the name of the KijiSchema instance. + The default KijiSchema instance name is `default`. + +The default value for this parameter is `--kiji=kiji://.env/default`, which +references the KijiSchema instance named "default" and installed on the HBase +instance identified in the HBase configuration files in `$HBASE_HOME`. + +The URI for KijiSchema instance named "the_instance" and installed on a mini +HBase cluster running locally on a laptop is +`--kiji=kiji://localhost:2181/the_instance`. + +## Installation: `install` + +The `kiji install` command will create the initial metadata tables +`kiji..meta`, `kiji..status`, +`kiji..schema_id` and `kiji..schema_hash` +required by the KijiSchema system. +This should be run once during initial setup of KijiSchema. + +A different HBase instance or KijiSchema instance name may be specified using the +[`--kiji` parameter](#ref.kiji_uri). + +## Removal: `uninstall` + +The `kiji uninstall` command removes an installed KijiSchema instance, and deletes +all the user tables it contains. +The KijiSchema instance to remove is specified through the +[`--kiji` parameter](#ref.kiji_uri). + +This command accepts an optional parameter: +* `--confirm` + - Must be set to perform the instance removal without interactive confirmation. + +## Listing Information: `ls` + +The `kiji ls` command is the basic tool used to explore a KijiSchema repository. +It can drill down into KijiSchema-based data sets at many levels. + +When run with `--instances`, this command lists the Kiji instances installed on the +HBase instance specified with `--kiji=` (by default, `kiji://.env`): + +{% highlight bash %} +$ kiji ls --instances +default +{% endhighlight %} + +When run with no arguments, this command lists the tables in the Kiji instance +specified with `--kiji=` (by default, `kiji://.env/default`): + +{% highlight bash %} +$ kiji ls +users +products +{% endhighlight %} + +The `ls` command can also be used to list the contents of a table. +`kiji ls --table=` displays the contents of a Kiji table. +Each record appears as a set of lines, set apart by blank lines. +Each cell appears on two lines: +the first line contains the row key (a hashed representation of a primary key), +a timestamp (expressed in milliseconds since the UNIX epoch), +and the cell name (`family:qualifier`). +The second line contains the string representation of the cell data itself. +For example, running `kiji ls --table=users` on a table generated with the `synthdata` +command (see [Generating Sample Data](#ref.synthdata)) displays rows like: + +{% highlight bash %} +$ kiji ls --table=users +\xA6t\xCEIm\xB7A\x88\x7F\xD1\xA9n\xB0\xEC\x16\xDB [1305851507300] info:name + Olga Jefferson +\xA6t\xCEIm\xB7A\x88\x7F\xD1\xA9n\xB0\xEC\x16\xDB [1305851507301] info:email + Olga.Jefferson@hotmail.com + +\xf8\x8f\xe2\xb2,E\x8b\xea\xd5\x08\xf8\x8a\xee`\x91y [1305851507425] info:name + Sidney Tijuana +\xf8\x8f\xe2\xb2,E\x8b\xea\xd5\x08\xf8\x8a\xee`\x91y [1305851507427] info:email + Sidney.Tijuana@hotmail.com +… +{% endhighlight %} + +Providing just the `--table` argument is not particularly useful; +you will typically want to restrict the set of data printed to the terminal. +The following options will do just that: + +* `--columns=family:qualifier,family:qualifier...` + - Display a subset of the available columns. `--columns=*` will include all columns. + +* `--start-row=row-key` and `--limit-row=row-key` + - Restrict the row range to print. + +* `--max-rows=` + - Display at most this many rows of data. + +* `--max-versions=` + - Display at most this many versions of each cell. + +* `--min-timestamp=` and `--max-timestamp=` + - Display only cells whose timestamps fall within the given range. + Timestamps are expressed in milliseconds since the Epoch. + +* `--entity-hash=` + - Display only cells from a single row; ignores `--start-row` and `--limit-row`. + The string argument is the hexadecimal representation of the pre-hashed row id. + +* `--entity-id=` + - Display only cells from a single row; ignores `--start-row` and `--limit-row`. + The string is the human-readable value representing the row id, encoded as UTF8. + +## Creating Tables: `create-table` + +The `kiji create-table` command creates a new +Kiji table. This is stored in an underlying HBase table with the name +`kiji..table.`. + +This command has two mandatory arguments: + +* `--table=` + - Name of the table to create. + It is an error for this table to already exist. +* `--layout=` + - Path to a file a JSON file containing the table layout specification, + as described in [Managing Data]({{site.userguide_schema_rc3}}/managing-data#layouts). + +The following arguments are optional: + +* `--kiji=` + - Address of the Kiji instance to interact with. + +* `--num-regions=` + - The number of initial regions to create in the table. + This may only be specified if the table uses row key hashing. + It may not be used in conjunction with `--split-key-file`. + +* `--split-key-file=` + - Path to a file containing the row keys to use as initial boundaries between regions. + This may only be specified if the table uses row key hashing. + It may not be used in conjunction with `--num-regions`. + + + +## Deleting tables, rows, and cells: `delete` + +The `delete` command will delete a KijiSchema +table, row, or cell, and drop all values which were in them. +This command has one mandatory argument: + +* `--table=` + - The name of the table from which to delete. If specified without --row, the entire table + will be deleted. + +And several optional arguments: + +* `--row=` + - The name of the row from which to delete values. If specified without --family, all + values in the row will be deleted. + +* `--family=` + - The name of the family from which to delete values. If specified without --qualifier, all + values in the row and family will be deleted. (requires a specified row) + +* `--qualifier=` + - The name of a column qualifier from which to delete values. If specified without a + timestamp or --most-recent, all values in the cell will be deleted. + (requires a specified family) + +* `--upto-timestamp=` + - The timestamp at or before which all values will be deleted. (requires a specified row) + +* `--exact-timestamp=` + - The timestamp at which to delete a value. + (requires a specified row, family, and qualifier) + +* `--most-recent` + - Set to delete the most recent value of a cell. + (requires a specified row, family, and qualifier) + +* `--confirm` + - Set to perform the deletions without interactive confirmation. + +## Flushing tables: `flush-table` +-------------------------------------------------------- + +The `flush-table` command will instruct HBase to +flush the contents of a table to HDFS. When HBase receives new data, it +is recorded in a write-ahead log (WAL). But this WAL is not merged with +existing table files until the table is flushed or compacted. This +happens more frequently if more data is written to a table. But you can +force data to be written to table files with this command. If a table is +not frequently updated, flushing the data with this command may improve +recovery time in the event that HBase experiences a failure. + +You must use one or both of the following arguments to specify what +to flush: + +* `--table=` + - Specifies the table name to flush. +* `--meta` + - If set, flushes KijiSchema metadata tables. + +It also accepts an optional `--kiji=` argument to +specify the address of the installed Kiji instance in which to find +the table to flush. + +You should only flush tables during a period of relative inactivity. +Flushing while a large number of operations are ongoing may adversely +affect performance. The flush operation is also asynchronous; the +command may return before the actual flush operation is complete. + +Managing layouts: `layout` +------------------------------------------------ + +The `kiji layout` command displays or modifies +the layout associated with a table. + +When run with `--table=`, this displays the current layout +associated with a given table: + +{% highlight bash %} +$ kiji layout --table=users +{ + name: "users", + description: "The user table", + keys_format : {encoding : "RAW"}, + locality_groups : [ + … + ], + layout_id : "3", +} +{% endhighlight %} + +When run with the `--do=set --layout=/path/to/layout.json` +argument, this sets the layout for a table to match the specified +layout JSON file. + +The `--dry-run` argument specifies that `--do=set` +should not actually update the layout; it simply prints out +a message stating whether or not the update would succeed (i.e., whether or not +the layout is valid) and what locality groups would be updated by the new layout. + +When run with the `--do=history --max-versions=`, this command dumps the most +recent versions of the table layout. + +Running an Application Jar with KijiSchema: `jar` +-------------------------------------------------------------------- + +If your application requires KijiSchema and its dependencies, you +can use the `kiji jar` command to launch your program's +main method with KijiSchema present on the classpath. + +This command requires two unlabeled arguments: the jar filename, and the +main class to run: + +{% highlight bash %} +$ kiji jar myapp.jar com.pkg.MyApp [args...] +{% endhighlight %} + +Incrementing counters: `increment` +--------------------------------------------------------------- + +The `kiji increment` command may be used to increment +(or decrement) a KijiSchema counter. + +The following arguments are required: + +* `--table=` - Target table +* `--column=family:qualifier` - Target column +* `--entity-hash=entity` - Target row id (the actual pre-hashed entity string) +* `--entity-id=entity` - Target row id (an unhashed, human-readable string) +* `--value=amount` - The value to increment by. + +Exactly one of `--entity-id` or `--entity-hash` must be used. + +Setting Individual Cells: `put` +-------------------------------------------------- + +To aid in the insertion of small data sets, debugging, and testing, the +`kiji put` command may be used to insert individual values in a Kiji table. + +The following arguments are required: + +* `--table=` - Target table +* `--column=family:qualifier` - Target column +* `--entity-hash=entity` - Target row id (the actual pre-hashed entity string) +* `--entity-id=entity` - Target row id (an unhashed, human-readable string) +* `--value=` - The value to insert. The value is specified as a + JSON string according to [the Avro JSON encoding specification](http://avro.apache.org/docs/current/spec.html#json_encoding) + +Exactly one of `--entity-id` or `--entity-hash` must be used. + +The following arguments are optional: + +* `--schema=Avro schema` - By default, KijiSchema will use the reader schema + attached to a column in its layout to decode the JSON and encode the binary + data for insertion in the table. This argument allows you to use an alternate + writer schema. +* `--timestamp=long` - Specifies a timestamp (in milliseconds since the Epoch) other than "now". +* `--kiji=` - Address of the Kiji instance to interact with. + +Generating Sample Data: `synthesize-user-data` +--------------------------------------------------------------------------- + +In the interest of enabling quick experimentation with KijiSchema, +the `kiji synthesize-user-data` tool will +generate a number of semi-random rows for you. + +The tool creates a set of rows which contain columns `info:id`, `info:name`, and +`info:email`; these are pseudo-randomly generated first and last names, with +plausible email addresses with gmail, hotmail, etc. accounts based on the +generated names. These columns can be used with mappers and reducers. + +To use this tool, first create a table with the layout in +`${KIJI_HOME}/examples/synthdata-layout.xml`. +Then invoke `bin/kiji synthesize-user-data --table=`. +This will generate 100 rows of data. +You can create a different number of records by specifying +`--num-users=`. + +You can specify a different list of names with the `--name-dict=filename` argument. + +It also accepts an optional `--kiji=` argument to specify the address of the Kiji instance. diff --git a/_posts/userguides/schema/1.0.0-rc4/2011-12-27-schema-shell-ddl-ref.md b/_posts/userguides/schema/1.0.0-rc4/2011-12-27-schema-shell-ddl-ref.md new file mode 100644 index 00000000..a58ab02d --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc4/2011-12-27-schema-shell-ddl-ref.md @@ -0,0 +1,340 @@ +--- +layout: post +title: DDL Shell Reference +id: userguide/ddl-ref +categories: [userguides, schema, 1.0.0-rc4] +component: schema +version: 1.0.0-rc4 +order : 6 +tags: [schema-ug] +description: An introduction to the DDL that manipulates table layouts. +--- + +The KijiSchema DDL Shell implements a _data definition language_ (DDL) that +allows you to create, modify, inspect, and delete kiji table layouts. A +_table layout_ is the KijiSchema data dictionary element that defines a set +of column families, qualifiers, etc. and associates these columns with +Avro schemas. + +With this shell, you can quickly create tables to use in your KijiSchema +applications. You can add, drop, or modify columns quickly too. These +modifications can be performed without any downtime associated with the +table; the only exception is that modifying a locality group causes +the table to be taken offline while applying changes. But locality group +changes should be rare in running applications. + +Finally, this shell allows you to quickly understand the layout of an +existing table. The `DESCRIBE` command will pretty-print the layout of a +table, eliminating the guesswork as to where your coworker has stashed an +important piece of data. + + +## Running + +* Export `$KIJI_HOME` to point to your KijiSchema installation. +* Run `bin/kiji-schema-shell` + +This command takes a few options (e.g., to load a script out of a file). +Run `bin/kiji-schema-shell --help` for all the available options. + +### An Example + +The following commands could be entered at the DDL shell prompt to create +a table, add another column family, describe its layout, and then remove the +table. + + CREATE TABLE foo WITH DESCRIPTION 'some data' + ROW KEY FORMAT HASHED + WITH LOCALITY GROUP default WITH DESCRIPTION 'main storage' ( + MAXVERSIONS = INFINITY, + TTL = FOREVER, + INMEMORY = false, + COMPRESSED WITH GZIP, + FAMILY info WITH DESCRIPTION 'basic information' ( + name "string" WITH DESCRIPTION 'The user\'s name', + email "string", + age "int"), + MAP TYPE FAMILY integers COUNTER WITH DESCRIPTION 'metric tracking data' + ); + + ALTER TABLE foo ADD MAP TYPE FAMILY strings { "type" : "string" } + WITH DESCRIPTION 'ad-hoc string data' TO LOCALITY GROUP default; + + SHOW TABLES; + DESCRIBE EXTENDED foo; + DROP TABLE foo; + SHOW TABLES; + + +## The Layout Definition Language + +This section defines the layout definition language. + +### General Language Notes and Style + +All statements in the language must end with a semi-colon character. +Statements may wrap across multiple lines. + +Keywords are case insensitive. The following are equivalent: + + schema> DESCRIBE foo; + schema> describe foo; + +Names for tables and columns are case sensitive. The following are _different_: + + schema> DESCRIBE FOO; + schema> DESCRIBE foo; + +Lines beginning with '#' are treated as comments and ignored. + + schema> # this is a comment line and will be ignored. + schema> # the next line will not be ignored. + schema> show tables; + + +Table and column names can be provided either as identifiers or +`'in single quotes'`. The following are equivalent: + + schema> DESCRIBE foo; + schema> DESCRIBE 'foo'; + +If you have a table whose name is a keyword (e.g., "SHOW" or "tables"), +you can wrap them `'in single quotes'` to protect them. e.g.: + + schema> CREATE TABLE 'WITH' WITH DESCRIPTION 'A table with a silly name'; + +By contrast, strings used to specify table or column descriptions, or other +string "values" must always be single quoted. + +Quoted strings may contain `'internally \'escaped quotes\', as well as escaped slashes:\\'`. + +The escape sequences `'\t'` and `'\n'` work as you'd hope, representing a tab +character and a newline character respectively. Everything else escapes to itself. + +`INFINITY` and `FOREVER` are both synonyms for Int.MaxValue wherever an integer +may be specified. + +Avro schemas are specified with the Avro JSON schema syntax. JSON uses "double quotes" +to enclose strings; this is respected in this shell as well. JSON can be entered directly +into the command. For example: + + ALTER TABLE foo ADD MAP TYPE FAMILY strings { "type" : "string" } + WITH DESCRIPTION 'ad-hoc string data' TO LOCALITY GROUP default; + + +For more information, see +[The Avro 1.7 specification](http://avro.apache.org/docs/1.7.2/spec.html). + +## Layout Definition Language Statements + +### Working with Kiji Instances + +A kiji instance is a collection of kiji tables. You can list the available +instances: + + schema> SHOW INSTANCES; + +The currently selected instance will have an asterisk next to it. + +You can also select an instance: + + schema> USE foo; + +The default instance is named `default`; in addition to `USE default;`, +you can also select that with the more readable (and more verbose) syntax: + + schema> USE DEFAULT INSTANCE; + + +### Listing and Describing Tables + +You can list the available tables with: + + schema> SHOW TABLES; + +You can pretty-print the layout of a table with: + + schema> DESCRIBE foo; + +This will not print locality group information or hidden columns. To include +this information, use: + + schema> DESCRIBE EXTENDED foo; + + +### Creating Tables + +This shell will allow you to create tables and define their locality groups, +column families, and column qualifiers. Each map-type family or qualifier in a +group-type family has a schema associated with it. + +#### Schemas + +There are three possible kinds of schemas that can be associated with a +column: + +* JSON schemas are declared inline. e.g. `"string"` or `{ "type" : "int" }` +* Avro SpecificRecord class names are declared as `CLASS com.example.FooRecord` +* A special type `COUNTER` can define an HBase counter column that can be + atomically incremented. + +#### Names + +Table, locality group, family, and column names must have the following +format: + + [a-zA-Z_][a-zA-Z0-9_]* + +The following are legal names: + + foo + meep123 + wom_bat + _aard_vark + users2 + +The following are not allowed: + + 42 + 2users + some-dashed-name + this$uses!special(characters_) + +#### `CREATE TABLE` Syntax + + CREATE TABLE t [WITH DESCRIPTION 'd'] + [ROW KEY FORMAT { HASHED | RAW | HASH PREFIXED(int) }] + WITH locality_group [ , locality_group ...]*; + +This creates a table, sets its description, defines how row keys are formatted, +and defines a list of locality groups. + +Row keys may be literal string values (`ROW KEY FORMAT RAW`), or they may be +the hash of the string value (`ROW KEY FORMAT HASHED`). They may also be a +composite of the two (`ROW KEY FORMAT HASH PREFIXED(n)`), where `n` is an +integer between 1 and 16 specifying the number of hash bytes to retain as +the prefix size (e.g: `ROW KEY FORMAT HASH PREFIXED(2)` will use raw keys +with two bytes of the key hash as a prefix.) If no `ROW KEY FORMAT` clause is +given, it is assumed to be `HASHED`. + +Each locality group is defined as follows: + + LOCALITY GROUP foo [WITH DESCRIPTION 'd'] [ ( property, property... ) ] + +This defines a locality group named `foo` with one or more properties set. The +valid properties are: + + MAXVERSIONS = int + INMEMORY = bool + TTL = int + COMPRESSED WITH (GZIP | LZO | SNAPPY | NONE) + +Remember that you can use `INFINITY` and `FOREVER` when specifying integer +values for `MAXVERSIONS` and `TTL` to make your statements more readable. + +You can also specify map- and group-type column families in the properties +list: + + [GROUP TYPE] FAMILY f [WITH DESCRIPTION 'd'] [( column, column... )] + MAP TYPE FAMILY f [WITH SCHEMA] schema [WITH DESCRIPTION 'd'] + + +Within a group-type family, individual column qualifiers are specified with: + + [COLUMN] foo [WITH SCHEMA] schema [WITH DESCRIPTION 'd'] + + +#### `CREATE TABLE` Example + +The following is an example that puts together all of the different syntax +elements described in the previous section: + + schema> CREATE TABLE foo WITH DESCRIPTION 'some data' + -> ROW KEY FORMAT HASHED + -> WITH LOCALITY GROUP default WITH DESCRIPTION 'main storage' ( + -> MAXVERSIONS = INFINITY, + -> TTL = FOREVER, + -> INMEMORY = false, + -> COMPRESSED WITH GZIP, + -> FAMILY info WITH DESCRIPTION 'basic information' ( + -> name "string" WITH DESCRIPTION 'The user\'s name', + -> email "string", + -> addr CLASS com.example.AddressRecord, + -> age "int"), + -> MAP TYPE FAMILY integers COUNTER WITH DESCRIPTION 'metric tracking data' + -> ); + +### Deleting Tables + +You can delete a table with the command: + + schema> DROP TABLE foo; + +Warning: THIS WILL DELETE ALL THE DATA IN THE TABLE. + +### Changing Table Properties + +All table properties that can be set (descriptions, columns & schemas, +locality group properties, etc) when a table is created, can also be changed +after the fact. + +Keywords or clauses in \[square brackets\] are optional in the examples below: + + + ALTER TABLE t ADD COLUMN info:foo [WITH SCHEMA] schema [WITH DESCRIPTION 'd']; + ALTER TABLE t RENAME COLUMN info:foo [AS] info:bar; + ALTER TABLE t DROP COLUMN info:foo; + + ALTER TABLE t ADD [GROUP TYPE] FAMILY f [WITH DESCRIPTION 'd'] TO [LOCALITY GROUP] lg; + + ALTER TABLE t ADD MAP TYPE FAMILY f [WITH SCHEMA] schema + [WITH DESCRIPTION 'd'] TO [LOCALITY GROUP] lg; + + ALTER TABLE t DROP FAMILY f; + ALTER TABLE t RENAME FAMILY f [AS] f2; + + ALTER TABLE t CREATE LOCALITY GROUP lg [WITH DESCRIPTION 'd'] + [( property, property... )] + + ... Where 'property' is one of: + MAXVERSIONS = int + | INMEMORY = bool + | TTL = int + | COMPRESSED WITH { GZIP | LZO | SNAPPY | NONE } + ... or a FAMILY definition (see the earlier section on the CREATE TABLE syntax) + + ALTER TABLE t RENAME LOCALITY GROUP lg [AS] lg2; + ALTER TABLE t DROP LOCALITY GROUP lg; + + ALTER TABLE t SET DESCRIPTION = 'desc' FOR FAMILY f; + ALTER TABLE t SET SCHEMA = schema FOR [MAP TYPE] FAMILY f; + + ALTER TABLE t SET DESCRIPTION = 'desc' FOR COLUMN info:foo; + ALTER TABLE t SET SCHEMA = schema FOR COLUMN info:foo; + + ALTER TABLE t SET DESCRIPTION = 'desc'; + + ALTER TABLE t SET DESCRIPTION = 'desc' FOR LOCALITY GROUP lg; + ALTER TABLE t SET property FOR LOCALITY GROUP lg; + ... where 'property' is one of MAXVERSIONS, INMEMORY, TTL, or COMPRESSED WITH. + + +### Working With Scripts + +You can write scripts that contain DDL statements to define tables or whole +instances. If you put a sequence of DDL statements in a file, you can run +this file with: + + schema> LOAD FROM FILE '/path/to/foo.ddl'; + +You can print the DDL that would create a whole instance or a specific table +to the screen: + + schema> DUMP DDL; + schema> DUMP DDL FOR TABLE foo; + +Or you can save the output to a file: + + schema> DUMP DDL TO FILE '/path/to/foo.ddl'; + schema> DUMP DDL FOR TABLE foo TO FILE '/path/to/foo.ddl'; + diff --git a/_posts/userguides/schema/1.0.0-rc4/2012-01-01-accessing-data.md b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-accessing-data.md new file mode 100644 index 00000000..cad8af9d --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-accessing-data.md @@ -0,0 +1,256 @@ +--- +title: Accessing Data +layout: post +categories: [userguides, schema, 1.0.0-rc4] +tags: [schema-ug] +version: 1.0.0-rc4 +order : 4 +description: How to access data using KijiSchema. +--- + +The [`KijiTableReader`]({{site.api_schema_rc4}}/KijiTableReader.html) class provides a `get(...)` method to read typed data from a Kiji table row. +The row is addressed by its [`EntityId`]({{site.api_schema_rc4}}/EntityId.html) +(which can be retrieved from the [`KijiTable`]({{site.api_schema_rc4}}/KijiTable.html) instance +using the [`getEntityId()`]({{site.api_schema_rc4}}/KijiTable.html#getEntityId%28java.lang.String%29) method). +Specify the desired cells from the rows with a [`KijiDataRequest`]({{site.api_schema_rc4}}/KijiDataRequest.html). +See the [`KijiDataRequest`]({{site.api_schema_rc4}}/KijiDataRequest.html) documentation for details. + +In general, [`Kiji`]({{site.api_schema_rc4}}/Kiji.html) and [`KijiTable`]({{site.api_schema_rc4}}/KijiTable.html) instances should only be opened once over the life of an application +([`EntityIdFactory`]({{site.api_schema_rc4}}/EntityIdFactory.html)s should also be reused). +[`KijiTablePool`]({{site.api_schema_rc4}}/KijiTablePool.html) can be used to maintain a pool of opened [`KijiTable`]({{site.api_schema_rc4}}/KijiTable.html) objects for reuse. +To initially open a [`KijiTable`]({{site.api_schema_rc4}}/KijiTable.html): + +{% highlight java %} +// URI for Kiji instance « kiji_instance_name » in your default HBase instance: +final KijiURI kijiURI = KijiURI.newBuilder().withInstanceName("kiji_instance_name"); +final Kiji kiji = Kiji.Factory.open(kijiURI); +try { + final KijiTable table = kiji.openTable("table_name"); + try { + // Use the opened table: + // … + } finally { + // Always close the table you open: + table.close(); + } +} finally { + // Always release the Kiji instances you open: + kiji.release(); +} +{% endhighlight %} + +To read from an existing [`KijiTable`]({{site.api_schema_rc4}}/KijiTable.html), +create a [`KijiDataRequest`]({{site.api_schema_rc4}}/KijiDataRequest.html) specifying the columns of data to return. +Then, query for the desired [`EntityId`]({{site.api_schema_rc4}}/EntityId.html), +using a [`KijiTableReader`]({{site.api_schema_rc4}}/KijiTableReader.html). +You can get a [`KijiTableReader`]({{site.api_schema_rc4}}/KijiTableReader.html) for a [`KijiTable`]({{site.api_schema_rc4}}/KijiTable.html) using the [`openTableReader()`]({{site.api_schema_rc4}}/KijiTable.html#openTableReader%28%29) method. + +For example: + +{% highlight java %} +final KijiTableReader reader = table.openTableReader(); +try { + // Select which columns you want to read: + final KijiDataRequest dataRequest = KijiDataRequest.builder() + .addColumns(ColumnsDef.create().add("some_family", "some_qualifier")) + .build(); + final EntityId entityId = table.getEntityId("your-row"); + final KijiRowData rowData = reader.get(entityId, dataRequest); + // Use the row: + // … +} finally { + // Always close the reader you open: + reader.close(); +} +{% endhighlight %} + +The [`KijiTableReader`]({{site.api_schema_rc4}}/KijiTableReader.html) also implements a [`bulkGet(...)`]({{site.api_schema_rc4}}/KijiTableReader.html#bulkGet%28java.util.List%2C%20org.kiji.schema.KijiDataRequest%29) method +for retrieving data for a list of [`EntityId`]({{site.api_schema_rc4}}/EntityId.html)s. +This is more efficient than a series of calls to `get(...)` because it uses a single RPC instead of one for each get. + +## Row scanners + +If you need to process a range of row, you may use a row [`KijiRowScanner`]({{site.api_schema_rc4}}/KijiRowScanner.html): + +{% highlight java %} +final KijiTableReader reader = table.openTableReader(); +try { + final KijiDataRequest dataRequest = KijiDataRequest.builder() + .addColumns(ColumnsDef.create().add("family", "qualifier")) + .build(); + final KijiScannerOptions scanOptions = new KijiScannerOptions() + .setStartRow(table.getEntityId("the-start-row")) + .setStopRow(table.getEntityId("the-stop-row")); + final KijiRowScanner scanner = reader.getScanner(dataRequest, scanOptions); + try { + // Scan over the requested row range, in order: + for (KijiRowData row : scanner) { + // Process the row: + // … + } + } finally { + // Always close scanners: + scanner.close(); + } +} finally { + // Always close table readers: + reader.close(); +} +{% endhighlight %} + +## Modifying Data + +The [`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html) class provides a `put(...)` method to write or update cells in a Kiji table. +The cell is addressed by its entity ID, column family, column qualifier, and timestamp. +You can get a [`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html) for a [`KijiTable`]({{site.api_schema_rc4}}/KijiTable.html) using the [`openTableWriter()`]({{site.api_schema_rc4}}/KijiTable.html#openTableWriter%28%29) method. + +{% highlight java %} +final KijiTableWriter writer = table.openTableWriter(); +try { + // Write a string cell named "a_family:some_qualifier" to the row "the-row": + final long timestamp = System.currentTimeMillis(); + final EntityId eid = table.getEntityId("the-row"); + writer.put(eid, "a_family", "some_qualifier", timestamp, "Some value!"); + writer.flush(); +} finally { + // Always close the writers you open: + writer.close(); +} +{% endhighlight %} + +Note: the type of the value being written to the cell must match the type of the column declared in the table layout. + +## Counters + +Incrementing a counter value stored in a Kiji cell would normally require a +"read-modify-write" transaction using a client-side row lock. Since row +locks can cause contention, Kiji exposes a feature of HBase to do this more +efficiently by pushing the work to the server side. To increment a counter value in +a Kiji cell, the column must be declared with a schema of type +"counter". See [Managing Data]({{site.userguide_schema_rc4}}/managing-data#layouts) +for details on how to declare a counter in your table layout. + +Columns containing counters may be accessed like other columns; counters are exposed as long integers. +In particular, the counter value may be retrieved using `KijiTableReader.get(...)` and written using `KijiTableWriter.put(...)`. +In addition to that, the [`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html) class also provides a method to atomically increment counter values. + +{% highlight java %} +final KijiTableWriter writer = table.openTableWriter(); +try { + // Incrementing the counter type column "a_family:some_counter_qualifier" by 2: + final EntityId eid = table.getEntityId("the-row"); + writer.increment(eid, "a_family", "some_counter_qualifier", 2); + writer.flush(); +} finally { + // Always close the writer you open: + writer.close(); +} +{% endhighlight %} + +## MapReduce + +
    +
     
    +
    +

    Deprecation Warning

    +

    + This section refers to classes in the org.kiji.schema.mapreduce package + that may be removed in the future. Please see the + KijiMR Userguide for information on using MapReduce with Kiji. +

    +
    +
    + +The [`KijiTableInputFormat`]({{site.api_schema_rc4}}/mapreduce/KijiTableInputFormat.html) provides the necessary functionality to read from a Kiji table in a +MapReduce job. To configure a job to read from a Kiji table, use [`KijiTableInputFormat`]({{site.api_schema_rc4}}/mapreduce/KijiTableInputFormat.html)'s +static `setOptions` method. For example: + +{% highlight java %} +Configuration conf = HBaseConfiguration.create(); +Job job = new Job(conf); + +// * Setup jars to ship to the hadoop cluster. +job.setJarByClass(YourClassHere.class); +GenericTableMapReduceUtil.addAllDependencyJars(job); +DistributedCacheJars.addJarsToDistributedCache(job, + new File(System.getenv("KIJI_HOME"), "lib")); +job.setUserClassesTakesPrecedence(true); +// * + +KijiDataRequest request = new KijiDataRequest() + .addColumn(new KijiDataRequest.Column("your-family", "your-qualifier")); + +// Setup the InputFormat. +KijiTableInputFormat.setOptions(job, "your-kiji-instance-name", "the-table-name", request); +job.setInputFormatClass(KijiTableInputFormat.class); +{% endhighlight %} +The code contained within "// \*" is responsible for shipping Kiji resources to the DistributedCache. +This is so that all nodes within your hadoop cluster will have access to Kiji dependencies. + +[`KijiTableInputFormat`]({{site.api_schema_rc4}}/mapreduce/KijiTableInputFormat.html) outputs keys of type [`EntityId`]({{site.api_schema_rc4}}/EntityId.html) and values of type [`KijiRowData`]({{site.api_schema_rc4}}/KijiRowData.html). This +data can be accessed from within a mapper: + +{% highlight java %} +@Override +public void map(EntityId entityId, KijiRowData row, Context context) { + // ... +} +{% endhighlight %} + +To write to a Kiji table from a MapReduce job, you should use +[`KijiTableWriter`]({{site.api_schema_rc4}}/KijiTableWriter.html) as before. You should also set +your OutputFormat class to `NullOutputFormat`, so MapReduce doesn't expect to create +a directory full of text files on your behalf. + +To configure a job to write to a Kiji table, refer to the following example: + +{% highlight java %} +Configuration conf = HBaseConfiguration.create(); +Job job = new Job(conf); + +// Setup jars to ship to the hadoop cluster. +job.setJarByClass(YourClassHere.class); +GenericTableMapReduceUtil.addAllDependencyJars(job); +DistributedCacheJars.addJarsToDistributedCache(job, + new File(System.getenv("KIJI_HOME"), "lib")); +job.setUserClassesTakesPrecedence(true); + +// Setup the OutputFormat. +job.setOutputKeyClass(NullWritable.class); +job.setOutputValueClass(NullWritable.class); +job.setOutputFormatClass(NullOutputFormat.class); +{% endhighlight %} + +And then, from within a Mapper: + +{% highlight java %} +public class MyMapper extends Mapper { + private KijiTableWriter writer; + private Kiji kiji; + private KijiTable table; + + @Override + public void setup(Context context) { + // Open a KijiTable for generating EntityIds. + kiji = Kiji.open("your-kiji-instance-name"); + table = kiji.openTable("the-table-name"); + + // Create a KijiTableWriter that writes to a MapReduce context. + writer = table.openTableWriter(); + } + + @Override + public void map(LongWritable key, Text value, Context context) { + // ... + + writer.put(table.getEntityId("your-row"), "your-family", "your-qualifier", value.toString()); + } + + @Override + public void cleanup(Context context) { + writer.close(); + kiji.close(); + table.close(); + } +} +{% endhighlight %} diff --git a/_posts/userguides/schema/1.0.0-rc4/2012-01-01-data-model.md b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-data-model.md new file mode 100644 index 00000000..48f5bbfe --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-data-model.md @@ -0,0 +1,55 @@ +--- +layout: post +title: Data Model +categories: [userguides, schema, 1.0.0-rc4] +tags : [schema-ug] +order : 2 +version: 1.0.0-rc4 +description: KijiSchema's underlying data model. +--- + +KijiSchema’s data model is an extension of HBase’s columnar storage +model. Like HBase, KijiSchema’s tables contain many rows; each row +contains many columns. A given *cell* identified by a row and column can +hold many different timestamped values, representing the changing values +of the cell over time. Columns are grouped together into column +*families*, which provide namespacing for columns that store related +data. Families are grouped into *locality groups*, which help store +related families physically close to one another. + +> What Kiji calls a "locality group", HBase calls a "family". The Kiji +> column "family" allows you to choose the logical grouping and namespace +> of columns separately from the physical configuration of how the data is stored. +> In Kiji, multiple families can belong to one locality group. + +As in HBase, rows in Kiji tables can have an arbitrary number of +columns. Individual rows may have hundreds or thousands (or more) +columns. Different rows may not necessarily have the same set of +columns. + +Unlike HBase, each cell in a Kiji table has a schema associated with it. +Schemas in KijiSchema are versioned. The schema and layout system is +described in greater detail in [Managing Data]({{site.userguide_schema_rc4}}/managing-data). + +### Entity-Centric Data Model +KijiSchema’s data model is *entity-centric*. Each row typically holds +information about a single *entity* in your information scheme. As an +example, a consumer e-commerce web site may have a row representing each +user of their site. The entity-centric data model enables easier analysis +of individual entities. For example, to recommend products to a user, +information such as the user’s past purchases, previously viewed items, +search queries, etc. all need to be brought together. The entity-centric +model stores all of these attributes of the user in the same row, +allowing for efficient access to relevant information. + +The entity-centric data model stands in comparison to a more typical +log-based approach to data collection. Many MapReduce systems import log +files for analysis. Logs are *action-centric*; each action performed by +a user (adding an item to a shopping cart, checking out, performing a +search, viewing a product) generates a new log entry. Collecting all the +data required for a per-user analysis thus requires a scan of many logs. +The entity-centric model is a “pivoted” form of this same information. +By pivoting the information as the data is loaded into KijiSchema, later +analysis can be run more efficiently, either in a MapReduce job +operating over all users, or in a more narrowly-targeted fashion if +individual rows require further computation. diff --git a/_posts/userguides/schema/1.0.0-rc4/2012-01-01-faq.md b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-faq.md new file mode 100644 index 00000000..891a00d7 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-faq.md @@ -0,0 +1,94 @@ +--- +layout: post +title: FAQ +categories: [userguides, schema, 1.0.0-rc4] +tags : [schema-ug] +version: 1.0.0-rc4 +order : 8 +description: A collection of commonly asked questions and answers. +--- + +## What license is KijiSchema under? + +KijiSchema is under the Apache License, Version 2.0 + +## How do I add Kiji and its dependencies to my application's classpath? + +Like `hadoop`, the `kiji` binary supports a `jar` operation. If your program is +packaged as a single jar and you want to run it with Kiji on the classpath, you +can run: + +{% highlight bash %} +$ kiji jar myapp.jar com.myorg.MyApp [args...] +{% endhighlight %} + +If your application constructs a more complex classpath, then you can also add +Kiji to your application's classpath explicitly. Like `hadoop` and `hbase`, the +`kiji` binary has a `classpath` command which will print a string that you can +use directly in your `$CLASSPATH` environment variable or on the `java` command +line as the `-cp` option. For example: + +{% highlight bash %} +$ java -cp myapp.jar:`kiji classpath` com.myorg.MyApp +{% endhighlight %} + +## I'm confident that I'm writing data to my Kiji table correctly. Why don't I see the new cells when I try to read them back? + +Check the retention policy for the cells in the locality group you are writing +to. The locality groups of your Kiji table are configured in your table's layout. +See [Managing Data]({{site.userguide_schema_rc4}}/managing-data#layouts) for details. + +In particular, check to make sure the timestamps of the new cells you are +writing are in milliseconds, and that they fall within the bounds of your +locality group's `ttl_seconds` setting. + +## How do I specify the schema of a column in my Kiji table? + +Kiji uses Avro for data type definitions and serialization within cells of Kiji +tables. Avro can define simple types like `"int"` and `"string"` as well as +complex record types, composed of scalars or other records, arrays, maps, etc. +Every column (or map-type family) in Kiji has a type (or «schema» in Avro +parlance) associated with it. + +For primitives types like, eg. `"int"`, use the following in your column layout +descriptor: + +{% highlight js %} +column_schema: {type: "INLINE", value = '"int"'} +{% endhighlight %} + +For complex record types, you may instead specify a generated record class: +{% highlight js %} +column_schema: {type: "CLASS", value = "org.package.GeneratedRecordClass"} +{% endhighlight %} + +You can write Avro schemas `.avsc` or `.avdl` files. These can be compiled into +Java classes that represent the record type. This makes working with these +objects easier in your mapper and reducers. For complete information on Avro, +visit http://avro.apache.org. + +See [Managing Data]({{site.userguide_schema_rc4}}/managing-data#layouts) for more +details on Kiji cell schemas. + +## How does data in Kiji map to Java types? + +Kiji uses Avro for data type management and serialization. Each cell of typed +data has an associated Avro schema. When reading or writing data from Kiji, the +Java type must be compatible with the Avro schema. For example, if a Kiji +column has the Avro schema `"string"`, data read from cells of the column will +implement the Java CharSequence interface. For +record schemas that have been compiled into Java classes using the Avro +compiler, the Java type corresponding to the schema is the compiled class. + +The full list of mappings between Avro schemas and Java types are documented in +the Avro Java API documentation. See the package documentation for +org.apache.avro.specific +and +org.apache.avro.generic. + +## Are there restrictions on the characters I use in table names, family names, and column names? + +Yes. All table names, column family names, and column qualifier +names may only contain numbers, letters and underscores +(`[A-Za-z_][A-Za-z0-9_]*`). However, the qualifiers of a map-type column family +may contain any printable characters. diff --git a/_posts/userguides/schema/1.0.0-rc4/2012-01-01-for-administrators.md b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-for-administrators.md new file mode 100644 index 00000000..d34f541c --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-for-administrators.md @@ -0,0 +1,159 @@ +--- +layout: post +title: For Administrators +categories: [userguides, schema, 1.0.0-rc4] +tags : [schema-ug] +version: 1.0.0-rc4 +order : 5 +description: Installation and maintenance of kiji-schema. +--- + +In this chapter, you will learn how to install and configure all aspects +of the KijiSchema system. + +## Installation Guide + +Kiji has been tested on GNU/Linux (Ubuntu 12.04, 12.10 and CentOS-6.3) +and Mac OS X (10.8.x, 10.7.x, 10.6.x). + +Kiji is a Java-based system. To run Kiji applications, you will need to +[download the Oracle Java JRE](http://www.oracle.com/technetwork/java/javase/downloads/index.html). +To develop Kiji applications, you will +need the Oracle Java JDK. We have tested this system with the Oracle +Java “Hotspot” JVM, version 6. Other JVMs are not supported at this +time. If you are running OS X, this is installed by default. + +Kiji is built on top of Hadoop and HBase. Our system depends on +[Cloudera's Distribution including Apache Hadoop](https://ccp.cloudera.com/display/SUPPORT/Downloads), version 4 (CDH4). +If you downloaded the BentoBox, a zero-configuration development/test +cluster is included in the package. If you downloaded KijiSchema, you +will need to install and configure Hadoop and HBase separately. + +### Installing and Configuring Kiji Clients + +After downloading either the BentoBox +(`kiji-bento-version-release.tar.gz`) or KijiSchema +(`kiji-schema-version-release.tar.gz`), unzip the archive with the +command `tar vzxf filename`. This will create to a directory named +`kiji-bento-version/` or `kiji-schema-version/`. + +For convenience, `$KIJI_HOME` should be set to this directory. For +example: + +{% highlight bash %} +$ export KIJI_HOME=/path/to/kiji-bento-(version) +{% endhighlight %} + +You should edit your `.bashrc` file to contain this line so that it's +incorporated in your environment for future bash sessions. + +If you're using the BentoBox edition, you can set up your environment as +follows: + +{% highlight bash %} +$ source $KIJI_HOME/bin/kiji-env.sh +$ bento start +{% endhighlight %} + +This starts the bento mini cluster and updates your environment variables +to use it. After a few seconds you should be able to view the status +page of your own mini HBase cluster at [http://localhost:60010/](http://localhost:60010/). (If +you don't see it right away, wait 10 seconds and reload the page.) +You're now ready to proceed with installing Kiji onto your cluster. + +If you installed only KijiSchema (not the BentoBox), you should instead +set `$HADOOP_HOME` and `$HBASE_HOME` and make sure the Hadoop HDFS and +HBase services are running. + +For help configuring CDH, see Cloudera's CDH4 Installation Guide. + +## Installing Kiji System Tables + +Kiji will manage tables for you on top of your HBase cluster. Each Kiji +table corresponds to a physical HBase table. There are also a number of +system tables that hold metadata maintained by Kiji itself. Before you +can use Kiji, you must run its install command and create these system +tables. + +Issue the following command from your Kiji release directory to install +a Kiji instance with the name `default`: + +{% highlight bash %} +$ bin/kiji install +{% endhighlight %} + +You should see output like the following: + + Creating kiji instance: kiji://localhost:2181/default/ + Creating meta tables for kiji instance in hbase... + 12/11/06 19:48:44 INFO org.kiji.schema.KijiInstaller: Installing a kiji instance named 'default'... + 12/11/06 19:48:50 INFO org.kiji.schema.KijiInstaller: Installed kiji 'default' + Successfully created kiji instance: kiji://localhost:2181/default/ + +Now you can create some tables in the +[DDL schema-shell]({{site.userguide_schema_rc4}}/schema-shell-ddl-ref), explore the +[Phonebook example]({{site.tutorial_phonebook_rc4}}/phonebook-tutorial), and get started +[building a Maven project](http://www.kiji.org/get-started-with-maven) with +Kiji. See the +[quickstart guide](http://www.kiji.org/getstarted/#Quick_Start_Guide) to get +acquainted with the tools. + +## Maintenance Guide + +Due to the fault-tolerant nature of Hadoop and HBase, your Kiji instance +should not require much ongoing maintenance. The following list of +recommended practices describe what maintenance should be performed to +ensure uninterrupted operation. + ++ Remove old logs - If log files fill a disk, Hadoop and HBase services may be + disrupted. Make sure to archive or delete old log files in `$HADOOP_HOME/logs` + and `$HBASE_HOME/logs` on a regular basis. + ++ Flush KijiSchema metadata tables - KijiSchema metadata tables are not frequently + updated. When an update happens, it is only recorded in the write-ahead logs + for the table. Periodically, you should run `bin/kiji flush-table --meta` to + flush metadata tables. This should be scheduled to run during a period of + low activity, nightly or weekly. + +## Troubleshooting Guide + +### Missing HBase Regions + +If HBase shuts down incorrectly or HDFS issues cause data loss, HBase's own +metadata tables `-ROOT-` and `.META.` may have inconsistent data. You can verify +that your HBase metadata tables are in good order by running `hbase hbck`. + +If `hbase hbck` prints `Status: INCONSISTENT`, +the advice in this section may help you restore functionality. + +Some problems can be fixed by running `hbase hbck -fix`. +This should be your first attempt. + +One particular kind of issue is a "hole" in the region chain for a table. Each +row stored in a table is assigned a region based on its row key. Each region is +responsible for a slice of the row key space. There should be no gaps between +these slices. If you run `hbase hbck -details`, it will print an error similar +to the following if it detects a hole in the region chain: + +{% highlight bash %} +$ hbase hbck -details +... + +Chain of regions in table kiji..table.tablename is broken; edges does not contain key +Table kiji..table.tablename is inconsistent. +... +Status: INCONSISTENT +{% endhighlight %} + +If the files for a missing region are present in HDFS, then no data has been +lost. HBase has simply lost track of the metadata for the region. The +following command can be used to scan your HBase root directory in HDFS for +region data, and add any regions back to tables that are missing from the HBase +metadata: + +{% highlight bash %} +$ hbase hbck -repairHoles +{% endhighlight %} + +See [hbck in depth](http://hbase.apache.org/book/hbck.in.depth.html) for more +details. diff --git a/_posts/userguides/schema/1.0.0-rc4/2012-01-01-kiji-schema-overview.md b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-kiji-schema-overview.md new file mode 100644 index 00000000..617786b8 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-kiji-schema-overview.md @@ -0,0 +1,29 @@ +--- +layout: post +title: What is KijiSchema? +categories: [userguides, schema, 1.0.0-rc4] +tags : [schema-ug] +version: 1.0.0-rc4 +order : 1 +description: Overview. +--- + +## What is KijiSchema? + +KijiSchema provides a simple Java API and command line interface for +importing, managing, and retrieving data from HBase. + + +## Key Features + +- Set up HBase layouts using user-friendly tools including a DDL +- Implement HBase best practices in table management +- Use evolving Avro schema management to serialize complex data +- Perform both short-request and batch processing on data in HBase +- Import data from HDFS into structured HBase tables + +KijiSchema promotes the use of entity-centric data modeling, where +all information about a given entity, including both dimensional and +transaction data, is encoded within the same row. This approach is +particularly valuable for user-based analytics such as targeting, +recommendations, and personalization. diff --git a/_posts/userguides/schema/1.0.0-rc4/2012-01-01-managing-data.md b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-managing-data.md new file mode 100644 index 00000000..d57d0487 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-managing-data.md @@ -0,0 +1,491 @@ +--- +layout: post +title: Managing Data +categories: [userguides, schema, 1.0.0-rc4] +tags: [schema-ug] +version: 1.0.0-rc4 +order: 3 +description: How to manage data with KijiSchema. +--- + +Every table in Kiji has an associated layout. The layout of a table contains a +baseline schema definition which can be used to access the majority of the +information in the table without further special knowledge. Each table's layout +describes the set of columns which can exist in any given row. For each column, +a minimal "reader" schema is specified; this provides multiple team members +working with a large data set with a common data dictionary; it also enables +validation of cell data against a reference schema. The layout also describes +some additional properties of the table; these are discussed in this section as +well. + +Every data element in Kiji is stored in a Kiji cell, which is uniquely +identified by an entity ID, column name, and timestamp. The column name is itself +two components: a family name and a qualifier. As in HBase, these are written +`family:qualifier`. Data written to a Kiji cell is serialized to a byte array +according to an Avro schema. The writer schema used for the particular write +operation is stored alongside the cell data, so the input data can be +deserialized exactly by subsequent read requests. But this schema must be +compatible with the expected reader schema specified in the layout for the cell. + +A JSON layout descriptor is a specification for the locality groups, +columns, and data types that comprise a table, written as a JSON +document whose elements are described in the following subsections. We will +refer to the following example layout file throughout this section: + +{% highlight js %} +{ + name: "users", + description: "A bunch of made-up users", + version: "kiji-1.0", + keys_format: {encoding: "HASH"}, + locality_groups: [ { + name: "default", + description: "The default locality group", + in_memory: false, + max_versions: 1, + ttl_seconds: 7776000, + compression_type: "NONE", + families: [ { + name: "info", + description: "A bunch of fields", + columns: [ { + name: "id", + description: "user id hash", + column_schema: {type: "INLINE", value: '"string"'} + }, { + name: "name", + description: "The person's name", + column_schema: {type: "INLINE", value: '"string"'} + }, { + name: "email", + description: "The person's email", + column_schema: {type: "INLINE", value: '"string"'} + } ] + }, { + name: "searches", + description: "The recent search queries the user has made", + map_schema: {type: "CLASS", value: "com.search.avro.Search"} + } ] + } ] +} +{% endhighlight %} + +The schema of the table layout descriptor is available in the KijiSchema source tree at +[Layout.avdl](#ref.table_layout_desc). + +### Overall structure of a table layout + +At the top-level, a table contains: + +* the table name and description; +* a description of the row keys encoding; +* the table locality groups. + +Each locality group has: + +* a primary name, unique within the table, a description and optionally some name aliases; +* whether the data is to be stored in memory or on disk; +* data retention lifetime; +* maximum number of versions to keep; +* type of compression; +* column families stored in this locality group. + +Each column family has: + +* a primary name, unique within the table, a description and optionally some name aliases; +* for map-type families, the Avro schema of the cell values; +* for group-type families, the collection of columns in the group. + +Each column in a group-type family has: + +* a primary name, unique within the family, a description and optionally some name aliases; +* an Avro schema. + +All names must start with a letter and may only use letters, numbers, and underscores. + +### Group-type and map-type families + +In KijiSchema, there are two kinds of column families: + +* Group-type families define a fixed set of named columns. In the example + layout above, there is a single group-type family named `info`, containing + the columns `info:id`, `info:name`, and `info:email`, each with their own + Avro schema. Each row may contain any subset of these three columns, but may + not contain any additional columns. + +* Map-type families define a family where the cell column qualifiers are not + explicitly defined. In the example layout above, the map-type family named + `searches` may be used to store every search performed by a user, each with + their own column qualifier; cell columns would have names of the form + `searches:`; the contents of each cell might be a compound Avro + record containing the list of products returned by the query specified in the + cell's qualifier, as well as a boolean for each indicating whether the user + actually clicked that search result. A map-type column specifies a single Avro + schema for all its column. Note that the column qualifiers used in a map-type + family must be valid UTF-8 strings (rather than arbitrary byte arrays). + +### Kiji cell schema + +Within a table, Kiji cells are encoded according to their declared schema. +There are three types of Kiji cell schemas, specified using the `type` field: + +* `INLINE` - field `value` contains an the JSON representation of an Avro + schema. In the earlier example, all three columns contain a single Avro + `"string"` field, but a column could also contain an array, record or other + complex Avro data type. +* `CLASS` - field `value` contains the fully-qualified name of a Java class + mapped by an Avro data type, like an implementation of `SpecificRecord`. The + user must ensure that the class is available on the classpath of any Kiji + tools accessing the cell. +* `COUNTER` - cells are encoded as long integers and support atomic increment + or decrement operations. + +The schema of cells in a group-type family is specified by the `column_schema` +field (see columns `info:id`, `info:name`, `info:email` in the example layout). +The schema of cells in a map-type family is specified by the `map_schema` field +(see map-type family `searches` in the example layout). + +### Locality groups + +All families within a locality group are stored together in HBase. It is +usually a good idea to put families that are often read and written together +into the same locality group. + +Locality groups control the physical properties of the underlying storage: + +* `in_memory` - when this boolean flag is set, Kiji configures HBase to keep as + much of this locality group in memory as possible. +* `ttl_seconds` - cells' time to live : cells older that this number of seconds + may be automatically discarded. +* `max_versions` - maximum number of timestamped versions of cells to retain : + as new versions of a cell are written, older versions are deleted to not + exceed this limit. +* `compression` - one of `NONE`, `GZ`, `LZO` or `SNAPPY`. + +### Names + +Locality groups, families, and columns are identified by their primary names. + +### Updating layouts + +Table layouts may be updated by specifying a table layout update descriptor. A table +layout update descriptor entirely specifies the new layout, and sets the `reference_layout` +field to specify the original layout to update. Locality groups, families, and columns can be +updated by redefining the locality group, family, or column with the same name. +To rename locality groups, families, or columns, set the `renamed_from` field +in the new definition to the original name. Table names may not be changed. + +For example, to rename the `default` locality group into `new_name`, one may +update the table layout with a locality group descriptor as follows: + +{% highlight js %} +locality_groups: [ { + name: "new_name", + renamed_from: "default", + ... +} ] +{% endhighlight %} + +### Layout record descriptor + +For reference, the Avro descriptor for table layout records is defined in +[`src/main/avro/Layout.avdl`](https://github.com/kijiproject/kiji-schema/blob/master/kiji-schema/src/main/avro/Layout.avdl "Layout.avdl") +within the kiji-schema git project as follows: + +{% highlight java %} +/** + * (c) Copyright 2012 WibiData, Inc. + * + * See the NOTICE file distributed with this work for additional + * information regarding copyright ownership. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// Kiji table layout. + +@namespace("org.kiji.schema.avro") +protocol KijiTableLayoutRecords { + + /** Type of compression for the data within a locality group. */ + enum CompressionType { + NONE, + GZ, + LZO, + SNAPPY + } + + /** Type of schema for column data. */ + enum SchemaType { + /** Column contains data encoded as specified inline. */ + INLINE, + + /** Column contains Avro records with the specified class name. */ + CLASS, + + /** Column contains counters. */ + COUNTER + } + + /** How schemas get encoded in cells. */ + enum SchemaStorage { + /** Data is prepended with the schema hash. */ + HASH, + + /** Data is prepended with the schema unique ID. */ + UID, + + /** Schema is immutable and not stored in the cell. */ + FINAL + } + + /** Schema of a Kiji cell. */ + record CellSchema { + /** Schema encoding in cells. Unused if type is COUNTER. */ + SchemaStorage storage = "HASH"; + + /** Type of schema. */ + SchemaType type; + + /** + * Schema value, whose interpretation depends on the schema type: + * - inline : immediate Avro schema description, eg. "string"; + * - class : Avro schema class name, eg. "org.kiji.avro.Node"; + * - counter : unused, must the empty. + */ + union { null, string } value = null; + } + + /** Column descriptor. */ + record ColumnDesc { + /** Column ID. Not visible to the user. 0 means unset. */ + int @internal("true") id = 0; + + /** Column primary name (A-Z, a-z, 0-9, -, _). */ + string name; + + /** Column name aliases. */ + array aliases = []; + + /** When false, the column is not visible or usable. */ + boolean enabled = true; + + /** User description of the column. */ + string description = ""; + + /** Schema for the cell values. */ + CellSchema column_schema; + + // Fields below are used to apply a diff against a reference family layout: + + /** When true, applying this layout deletes the column. */ + boolean @diff("true") delete = false; + + /** Reference primary name of the column, when renaming the column. */ + union { null, string } @diff("true") renamed_from = null; + } + + /** Descriptor for a group of columns. */ + record FamilyDesc { + /** Family ID. Not visible to the user. 0 means unset. */ + int @internal("true") id = 0; + + /** Column family primary name (A-Z, a-z, 0-9, -, _). */ + string name; + + /** Column family name aliases. */ + array aliases = []; + + /** When false, the family and its columns are not visible/usable. */ + boolean enabled = true; + + /** User description of the column family. */ + string description = ""; + + /** Cell schema for map-type families. Null for group-type families. */ + union { null, CellSchema } map_schema = null; + + /** Columns, for group-type families only. Empty for map-type families. */ + array columns = []; + + // Fields below are used to apply a diff against a reference family layout: + + /** When true, applying this layout deletes the family. */ + boolean @diff("true") delete = false; + + /** Reference primary name of the family, when renaming the family. */ + union { null, string } @diff("true") renamed_from = null; + } + + /** A group of Kiji column families stored together in a table. */ + record LocalityGroupDesc { + /** Locality group ID. Not visible to the user. 0 means unset. */ + int @internal("true") id = 0; + + /** Locality group primary name (A-Z, a-z, 0-9, -, _). */ + string name; + + /** Locality group name aliases. */ + array aliases = []; + + /** When false, the locality group and its families are not visible. */ + boolean enabled = true; + + /** User description of the locality group. */ + string description = ""; + + /** Reduce latency by forcing all data to be kept in memory. */ + boolean in_memory; + + /** Maximum number of the most recent cell versions to retain. */ + int max_versions; + + /** Length of time in seconds to retain cells. */ + int ttl_seconds; + + /** Data compression type. */ + CompressionType compression_type; + + /** Column family descriptors. */ + array families = []; + + // Fields below are used against a reference locality group layout: + + /** When true, applying this layout deletes the locality group. */ + boolean @diff("true") delete = false; + + /** Reference primary name of the locality group, when renaming. */ + union { null, string } @diff("true") renamed_from = null; + } + + + /** Hashing methods. */ + enum HashType { + /** MD5 hashing (16 bytes). */ + MD5 + } + + /** Row keys encoding. */ + enum RowKeyEncoding { + /** Row keys are managed by the user. */ + RAW, + + /** Row keys are hashed. */ + HASH, + + /** Row keys are prefixed by a hash. */ + HASH_PREFIX + } + + record RowKeyFormat { + /** Encoding of the row key. */ + RowKeyEncoding encoding; + + /** Type of hashing used, if any. */ + union { null, HashType } hash_type = null; + + /** + * Size of the hash, in bytes. + * - unused when encoding is RAW. + * - smaller than the hash size used for HASH or HASH_PREFIX. + */ + int hash_size = 0; + } + + /** Layout of a Kiji table. */ + record TableLayoutDesc { + /** Name of the table (A-Z, a-z, 0-9, -, _). */ + string name; + + /** User description of the table. */ + string description = ""; + + /** Whether row key hashing should be managed by Kiji. */ + RowKeyFormat keys_format; + + /** Locality groups in the table. */ + array locality_groups = []; + + /** Data layout version (eg. "kiji-1.0"). */ + string version; + + /** ID of the layout. */ + union { null, string } layout_id = null; + + /** Reference to the base layout this descriptor builds on. */ + union { null, string } reference_layout = null; + } + + // --------------------------------------------------------------------------- + // Backup records + + /** An MD5 hash. */ + fixed MD5Hash(16); + + /** An entry from the SchemaTable inside a metadata backup file. */ + record SchemaTableEntry { + /** Schema ID: positive integers only. */ + long id; + + /** 128 bits (16 bytes) hash of the schema JSON representation. */ + MD5Hash hash; + + /** JSON representation of the schema. */ + string avro_schema; + } + + /** Entry to backup a table layout update. */ + record TableLayoutBackupEntry { + /** Update timestamp, in ms. */ + long timestamp; + + /** + * Table layout update, as specified by the submitter/user. + * Except for the first one, the update builds on the previous layout. + */ + union { TableLayoutDesc, null } update = null; + + /** Effective table layout, after applying the update. */ + TableLayoutDesc layout; + } + + /** Table backup, ie. everything needed to restore a table. */ + record TableBackup { + /** Table name. */ + string name; + + /** Sequence of layouts, in order. */ + array layouts = []; + } + + /** Record that encapsulates all Kiji metadata, for backup purposes. */ + record MetadataBackup { + /** Layout version (eg. "kiji-1.0"). */ + string layout_version; + + /** Schema entries. */ + array schema_table = []; + + /** Map from table names to table backup records. */ + map meta_table = {}; + } + +} +{% endhighlight %} + + diff --git a/_posts/userguides/schema/1.0.0-rc4/2012-01-01-tool-reference.md b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-tool-reference.md new file mode 100644 index 00000000..c7c68556 --- /dev/null +++ b/_posts/userguides/schema/1.0.0-rc4/2012-01-01-tool-reference.md @@ -0,0 +1,451 @@ +--- +layout: post +title: Command-Line Tool Reference +categories: [userguides, schema, 1.0.0-rc4] +component: schema +version: 1.0.0-rc4 +tags : [schema-ug] +order : 7 +description: A reference of commands available for the schema command line tool. +--- + +Running kiji with no arguments will list all the available tools: + +{% highlight bash %} +$ kiji [FLAG]... +{% endhighlight %} + +### Instance administration +* `install` - [Install a kiji instance onto a running HBase cluster.](#ref.install) +* `uninstall` - [Remove a kiji instance from a running HBase cluster.](#ref.uninstall) +* `metadata` - [Backup or restore kiji metadata.](#ref.metadata) + +### Table administration +* `create-table` - [Create a kiji table in a kiji instance.](#ref.create-table) +* `delete` - [Delete kiji tables, rows, and cells.](#ref.delete) +* `layout` - [View or modify kiji table layouts.](#ref.layout) +* `flush-table` - [Flush kiji user and meta table write-ahead logs.](#ref.flush-table) + +### Data inspection/modification +* `ls` - [List kiji instances, tables and rows.](#ref.ls) +* `increment` - [Increment a counter column in a kiji table.](#ref.increment) +* `put` - [Write a cell to a column in a kiji table.](#ref.put) + +### Miscellaneous +* `help` - Describe available Kiji tools. +* `version` - Print the kiji distribution and data versions in use. +* `classpath` - Print the classpath used to run kiji tools. +* `synthesize-user-data` - [Synthesize user data into a kiji table.](#ref.synthdata) +* `jar` - [Run a class from a user-supplied jar file.](#ref.jar) + +### Targeting a Kiji instance or a Kiji table with Kiji URIs + +Most KijiSchema command-line tools accept a parameter specifying an HBase cluster, a Kiji instance or a Kiji table. +These elements can be specified in a unified way through Kiji URIs. + +Kiji URIs are formatted hierarchically: +{% highlight bash %} + kiji:///// +{% endhighlight %} + +* `HBase cluster`: the address of a ZooKeeper quorum used by the HBase + instance KijiSchema has been installed on. The default is `.env`, which + tells KijiSchema to use the HBase instance identified by the HBase + configuration files available on the classpath. +* `Kiji instance`: the name of the Kiji instance within the HBase cluster. +* `Kiji table`: the name of the Kiji table within the Kiji instance. +* `columns`: a set of columns or column families within the Kiji table, separated by comas. + +The HBase cluster address is a required component of all Kiji URIs. +Any further component is optional. For instance: + +* `kiji://localhost:2181` references the HBase cluster whose ZooKeeper quorum is composed + of the server listening on `localhost:2181`. +* `kiji://localhost:2181/kiji_instance_1` designates the Kiji instance named `kiji_instance_1` + and living the the HBase cluster `kiji://localhost:2181`. +* `kiji://localhost:2181/kiji_instance_1/the_table` designates the Kiji table named `the_table` + and living the the Kiji instance `kiji://localhost:2181/kiji_instance_1`. +* `kiji://localhost:2181/kiji_instance_1/the_table/family1,family:column2` references the + column family `family1` and the column `family:column2` within the Kiji table + `kiji://localhost:2181/kiji_instance_1/the_table`. + + +The default value for Kiji URIs is `kiji://.env/default`, which +references the Kiji instance named `default` and installed on the HBase +instance identified by the HBase configuration available on the classpath. + +### Scripting using the command-line interface + +All Kiji command-line tools accept a `--interactive` flag that controls whether user +interactions are allowed. By default, this flag is set to true, which enables user +interactions such as confirmations for dangerous operations. + +When scripting Kiji commands, you may disable user interactions with `--interactive=false`. + +---------- + +## Installation: `install` + +The `kiji install` command creates the initial metadata tables +`kiji..meta`, `kiji..status`, +`kiji..schema_id` and `kiji..schema_hash` +required by the KijiSchema system. +This should be run once during initial setup of a KijiSchema instance. + +The HBase cluster and the Kiji instance name may be specified with a [Kiji URI](#ref.kiji_uri): + +{% highlight bash %} +kiji install --kiji=kiji://hbase_cluster/kiji_instance +{% endhighlight %} + +## Removal: `uninstall` + +The `kiji uninstall` command removes an installed KijiSchema instance, and deletes +all the user tables it contains. +The HBase cluster and the name of the Kiji instance to remove is specified with a [Kiji URI](#ref.kiji_uri): + +{% highlight bash %} +kiji uninstall --kiji=kiji://hbase_cluster/kiji_instance +{% endhighlight %} + +Metadata backups: `metadata` +------------------------------------------------------- + +The `kiji metadata` command allows you to backup and restore metadata information in KijiSchema. +This metadata contains table layout information as well as the schema definitions. + +### Creating a backup + +You can backup the metadata for a specific Kiji instance with: + +
    +{% highlight bash %} +kiji metadata --kiji=kiji://hbase_cluster/kiji_instance --backup=mybackup +{% endhighlight %} +
    + +### Restoring from a backup + +Similarily, you can restore the metadata for a specific Kiji instance with: + +
    +{% highlight bash %} +kiji metadata --kiji=kiji://hbase_cluster/kiji_instance --restore=mybackup +{% endhighlight %} +
    + +After asking for confirmation: + + Are you sure you want to restore metadata from backup? + This will delete your current metatable. + Please answer yes or no. + +Restoration begins: + + Restoring Metadata from backup. + Restore complete. + +If restoration of only a subset of the table and schema information is desired, the following flags should be used: +* `--tables` - restores all tables from the metadata backup into the specified Kiji instance. +* `--schemas` - restores all schema table entries from the metadata backup into the specified Kiji instance. + +---------- + +## Creating Tables: `create-table` + +The `kiji create-table` command creates a new +Kiji table. This is stored in an underlying HBase table with the name +`kiji..table.`. + +This command has two mandatory arguments: + +* `--table=` + - Kiji URI of the table to create. + It is an error for this table to already exist. +* `--layout=` + - Path to a file a JSON file containing the table layout specification, + as described in [Managing Data]({{site.userguide_schema_rc4}}/managing-data#layouts). + +The following arguments are optional: + +* `--num-regions=` + - The number of initial regions to create in the table. + This may only be specified if the table uses row key hashing. + It may not be used in conjunction with `--split-key-file`. + +* `--split-key-file=` + - Path to a file containing the row keys to use as initial boundaries between regions. + This may only be specified if the table uses row key hashing. + It may not be used in conjunction with `--num-regions`. + + + +## Deleting tables, rows, and cells: `delete` + +The `delete` command will delete a KijiSchema +table, row, or cell, and drop all values which were in them. +This command has one mandatory argument: + +* `--target=` - + URI of the target to delete or to delete from. + The target may be an entire Kiji instance, a Kiji table or a set of columns within a Kiji table. + +And several optional arguments: + +* `--entity-id=` - + Specifies the entity ID of a single row to delete or to delete from. + Requires the target Kiji URI to designate a Kiji table. + + The default is to not target a specific row, ie. to delete the entire Kiji table specified with `--target=...`. + +* `--timestamp=` - + Timestamp specification: + * `''` to delete cells with exactly this timestamp, expressed in milliseconds since the Epoch; + * `'latest'` to delete the most recent cell only; + * `'upto:'` to delete all cells with a timestamp older than the specified timestamp expressed in milliseconds since the Epoch; + * `'all'` to delete all cells, irrespective of their timestamp. + + The default is `--timestamp=all`. + +Managing layouts: `layout` +------------------------------------------------ + +The `kiji layout` command displays or modifies the layout associated with a table. + +This command requires two parameters: + +* `--table=` - URI of the Kiji table to examine the layout of. +* `--do=` - Action to perform on the layout: `dump` (the default), `set` or `history`. + +You may dump the current layout of a table with: +{% highlight bash %} +$ kiji layout --table=kiji://.env/default/users +{ + name: "users", + description: "The user table", + keys_format : {encoding : "RAW"}, + locality_groups : [ + … + ], + layout_id : "3", +} +{% endhighlight %} + +You may update the layout of a table with: +{% highlight bash %} +$ kiji layout --table=kiji://.env/default/users --do=set --layout=/path/to/layout.json +{% endhighlight %} + +The file `/path/to/layout.json` is a JSON descriptor of the updated table layout. + +Optionally, you may use the `--dry-run` argument to prints out messages stating whether or not the update would succeed +(i.e., whether or not the layout is valid) and what locality groups would be updated by the new layout. + +Finally, you may dump the layout history of a table with: +{% highlight bash %} +$ kiji layout \ + --table=kiji://.env/default/users \ + --do=history \ + --max-version=5 \ + --write-to=/path/to/table-layout-history/layout +{% endhighlight %} + +This dumps the 5 latest revisions of the table layout in 5 JSON files `/path/to/table-layout-history/layout-.json`. + +## Flushing tables: `flush-table` +-------------------------------------------------------- + +The `flush-table` command will instruct HBase to +flush the contents of a table to HDFS. When HBase receives new data, it +is recorded in a write-ahead log (WAL). But this WAL is not merged with +existing table files until the table is flushed or compacted. This +happens more frequently if more data is written to a table. But you can +force data to be written to table files with this command. If a table is +not frequently updated, flushing the data with this command may improve +recovery time in the event that HBase experiences a failure. + +You must use one or both of the following arguments to specify what +to flush: + +* `--table=` + - URI of the Kiji table to flush. +* `--meta` + - If set, flushes KijiSchema metadata tables. + +You should only flush tables during a period of relative inactivity. +Flushing while a large number of operations are ongoing may adversely +affect performance. The flush operation is also asynchronous; the +command may return before the actual flush operation is complete. + +---------- + +## Listing Information: `ls` + +The `kiji ls` command is the basic tool used to explore a KijiSchema repository. +It can drill down into KijiSchema-based data sets at many levels, +according to the target referenced through the Kiji URI specified with `--kiji=...`. + +You may list the Kiji instances existing in an HBase cluster by specifying the URI of an HBase cluster: +{% highlight bash %} +$ kiji ls --kiji=kiji://localhost:2181 +kiji://localhost:2181/kiji_instance1/ +kiji://localhost:2181/kiji_instance2/ +{% endhighlight %} + +You may list the Kiji tables within a Kiji instance by specifying the URI of a Kiji instance: +{% highlight bash %} +$ kiji ls --kiji=kiji://localhost:2181/kiji_instance1 +Listing tables in kiji instance: kiji://localhost:2181/kiji_instance1/ +table1 +table2 +table3 +{% endhighlight %} + +Finally, you may display the content of a table by specifying the URI of a Kiji table: +{% highlight bash %} +$ kiji ls --kiji=kiji://localhost:2181/kiji_instance1/table1 +Scanning kiji table: kiji://localhost:2181/kiji_instance1/table1/ +entity-id='Olga Jefferson' [1305851507300] info:name + Olga Jefferson +entity-id='Olga Jefferson' [1305851507301] info:email + Olga.Jefferson@hotmail.com + +entity-id='Sidney Tijuana' [1305851507425] info:name + Sidney Tijuana +entity-id='Sidney Tijuana' [1305851507427] info:email + Sidney.Tijuana@hotmail.com +… +{% endhighlight %} + +Each record appears as a set of lines, set apart by blank lines. +Each cell appears on two lines: +the first line contains the row entity ID, +the cell timestamp expressed in milliseconds since the UNIX epoch, +and the cell column name (`family:qualifier`). +The second line contains the string representation of the cell data itself. + + +You will typically want to restrict the set of data printed to the terminal. +The following options will do just that: + +* `--columns=family:qualifier,family:qualifier...` - + Restricts the set of columns to print the content of. + + The default, `--columns=*`, includes all columns in the table. + +* `--start-row=row-key` and `--limit-row=row-key` - + Restrict the range of rows to scan through. + The start row is included in the scan while the limit row is excluded. + Start and limit rows are expressed as HBase encoded rows, as in: + `--start-row='hex:0088deadbeef'` or `--limit-row='utf8:the row key in UTF8'`. + + The default is to scan through all the rows in the table. + +* `--max-rows=` - + Limits the total number of rows to display the content of. + + The default is 0 and sets no limit. + +* `--max-versions=` - + Restrict the number of versions of each cell to display. + + The default is 1, ie. displays the latest version of each cell. + +* `--min-timestamp=` and `--max-timestamp=` - + Excludes cell versions whose timestamp is outside the specified time range. + Timestamps are expressed in milliseconds since the Epoch. + + The default is to not exclude any cell. + +* `--entity-id=` - + Specifies the entity ID of a single row to look up: + + * Either as Kiji row keys, with `--entity-id=kiji=...`: + + Old deprecated Kiji row keys are specified as naked UTF-8 strings; + + New Kiji row keys are specified in JSON, as in: `--entity-id=kiji="['component1', 2, 'component3']"`. + + * or as HBase encoded row keys specified as bytes: + * by default as UTF-8 strings, or prefixed as in `'utf8:encoded\x0astring'`; + * in hexadecimal as in `'hex:deadfeed'`; + * as a URL with `'url:this%20URL%00'`. + + + Specifying `--entity-id=...` overrides `--start-row` and `--limit-row`. + +Incrementing counters: `increment` +--------------------------------------------------------------- + +The `kiji increment` command may be used to increment +(or decrement) a KijiSchema counter. + +The following arguments are required: + +* `--cell=` - [Kiji URI](#ref.kiji_uri) specifying a single column to increment. +* `--entity-id=` - Entity ID of the target row. +* `--value=amount` - The value to increment by. + +See [`kiji ls`](#ref.ls) for how to specify entity IDs. + +Setting Individual Cells: `put` +-------------------------------------------------- + +To aid in the insertion of small data sets, debugging, and testing, the +`kiji put` command may be used to insert individual values in a Kiji table. + +The following arguments are required: + +* `--target=` - [Kiji URI](#ref.kiji_uri) specifying a single column to write. +* `--entity-id=` - Target row id (an unhashed, human-readable string) +* `--value=` - The value to insert. The value is specified as a + JSON string according to [the Avro JSON encoding specification](http://avro.apache.org/docs/current/spec.html#json_encoding) + +See [`kiji ls`](#ref.ls) for how to specify entity IDs. + +The following arguments are optional: + +* `--schema=Avro schema` - By default, KijiSchema will use the reader schema + attached to a column in its layout to decode the JSON and encode the binary + data for insertion in the table. This argument allows you to use an alternate + writer schema. +* `--timestamp=long` - Specifies a timestamp (in milliseconds since the Epoch) other than "now". + +---------- + +Running an Application Jar with KijiSchema: `jar` +-------------------------------------------------------------------- + +If your application requires KijiSchema and its dependencies, you +can use the `kiji jar` command to launch your program's +main method with KijiSchema present on the classpath. + +This command requires two unlabeled arguments: the jar filename, and the +main class to run: + +{% highlight bash %} +$ kiji jar myapp.jar com.pkg.MyApp [args...] +{% endhighlight %} + +Generating Sample Data: `synthesize-user-data` +--------------------------------------------------------------------------- + +In the interest of enabling quick experimentation with KijiSchema, +the `kiji synthesize-user-data` tool will +generate a number of semi-random rows for you. + +The tool creates a set of rows which contain columns `info:id`, `info:name`, and +`info:email`; these are pseudo-randomly generated first and last names, with +plausible email addresses with gmail, hotmail, etc. accounts based on the +generated names. These columns can be used with mappers and reducers. + +To use this tool, first create a table with the layout in +`${KIJI_HOME}/examples/synthdata-layout.xml`. +Then invoke `bin/kiji synthesize-user-data --table=`. +This will generate 100 rows of data. +You can create a different number of records by specifying +`--num-users=`. + +You can specify a different list of names with the `--name-dict=filename` argument. diff --git a/apidocs/annotations/1.0.0-rc2/allclasses-frame.html b/apidocs/annotations/1.0.0-rc2/allclasses-frame.html new file mode 100644 index 00000000..723a5f24 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/allclasses-frame.html @@ -0,0 +1,46 @@ + + + + + + + +All Classes (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + +All Classes +
    + + + + + +
    ApiAudience +
    +ApiAudience.Framework +
    +ApiAudience.Private +
    +ApiAudience.Public +
    +ApiStability +
    +ApiStability.Evolving +
    +ApiStability.Stable +
    +ApiStability.Unstable +
    +
    + + + diff --git a/apidocs/annotations/1.0.0-rc2/allclasses-noframe.html b/apidocs/annotations/1.0.0-rc2/allclasses-noframe.html new file mode 100644 index 00000000..72e946b0 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/allclasses-noframe.html @@ -0,0 +1,46 @@ + + + + + + + +All Classes (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + +All Classes +
    + + + + + +
    ApiAudience +
    +ApiAudience.Framework +
    +ApiAudience.Private +
    +ApiAudience.Public +
    +ApiStability +
    +ApiStability.Evolving +
    +ApiStability.Stable +
    +ApiStability.Unstable +
    +
    + + + diff --git a/apidocs/annotations/1.0.0-rc2/constant-values.html b/apidocs/annotations/1.0.0-rc2/constant-values.html new file mode 100644 index 00000000..36b42b58 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/constant-values.html @@ -0,0 +1,145 @@ + + + + + + + +Constant Field Values (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Constant Field Values

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/deprecated-list.html b/apidocs/annotations/1.0.0-rc2/deprecated-list.html new file mode 100644 index 00000000..88f6b32d --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Deprecated API

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/help-doc.html b/apidocs/annotations/1.0.0-rc2/help-doc.html new file mode 100644 index 00000000..6a4f23d8 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +How This API Document Is Organized

    +
    +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

    +Package

    +
    + +

    +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

      +
    • Interfaces (italic)
    • Classes
    • Enums
    • Exceptions
    • Errors
    • Annotation Types
    +
    +

    +Class/Interface

    +
    + +

    +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      +
    • Class inheritance diagram
    • Direct Subclasses
    • All Known Subinterfaces
    • All Known Implementing Classes
    • Class/interface declaration
    • Class/interface description +

      +

    • Nested Class Summary
    • Field Summary
    • Constructor Summary
    • Method Summary +

      +

    • Field Detail
    • Constructor Detail
    • Method Detail
    +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
    + +

    +Annotation Type

    +
    + +

    +Each annotation type has its own separate page with the following sections:

      +
    • Annotation Type declaration
    • Annotation Type description
    • Required Element Summary
    • Optional Element Summary
    • Element Detail
    +
    + +

    +Enum

    +
    + +

    +Each enum has its own separate page with the following sections:

      +
    • Enum declaration
    • Enum description
    • Enum Constant Summary
    • Enum Constant Detail
    +
    +

    +Use

    +
    +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
    +

    +Tree (Class Hierarchy)

    +
    +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
    +
    +

    +Deprecated API

    +
    +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
    +

    +Index

    +
    +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
    +

    +Prev/Next

    +These links take you to the next or previous class, interface, package, or related page.

    +Frames/No Frames

    +These links show and hide the HTML frames. All pages are available with or without frames. +

    +

    +Serialized Form

    +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

    +

    +Constant Field Values

    +The Constant Field Values page lists the static final fields and their values. +

    + + +This help file applies to API documentation generated using the standard doclet. + +
    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/index-all.html b/apidocs/annotations/1.0.0-rc2/index-all.html new file mode 100644 index 00000000..e88518f2 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/index-all.html @@ -0,0 +1,148 @@ + + + + + + + +Index (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +A O
    +

    +A

    +
    +
    ApiAudience - Class in org.kiji.annotations
    Annotations that inform users of a package, class or method's intended audience.
    ApiAudience.Framework - Annotation Type in org.kiji.annotations
    An API intended to be used between Kiji framework modules.
    ApiAudience.Private - Annotation Type in org.kiji.annotations
    Only to be used within a Kiji module.
    ApiAudience.Public - Annotation Type in org.kiji.annotations
    An API intended to be used by clients at large.
    ApiStability - Class in org.kiji.annotations
    Annotations that inform users of a package, class or method's current stability + level.
    ApiStability.Evolving - Annotation Type in org.kiji.annotations
    An API that does not change in incompatible ways within a minor version.
    ApiStability.Stable - Annotation Type in org.kiji.annotations
    An API that does not change in incompatible ways within a major version.
    ApiStability.Unstable - Annotation Type in org.kiji.annotations
    An API that may change at any time.
    +
    +

    +O

    +
    +
    org.kiji.annotations - package org.kiji.annotations
    Annotations used within the Kiji project to confer information to consumers + of the framework and other framework developers.
    +
    +A O + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/index.html b/apidocs/annotations/1.0.0-rc2/index.html new file mode 100644 index 00000000..2bba8e9a --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/index.html @@ -0,0 +1,37 @@ + + + + + + + +annotations 1.0.0-rc3-SNAPSHOT API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/annotations/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.Framework.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.Framework.html new file mode 100644 index 00000000..0e420b06 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.Framework.html @@ -0,0 +1,171 @@ + + + + + + + +ApiAudience.Framework (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiAudience.Framework

    +
    +
    +
    @Documented
+public static @interface ApiAudience.Framework
    + + +

    +An API intended to be used between Kiji framework modules. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.Private.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.Private.html new file mode 100644 index 00000000..2b95eb51 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.Private.html @@ -0,0 +1,172 @@ + + + + + + + +ApiAudience.Private (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiAudience.Private

    +
    +
    +
    @Documented
+public static @interface ApiAudience.Private
    + + +

    +Only to be used within a Kiji module. The API or semantics of the annotated + class may change at any time. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.Public.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.Public.html new file mode 100644 index 00000000..11a60bf9 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.Public.html @@ -0,0 +1,171 @@ + + + + + + + +ApiAudience.Public (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiAudience.Public

    +
    +
    +
    @Documented
+public static @interface ApiAudience.Public
    + + +

    +An API intended to be used by clients at large. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.html new file mode 100644 index 00000000..de8fa11d --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiAudience.html @@ -0,0 +1,249 @@ + + + + + + + +ApiAudience (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.annotations +
    +Class ApiAudience

    +
    +java.lang.Object
+  extended by org.kiji.annotations.ApiAudience
+
    +
    +
    +
    @ApiAudience.Framework
+@ApiStability.Evolving
+public final class ApiAudience
    extends Object
    + + +

    +Annotations that inform users of a package, class or method's intended audience. + The audience may be ApiAudience.Public, ApiAudience.Framework, or ApiAudience.Private. + +

      +
    • By default, unlabeled classes should be assumed to be private.
      • +
    • External applications must only use classes marked as ApiAudience.Public. + Public classes will evolve in compatible ways only, subject to ApiStability + concerns. External client apps that depend on non-public APIs may find that they + have difficulty upgrading Kiji versions.
      • +
    • The ApiAudience.Framework publicity level is reserved for APIs that allow + communication between Kiji modules (e.g., between KijiSchema and kiji-schema-shell). + These are not intended for direct use by clients. Authors + of system-level tools may use these APIs, but should keep a close eye + on dev@kiji.org and issues@kiji.org.
      + + Framework-public APIs may change in incompatible ways between + minor releases (1.1.0 -> 1.2.0) of a component.
      • +
    • The ApiAudience.Private publicity level is used for code whose audience is + restricted to the current module (e.g., within KijiSchema). This code may + change in incompatible ways at any time.
      • +
    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static interfaceApiAudience.Framework + +
    +          An API intended to be used between Kiji framework modules.
    +static interfaceApiAudience.Private + +
    +          Only to be used within a Kiji module.
    +static interfaceApiAudience.Public + +
    +          An API intended to be used by clients at large.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.Evolving.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.Evolving.html new file mode 100644 index 00000000..2b103c84 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.Evolving.html @@ -0,0 +1,171 @@ + + + + + + + +ApiStability.Evolving (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiStability.Evolving

    +
    +
    +
    @Documented
+public static @interface ApiStability.Evolving
    + + +

    +An API that does not change in incompatible ways within a minor version. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.Stable.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.Stable.html new file mode 100644 index 00000000..5d2a0acf --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.Stable.html @@ -0,0 +1,171 @@ + + + + + + + +ApiStability.Stable (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiStability.Stable

    +
    +
    +
    @Documented
+public static @interface ApiStability.Stable
    + + +

    +An API that does not change in incompatible ways within a major version. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.Unstable.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.Unstable.html new file mode 100644 index 00000000..b80e8586 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.Unstable.html @@ -0,0 +1,171 @@ + + + + + + + +ApiStability.Unstable (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiStability.Unstable

    +
    +
    +
    @Documented
+public static @interface ApiStability.Unstable
    + + +

    +An API that may change at any time. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.html new file mode 100644 index 00000000..f9ec5431 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/ApiStability.html @@ -0,0 +1,241 @@ + + + + + + + +ApiStability (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.annotations +
    +Class ApiStability

    +
    +java.lang.Object
+  extended by org.kiji.annotations.ApiStability
+
    +
    +
    +
    @ApiAudience.Framework
+@ApiStability.Evolving
+public final class ApiStability
    extends Object
    + + +

    +Annotations that inform users of a package, class or method's current stability + level. The stability level may be ApiStability.Stable, ApiStability.Evolving, or ApiStability.Unstable. + +

      +
    • By default, unlabeled classes should be assumed to be unstable.
      • +
    • ApiStability.Stable APIs are guaranteed to change only in binary-compatible + ways within a major version (e.g., all 1.x.x versions)
      • +
    • ApiStability.Evolving APIs may change in binary-incompatible ways between + minor versions (e.g., from 1.4.1 to 1.5.0) of the software.
      • +
    • ApiStability.Unstable APIs may change at any time.
      • +
    + +

    Private APIs should all be considered ApiStability.Unstable.

    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static interfaceApiStability.Evolving + +
    +          An API that does not change in incompatible ways within a minor version.
    +static interfaceApiStability.Stable + +
    +          An API that does not change in incompatible ways within a major version.
    +static interfaceApiStability.Unstable + +
    +          An API that may change at any time.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.Framework.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.Framework.html new file mode 100644 index 00000000..d1e8c535 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.Framework.html @@ -0,0 +1,175 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience.Framework (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience.Framework

    +
    + + + + + +
    +Uses of ApiAudience.Framework in org.kiji.annotations
    +  +

    + + + + + + + + + + + + + +
    Classes in org.kiji.annotations with annotations of type ApiAudience.Framework
    + classApiAudience + +
    +          Annotations that inform users of a package, class or method's intended audience.
    + classApiStability + +
    +          Annotations that inform users of a package, class or method's current stability + level.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.Private.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.Private.html new file mode 100644 index 00000000..a22276e9 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.Private.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience.Private (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience.Private

    +
    +No usage of org.kiji.annotations.ApiAudience.Private +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.Public.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.Public.html new file mode 100644 index 00000000..d59cf8a9 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.Public.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience.Public (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience.Public

    +
    +No usage of org.kiji.annotations.ApiAudience.Public +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.html new file mode 100644 index 00000000..c8bb2964 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiAudience.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience

    +
    +No usage of org.kiji.annotations.ApiAudience +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.Evolving.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.Evolving.html new file mode 100644 index 00000000..5d53c3e2 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.Evolving.html @@ -0,0 +1,175 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability.Evolving (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability.Evolving

    +
    + + + + + +
    +Uses of ApiStability.Evolving in org.kiji.annotations
    +  +

    + + + + + + + + + + + + + +
    Classes in org.kiji.annotations with annotations of type ApiStability.Evolving
    + classApiAudience + +
    +          Annotations that inform users of a package, class or method's intended audience.
    + classApiStability + +
    +          Annotations that inform users of a package, class or method's current stability + level.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.Stable.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.Stable.html new file mode 100644 index 00000000..016b57f8 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.Stable.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability.Stable (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability.Stable

    +
    +No usage of org.kiji.annotations.ApiStability.Stable +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.Unstable.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.Unstable.html new file mode 100644 index 00000000..0e58e902 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.Unstable.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability.Unstable (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability.Unstable

    +
    +No usage of org.kiji.annotations.ApiStability.Unstable +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.html new file mode 100644 index 00000000..7c174588 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/class-use/ApiStability.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability

    +
    +No usage of org.kiji.annotations.ApiStability +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-frame.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-frame.html new file mode 100644 index 00000000..67253232 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +org.kiji.annotations (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + +org.kiji.annotations + + + + +
    +Classes  + +
    +ApiAudience +
    +ApiStability
    + + + + + + +
    +Annotation Types  + +
    +ApiAudience.Framework +
    +ApiAudience.Private +
    +ApiAudience.Public +
    +ApiStability.Evolving +
    +ApiStability.Stable +
    +ApiStability.Unstable
    + + + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-summary.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-summary.html new file mode 100644 index 00000000..c5043024 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-summary.html @@ -0,0 +1,214 @@ + + + + + + + +org.kiji.annotations (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.kiji.annotations +

    +Annotations used within the Kiji project to confer information to consumers + of the framework and other framework developers. +

    +See: +
    +          Description +

    + + + + + + + + + + + + + +
    +Class Summary
    ApiAudienceAnnotations that inform users of a package, class or method's intended audience.
    ApiStabilityAnnotations that inform users of a package, class or method's current stability + level.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Annotation Types Summary
    ApiAudience.FrameworkAn API intended to be used between Kiji framework modules.
    ApiAudience.PrivateOnly to be used within a Kiji module.
    ApiAudience.PublicAn API intended to be used by clients at large.
    ApiStability.EvolvingAn API that does not change in incompatible ways within a minor version.
    ApiStability.StableAn API that does not change in incompatible ways within a major version.
    ApiStability.UnstableAn API that may change at any time.
    +  + +

    +

    +Package org.kiji.annotations Description +

    + +

    +Annotations used within the Kiji project to confer information to consumers + of the framework and other framework developers. These annotations include + ApiStability and ApiAudience information that specify the + scope in which code may be consumed. +

    + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-tree.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-tree.html new file mode 100644 index 00000000..8b582995 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.annotations Class Hierarchy (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.kiji.annotations +

    +
    +

    +Class Hierarchy +

    + +

    +Annotation Type Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-use.html b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-use.html new file mode 100644 index 00000000..db1a2e24 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/org/kiji/annotations/package-use.html @@ -0,0 +1,162 @@ + + + + + + + +Uses of Package org.kiji.annotations (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    org.kiji.annotations

    +
    + + + + + + + + + + + +
    +Classes in org.kiji.annotations used by org.kiji.annotations
    ApiAudience.Framework + +
    +          An API intended to be used between Kiji framework modules.
    ApiStability.Evolving + +
    +          An API that does not change in incompatible ways within a minor version.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/overview-tree.html b/apidocs/annotations/1.0.0-rc2/overview-tree.html new file mode 100644 index 00000000..902a58b5 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/overview-tree.html @@ -0,0 +1,162 @@ + + + + + + + +Class Hierarchy (annotations 1.0.0-rc3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For All Packages

    +
    +
    +
    Package Hierarchies:
    org.kiji.annotations
    +
    +

    +Class Hierarchy +

    + +

    +Annotation Type Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc2/package-list b/apidocs/annotations/1.0.0-rc2/package-list new file mode 100644 index 00000000..2493c850 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc2/package-list @@ -0,0 +1 @@ +org.kiji.annotations diff --git a/apidocs/resources/inherit.gif b/apidocs/annotations/1.0.0-rc2/resources/inherit.gif similarity index 100% rename from apidocs/resources/inherit.gif rename to apidocs/annotations/1.0.0-rc2/resources/inherit.gif diff --git a/apidocs/stylesheet.css b/apidocs/annotations/1.0.0-rc2/stylesheet.css similarity index 100% rename from apidocs/stylesheet.css rename to apidocs/annotations/1.0.0-rc2/stylesheet.css diff --git a/apidocs/annotations/1.0.0-rc3/allclasses-frame.html b/apidocs/annotations/1.0.0-rc3/allclasses-frame.html new file mode 100644 index 00000000..5d193413 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/allclasses-frame.html @@ -0,0 +1,52 @@ + + + + + + + +All Classes (annotations 1.0.0-rc3 API) + + + + + + + + + + + +All Classes +
    + + + + + +
    ApiAudience +
    +ApiAudience.Framework +
    +ApiAudience.Private +
    +ApiAudience.Public +
    +ApiStability +
    +ApiStability.Evolving +
    +ApiStability.Stable +
    +ApiStability.Unstable +
    +Inheritance +
    +Inheritance.Extensible +
    +Inheritance.Sealed +
    +
    + + + diff --git a/apidocs/annotations/1.0.0-rc3/allclasses-noframe.html b/apidocs/annotations/1.0.0-rc3/allclasses-noframe.html new file mode 100644 index 00000000..c0efc072 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/allclasses-noframe.html @@ -0,0 +1,52 @@ + + + + + + + +All Classes (annotations 1.0.0-rc3 API) + + + + + + + + + + + +All Classes +
    + + + + + +
    ApiAudience +
    +ApiAudience.Framework +
    +ApiAudience.Private +
    +ApiAudience.Public +
    +ApiStability +
    +ApiStability.Evolving +
    +ApiStability.Stable +
    +ApiStability.Unstable +
    +Inheritance +
    +Inheritance.Extensible +
    +Inheritance.Sealed +
    +
    + + + diff --git a/apidocs/annotations/1.0.0-rc3/constant-values.html b/apidocs/annotations/1.0.0-rc3/constant-values.html new file mode 100644 index 00000000..dca9fba8 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/constant-values.html @@ -0,0 +1,145 @@ + + + + + + + +Constant Field Values (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Constant Field Values

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/deprecated-list.html b/apidocs/annotations/1.0.0-rc3/deprecated-list.html new file mode 100644 index 00000000..cc1cc7d4 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Deprecated API

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/help-doc.html b/apidocs/annotations/1.0.0-rc3/help-doc.html new file mode 100644 index 00000000..e7769f91 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +How This API Document Is Organized

    +
    +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

    +Package

    +
    + +

    +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

      +
    • Interfaces (italic)
    • Classes
    • Enums
    • Exceptions
    • Errors
    • Annotation Types
    +
    +

    +Class/Interface

    +
    + +

    +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      +
    • Class inheritance diagram
    • Direct Subclasses
    • All Known Subinterfaces
    • All Known Implementing Classes
    • Class/interface declaration
    • Class/interface description +

      +

    • Nested Class Summary
    • Field Summary
    • Constructor Summary
    • Method Summary +

      +

    • Field Detail
    • Constructor Detail
    • Method Detail
    +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
    + +

    +Annotation Type

    +
    + +

    +Each annotation type has its own separate page with the following sections:

      +
    • Annotation Type declaration
    • Annotation Type description
    • Required Element Summary
    • Optional Element Summary
    • Element Detail
    +
    + +

    +Enum

    +
    + +

    +Each enum has its own separate page with the following sections:

      +
    • Enum declaration
    • Enum description
    • Enum Constant Summary
    • Enum Constant Detail
    +
    +

    +Use

    +
    +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
    +

    +Tree (Class Hierarchy)

    +
    +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
    +
    +

    +Deprecated API

    +
    +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
    +

    +Index

    +
    +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
    +

    +Prev/Next

    +These links take you to the next or previous class, interface, package, or related page.

    +Frames/No Frames

    +These links show and hide the HTML frames. All pages are available with or without frames. +

    +

    +Serialized Form

    +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

    +

    +Constant Field Values

    +The Constant Field Values page lists the static final fields and their values. +

    + + +This help file applies to API documentation generated using the standard doclet. + +
    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/index-all.html b/apidocs/annotations/1.0.0-rc3/index-all.html new file mode 100644 index 00000000..f30dbc76 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/index-all.html @@ -0,0 +1,154 @@ + + + + + + + +Index (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +A I O
    +

    +A

    +
    +
    ApiAudience - Class in org.kiji.annotations
    Annotations that inform users of a package, class or method's intended audience.
    ApiAudience.Framework - Annotation Type in org.kiji.annotations
    An API intended to be used between Kiji framework modules.
    ApiAudience.Private - Annotation Type in org.kiji.annotations
    Only to be used within a Kiji module.
    ApiAudience.Public - Annotation Type in org.kiji.annotations
    An API intended to be used by clients at large.
    ApiStability - Class in org.kiji.annotations
    Annotations that inform users of a package, class or method's current stability + level.
    ApiStability.Evolving - Annotation Type in org.kiji.annotations
    An API that does not change in incompatible ways within a minor version.
    ApiStability.Stable - Annotation Type in org.kiji.annotations
    An API that does not change in incompatible ways within a major version.
    ApiStability.Unstable - Annotation Type in org.kiji.annotations
    An API that may change at any time.
    +
    +

    +I

    +
    +
    Inheritance - Class in org.kiji.annotations
    Annotations that inform users of an interface or class's intended use + case.
    Inheritance.Extensible - Annotation Type in org.kiji.annotations
    An interface or class that users can implement or extend.
    Inheritance.Sealed - Annotation Type in org.kiji.annotations
    An interface or class that you should not implement or extend.
    +
    +

    +O

    +
    +
    org.kiji.annotations - package org.kiji.annotations
    Annotations used within the Kiji project to confer information to consumers + of the framework and other framework developers.
    +
    +A I O + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/index.html b/apidocs/annotations/1.0.0-rc3/index.html new file mode 100644 index 00000000..a225089c --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/index.html @@ -0,0 +1,37 @@ + + + + + + + +annotations 1.0.0-rc3 API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/annotations/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.Framework.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.Framework.html new file mode 100644 index 00000000..343b14ec --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.Framework.html @@ -0,0 +1,171 @@ + + + + + + + +ApiAudience.Framework (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiAudience.Framework

    +
    +
    +
    @Documented
+public static @interface ApiAudience.Framework
    + + +

    +An API intended to be used between Kiji framework modules. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.Private.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.Private.html new file mode 100644 index 00000000..2b3b35b3 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.Private.html @@ -0,0 +1,172 @@ + + + + + + + +ApiAudience.Private (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiAudience.Private

    +
    +
    +
    @Documented
+public static @interface ApiAudience.Private
    + + +

    +Only to be used within a Kiji module. The API or semantics of the annotated + class may change at any time. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.Public.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.Public.html new file mode 100644 index 00000000..2d47b168 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.Public.html @@ -0,0 +1,171 @@ + + + + + + + +ApiAudience.Public (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiAudience.Public

    +
    +
    +
    @Documented
+public static @interface ApiAudience.Public
    + + +

    +An API intended to be used by clients at large. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.html new file mode 100644 index 00000000..08f50843 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiAudience.html @@ -0,0 +1,249 @@ + + + + + + + +ApiAudience (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.annotations +
    +Class ApiAudience

    +
    +java.lang.Object
+  extended by org.kiji.annotations.ApiAudience
+
    +
    +
    +
    @ApiAudience.Framework
+@ApiStability.Evolving
+public final class ApiAudience
    extends Object
    + + +

    +Annotations that inform users of a package, class or method's intended audience. + The audience may be ApiAudience.Public, ApiAudience.Framework, or ApiAudience.Private. + +

      +
    • By default, unlabeled classes should be assumed to be private.
      • +
    • External applications must only use classes marked as ApiAudience.Public. + Public classes will evolve in compatible ways only, subject to ApiStability + concerns. External client apps that depend on non-public APIs may find that they + have difficulty upgrading Kiji versions.
      • +
    • The ApiAudience.Framework publicity level is reserved for APIs that allow + communication between Kiji modules (e.g., between KijiSchema and kiji-schema-shell). + These are not intended for direct use by clients. Authors + of system-level tools may use these APIs, but should keep a close eye + on dev@kiji.org and issues@kiji.org.
      + + Framework-public APIs may change in incompatible ways between + minor releases (1.1.0 -> 1.2.0) of a component.
      • +
    • The ApiAudience.Private publicity level is used for code whose audience is + restricted to the current module (e.g., within KijiSchema). This code may + change in incompatible ways at any time.
      • +
    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static interfaceApiAudience.Framework + +
    +          An API intended to be used between Kiji framework modules.
    +static interfaceApiAudience.Private + +
    +          Only to be used within a Kiji module.
    +static interfaceApiAudience.Public + +
    +          An API intended to be used by clients at large.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.Evolving.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.Evolving.html new file mode 100644 index 00000000..90990adb --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.Evolving.html @@ -0,0 +1,171 @@ + + + + + + + +ApiStability.Evolving (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiStability.Evolving

    +
    +
    +
    @Documented
+public static @interface ApiStability.Evolving
    + + +

    +An API that does not change in incompatible ways within a minor version. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.Stable.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.Stable.html new file mode 100644 index 00000000..c122cf8a --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.Stable.html @@ -0,0 +1,171 @@ + + + + + + + +ApiStability.Stable (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiStability.Stable

    +
    +
    +
    @Documented
+public static @interface ApiStability.Stable
    + + +

    +An API that does not change in incompatible ways within a major version. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.Unstable.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.Unstable.html new file mode 100644 index 00000000..5bb784f8 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.Unstable.html @@ -0,0 +1,171 @@ + + + + + + + +ApiStability.Unstable (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiStability.Unstable

    +
    +
    +
    @Documented
+public static @interface ApiStability.Unstable
    + + +

    +An API that may change at any time. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.html new file mode 100644 index 00000000..a4cf4132 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/ApiStability.html @@ -0,0 +1,241 @@ + + + + + + + +ApiStability (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.annotations +
    +Class ApiStability

    +
    +java.lang.Object
+  extended by org.kiji.annotations.ApiStability
+
    +
    +
    +
    @ApiAudience.Framework
+@ApiStability.Evolving
+public final class ApiStability
    extends Object
    + + +

    +Annotations that inform users of a package, class or method's current stability + level. The stability level may be ApiStability.Stable, ApiStability.Evolving, or ApiStability.Unstable. + +

      +
    • By default, unlabeled classes should be assumed to be unstable.
      • +
    • ApiStability.Stable APIs are guaranteed to change only in binary-compatible + ways within a major version (e.g., all 1.x.x versions)
      • +
    • ApiStability.Evolving APIs may change in binary-incompatible ways between + minor versions (e.g., from 1.4.1 to 1.5.0) of the software.
      • +
    • ApiStability.Unstable APIs may change at any time.
      • +
    + +

    Private APIs should all be considered ApiStability.Unstable.

    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static interfaceApiStability.Evolving + +
    +          An API that does not change in incompatible ways within a minor version.
    +static interfaceApiStability.Stable + +
    +          An API that does not change in incompatible ways within a major version.
    +static interfaceApiStability.Unstable + +
    +          An API that may change at any time.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/Inheritance.Extensible.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/Inheritance.Extensible.html new file mode 100644 index 00000000..a6b7edf2 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/Inheritance.Extensible.html @@ -0,0 +1,171 @@ + + + + + + + +Inheritance.Extensible (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type Inheritance.Extensible

    +
    +
    +
    @Documented
+public static @interface Inheritance.Extensible
    + + +

    +An interface or class that users can implement or extend. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/Inheritance.Sealed.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/Inheritance.Sealed.html new file mode 100644 index 00000000..4d06b4aa --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/Inheritance.Sealed.html @@ -0,0 +1,173 @@ + + + + + + + +Inheritance.Sealed (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type Inheritance.Sealed

    +
    +
    +
    @Documented
+public static @interface Inheritance.Sealed
    + + +

    +An interface or class that you should not implement or extend. You may + be handed instances of this interface in response to another Kiji API + call. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/Inheritance.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/Inheritance.html new file mode 100644 index 00000000..5bc30bce --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/Inheritance.html @@ -0,0 +1,233 @@ + + + + + + + +Inheritance (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.annotations +
    +Class Inheritance

    +
    +java.lang.Object
+  extended by org.kiji.annotations.Inheritance
+
    +
    +
    +
    @ApiAudience.Framework
+@ApiStability.Evolving
+public final class Inheritance
    extends Object
    + + +

    +Annotations that inform users of an interface or class's intended use + case. The class/interface may be Inheritance.Sealed or Inheritance.Extensible. + +

      +
    • By default, unlabeled interfaces (or classes) should be assumed to be sealed.
      • +
    • A Inheritance.Sealed interface should only be implemented by Kiji. + Clients should expect to hold references to concrete instances + of such classes/interfaces, but should not implement them.
      • +
    • An Inheritance.Extensible interface is intended for extension by clients. You + may write classes that implement these interfaces.
      • +
    + +

    These +

    + +

    +

    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static interfaceInheritance.Extensible + +
    +          An interface or class that users can implement or extend.
    +static interfaceInheritance.Sealed + +
    +          An interface or class that you should not implement or extend.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.Framework.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.Framework.html new file mode 100644 index 00000000..d2235e80 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.Framework.html @@ -0,0 +1,184 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience.Framework (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience.Framework

    +
    + + + + + +
    +Uses of ApiAudience.Framework in org.kiji.annotations
    +  +

    + + + + + + + + + + + + + + + + + +
    Classes in org.kiji.annotations with annotations of type ApiAudience.Framework
    + classApiAudience + +
    +          Annotations that inform users of a package, class or method's intended audience.
    + classApiStability + +
    +          Annotations that inform users of a package, class or method's current stability + level.
    + classInheritance + +
    +          Annotations that inform users of an interface or class's intended use + case.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.Private.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.Private.html new file mode 100644 index 00000000..c90b73de --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.Private.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience.Private (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience.Private

    +
    +No usage of org.kiji.annotations.ApiAudience.Private +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.Public.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.Public.html new file mode 100644 index 00000000..126fdae1 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.Public.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience.Public (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience.Public

    +
    +No usage of org.kiji.annotations.ApiAudience.Public +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.html new file mode 100644 index 00000000..38cc8fd1 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiAudience.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience

    +
    +No usage of org.kiji.annotations.ApiAudience +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.Evolving.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.Evolving.html new file mode 100644 index 00000000..ccd6f710 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.Evolving.html @@ -0,0 +1,184 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability.Evolving (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability.Evolving

    +
    + + + + + +
    +Uses of ApiStability.Evolving in org.kiji.annotations
    +  +

    + + + + + + + + + + + + + + + + + +
    Classes in org.kiji.annotations with annotations of type ApiStability.Evolving
    + classApiAudience + +
    +          Annotations that inform users of a package, class or method's intended audience.
    + classApiStability + +
    +          Annotations that inform users of a package, class or method's current stability + level.
    + classInheritance + +
    +          Annotations that inform users of an interface or class's intended use + case.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.Stable.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.Stable.html new file mode 100644 index 00000000..53e34963 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.Stable.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability.Stable (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability.Stable

    +
    +No usage of org.kiji.annotations.ApiStability.Stable +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.Unstable.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.Unstable.html new file mode 100644 index 00000000..c04048ca --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.Unstable.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability.Unstable (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability.Unstable

    +
    +No usage of org.kiji.annotations.ApiStability.Unstable +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.html new file mode 100644 index 00000000..62383a05 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/ApiStability.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability

    +
    +No usage of org.kiji.annotations.ApiStability +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/Inheritance.Extensible.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/Inheritance.Extensible.html new file mode 100644 index 00000000..ba179b53 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/Inheritance.Extensible.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.Inheritance.Extensible (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.Inheritance.Extensible

    +
    +No usage of org.kiji.annotations.Inheritance.Extensible +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/Inheritance.Sealed.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/Inheritance.Sealed.html new file mode 100644 index 00000000..3826f4b5 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/Inheritance.Sealed.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.Inheritance.Sealed (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.Inheritance.Sealed

    +
    +No usage of org.kiji.annotations.Inheritance.Sealed +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/Inheritance.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/Inheritance.html new file mode 100644 index 00000000..b1364e0d --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/class-use/Inheritance.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.Inheritance (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.Inheritance

    +
    +No usage of org.kiji.annotations.Inheritance +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-frame.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-frame.html new file mode 100644 index 00000000..f5ace8fa --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-frame.html @@ -0,0 +1,62 @@ + + + + + + + +org.kiji.annotations (annotations 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.annotations + + + + +
    +Classes  + +
    +ApiAudience +
    +ApiStability +
    +Inheritance
    + + + + + + +
    +Annotation Types  + +
    +ApiAudience.Framework +
    +ApiAudience.Private +
    +ApiAudience.Public +
    +ApiStability.Evolving +
    +ApiStability.Stable +
    +ApiStability.Unstable +
    +Inheritance.Extensible +
    +Inheritance.Sealed
    + + + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-summary.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-summary.html new file mode 100644 index 00000000..91fa845c --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-summary.html @@ -0,0 +1,227 @@ + + + + + + + +org.kiji.annotations (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.kiji.annotations +

    +Annotations used within the Kiji project to confer information to consumers + of the framework and other framework developers. +

    +See: +
    +          Description +

    + + + + + + + + + + + + + + + + + +
    +Class Summary
    ApiAudienceAnnotations that inform users of a package, class or method's intended audience.
    ApiStabilityAnnotations that inform users of a package, class or method's current stability + level.
    InheritanceAnnotations that inform users of an interface or class's intended use + case.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Annotation Types Summary
    ApiAudience.FrameworkAn API intended to be used between Kiji framework modules.
    ApiAudience.PrivateOnly to be used within a Kiji module.
    ApiAudience.PublicAn API intended to be used by clients at large.
    ApiStability.EvolvingAn API that does not change in incompatible ways within a minor version.
    ApiStability.StableAn API that does not change in incompatible ways within a major version.
    ApiStability.UnstableAn API that may change at any time.
    Inheritance.ExtensibleAn interface or class that users can implement or extend.
    Inheritance.SealedAn interface or class that you should not implement or extend.
    +  + +

    +

    +Package org.kiji.annotations Description +

    + +

    +Annotations used within the Kiji project to confer information to consumers + of the framework and other framework developers. These annotations include + ApiStability and ApiAudience information that specify the + scope in which code may be consumed. +

    + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-tree.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-tree.html new file mode 100644 index 00000000..74a0c1ac --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.annotations Class Hierarchy (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.kiji.annotations +

    +
    +

    +Class Hierarchy +

    + +

    +Annotation Type Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-use.html b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-use.html new file mode 100644 index 00000000..33d9a378 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/org/kiji/annotations/package-use.html @@ -0,0 +1,162 @@ + + + + + + + +Uses of Package org.kiji.annotations (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    org.kiji.annotations

    +
    + + + + + + + + + + + +
    +Classes in org.kiji.annotations used by org.kiji.annotations
    ApiAudience.Framework + +
    +          An API intended to be used between Kiji framework modules.
    ApiStability.Evolving + +
    +          An API that does not change in incompatible ways within a minor version.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/overview-tree.html b/apidocs/annotations/1.0.0-rc3/overview-tree.html new file mode 100644 index 00000000..df5a8bd1 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/overview-tree.html @@ -0,0 +1,164 @@ + + + + + + + +Class Hierarchy (annotations 1.0.0-rc3 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For All Packages

    +
    +
    +
    Package Hierarchies:
    org.kiji.annotations
    +
    +

    +Class Hierarchy +

    + +

    +Annotation Type Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc3/package-list b/apidocs/annotations/1.0.0-rc3/package-list new file mode 100644 index 00000000..2493c850 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/package-list @@ -0,0 +1 @@ +org.kiji.annotations diff --git a/apidocs/annotations/1.0.0-rc3/resources/inherit.gif b/apidocs/annotations/1.0.0-rc3/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/annotations/1.0.0-rc3/resources/inherit.gif differ diff --git a/apidocs/annotations/1.0.0-rc3/stylesheet.css b/apidocs/annotations/1.0.0-rc3/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc3/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/annotations/1.0.0-rc4/allclasses-frame.html b/apidocs/annotations/1.0.0-rc4/allclasses-frame.html new file mode 100644 index 00000000..f9a47acc --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/allclasses-frame.html @@ -0,0 +1,52 @@ + + + + + + + +All Classes (annotations 1.0.0-rc4 API) + + + + + + + + + + + +All Classes +
    + + + + + +
    ApiAudience +
    +ApiAudience.Framework +
    +ApiAudience.Private +
    +ApiAudience.Public +
    +ApiStability +
    +ApiStability.Evolving +
    +ApiStability.Stable +
    +ApiStability.Unstable +
    +Inheritance +
    +Inheritance.Extensible +
    +Inheritance.Sealed +
    +
    + + + diff --git a/apidocs/annotations/1.0.0-rc4/allclasses-noframe.html b/apidocs/annotations/1.0.0-rc4/allclasses-noframe.html new file mode 100644 index 00000000..55650d76 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/allclasses-noframe.html @@ -0,0 +1,52 @@ + + + + + + + +All Classes (annotations 1.0.0-rc4 API) + + + + + + + + + + + +All Classes +
    + + + + + +
    ApiAudience +
    +ApiAudience.Framework +
    +ApiAudience.Private +
    +ApiAudience.Public +
    +ApiStability +
    +ApiStability.Evolving +
    +ApiStability.Stable +
    +ApiStability.Unstable +
    +Inheritance +
    +Inheritance.Extensible +
    +Inheritance.Sealed +
    +
    + + + diff --git a/apidocs/annotations/1.0.0-rc4/constant-values.html b/apidocs/annotations/1.0.0-rc4/constant-values.html new file mode 100644 index 00000000..769706f1 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/constant-values.html @@ -0,0 +1,145 @@ + + + + + + + +Constant Field Values (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Constant Field Values

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/deprecated-list.html b/apidocs/annotations/1.0.0-rc4/deprecated-list.html new file mode 100644 index 00000000..8ca71b2e --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Deprecated API

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/help-doc.html b/apidocs/annotations/1.0.0-rc4/help-doc.html new file mode 100644 index 00000000..f0e8862d --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +How This API Document Is Organized

    +
    +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

    +Package

    +
    + +

    +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

      +
    • Interfaces (italic)
    • Classes
    • Enums
    • Exceptions
    • Errors
    • Annotation Types
    +
    +

    +Class/Interface

    +
    + +

    +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      +
    • Class inheritance diagram
    • Direct Subclasses
    • All Known Subinterfaces
    • All Known Implementing Classes
    • Class/interface declaration
    • Class/interface description +

      +

    • Nested Class Summary
    • Field Summary
    • Constructor Summary
    • Method Summary +

      +

    • Field Detail
    • Constructor Detail
    • Method Detail
    +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
    + +

    +Annotation Type

    +
    + +

    +Each annotation type has its own separate page with the following sections:

      +
    • Annotation Type declaration
    • Annotation Type description
    • Required Element Summary
    • Optional Element Summary
    • Element Detail
    +
    + +

    +Enum

    +
    + +

    +Each enum has its own separate page with the following sections:

      +
    • Enum declaration
    • Enum description
    • Enum Constant Summary
    • Enum Constant Detail
    +
    +

    +Use

    +
    +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
    +

    +Tree (Class Hierarchy)

    +
    +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
    +
    +

    +Deprecated API

    +
    +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
    +

    +Index

    +
    +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
    +

    +Prev/Next

    +These links take you to the next or previous class, interface, package, or related page.

    +Frames/No Frames

    +These links show and hide the HTML frames. All pages are available with or without frames. +

    +

    +Serialized Form

    +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

    +

    +Constant Field Values

    +The Constant Field Values page lists the static final fields and their values. +

    + + +This help file applies to API documentation generated using the standard doclet. + +
    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/index-all.html b/apidocs/annotations/1.0.0-rc4/index-all.html new file mode 100644 index 00000000..4e7e5127 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/index-all.html @@ -0,0 +1,154 @@ + + + + + + + +Index (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +A I O
    +

    +A

    +
    +
    ApiAudience - Class in org.kiji.annotations
    Annotations that inform users of a package, class or method's intended audience.
    ApiAudience.Framework - Annotation Type in org.kiji.annotations
    An API intended to be used between Kiji framework modules.
    ApiAudience.Private - Annotation Type in org.kiji.annotations
    Only to be used within a Kiji module.
    ApiAudience.Public - Annotation Type in org.kiji.annotations
    An API intended to be used by clients at large.
    ApiStability - Class in org.kiji.annotations
    Annotations that inform users of a package, class or method's current stability + level.
    ApiStability.Evolving - Annotation Type in org.kiji.annotations
    An API that does not change in incompatible ways within a minor version.
    ApiStability.Stable - Annotation Type in org.kiji.annotations
    An API that does not change in incompatible ways within a major version.
    ApiStability.Unstable - Annotation Type in org.kiji.annotations
    An API that may change at any time.
    +
    +

    +I

    +
    +
    Inheritance - Class in org.kiji.annotations
    Annotations that inform users of an interface or class's intended use + case.
    Inheritance.Extensible - Annotation Type in org.kiji.annotations
    An interface or class that users can implement or extend.
    Inheritance.Sealed - Annotation Type in org.kiji.annotations
    An interface or class that you should not implement or extend.
    +
    +

    +O

    +
    +
    org.kiji.annotations - package org.kiji.annotations
    Annotations used within the Kiji project to confer information to consumers + of the framework and other framework developers.
    +
    +A I O + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/index.html b/apidocs/annotations/1.0.0-rc4/index.html new file mode 100644 index 00000000..cd316e96 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/index.html @@ -0,0 +1,37 @@ + + + + + + + +annotations 1.0.0-rc4 API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/annotations/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.Framework.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.Framework.html new file mode 100644 index 00000000..db7e34f2 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.Framework.html @@ -0,0 +1,171 @@ + + + + + + + +ApiAudience.Framework (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiAudience.Framework

    +
    +
    +
    @Documented
+public static @interface ApiAudience.Framework
    + + +

    +An API intended to be used between Kiji framework modules. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.Private.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.Private.html new file mode 100644 index 00000000..0dc0eba4 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.Private.html @@ -0,0 +1,172 @@ + + + + + + + +ApiAudience.Private (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiAudience.Private

    +
    +
    +
    @Documented
+public static @interface ApiAudience.Private
    + + +

    +Only to be used within a Kiji module. The API or semantics of the annotated + class may change at any time. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.Public.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.Public.html new file mode 100644 index 00000000..34478667 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.Public.html @@ -0,0 +1,171 @@ + + + + + + + +ApiAudience.Public (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiAudience.Public

    +
    +
    +
    @Documented
+public static @interface ApiAudience.Public
    + + +

    +An API intended to be used by clients at large. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.html new file mode 100644 index 00000000..86629c82 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiAudience.html @@ -0,0 +1,249 @@ + + + + + + + +ApiAudience (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.annotations +
    +Class ApiAudience

    +
    +java.lang.Object
+  extended by org.kiji.annotations.ApiAudience
+
    +
    +
    +
    @ApiAudience.Framework
+@ApiStability.Evolving
+public final class ApiAudience
    extends Object
    + + +

    +Annotations that inform users of a package, class or method's intended audience. + The audience may be ApiAudience.Public, ApiAudience.Framework, or ApiAudience.Private. + +

      +
    • By default, unlabeled classes should be assumed to be private.
      • +
    • External applications must only use classes marked as ApiAudience.Public. + Public classes will evolve in compatible ways only, subject to ApiStability + concerns. External client apps that depend on non-public APIs may find that they + have difficulty upgrading Kiji versions.
      • +
    • The ApiAudience.Framework publicity level is reserved for APIs that allow + communication between Kiji modules (e.g., between KijiSchema and kiji-schema-shell). + These are not intended for direct use by clients. Authors + of system-level tools may use these APIs, but should keep a close eye + on dev@kiji.org and issues@kiji.org.
      + + Framework-public APIs may change in incompatible ways between + minor releases (1.1.0 -> 1.2.0) of a component.
      • +
    • The ApiAudience.Private publicity level is used for code whose audience is + restricted to the current module (e.g., within KijiSchema). This code may + change in incompatible ways at any time.
      • +
    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static interfaceApiAudience.Framework + +
    +          An API intended to be used between Kiji framework modules.
    +static interfaceApiAudience.Private + +
    +          Only to be used within a Kiji module.
    +static interfaceApiAudience.Public + +
    +          An API intended to be used by clients at large.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.Evolving.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.Evolving.html new file mode 100644 index 00000000..be6fa687 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.Evolving.html @@ -0,0 +1,171 @@ + + + + + + + +ApiStability.Evolving (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiStability.Evolving

    +
    +
    +
    @Documented
+public static @interface ApiStability.Evolving
    + + +

    +An API that does not change in incompatible ways within a minor version. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.Stable.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.Stable.html new file mode 100644 index 00000000..4f7314b9 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.Stable.html @@ -0,0 +1,171 @@ + + + + + + + +ApiStability.Stable (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiStability.Stable

    +
    +
    +
    @Documented
+public static @interface ApiStability.Stable
    + + +

    +An API that does not change in incompatible ways within a major version. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.Unstable.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.Unstable.html new file mode 100644 index 00000000..b1cd3ab8 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.Unstable.html @@ -0,0 +1,171 @@ + + + + + + + +ApiStability.Unstable (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type ApiStability.Unstable

    +
    +
    +
    @Documented
+public static @interface ApiStability.Unstable
    + + +

    +An API that may change at any time. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.html new file mode 100644 index 00000000..0e489c42 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/ApiStability.html @@ -0,0 +1,241 @@ + + + + + + + +ApiStability (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.annotations +
    +Class ApiStability

    +
    +java.lang.Object
+  extended by org.kiji.annotations.ApiStability
+
    +
    +
    +
    @ApiAudience.Framework
+@ApiStability.Evolving
+public final class ApiStability
    extends Object
    + + +

    +Annotations that inform users of a package, class or method's current stability + level. The stability level may be ApiStability.Stable, ApiStability.Evolving, or ApiStability.Unstable. + +

      +
    • By default, unlabeled classes should be assumed to be unstable.
      • +
    • ApiStability.Stable APIs are guaranteed to change only in binary-compatible + ways within a major version (e.g., all 1.x.x versions)
      • +
    • ApiStability.Evolving APIs may change in binary-incompatible ways between + minor versions (e.g., from 1.4.1 to 1.5.0) of the software.
      • +
    • ApiStability.Unstable APIs may change at any time.
      • +
    + +

    Private APIs should all be considered ApiStability.Unstable.

    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static interfaceApiStability.Evolving + +
    +          An API that does not change in incompatible ways within a minor version.
    +static interfaceApiStability.Stable + +
    +          An API that does not change in incompatible ways within a major version.
    +static interfaceApiStability.Unstable + +
    +          An API that may change at any time.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/Inheritance.Extensible.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/Inheritance.Extensible.html new file mode 100644 index 00000000..9871dda3 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/Inheritance.Extensible.html @@ -0,0 +1,171 @@ + + + + + + + +Inheritance.Extensible (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type Inheritance.Extensible

    +
    +
    +
    @Documented
+public static @interface Inheritance.Extensible
    + + +

    +An interface or class that users can implement or extend. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/Inheritance.Sealed.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/Inheritance.Sealed.html new file mode 100644 index 00000000..437c7d15 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/Inheritance.Sealed.html @@ -0,0 +1,173 @@ + + + + + + + +Inheritance.Sealed (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.annotations +
    +Annotation Type Inheritance.Sealed

    +
    +
    +
    @Documented
+public static @interface Inheritance.Sealed
    + + +

    +An interface or class that you should not implement or extend. You may + be handed instances of this interface in response to another Kiji API + call. +

    + +

    + +

    + +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/Inheritance.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/Inheritance.html new file mode 100644 index 00000000..f2bccc90 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/Inheritance.html @@ -0,0 +1,233 @@ + + + + + + + +Inheritance (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.annotations +
    +Class Inheritance

    +
    +java.lang.Object
+  extended by org.kiji.annotations.Inheritance
+
    +
    +
    +
    @ApiAudience.Framework
+@ApiStability.Evolving
+public final class Inheritance
    extends Object
    + + +

    +Annotations that inform users of an interface or class's intended use + case. The class/interface may be Inheritance.Sealed or Inheritance.Extensible. + +

      +
    • By default, unlabeled interfaces (or classes) should be assumed to be sealed.
      • +
    • A Inheritance.Sealed interface should only be implemented by Kiji. + Clients should expect to hold references to concrete instances + of such classes/interfaces, but should not implement them.
      • +
    • An Inheritance.Extensible interface is intended for extension by clients. You + may write classes that implement these interfaces.
      • +
    + +

    These +

    + +

    +

    + +

    + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static interfaceInheritance.Extensible + +
    +          An interface or class that users can implement or extend.
    +static interfaceInheritance.Sealed + +
    +          An interface or class that you should not implement or extend.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + +

    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.Framework.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.Framework.html new file mode 100644 index 00000000..ab1a85dd --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.Framework.html @@ -0,0 +1,184 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience.Framework (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience.Framework

    +
    + + + + + +
    +Uses of ApiAudience.Framework in org.kiji.annotations
    +  +

    + + + + + + + + + + + + + + + + + +
    Classes in org.kiji.annotations with annotations of type ApiAudience.Framework
    + classApiAudience + +
    +          Annotations that inform users of a package, class or method's intended audience.
    + classApiStability + +
    +          Annotations that inform users of a package, class or method's current stability + level.
    + classInheritance + +
    +          Annotations that inform users of an interface or class's intended use + case.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.Private.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.Private.html new file mode 100644 index 00000000..08f9bce2 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.Private.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience.Private (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience.Private

    +
    +No usage of org.kiji.annotations.ApiAudience.Private +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.Public.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.Public.html new file mode 100644 index 00000000..703b0933 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.Public.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience.Public (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience.Public

    +
    +No usage of org.kiji.annotations.ApiAudience.Public +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.html new file mode 100644 index 00000000..bd8a4eb6 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiAudience.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiAudience (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiAudience

    +
    +No usage of org.kiji.annotations.ApiAudience +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.Evolving.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.Evolving.html new file mode 100644 index 00000000..a93a6ff0 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.Evolving.html @@ -0,0 +1,184 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability.Evolving (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability.Evolving

    +
    + + + + + +
    +Uses of ApiStability.Evolving in org.kiji.annotations
    +  +

    + + + + + + + + + + + + + + + + + +
    Classes in org.kiji.annotations with annotations of type ApiStability.Evolving
    + classApiAudience + +
    +          Annotations that inform users of a package, class or method's intended audience.
    + classApiStability + +
    +          Annotations that inform users of a package, class or method's current stability + level.
    + classInheritance + +
    +          Annotations that inform users of an interface or class's intended use + case.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.Stable.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.Stable.html new file mode 100644 index 00000000..bad80b0d --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.Stable.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability.Stable (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability.Stable

    +
    +No usage of org.kiji.annotations.ApiStability.Stable +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.Unstable.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.Unstable.html new file mode 100644 index 00000000..2cb0e21e --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.Unstable.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability.Unstable (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability.Unstable

    +
    +No usage of org.kiji.annotations.ApiStability.Unstable +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.html new file mode 100644 index 00000000..2d0e082d --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/ApiStability.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.ApiStability (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.ApiStability

    +
    +No usage of org.kiji.annotations.ApiStability +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/Inheritance.Extensible.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/Inheritance.Extensible.html new file mode 100644 index 00000000..d349c09d --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/Inheritance.Extensible.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.Inheritance.Extensible (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.Inheritance.Extensible

    +
    +No usage of org.kiji.annotations.Inheritance.Extensible +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/Inheritance.Sealed.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/Inheritance.Sealed.html new file mode 100644 index 00000000..87045c6e --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/Inheritance.Sealed.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.Inheritance.Sealed (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.Inheritance.Sealed

    +
    +No usage of org.kiji.annotations.Inheritance.Sealed +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/Inheritance.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/Inheritance.html new file mode 100644 index 00000000..daf38cbc --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/class-use/Inheritance.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.annotations.Inheritance (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.annotations.Inheritance

    +
    +No usage of org.kiji.annotations.Inheritance +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-frame.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-frame.html new file mode 100644 index 00000000..37217550 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-frame.html @@ -0,0 +1,62 @@ + + + + + + + +org.kiji.annotations (annotations 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.annotations + + + + +
    +Classes  + +
    +ApiAudience +
    +ApiStability +
    +Inheritance
    + + + + + + +
    +Annotation Types  + +
    +ApiAudience.Framework +
    +ApiAudience.Private +
    +ApiAudience.Public +
    +ApiStability.Evolving +
    +ApiStability.Stable +
    +ApiStability.Unstable +
    +Inheritance.Extensible +
    +Inheritance.Sealed
    + + + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-summary.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-summary.html new file mode 100644 index 00000000..eb433ccc --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-summary.html @@ -0,0 +1,227 @@ + + + + + + + +org.kiji.annotations (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.kiji.annotations +

    +Annotations used within the Kiji project to confer information to consumers + of the framework and other framework developers. +

    +See: +
    +          Description +

    + + + + + + + + + + + + + + + + + +
    +Class Summary
    ApiAudienceAnnotations that inform users of a package, class or method's intended audience.
    ApiStabilityAnnotations that inform users of a package, class or method's current stability + level.
    InheritanceAnnotations that inform users of an interface or class's intended use + case.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Annotation Types Summary
    ApiAudience.FrameworkAn API intended to be used between Kiji framework modules.
    ApiAudience.PrivateOnly to be used within a Kiji module.
    ApiAudience.PublicAn API intended to be used by clients at large.
    ApiStability.EvolvingAn API that does not change in incompatible ways within a minor version.
    ApiStability.StableAn API that does not change in incompatible ways within a major version.
    ApiStability.UnstableAn API that may change at any time.
    Inheritance.ExtensibleAn interface or class that users can implement or extend.
    Inheritance.SealedAn interface or class that you should not implement or extend.
    +  + +

    +

    +Package org.kiji.annotations Description +

    + +

    +Annotations used within the Kiji project to confer information to consumers + of the framework and other framework developers. These annotations include + ApiStability and ApiAudience information that specify the + scope in which code may be consumed. +

    + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-tree.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-tree.html new file mode 100644 index 00000000..bc122555 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.annotations Class Hierarchy (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.kiji.annotations +

    +
    +

    +Class Hierarchy +

    + +

    +Annotation Type Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-use.html b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-use.html new file mode 100644 index 00000000..b06f942e --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/org/kiji/annotations/package-use.html @@ -0,0 +1,162 @@ + + + + + + + +Uses of Package org.kiji.annotations (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    org.kiji.annotations

    +
    + + + + + + + + + + + +
    +Classes in org.kiji.annotations used by org.kiji.annotations
    ApiAudience.Framework + +
    +          An API intended to be used between Kiji framework modules.
    ApiStability.Evolving + +
    +          An API that does not change in incompatible ways within a minor version.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/overview-tree.html b/apidocs/annotations/1.0.0-rc4/overview-tree.html new file mode 100644 index 00000000..d68444f5 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/overview-tree.html @@ -0,0 +1,164 @@ + + + + + + + +Class Hierarchy (annotations 1.0.0-rc4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For All Packages

    +
    +
    +
    Package Hierarchies:
    org.kiji.annotations
    +
    +

    +Class Hierarchy +

    + +

    +Annotation Type Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/annotations/1.0.0-rc4/package-list b/apidocs/annotations/1.0.0-rc4/package-list new file mode 100644 index 00000000..2493c850 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/package-list @@ -0,0 +1 @@ +org.kiji.annotations diff --git a/apidocs/annotations/1.0.0-rc4/resources/inherit.gif b/apidocs/annotations/1.0.0-rc4/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/annotations/1.0.0-rc4/resources/inherit.gif differ diff --git a/apidocs/annotations/1.0.0-rc4/stylesheet.css b/apidocs/annotations/1.0.0-rc4/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/annotations/1.0.0-rc4/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/hadoop-configurator/1.0.2/allclasses-frame.html b/apidocs/hadoop-configurator/1.0.2/allclasses-frame.html new file mode 100644 index 00000000..ed24d6e6 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/allclasses-frame.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (hadoop-configurator 1.0.2 API) + + + + + + + + + + + +All Classes +
    + + + + + +
    ConfigurationMethod +
    +ConfigurationVariable +
    +HadoopConf +
    +HadoopConfigurationException +
    +HadoopConfigurator +
    +
    + + + diff --git a/apidocs/hadoop-configurator/1.0.2/allclasses-noframe.html b/apidocs/hadoop-configurator/1.0.2/allclasses-noframe.html new file mode 100644 index 00000000..29a011b1 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/allclasses-noframe.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (hadoop-configurator 1.0.2 API) + + + + + + + + + + + +All Classes +
    + + + + + +
    ConfigurationMethod +
    +ConfigurationVariable +
    +HadoopConf +
    +HadoopConfigurationException +
    +HadoopConfigurator +
    +
    + + + diff --git a/apidocs/hadoop-configurator/1.0.2/constant-values.html b/apidocs/hadoop-configurator/1.0.2/constant-values.html new file mode 100644 index 00000000..0e22576c --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/constant-values.html @@ -0,0 +1,145 @@ + + + + + + + +Constant Field Values (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Constant Field Values

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/deprecated-list.html b/apidocs/hadoop-configurator/1.0.2/deprecated-list.html new file mode 100644 index 00000000..3605ad28 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Deprecated API

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/help-doc.html b/apidocs/hadoop-configurator/1.0.2/help-doc.html new file mode 100644 index 00000000..bddc8c22 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +How This API Document Is Organized

    +
    +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

    +Package

    +
    + +

    +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

      +
    • Interfaces (italic)
    • Classes
    • Enums
    • Exceptions
    • Errors
    • Annotation Types
    +
    +

    +Class/Interface

    +
    + +

    +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      +
    • Class inheritance diagram
    • Direct Subclasses
    • All Known Subinterfaces
    • All Known Implementing Classes
    • Class/interface declaration
    • Class/interface description +

      +

    • Nested Class Summary
    • Field Summary
    • Constructor Summary
    • Method Summary +

      +

    • Field Detail
    • Constructor Detail
    • Method Detail
    +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
    + +

    +Annotation Type

    +
    + +

    +Each annotation type has its own separate page with the following sections:

      +
    • Annotation Type declaration
    • Annotation Type description
    • Required Element Summary
    • Optional Element Summary
    • Element Detail
    +
    + +

    +Enum

    +
    + +

    +Each enum has its own separate page with the following sections:

      +
    • Enum declaration
    • Enum description
    • Enum Constant Summary
    • Enum Constant Detail
    +
    +

    +Use

    +
    +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
    +

    +Tree (Class Hierarchy)

    +
    +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
    +
    +

    +Deprecated API

    +
    +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
    +

    +Index

    +
    +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
    +

    +Prev/Next

    +These links take you to the next or previous class, interface, package, or related page.

    +Frames/No Frames

    +These links show and hide the HTML frames. All pages are available with or without frames. +

    +

    +Serialized Form

    +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

    +

    +Constant Field Values

    +The Constant Field Values page lists the static final fields and their values. +

    + + +This help file applies to API documentation generated using the standard doclet. + +
    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/index-all.html b/apidocs/hadoop-configurator/1.0.2/index-all.html new file mode 100644 index 00000000..20ff13eb --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/index-all.html @@ -0,0 +1,214 @@ + + + + + + + +Index (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +C E G H O S
    +

    +C

    +
    +
    call(Object, Configuration) - +Method in class org.kiji.hadoop.configurator.ConfigurationMethod +
    Calls an object's method with the value read from a Configuration instance. +
    ConfigurationMethod - Class in org.kiji.hadoop.configurator
    This class encapsulates everything there is to know about a Hadoop + configuration method declaration.
    ConfigurationMethod(Method, HadoopConf) - +Constructor for class org.kiji.hadoop.configurator.ConfigurationMethod +
    Constructs a ConfigurationMethod instance. +
    ConfigurationVariable - Class in org.kiji.hadoop.configurator
    This class encapsulates everything there is to know about a Hadoop + configuration variable declaration.
    ConfigurationVariable(Field, HadoopConf) - +Constructor for class org.kiji.hadoop.configurator.ConfigurationVariable +
    Constructs a ConfigurationVariable instance. +
    configure(Object, Configuration, boolean) - +Static method in class org.kiji.hadoop.configurator.HadoopConfigurator +
    Populates the instance variables of a Configurable + instance with values from its Configuration. +
    configure(Configurable, boolean) - +Static method in class org.kiji.hadoop.configurator.HadoopConfigurator +
    Populates the instance variables of a Configurable + instance with values from its Configuration. +
    configure(Configurable) - +Static method in class org.kiji.hadoop.configurator.HadoopConfigurator +
    Populates the instance variables of a Configurable + instance with values from its Configuration. +
    +
    +

    +E

    +
    +
    extractDeclaredMethods(Class<?>, boolean) - +Static method in class org.kiji.hadoop.configurator.HadoopConfigurator +
    Extracts the declared Hadoop configuration method (methods with + @HadoopConf annotations) from a class. +
    extractDeclaredVariables(Class<?>, boolean) - +Static method in class org.kiji.hadoop.configurator.HadoopConfigurator +
    Extracts the declared Hadoop configuration variables (fields with + @HadoopConf annotations) from a class. +
    +
    +

    +G

    +
    +
    getKey() - +Method in class org.kiji.hadoop.configurator.ConfigurationMethod +
    Gets the configuration key that should be used to populate the field. +
    getKey() - +Method in class org.kiji.hadoop.configurator.ConfigurationVariable +
    Gets the configuration key that should be used to populate the field. +
    +
    +

    +H

    +
    +
    HadoopConf - Annotation Type in org.kiji.hadoop.configurator
    The annotation used on instance (member) variables to tell the HadoopConfigurator + system that they should be populated with values from the Configuration.
    HadoopConfigurationException - Exception in org.kiji.hadoop.configurator
    An exception thrown when there is an error populating the member + variables of a Configurable instance.
    HadoopConfigurationException(String) - +Constructor for exception org.kiji.hadoop.configurator.HadoopConfigurationException +
    Constructs the exception. +
    HadoopConfigurationException(Throwable) - +Constructor for exception org.kiji.hadoop.configurator.HadoopConfigurationException +
    Constructs the exception. +
    HadoopConfigurator - Class in org.kiji.hadoop.configurator
    The entry point for the HadoopConfigurator system.
    +
    +

    +O

    +
    +
    org.kiji.hadoop.configurator - package org.kiji.hadoop.configurator
    The HadoopConfigurator system.
    +
    +

    +S

    +
    +
    setValue(Object, Configuration) - +Method in class org.kiji.hadoop.configurator.ConfigurationVariable +
    Populates an object's field with the value read from a Configuration instance. +
    +
    +C E G H O S + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/index.html b/apidocs/hadoop-configurator/1.0.2/index.html new file mode 100644 index 00000000..a285ab91 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/index.html @@ -0,0 +1,37 @@ + + + + + + + +hadoop-configurator 1.0.2 API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/hadoop/configurator/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/ConfigurationMethod.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/ConfigurationMethod.html new file mode 100644 index 00000000..55a90dad --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/ConfigurationMethod.html @@ -0,0 +1,292 @@ + + + + + + + +ConfigurationMethod (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.hadoop.configurator +
    +Class ConfigurationMethod

    +
    +java.lang.Object
+  extended by org.kiji.hadoop.configurator.ConfigurationMethod
+
    +
    +
    +
    public class ConfigurationMethod
    extends Object
    + + +

    +This class encapsulates everything there is to know about a Hadoop + configuration method declaration. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ConfigurationMethod(Method method, + HadoopConf annotation) + +
    +          Constructs a ConfigurationMethod instance.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcall(Object instance, + org.apache.hadoop.conf.Configuration conf) + +
    +          Calls an object's method with the value read from a Configuration instance.
    + StringgetKey() + +
    +          Gets the configuration key that should be used to populate the field.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +ConfigurationMethod

    +
    +public ConfigurationMethod(Method method,
+                           HadoopConf annotation)
    +
    +
    Constructs a ConfigurationMethod instance. +

    +

    +
    Parameters:
    method - The method that has the annotation on it.
    annotation - The annotation on the method.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getKey

    +
    +public String getKey()
    +
    +
    Gets the configuration key that should be used to populate the field. +

    +

    + +
    Returns:
    The key that was specified in the HadoopConf annotation.
    +
    +
    +
    + +

    +call

    +
    +public void call(Object instance,
+                 org.apache.hadoop.conf.Configuration conf)
+          throws IllegalAccessException
    +
    +
    Calls an object's method with the value read from a Configuration instance. +

    +

    +
    Parameters:
    instance - The object to populate.
    conf - The configuration to read from. +
    Throws: +
    IllegalAccessException - If the method cannot be called on the object. +
    HadoopConfigurationException - If there is a problem with the annotation definition.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/ConfigurationVariable.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/ConfigurationVariable.html new file mode 100644 index 00000000..e49891b8 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/ConfigurationVariable.html @@ -0,0 +1,292 @@ + + + + + + + +ConfigurationVariable (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.hadoop.configurator +
    +Class ConfigurationVariable

    +
    +java.lang.Object
+  extended by org.kiji.hadoop.configurator.ConfigurationVariable
+
    +
    +
    +
    public class ConfigurationVariable
    extends Object
    + + +

    +This class encapsulates everything there is to know about a Hadoop + configuration variable declaration. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ConfigurationVariable(Field field, + HadoopConf annotation) + +
    +          Constructs a ConfigurationVariable instance.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + StringgetKey() + +
    +          Gets the configuration key that should be used to populate the field.
    + voidsetValue(Object instance, + org.apache.hadoop.conf.Configuration conf) + +
    +          Populates an object's field with the value read from a Configuration instance.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +ConfigurationVariable

    +
    +public ConfigurationVariable(Field field,
+                             HadoopConf annotation)
    +
    +
    Constructs a ConfigurationVariable instance. +

    +

    +
    Parameters:
    field - The variable that has the annotation on it.
    annotation - The annotation on the field.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getKey

    +
    +public String getKey()
    +
    +
    Gets the configuration key that should be used to populate the field. +

    +

    + +
    Returns:
    The key that was specified in the HadoopConf annotation.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(Object instance,
+                     org.apache.hadoop.conf.Configuration conf)
+              throws IllegalAccessException
    +
    +
    Populates an object's field with the value read from a Configuration instance. +

    +

    +
    Parameters:
    instance - The object to populate.
    conf - The configuration to read from. +
    Throws: +
    IllegalAccessException - If the field cannot be set on the object. +
    HadoopConfigurationException - If there is a problem with the annotation definition.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/HadoopConf.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/HadoopConf.html new file mode 100644 index 00000000..dac24ffe --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/HadoopConf.html @@ -0,0 +1,278 @@ + + + + + + + +HadoopConf (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.hadoop.configurator +
    +Annotation Type HadoopConf

    +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value={FIELD,METHOD})
+public @interface HadoopConf
    + + +

    +The annotation used on instance (member) variables to tell the HadoopConfigurator + system that they should be populated with values from the Configuration. +

    + +

    +

    +
    See Also:
    HadoopConfigurator
    +
    + +

    + + + + + + + + + + + +
    +Required Element Summary
    + Stringkey + +
    +          The key used in the Configuration for this variable.
    +  + + + + + + + + + + + + + + +
    +Optional Element Summary
    + StringdefaultValue + +
    +          The default value for the configuration variable.
    + Stringusage + +
    +          Documents the usage of this configuration variable.
    +  +

    + + + + + + + + +
    +Element Detail
    + +

    +key

    +
    +public abstract String key
    +
    +
    The key used in the Configuration for this variable. + +

    This field is required.

    +

    +

    +
    +
    +
    +
    +
    +

    +usage

    +
    +public abstract String usage
    +
    +
    Documents the usage of this configuration variable. +

    +

    +
    +
    +
    +
    +
    +
    Default:
    ""
    +
    +
    +
    + +

    +defaultValue

    +
    +public abstract String defaultValue
    +
    +
    The default value for the configuration variable. +

    +

    +
    +
    +
    +
    +
    +
    Default:
    ""
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/HadoopConfigurationException.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/HadoopConfigurationException.html new file mode 100644 index 00000000..227562a7 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/HadoopConfigurationException.html @@ -0,0 +1,267 @@ + + + + + + + +HadoopConfigurationException (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.hadoop.configurator +
    +Class HadoopConfigurationException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.hadoop.configurator.HadoopConfigurationException
+
    +
    +
    All Implemented Interfaces:
    Serializable
    +
    +
    +
    +
    public class HadoopConfigurationException
    extends RuntimeException
    + + +

    +An exception thrown when there is an error populating the member + variables of a Configurable instance. +

    + +

    +

    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + + + + + + + + +
    +Constructor Summary
    HadoopConfigurationException(String message) + +
    +          Constructs the exception.
    HadoopConfigurationException(Throwable cause) + +
    +          Constructs the exception.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Throwable
    fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +HadoopConfigurationException

    +
    +public HadoopConfigurationException(String message)
    +
    +
    Constructs the exception. +

    +

    +
    Parameters:
    message - A message.
    +
    +
    + +

    +HadoopConfigurationException

    +
    +public HadoopConfigurationException(Throwable cause)
    +
    +
    Constructs the exception. +

    +

    +
    Parameters:
    cause - The cause.
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/HadoopConfigurator.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/HadoopConfigurator.html new file mode 100644 index 00000000..3135b300 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/HadoopConfigurator.html @@ -0,0 +1,360 @@ + + + + + + + +HadoopConfigurator (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.hadoop.configurator +
    +Class HadoopConfigurator

    +
    +java.lang.Object
+  extended by org.kiji.hadoop.configurator.HadoopConfigurator
+
    +
    +
    +
    public final class HadoopConfigurator
    extends Object
    + + +

    +The entry point for the HadoopConfigurator system. + +

    Clients should call configure(org.apache.hadoop.conf.Configurable) within their Configurable.setConf(org.apache.hadoop.conf.Configuration) + method to populate all of their member variables with values read from the Configuration.

    + +

    For example:

    + + 
    + public class Foo extends Configured {
+   @HadoopConf(key="foo.value", usage="The foo value")
+   private String fooValue = "defaultValue";
+
+   @Override
+   public void setConf(Configuration conf) {
+     super.setConf(conf);
+     HadoopConfigurator.configure(this);
+     // Now fooValue has been populated with the value of conf.get("foo.value").
+   }
+ }
+
    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static voidconfigure(org.apache.hadoop.conf.Configurable instance) + +
    +          Populates the instance variables of a Configurable + instance with values from its Configuration.
    +static voidconfigure(org.apache.hadoop.conf.Configurable instance, + boolean includeParentClasses) + +
    +          Populates the instance variables of a Configurable + instance with values from its Configuration.
    +static voidconfigure(Object instance, + org.apache.hadoop.conf.Configuration conf, + boolean includeParentClasses) + +
    +          Populates the instance variables of a Configurable + instance with values from its Configuration.
    +static List<ConfigurationMethod>extractDeclaredMethods(Class<?> clazz, + boolean includeParentClasses) + +
    +          Extracts the declared Hadoop configuration method (methods with + @HadoopConf annotations) from a class.
    +static List<ConfigurationVariable>extractDeclaredVariables(Class<?> clazz, + boolean includeParentClasses) + +
    +          Extracts the declared Hadoop configuration variables (fields with + @HadoopConf annotations) from a class.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +configure

    +
    +public static void configure(Object instance,
+                             org.apache.hadoop.conf.Configuration conf,
+                             boolean includeParentClasses)
    +
    +
    Populates the instance variables of a Configurable + instance with values from its Configuration. +

    +

    +
    Parameters:
    instance - The instance to configure.
    conf - The configuration to read from.
    includeParentClasses - Whether to include declared variables in super classes. +
    Throws: +
    HadoopConfigurationException - If there is an error with the declaration or + assigning the field.
    +
    +
    +
    + +

    +configure

    +
    +public static void configure(org.apache.hadoop.conf.Configurable instance,
+                             boolean includeParentClasses)
    +
    +
    Populates the instance variables of a Configurable + instance with values from its Configuration. +

    +

    +
    Parameters:
    instance - The instance to configure.
    includeParentClasses - Whether to include declared variables in super classes. +
    Throws: +
    HadoopConfigurationException - If there is an error with the declaration or + assigning the field.
    +
    +
    +
    + +

    +configure

    +
    +public static void configure(org.apache.hadoop.conf.Configurable instance)
    +
    +
    Populates the instance variables of a Configurable + instance with values from its Configuration. + +

    This includes annotations declared in parent classes.

    +

    +

    +
    Parameters:
    instance - The instance to configure. +
    Throws: +
    HadoopConfigurationException - If there is an error with the declaration or + assigning the field.
    +
    +
    +
    + +

    +extractDeclaredVariables

    +
    +public static List<ConfigurationVariable> extractDeclaredVariables(Class<?> clazz,
+                                                                   boolean includeParentClasses)
    +
    +
    Extracts the declared Hadoop configuration variables (fields with + @HadoopConf annotations) from a class. +

    +

    +
    Parameters:
    clazz - The class to extract conf variable declarations from.
    includeParentClasses - If true, also includes declared variables in the super classes. +
    Returns:
    The list of configuration variables declared.
    +
    +
    +
    + +

    +extractDeclaredMethods

    +
    +public static List<ConfigurationMethod> extractDeclaredMethods(Class<?> clazz,
+                                                               boolean includeParentClasses)
    +
    +
    Extracts the declared Hadoop configuration method (methods with + @HadoopConf annotations) from a class. +

    +

    +
    Parameters:
    clazz - The class to extract conf method declarations from.
    includeParentClasses - If true, also includes declared methods in the super classes. +
    Returns:
    The list of configuration methods declared.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/ConfigurationMethod.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/ConfigurationMethod.html new file mode 100644 index 00000000..342785c1 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/ConfigurationMethod.html @@ -0,0 +1,168 @@ + + + + + + + +Uses of Class org.kiji.hadoop.configurator.ConfigurationMethod (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.hadoop.configurator.ConfigurationMethod

    +
    + + + + + +
    +Uses of ConfigurationMethod in org.kiji.hadoop.configurator
    +  +

    + + + + + + + + + +
    Methods in org.kiji.hadoop.configurator that return types with arguments of type ConfigurationMethod
    +static List<ConfigurationMethod>HadoopConfigurator.extractDeclaredMethods(Class<?> clazz, + boolean includeParentClasses) + +
    +          Extracts the declared Hadoop configuration method (methods with + @HadoopConf annotations) from a class.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/ConfigurationVariable.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/ConfigurationVariable.html new file mode 100644 index 00000000..609f70e2 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/ConfigurationVariable.html @@ -0,0 +1,168 @@ + + + + + + + +Uses of Class org.kiji.hadoop.configurator.ConfigurationVariable (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.hadoop.configurator.ConfigurationVariable

    +
    + + + + + +
    +Uses of ConfigurationVariable in org.kiji.hadoop.configurator
    +  +

    + + + + + + + + + +
    Methods in org.kiji.hadoop.configurator that return types with arguments of type ConfigurationVariable
    +static List<ConfigurationVariable>HadoopConfigurator.extractDeclaredVariables(Class<?> clazz, + boolean includeParentClasses) + +
    +          Extracts the declared Hadoop configuration variables (fields with + @HadoopConf annotations) from a class.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/HadoopConf.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/HadoopConf.html new file mode 100644 index 00000000..f67bcc9e --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/HadoopConf.html @@ -0,0 +1,172 @@ + + + + + + + +Uses of Class org.kiji.hadoop.configurator.HadoopConf (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.hadoop.configurator.HadoopConf

    +
    + + + + + +
    +Uses of HadoopConf in org.kiji.hadoop.configurator
    +  +

    + + + + + + + + + + + +
    Constructors in org.kiji.hadoop.configurator with parameters of type HadoopConf
    ConfigurationMethod(Method method, + HadoopConf annotation) + +
    +          Constructs a ConfigurationMethod instance.
    ConfigurationVariable(Field field, + HadoopConf annotation) + +
    +          Constructs a ConfigurationVariable instance.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/HadoopConfigurationException.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/HadoopConfigurationException.html new file mode 100644 index 00000000..390111f9 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/HadoopConfigurationException.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.hadoop.configurator.HadoopConfigurationException (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.hadoop.configurator.HadoopConfigurationException

    +
    +No usage of org.kiji.hadoop.configurator.HadoopConfigurationException +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/HadoopConfigurator.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/HadoopConfigurator.html new file mode 100644 index 00000000..051c91b7 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/class-use/HadoopConfigurator.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.hadoop.configurator.HadoopConfigurator (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.hadoop.configurator.HadoopConfigurator

    +
    +No usage of org.kiji.hadoop.configurator.HadoopConfigurator +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-frame.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-frame.html new file mode 100644 index 00000000..6e308217 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-frame.html @@ -0,0 +1,59 @@ + + + + + + + +org.kiji.hadoop.configurator (hadoop-configurator 1.0.2 API) + + + + + + + + + + + +org.kiji.hadoop.configurator + + + + +
    +Classes  + +
    +ConfigurationMethod +
    +ConfigurationVariable +
    +HadoopConfigurator
    + + + + + + +
    +Exceptions  + +
    +HadoopConfigurationException
    + + + + + + +
    +Annotation Types  + +
    +HadoopConf
    + + + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-summary.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-summary.html new file mode 100644 index 00000000..b0348eb2 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-summary.html @@ -0,0 +1,211 @@ + + + + + + + +org.kiji.hadoop.configurator (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.kiji.hadoop.configurator +

    +The HadoopConfigurator system. +

    +See: +
    +          Description +

    + + + + + + + + + + + + + + + + + +
    +Class Summary
    ConfigurationMethodThis class encapsulates everything there is to know about a Hadoop + configuration method declaration.
    ConfigurationVariableThis class encapsulates everything there is to know about a Hadoop + configuration variable declaration.
    HadoopConfiguratorThe entry point for the HadoopConfigurator system.
    +  + +

    + + + + + + + + + +
    +Exception Summary
    HadoopConfigurationExceptionAn exception thrown when there is an error populating the member + variables of a Configurable instance.
    +  + +

    + + + + + + + + + +
    +Annotation Types Summary
    HadoopConfThe annotation used on instance (member) variables to tell the HadoopConfigurator + system that they should be populated with values from the Configuration.
    +  + +

    +

    +Package org.kiji.hadoop.configurator Description +

    + +

    +The HadoopConfigurator system. +

    + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-tree.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-tree.html new file mode 100644 index 00000000..863b30c9 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.hadoop.configurator Class Hierarchy (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.kiji.hadoop.configurator +

    +
    +

    +Class Hierarchy +

    + +

    +Annotation Type Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-use.html b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-use.html new file mode 100644 index 00000000..7db96831 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/org/kiji/hadoop/configurator/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package org.kiji.hadoop.configurator (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    org.kiji.hadoop.configurator

    +
    + + + + + + + + + + + + + + +
    +Classes in org.kiji.hadoop.configurator used by org.kiji.hadoop.configurator
    ConfigurationMethod + +
    +          This class encapsulates everything there is to know about a Hadoop + configuration method declaration.
    ConfigurationVariable + +
    +          This class encapsulates everything there is to know about a Hadoop + configuration variable declaration.
    HadoopConf + +
    +          The annotation used on instance (member) variables to tell the HadoopConfigurator + system that they should be populated with values from the Configuration.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/overview-tree.html b/apidocs/hadoop-configurator/1.0.2/overview-tree.html new file mode 100644 index 00000000..47852579 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/overview-tree.html @@ -0,0 +1,164 @@ + + + + + + + +Class Hierarchy (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For All Packages

    +
    +
    +
    Package Hierarchies:
    org.kiji.hadoop.configurator
    +
    +

    +Class Hierarchy +

    + +

    +Annotation Type Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/package-list b/apidocs/hadoop-configurator/1.0.2/package-list new file mode 100644 index 00000000..481f60ec --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/package-list @@ -0,0 +1 @@ +org.kiji.hadoop.configurator diff --git a/apidocs/hadoop-configurator/1.0.2/resources/inherit.gif b/apidocs/hadoop-configurator/1.0.2/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/hadoop-configurator/1.0.2/resources/inherit.gif differ diff --git a/apidocs/hadoop-configurator/1.0.2/serialized-form.html b/apidocs/hadoop-configurator/1.0.2/serialized-form.html new file mode 100644 index 00000000..4a1f48f8 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/serialized-form.html @@ -0,0 +1,162 @@ + + + + + + + +Serialized Form (hadoop-configurator 1.0.2 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Serialized Form

    +
    +
    + + + + + +
    +Package org.kiji.hadoop.configurator
    + +

    + + + + + +
    +Class org.kiji.hadoop.configurator.HadoopConfigurationException extends RuntimeException implements Serializable
    + +

    + +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2012. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.2/stylesheet.css b/apidocs/hadoop-configurator/1.0.2/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.2/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/hadoop-configurator/1.0.3/allclasses-frame.html b/apidocs/hadoop-configurator/1.0.3/allclasses-frame.html new file mode 100644 index 00000000..e68687bb --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/allclasses-frame.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + +All Classes +
    + + + + + +
    ConfigurationMethod +
    +ConfigurationVariable +
    +HadoopConf +
    +HadoopConfigurationException +
    +HadoopConfigurator +
    +
    + + + diff --git a/apidocs/hadoop-configurator/1.0.3/allclasses-noframe.html b/apidocs/hadoop-configurator/1.0.3/allclasses-noframe.html new file mode 100644 index 00000000..fe22172a --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/allclasses-noframe.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + +All Classes +
    + + + + + +
    ConfigurationMethod +
    +ConfigurationVariable +
    +HadoopConf +
    +HadoopConfigurationException +
    +HadoopConfigurator +
    +
    + + + diff --git a/apidocs/hadoop-configurator/1.0.3/constant-values.html b/apidocs/hadoop-configurator/1.0.3/constant-values.html new file mode 100644 index 00000000..9b41a380 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/constant-values.html @@ -0,0 +1,145 @@ + + + + + + + +Constant Field Values (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Constant Field Values

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/deprecated-list.html b/apidocs/hadoop-configurator/1.0.3/deprecated-list.html new file mode 100644 index 00000000..bbd85bd0 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Deprecated API

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/help-doc.html b/apidocs/hadoop-configurator/1.0.3/help-doc.html new file mode 100644 index 00000000..aa1c89fe --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +How This API Document Is Organized

    +
    +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

    +Package

    +
    + +

    +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

      +
    • Interfaces (italic)
    • Classes
    • Enums
    • Exceptions
    • Errors
    • Annotation Types
    +
    +

    +Class/Interface

    +
    + +

    +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      +
    • Class inheritance diagram
    • Direct Subclasses
    • All Known Subinterfaces
    • All Known Implementing Classes
    • Class/interface declaration
    • Class/interface description +

      +

    • Nested Class Summary
    • Field Summary
    • Constructor Summary
    • Method Summary +

      +

    • Field Detail
    • Constructor Detail
    • Method Detail
    +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
    + +

    +Annotation Type

    +
    + +

    +Each annotation type has its own separate page with the following sections:

      +
    • Annotation Type declaration
    • Annotation Type description
    • Required Element Summary
    • Optional Element Summary
    • Element Detail
    +
    + +

    +Enum

    +
    + +

    +Each enum has its own separate page with the following sections:

      +
    • Enum declaration
    • Enum description
    • Enum Constant Summary
    • Enum Constant Detail
    +
    +

    +Use

    +
    +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
    +

    +Tree (Class Hierarchy)

    +
    +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
    +
    +

    +Deprecated API

    +
    +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
    +

    +Index

    +
    +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
    +

    +Prev/Next

    +These links take you to the next or previous class, interface, package, or related page.

    +Frames/No Frames

    +These links show and hide the HTML frames. All pages are available with or without frames. +

    +

    +Serialized Form

    +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

    +

    +Constant Field Values

    +The Constant Field Values page lists the static final fields and their values. +

    + + +This help file applies to API documentation generated using the standard doclet. + +
    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/index-all.html b/apidocs/hadoop-configurator/1.0.3/index-all.html new file mode 100644 index 00000000..c5b60109 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/index-all.html @@ -0,0 +1,214 @@ + + + + + + + +Index (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +C E G H O S
    +

    +C

    +
    +
    call(Object, Configuration) - +Method in class org.kiji.hadoop.configurator.ConfigurationMethod +
    Calls an object's method with the value read from a Configuration instance. +
    ConfigurationMethod - Class in org.kiji.hadoop.configurator
    This class encapsulates everything there is to know about a Hadoop + configuration method declaration.
    ConfigurationMethod(Method, HadoopConf) - +Constructor for class org.kiji.hadoop.configurator.ConfigurationMethod +
    Constructs a ConfigurationMethod instance. +
    ConfigurationVariable - Class in org.kiji.hadoop.configurator
    This class encapsulates everything there is to know about a Hadoop + configuration variable declaration.
    ConfigurationVariable(Field, HadoopConf) - +Constructor for class org.kiji.hadoop.configurator.ConfigurationVariable +
    Constructs a ConfigurationVariable instance. +
    configure(Object, Configuration, boolean) - +Static method in class org.kiji.hadoop.configurator.HadoopConfigurator +
    Populates the instance variables of a Configurable + instance with values from its Configuration. +
    configure(Configurable, boolean) - +Static method in class org.kiji.hadoop.configurator.HadoopConfigurator +
    Populates the instance variables of a Configurable + instance with values from its Configuration. +
    configure(Configurable) - +Static method in class org.kiji.hadoop.configurator.HadoopConfigurator +
    Populates the instance variables of a Configurable + instance with values from its Configuration. +
    +
    +

    +E

    +
    +
    extractDeclaredMethods(Class<?>, boolean) - +Static method in class org.kiji.hadoop.configurator.HadoopConfigurator +
    Extracts the declared Hadoop configuration method (methods with + @HadoopConf annotations) from a class. +
    extractDeclaredVariables(Class<?>, boolean) - +Static method in class org.kiji.hadoop.configurator.HadoopConfigurator +
    Extracts the declared Hadoop configuration variables (fields with + @HadoopConf annotations) from a class. +
    +
    +

    +G

    +
    +
    getKey() - +Method in class org.kiji.hadoop.configurator.ConfigurationMethod +
    Gets the configuration key that should be used to populate the field. +
    getKey() - +Method in class org.kiji.hadoop.configurator.ConfigurationVariable +
    Gets the configuration key that should be used to populate the field. +
    +
    +

    +H

    +
    +
    HadoopConf - Annotation Type in org.kiji.hadoop.configurator
    The annotation used on instance (member) variables to tell the HadoopConfigurator + system that they should be populated with values from the Configuration.
    HadoopConfigurationException - Exception in org.kiji.hadoop.configurator
    An exception thrown when there is an error populating the member + variables of a Configurable instance.
    HadoopConfigurationException(String) - +Constructor for exception org.kiji.hadoop.configurator.HadoopConfigurationException +
    Constructs the exception. +
    HadoopConfigurationException(Throwable) - +Constructor for exception org.kiji.hadoop.configurator.HadoopConfigurationException +
    Constructs the exception. +
    HadoopConfigurator - Class in org.kiji.hadoop.configurator
    The entry point for the HadoopConfigurator system.
    +
    +

    +O

    +
    +
    org.kiji.hadoop.configurator - package org.kiji.hadoop.configurator
    The HadoopConfigurator system.
    +
    +

    +S

    +
    +
    setValue(Object, Configuration) - +Method in class org.kiji.hadoop.configurator.ConfigurationVariable +
    Populates an object's field with the value read from a Configuration instance. +
    +
    +C E G H O S + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/index.html b/apidocs/hadoop-configurator/1.0.3/index.html new file mode 100644 index 00000000..b243c494 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/index.html @@ -0,0 +1,37 @@ + + + + + + + +hadoop-configurator 1.0.3-SNAPSHOT API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/hadoop/configurator/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/ConfigurationMethod.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/ConfigurationMethod.html new file mode 100644 index 00000000..2fc2bc92 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/ConfigurationMethod.html @@ -0,0 +1,292 @@ + + + + + + + +ConfigurationMethod (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.hadoop.configurator +
    +Class ConfigurationMethod

    +
    +java.lang.Object
+  extended by org.kiji.hadoop.configurator.ConfigurationMethod
+
    +
    +
    +
    public class ConfigurationMethod
    extends Object
    + + +

    +This class encapsulates everything there is to know about a Hadoop + configuration method declaration. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ConfigurationMethod(Method method, + HadoopConf annotation) + +
    +          Constructs a ConfigurationMethod instance.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + voidcall(Object instance, + org.apache.hadoop.conf.Configuration conf) + +
    +          Calls an object's method with the value read from a Configuration instance.
    + StringgetKey() + +
    +          Gets the configuration key that should be used to populate the field.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +ConfigurationMethod

    +
    +public ConfigurationMethod(Method method,
+                           HadoopConf annotation)
    +
    +
    Constructs a ConfigurationMethod instance. +

    +

    +
    Parameters:
    method - The method that has the annotation on it.
    annotation - The annotation on the method.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getKey

    +
    +public String getKey()
    +
    +
    Gets the configuration key that should be used to populate the field. +

    +

    + +
    Returns:
    The key that was specified in the HadoopConf annotation.
    +
    +
    +
    + +

    +call

    +
    +public void call(Object instance,
+                 org.apache.hadoop.conf.Configuration conf)
+          throws IllegalAccessException
    +
    +
    Calls an object's method with the value read from a Configuration instance. +

    +

    +
    Parameters:
    instance - The object to populate.
    conf - The configuration to read from. +
    Throws: +
    IllegalAccessException - If the method cannot be called on the object. +
    HadoopConfigurationException - If there is a problem with the annotation definition.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/ConfigurationVariable.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/ConfigurationVariable.html new file mode 100644 index 00000000..a8fbcf28 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/ConfigurationVariable.html @@ -0,0 +1,292 @@ + + + + + + + +ConfigurationVariable (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.hadoop.configurator +
    +Class ConfigurationVariable

    +
    +java.lang.Object
+  extended by org.kiji.hadoop.configurator.ConfigurationVariable
+
    +
    +
    +
    public class ConfigurationVariable
    extends Object
    + + +

    +This class encapsulates everything there is to know about a Hadoop + configuration variable declaration. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    ConfigurationVariable(Field field, + HadoopConf annotation) + +
    +          Constructs a ConfigurationVariable instance.
    +  + + + + + + + + + + + + + + + +
    +Method Summary
    + StringgetKey() + +
    +          Gets the configuration key that should be used to populate the field.
    + voidsetValue(Object instance, + org.apache.hadoop.conf.Configuration conf) + +
    +          Populates an object's field with the value read from a Configuration instance.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +ConfigurationVariable

    +
    +public ConfigurationVariable(Field field,
+                             HadoopConf annotation)
    +
    +
    Constructs a ConfigurationVariable instance. +

    +

    +
    Parameters:
    field - The variable that has the annotation on it.
    annotation - The annotation on the field.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getKey

    +
    +public String getKey()
    +
    +
    Gets the configuration key that should be used to populate the field. +

    +

    + +
    Returns:
    The key that was specified in the HadoopConf annotation.
    +
    +
    +
    + +

    +setValue

    +
    +public void setValue(Object instance,
+                     org.apache.hadoop.conf.Configuration conf)
+              throws IllegalAccessException
    +
    +
    Populates an object's field with the value read from a Configuration instance. +

    +

    +
    Parameters:
    instance - The object to populate.
    conf - The configuration to read from. +
    Throws: +
    IllegalAccessException - If the field cannot be set on the object. +
    HadoopConfigurationException - If there is a problem with the annotation definition.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/HadoopConf.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/HadoopConf.html new file mode 100644 index 00000000..cb8329ad --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/HadoopConf.html @@ -0,0 +1,278 @@ + + + + + + + +HadoopConf (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    + +

    + +org.kiji.hadoop.configurator +
    +Annotation Type HadoopConf

    +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value={FIELD,METHOD})
+public @interface HadoopConf
    + + +

    +The annotation used on instance (member) variables to tell the HadoopConfigurator + system that they should be populated with values from the Configuration. +

    + +

    +

    +
    See Also:
    HadoopConfigurator
    +
    + +

    + + + + + + + + + + + +
    +Required Element Summary
    + Stringkey + +
    +          The key used in the Configuration for this variable.
    +  + + + + + + + + + + + + + + +
    +Optional Element Summary
    + StringdefaultValue + +
    +          The default value for the configuration variable.
    + Stringusage + +
    +          Documents the usage of this configuration variable.
    +  +

    + + + + + + + + +
    +Element Detail
    + +

    +key

    +
    +public abstract String key
    +
    +
    The key used in the Configuration for this variable. + +

    This field is required.

    +

    +

    +
    +
    +
    +
    +
    +

    +usage

    +
    +public abstract String usage
    +
    +
    Documents the usage of this configuration variable. +

    +

    +
    +
    +
    +
    +
    +
    Default:
    ""
    +
    +
    +
    + +

    +defaultValue

    +
    +public abstract String defaultValue
    +
    +
    The default value for the configuration variable. +

    +

    +
    +
    +
    +
    +
    +
    Default:
    ""
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: REQUIRED | OPTIONAL +DETAIL: ELEMENT
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/HadoopConfigurationException.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/HadoopConfigurationException.html new file mode 100644 index 00000000..c25c8e55 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/HadoopConfigurationException.html @@ -0,0 +1,267 @@ + + + + + + + +HadoopConfigurationException (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.hadoop.configurator +
    +Class HadoopConfigurationException

    +
    +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.hadoop.configurator.HadoopConfigurationException
+
    +
    +
    All Implemented Interfaces:
    Serializable
    +
    +
    +
    +
    public class HadoopConfigurationException
    extends RuntimeException
    + + +

    +An exception thrown when there is an error populating the member + variables of a Configurable instance. +

    + +

    +

    +
    See Also:
    Serialized Form
    +
    + +

    + + + + + + + + + + + + + + +
    +Constructor Summary
    HadoopConfigurationException(String message) + +
    +          Constructs the exception.
    HadoopConfigurationException(Throwable cause) + +
    +          Constructs the exception.
    +  + + + + + + + +
    +Method Summary
    +  + + + + + + + +
    Methods inherited from class java.lang.Throwable
    fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +HadoopConfigurationException

    +
    +public HadoopConfigurationException(String message)
    +
    +
    Constructs the exception. +

    +

    +
    Parameters:
    message - A message.
    +
    +
    + +

    +HadoopConfigurationException

    +
    +public HadoopConfigurationException(Throwable cause)
    +
    +
    Constructs the exception. +

    +

    +
    Parameters:
    cause - The cause.
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/HadoopConfigurator.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/HadoopConfigurator.html new file mode 100644 index 00000000..a31d47c5 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/HadoopConfigurator.html @@ -0,0 +1,360 @@ + + + + + + + +HadoopConfigurator (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.hadoop.configurator +
    +Class HadoopConfigurator

    +
    +java.lang.Object
+  extended by org.kiji.hadoop.configurator.HadoopConfigurator
+
    +
    +
    +
    public final class HadoopConfigurator
    extends Object
    + + +

    +The entry point for the HadoopConfigurator system. + +

    Clients should call configure(org.apache.hadoop.conf.Configurable) within their Configurable.setConf(org.apache.hadoop.conf.Configuration) + method to populate all of their member variables with values read from the Configuration.

    + +

    For example:

    + + 
    + public class Foo extends Configured {
+   @HadoopConf(key="foo.value", usage="The foo value")
+   private String fooValue = "defaultValue";
+
+   @Override
+   public void setConf(Configuration conf) {
+     super.setConf(conf);
+     HadoopConfigurator.configure(this);
+     // Now fooValue has been populated with the value of conf.get("foo.value").
+   }
+ }
+
    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static voidconfigure(org.apache.hadoop.conf.Configurable instance) + +
    +          Populates the instance variables of a Configurable + instance with values from its Configuration.
    +static voidconfigure(org.apache.hadoop.conf.Configurable instance, + boolean includeParentClasses) + +
    +          Populates the instance variables of a Configurable + instance with values from its Configuration.
    +static voidconfigure(Object instance, + org.apache.hadoop.conf.Configuration conf, + boolean includeParentClasses) + +
    +          Populates the instance variables of a Configurable + instance with values from its Configuration.
    +static List<ConfigurationMethod>extractDeclaredMethods(Class<?> clazz, + boolean includeParentClasses) + +
    +          Extracts the declared Hadoop configuration method (methods with + @HadoopConf annotations) from a class.
    +static List<ConfigurationVariable>extractDeclaredVariables(Class<?> clazz, + boolean includeParentClasses) + +
    +          Extracts the declared Hadoop configuration variables (fields with + @HadoopConf annotations) from a class.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +configure

    +
    +public static void configure(Object instance,
+                             org.apache.hadoop.conf.Configuration conf,
+                             boolean includeParentClasses)
    +
    +
    Populates the instance variables of a Configurable + instance with values from its Configuration. +

    +

    +
    Parameters:
    instance - The instance to configure.
    conf - The configuration to read from.
    includeParentClasses - Whether to include declared variables in super classes. +
    Throws: +
    HadoopConfigurationException - If there is an error with the declaration or + assigning the field.
    +
    +
    +
    + +

    +configure

    +
    +public static void configure(org.apache.hadoop.conf.Configurable instance,
+                             boolean includeParentClasses)
    +
    +
    Populates the instance variables of a Configurable + instance with values from its Configuration. +

    +

    +
    Parameters:
    instance - The instance to configure.
    includeParentClasses - Whether to include declared variables in super classes. +
    Throws: +
    HadoopConfigurationException - If there is an error with the declaration or + assigning the field.
    +
    +
    +
    + +

    +configure

    +
    +public static void configure(org.apache.hadoop.conf.Configurable instance)
    +
    +
    Populates the instance variables of a Configurable + instance with values from its Configuration. + +

    This includes annotations declared in parent classes.

    +

    +

    +
    Parameters:
    instance - The instance to configure. +
    Throws: +
    HadoopConfigurationException - If there is an error with the declaration or + assigning the field.
    +
    +
    +
    + +

    +extractDeclaredVariables

    +
    +public static List<ConfigurationVariable> extractDeclaredVariables(Class<?> clazz,
+                                                                   boolean includeParentClasses)
    +
    +
    Extracts the declared Hadoop configuration variables (fields with + @HadoopConf annotations) from a class. +

    +

    +
    Parameters:
    clazz - The class to extract conf variable declarations from.
    includeParentClasses - If true, also includes declared variables in the super classes. +
    Returns:
    The list of configuration variables declared.
    +
    +
    +
    + +

    +extractDeclaredMethods

    +
    +public static List<ConfigurationMethod> extractDeclaredMethods(Class<?> clazz,
+                                                               boolean includeParentClasses)
    +
    +
    Extracts the declared Hadoop configuration method (methods with + @HadoopConf annotations) from a class. +

    +

    +
    Parameters:
    clazz - The class to extract conf method declarations from.
    includeParentClasses - If true, also includes declared methods in the super classes. +
    Returns:
    The list of configuration methods declared.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/ConfigurationMethod.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/ConfigurationMethod.html new file mode 100644 index 00000000..81e5bc1c --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/ConfigurationMethod.html @@ -0,0 +1,168 @@ + + + + + + + +Uses of Class org.kiji.hadoop.configurator.ConfigurationMethod (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.hadoop.configurator.ConfigurationMethod

    +
    + + + + + +
    +Uses of ConfigurationMethod in org.kiji.hadoop.configurator
    +  +

    + + + + + + + + + +
    Methods in org.kiji.hadoop.configurator that return types with arguments of type ConfigurationMethod
    +static List<ConfigurationMethod>HadoopConfigurator.extractDeclaredMethods(Class<?> clazz, + boolean includeParentClasses) + +
    +          Extracts the declared Hadoop configuration method (methods with + @HadoopConf annotations) from a class.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/ConfigurationVariable.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/ConfigurationVariable.html new file mode 100644 index 00000000..c18e33a8 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/ConfigurationVariable.html @@ -0,0 +1,168 @@ + + + + + + + +Uses of Class org.kiji.hadoop.configurator.ConfigurationVariable (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.hadoop.configurator.ConfigurationVariable

    +
    + + + + + +
    +Uses of ConfigurationVariable in org.kiji.hadoop.configurator
    +  +

    + + + + + + + + + +
    Methods in org.kiji.hadoop.configurator that return types with arguments of type ConfigurationVariable
    +static List<ConfigurationVariable>HadoopConfigurator.extractDeclaredVariables(Class<?> clazz, + boolean includeParentClasses) + +
    +          Extracts the declared Hadoop configuration variables (fields with + @HadoopConf annotations) from a class.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/HadoopConf.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/HadoopConf.html new file mode 100644 index 00000000..ab37b4ac --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/HadoopConf.html @@ -0,0 +1,172 @@ + + + + + + + +Uses of Class org.kiji.hadoop.configurator.HadoopConf (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.hadoop.configurator.HadoopConf

    +
    + + + + + +
    +Uses of HadoopConf in org.kiji.hadoop.configurator
    +  +

    + + + + + + + + + + + +
    Constructors in org.kiji.hadoop.configurator with parameters of type HadoopConf
    ConfigurationMethod(Method method, + HadoopConf annotation) + +
    +          Constructs a ConfigurationMethod instance.
    ConfigurationVariable(Field field, + HadoopConf annotation) + +
    +          Constructs a ConfigurationVariable instance.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/HadoopConfigurationException.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/HadoopConfigurationException.html new file mode 100644 index 00000000..c9f84903 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/HadoopConfigurationException.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.hadoop.configurator.HadoopConfigurationException (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.hadoop.configurator.HadoopConfigurationException

    +
    +No usage of org.kiji.hadoop.configurator.HadoopConfigurationException +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/HadoopConfigurator.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/HadoopConfigurator.html new file mode 100644 index 00000000..6a98d68b --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/class-use/HadoopConfigurator.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.hadoop.configurator.HadoopConfigurator (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.hadoop.configurator.HadoopConfigurator

    +
    +No usage of org.kiji.hadoop.configurator.HadoopConfigurator +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-frame.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-frame.html new file mode 100644 index 00000000..a8987a13 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-frame.html @@ -0,0 +1,59 @@ + + + + + + + +org.kiji.hadoop.configurator (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + +org.kiji.hadoop.configurator + + + + +
    +Classes  + +
    +ConfigurationMethod +
    +ConfigurationVariable +
    +HadoopConfigurator
    + + + + + + +
    +Exceptions  + +
    +HadoopConfigurationException
    + + + + + + +
    +Annotation Types  + +
    +HadoopConf
    + + + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-summary.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-summary.html new file mode 100644 index 00000000..96fe921c --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-summary.html @@ -0,0 +1,211 @@ + + + + + + + +org.kiji.hadoop.configurator (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.kiji.hadoop.configurator +

    +The HadoopConfigurator system. +

    +See: +
    +          Description +

    + + + + + + + + + + + + + + + + + +
    +Class Summary
    ConfigurationMethodThis class encapsulates everything there is to know about a Hadoop + configuration method declaration.
    ConfigurationVariableThis class encapsulates everything there is to know about a Hadoop + configuration variable declaration.
    HadoopConfiguratorThe entry point for the HadoopConfigurator system.
    +  + +

    + + + + + + + + + +
    +Exception Summary
    HadoopConfigurationExceptionAn exception thrown when there is an error populating the member + variables of a Configurable instance.
    +  + +

    + + + + + + + + + +
    +Annotation Types Summary
    HadoopConfThe annotation used on instance (member) variables to tell the HadoopConfigurator + system that they should be populated with values from the Configuration.
    +  + +

    +

    +Package org.kiji.hadoop.configurator Description +

    + +

    +The HadoopConfigurator system. +

    + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-tree.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-tree.html new file mode 100644 index 00000000..e2910cbc --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.hadoop.configurator Class Hierarchy (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.kiji.hadoop.configurator +

    +
    +

    +Class Hierarchy +

    + +

    +Annotation Type Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-use.html b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-use.html new file mode 100644 index 00000000..a9214552 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/org/kiji/hadoop/configurator/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package org.kiji.hadoop.configurator (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    org.kiji.hadoop.configurator

    +
    + + + + + + + + + + + + + + +
    +Classes in org.kiji.hadoop.configurator used by org.kiji.hadoop.configurator
    ConfigurationMethod + +
    +          This class encapsulates everything there is to know about a Hadoop + configuration method declaration.
    ConfigurationVariable + +
    +          This class encapsulates everything there is to know about a Hadoop + configuration variable declaration.
    HadoopConf + +
    +          The annotation used on instance (member) variables to tell the HadoopConfigurator + system that they should be populated with values from the Configuration.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/overview-tree.html b/apidocs/hadoop-configurator/1.0.3/overview-tree.html new file mode 100644 index 00000000..b02cd312 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/overview-tree.html @@ -0,0 +1,164 @@ + + + + + + + +Class Hierarchy (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For All Packages

    +
    +
    +
    Package Hierarchies:
    org.kiji.hadoop.configurator
    +
    +

    +Class Hierarchy +

    + +

    +Annotation Type Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/package-list b/apidocs/hadoop-configurator/1.0.3/package-list new file mode 100644 index 00000000..481f60ec --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/package-list @@ -0,0 +1 @@ +org.kiji.hadoop.configurator diff --git a/apidocs/hadoop-configurator/1.0.3/resources/inherit.gif b/apidocs/hadoop-configurator/1.0.3/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/hadoop-configurator/1.0.3/resources/inherit.gif differ diff --git a/apidocs/hadoop-configurator/1.0.3/serialized-form.html b/apidocs/hadoop-configurator/1.0.3/serialized-form.html new file mode 100644 index 00000000..083ca8a6 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/serialized-form.html @@ -0,0 +1,162 @@ + + + + + + + +Serialized Form (hadoop-configurator 1.0.3-SNAPSHOT API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Serialized Form

    +
    +
    + + + + + +
    +Package org.kiji.hadoop.configurator
    + +

    + + + + + +
    +Class org.kiji.hadoop.configurator.HadoopConfigurationException extends RuntimeException implements Serializable
    + +

    + +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + +
    Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013. All Rights Reserved. + + diff --git a/apidocs/hadoop-configurator/1.0.3/stylesheet.css b/apidocs/hadoop-configurator/1.0.3/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/hadoop-configurator/1.0.3/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/allclasses-frame.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/allclasses-frame.html new file mode 100644 index 00000000..7bdb44cc --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/allclasses-frame.html @@ -0,0 +1,68 @@ + + + + +<<<<<<< HEAD + + + +All Classes (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +All Classes (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + +All Classes +
    + + + +<<<<<<< HEAD + + +
    MavenLoggable +======= +FSUtils +
    +FSUtils.DirFilter +
    +FSUtils.FamilyDirFilter +
    +FSUtils.HFileFilter +
    +FSUtils.RegionDirFilter +
    +MavenLoggable +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +MavenLogged +
    +MiniHBaseCluster +
    +MiniHBaseClusterSingleton +
    +MiniHBaseClusterThread +
    +StartMojo +
    +StopMojo +
    +
    + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/allclasses-noframe.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/allclasses-noframe.html new file mode 100644 index 00000000..11db8228 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/allclasses-noframe.html @@ -0,0 +1,68 @@ + + + + +<<<<<<< HEAD + + + +All Classes (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +All Classes (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + +All Classes +
    + + + +<<<<<<< HEAD + + +
    MavenLoggable +======= +FSUtils +
    +FSUtils.DirFilter +
    +FSUtils.FamilyDirFilter +
    +FSUtils.HFileFilter +
    +FSUtils.RegionDirFilter +
    +MavenLoggable +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +MavenLogged +
    +MiniHBaseCluster +
    +MiniHBaseClusterSingleton +
    +MiniHBaseClusterThread +
    +StartMojo +
    +StopMojo +
    +
    + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/constant-values.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/constant-values.html new file mode 100644 index 00000000..d05ab58b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/constant-values.html @@ -0,0 +1,175 @@ + + + + +<<<<<<< HEAD + + + +Constant Field Values (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Constant Field Values (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + + + + +======= + + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + +
    Package  Class  Use  Tree  Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Constant Field Values

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + + + + +======= + + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + +
    Package  Class  Use  Tree  Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/deprecated-list.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/deprecated-list.html new file mode 100644 index 00000000..558df2cc --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/deprecated-list.html @@ -0,0 +1,175 @@ + + + + +<<<<<<< HEAD + + + +Deprecated List (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Deprecated List (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + + + + +======= + + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + +
    Package  Class  Use  Tree  Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Deprecated API

    +
    +
    +Contents
      +
    + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + + + + +======= + + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + +
    Package  Class  Use  Tree  Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/help-doc.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/help-doc.html new file mode 100644 index 00000000..c06a3552 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/help-doc.html @@ -0,0 +1,255 @@ + + + + +<<<<<<< HEAD + + + +API Help (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +API Help (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + + + + +======= + + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + +
    Package  Class  Use  Tree  Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +How This API Document Is Organized

    +
    +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

    +<<<<<<< HEAD +======= +Overview

    +
    + +

    +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    +

    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +Package

    +
    + +

    +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

      +
    • Interfaces (italic)
    • Classes
    • Enums
    • Exceptions
    • Errors
    • Annotation Types
    +
    +

    +Class/Interface

    +
    + +

    +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      +
    • Class inheritance diagram
    • Direct Subclasses
    • All Known Subinterfaces
    • All Known Implementing Classes
    • Class/interface declaration
    • Class/interface description +

      +

    • Nested Class Summary
    • Field Summary
    • Constructor Summary
    • Method Summary +

      +

    • Field Detail
    • Constructor Detail
    • Method Detail
    +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
    + +

    +Annotation Type

    +
    + +

    +Each annotation type has its own separate page with the following sections:

      +
    • Annotation Type declaration
    • Annotation Type description
    • Required Element Summary
    • Optional Element Summary
    • Element Detail
    +
    + +

    +Enum

    +
    + +

    +Each enum has its own separate page with the following sections:

      +
    • Enum declaration
    • Enum description
    • Enum Constant Summary
    • Enum Constant Detail
    +
    +

    +Use

    +
    +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
    +

    +Tree (Class Hierarchy)

    +
    +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
      +
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
    +
    +

    +Deprecated API

    +
    +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
    +

    +Index

    +
    +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
    +

    +Prev/Next

    +These links take you to the next or previous class, interface, package, or related page.

    +Frames/No Frames

    +These links show and hide the HTML frames. All pages are available with or without frames. +

    +

    +Serialized Form

    +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

    +

    +Constant Field Values

    +The Constant Field Values page lists the static final fields and their values. +

    + + +This help file applies to API documentation generated using the standard doclet. + +
    +

    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + + + + +======= + + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + +
    Package  Class  Use  Tree  Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/index-all.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/index-all.html new file mode 100644 index 00000000..a1718a2d --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/index-all.html @@ -0,0 +1,558 @@ + + + + +<<<<<<< HEAD + + + +Index (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Index (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + + + + +======= + + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + +
    Package  Class  Use  Tree  Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +<<<<<<< HEAD +E F G I M O R S V
    +======= +A C D E F G H I L M O R S V W
    +

    +A

    +
    +
    accept(Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils.DirFilter +
      +
    accept(Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter +
      +
    accept(Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils.HFileFilter +
      +
    accept(Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter +
      +
    +
    +

    +C

    +
    +
    checkAccess(UserGroupInformation, FileStatus, FsAction) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Throw an exception if an action is not permitted by a user on a file. +
    checkClusterIdExists(FileSystem, Path, int) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Checks that a cluster ID file exists in the HBase root directory +
    checkDfsSafeMode(Configuration) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Check whether dfs is in safemode. +
    checkdir(FileSystem, Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils +
    Check if directory exists. +
    checkFileSystemAvailable(FileSystem) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Checks to see if the specified file system is available +
    checkVersion(FileSystem, Path, boolean) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Verifies current version of file system +
    checkVersion(FileSystem, Path, boolean, int, int) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Verifies current version of file system +
    computeHDFSBlocksDistribution(FileSystem, FileStatus, long, long) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Compute HDFS blocks distribution of a given file, or a portion of the file +
    create(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Create file. +
    +
    +

    +D

    +
    +
    deleteDirectory(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Delete if exists. +
    +
    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +

    +E

    +
    +
    execute() - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
    Starts a mini HBase cluster in a new thread. +
    execute() - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
    +
    +
    +

    +F

    +
    +
    findOpenPort(int) - +Static method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
    Find an available port. +<<<<<<< HEAD +======= +
    FSUtils - Class in org.apache.hadoop.hbase.util
    Utility methods for interacting with the underlying file system.
    FSUtils() - +Constructor for class org.apache.hadoop.hbase.util.FSUtils +
      +
    FSUtils.DirFilter - Class in org.apache.hadoop.hbase.util
    A PathFilter that returns directories.
    FSUtils.DirFilter(FileSystem) - +Constructor for class org.apache.hadoop.hbase.util.FSUtils.DirFilter +
      +
    FSUtils.FamilyDirFilter - Class in org.apache.hadoop.hbase.util
    Filter for all dirs that are legal column family names.
    FSUtils.FamilyDirFilter(FileSystem) - +Constructor for class org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter +
      +
    FSUtils.HFileFilter - Class in org.apache.hadoop.hbase.util
    Filter for HFiles that excludes reference files.
    FSUtils.HFileFilter(FileSystem) - +Constructor for class org.apache.hadoop.hbase.util.FSUtils.HFileFilter +
      +
    FSUtils.RegionDirFilter - Class in org.apache.hadoop.hbase.util
    Filter for all dirs that don't start with '.'
    FSUtils.RegionDirFilter(FileSystem) - +Constructor for class org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter +
      +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    +

    +G

    +
    +
    getClusterConfiguration() - +Method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
    Provides access to the cluster configuration after it has started. +<<<<<<< HEAD +
    getConfiguration() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
    Provides access to the HBase cluster configuration. +======= +
    getClusterId(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Returns the value of the unique cluster ID stored for this HBase instance. +
    getConfiguration() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
    Provides access to the HBase cluster configuration. +
    getCurrentFileSystem(Configuration) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
      +
    getInstance(FileSystem, Configuration) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
      +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    getLog() - +Method in interface org.kiji.maven.plugins.hbase.MavenLoggable +
    Provides access to the maven log used to communicate with the user. +
    getLog() - +Method in class org.kiji.maven.plugins.hbase.MavenLogged +
    Provides access to the maven log used to communicate with the user. +
    getLog() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
      +<<<<<<< HEAD +======= +
    getPath(Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Return the 'path' component of a Path. +
    getRegionDirs(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Given a particular table dir, return all the regiondirs inside it, excluding files such as + .tableinfo +
    getRootDir(Configuration) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
      +
    getTableDirs(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
      +
    getTableFragmentation(HMaster) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them. +
    getTableFragmentation(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them. +
    getTablePath(Path, byte[]) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
      +
    getTablePath(Path, String) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
      +
    getTableStoreFilePathMap(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Runs through the HBase rootdir and creates a reverse lookup map for + table StoreFile names to the full Path. +
    getTotalTableFragmentation(HMaster) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Returns the total overall fragmentation percentage. +
    getVersion(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Verifies current version of file system +
    +
    +

    +H

    +
    +
    hfilePattern - +Static variable in class org.apache.hadoop.hbase.util.FSUtils.HFileFilter +
      +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    +

    +I

    +
    +
    isClusterReady() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
    Determine whether the HBase cluster is up and running. +<<<<<<< HEAD +
    isRunning() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
    Determine whether the cluster is running. +======= +
    isHDFS(Configuration) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
      +
    isHflushSupported() - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Heuristic to determine whether is safe or not to open a file for hflush + Uses reflection to search for FSDataOutputStream.hflush() +
    isMajorCompacted(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted. +
    isMajorCompactedPre020(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted. +
    isPre020FileLayout(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Expects to find -ROOT- directory. +
    isRunning() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
    Determine whether the cluster is running. +
    isSyncSupported() - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Heuristic to determine whether is safe or not to open a file for sync + Uses reflection to search for SequenceFile.Writer.syncFs() +
    +
    +

    +L

    +
    +
    listStatus(FileSystem, Path, PathFilter) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Calls fs.listStatus() and treats FileNotFoundException as non-fatal + This would accommodate difference in various hadoop versions +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    +

    +M

    +
    +
    MavenLoggable - Interface in org.kiji.maven.plugins.hbase
    Interface for objects that can write to the maven log.
    MavenLogged - Class in org.kiji.maven.plugins.hbase
    An abstract base class for objects that write to the maven log.
    MavenLogged(Log) - +Constructor for class org.kiji.maven.plugins.hbase.MavenLogged +
    Constructor. +
    MiniHBaseCluster - Class in org.kiji.maven.plugins.hbase
    A in-process mini HBase cluster that may be started and stopped.
    MiniHBaseCluster(Log, boolean, Configuration) - +Constructor for class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
    Creates a new MiniHBaseCluster instance. +
    MiniHBaseCluster(Log, boolean, HBaseTestingUtility) - +Constructor for class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
    Creates a new MiniHBaseCluster instance. +
    MiniHBaseClusterSingleton - Enum in org.kiji.maven.plugins.hbase
    A singleton instance of a mini HBase cluster.
    MiniHBaseClusterThread - Class in org.kiji.maven.plugins.hbase
    A thread that starts and runs a mini HBase cluster.
    MiniHBaseClusterThread(Log, MiniHBaseCluster) - +Constructor for class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
    Creates a new MiniHBaseClusterThread instance. +
    +
    +

    +O

    +
    +<<<<<<< HEAD +
    org.kiji.maven.plugins.hbase - package org.kiji.maven.plugins.hbase
    A maven plugin that allows integration tests to run with a mini-hbase cluster.
    +======= +
    org.apache.hadoop.hbase.util - package org.apache.hadoop.hbase.util
     
    org.kiji.maven.plugins.hbase - package org.kiji.maven.plugins.hbase
    A maven plugin that allows integration tests to run with a mini-hbase cluster. +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +

    +R

    +
    +<<<<<<< HEAD +======= +
    recoverFileLease(FileSystem, Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils +
    Recover file lease. +
    regionDirPattern - +Static variable in class org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter +
      +
    rootRegionExists(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Checks if root region exists +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    run() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
    Runs the mini HBase cluster. +
    +
    +

    +S

    +
    +<<<<<<< HEAD +======= +
    setClusterId(FileSystem, Path, String, int) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Writes a new unique identifier for this cluster to the "hbase.id" file + in the HBase root directory +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    setCoreSiteFile(File) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
    Sets the file that we should write the MapReduce/HDFS cluster configuration to. +
    setHadoopConfiguration(Properties) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
    Sets Hadoop configuration properties. +
    setHbaseConfIndex(File) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
    Sets the file that the HBase configuration index should be written to. +
    setHbaseSiteFile(File) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
    Sets the file that we should write the HBase cluster configuration to. +
    setMapReduceEnabled(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
    Sets whether we should start a mini MapReduce cluster in addition to the HBase cluster. +
    setProjectBuildDir(String) - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
    Sets the output directory for the project's build. +
    setSaveHadoopTmpDir(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
    Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +
    setSaveHadoopTmpDir(boolean) - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
    Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +
    setSeparateConfigurationFiles(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
    Sets whether separate core-site.xml and hbase-site.xml files + should be generated (otherwise they are combined into a single + hbase-site.xml file). +
    setSkip(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
    Sets whether this goal should be a no-op. +
    setSkip(boolean) - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
    Sets whether this goal should be a no-op. +<<<<<<< HEAD +======= +
    setVersion(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Sets version of file system +
    setVersion(FileSystem, Path, int, int) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Sets version of file system +
    setVersion(FileSystem, Path, String, int, int) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Sets version of file system +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    setWriteConfIndex(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
    Sets whether this goal should write a configuration index file. +
    shutdown() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
    Stops the cluster. +
    startAndWaitUntilReady(Log, boolean, Configuration) - +Method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
    Starts the HBase cluster and blocks until it is ready. +
    StartMojo - Class in org.kiji.maven.plugins.hbase
    A maven goal that starts a mini HBase cluster in a new daemon thread.
    StartMojo() - +Constructor for class org.kiji.maven.plugins.hbase.StartMojo +
      +
    startup() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
    Starts the cluster. +
    stop(Log) - +Method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
    Stops the HBase cluster and blocks until is has been shutdown completely. +
    stopClusterGracefully() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
    Stops the HBase cluster gracefully. +
    StopMojo - Class in org.kiji.maven.plugins.hbase
    A maven goal that stops the mini HBase cluster started by the 'start' goal.
    StopMojo() - +Constructor for class org.kiji.maven.plugins.hbase.StopMojo +
      +
    +
    +

    +V

    +
    +<<<<<<< HEAD +======= +
    validateRootPath(Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    Verifies root directory path is a valid URI with a scheme +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    valueOf(String) - +Static method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
    Returns the enum constant of this type with the specified name. +
    values() - +Static method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
    Returns an array containing the constants of this enum type, in +the order they are declared. +
    +
    +<<<<<<< HEAD +E F G I M O R S V +======= +

    +W

    +
    +
    waitOnSafeMode(Configuration, long) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
    If DFS, check safe mode and if so, wait until we clear it. +
    +
    +A C D E F G H I L M O R S V W +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + + + + +======= + + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + +
    Package  Class  Use  Tree  Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/index.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/index.html new file mode 100644 index 00000000..027683bf --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/index.html @@ -0,0 +1,56 @@ + + + + +<<<<<<< HEAD + + + +hbase-maven-plugin 1.0.10-hadoop1 API +======= +<!-- Generated by javadoc on Tue Jan 22 12:38:29 PST 2013--> +<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<TITLE> +hbase-maven-plugin 1.0.10-cdh4 API +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + +<<<<<<< HEAD + + +======= + + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +<<<<<<< HEAD +Link to<A HREF="org/kiji/maven/plugins/hbase/package-summary.html">Non-frame version.</A> +======= +Link to<A HREF="overview-summary.html">Non-frame version.</A> +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.DirFilter.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.DirFilter.html new file mode 100644 index 00000000..48ff6311 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.DirFilter.html @@ -0,0 +1,266 @@ + + + + + + + +FSUtils.DirFilter (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.hadoop.hbase.util +
    +Class FSUtils.DirFilter

    +
    +java.lang.Object
+  extended by org.apache.hadoop.hbase.util.FSUtils.DirFilter
+
    +
    +
    All Implemented Interfaces:
    org.apache.hadoop.fs.PathFilter
    +
    +
    +
    Enclosing class:
    FSUtils
    +
    +
    +
    +
    public static class FSUtils.DirFilter
    extends Object
    implements org.apache.hadoop.fs.PathFilter
    + + +

    +A PathFilter that returns directories. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    FSUtils.DirFilter(org.apache.hadoop.fs.FileSystem fs) + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleanaccept(org.apache.hadoop.fs.Path p) + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +FSUtils.DirFilter

    +
    +public FSUtils.DirFilter(org.apache.hadoop.fs.FileSystem fs)
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +accept

    +
    +public boolean accept(org.apache.hadoop.fs.Path p)
    +
    +
    +
    Specified by:
    accept in interface org.apache.hadoop.fs.PathFilter
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.FamilyDirFilter.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.FamilyDirFilter.html new file mode 100644 index 00000000..6fafefd1 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.FamilyDirFilter.html @@ -0,0 +1,267 @@ + + + + + + + +FSUtils.FamilyDirFilter (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.hadoop.hbase.util +
    +Class FSUtils.FamilyDirFilter

    +
    +java.lang.Object
+  extended by org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter
+
    +
    +
    All Implemented Interfaces:
    org.apache.hadoop.fs.PathFilter
    +
    +
    +
    Enclosing class:
    FSUtils
    +
    +
    +
    +
    public static class FSUtils.FamilyDirFilter
    extends Object
    implements org.apache.hadoop.fs.PathFilter
    + + +

    +Filter for all dirs that are legal column family names. This is generally used for colfam + dirs ///. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Constructor Summary
    FSUtils.FamilyDirFilter(org.apache.hadoop.fs.FileSystem fs) + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleanaccept(org.apache.hadoop.fs.Path rd) + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +FSUtils.FamilyDirFilter

    +
    +public FSUtils.FamilyDirFilter(org.apache.hadoop.fs.FileSystem fs)
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +accept

    +
    +public boolean accept(org.apache.hadoop.fs.Path rd)
    +
    +
    +
    Specified by:
    accept in interface org.apache.hadoop.fs.PathFilter
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.HFileFilter.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.HFileFilter.html new file mode 100644 index 00000000..21d8079b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.HFileFilter.html @@ -0,0 +1,302 @@ + + + + + + + +FSUtils.HFileFilter (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.hadoop.hbase.util +
    +Class FSUtils.HFileFilter

    +
    +java.lang.Object
+  extended by org.apache.hadoop.hbase.util.FSUtils.HFileFilter
+
    +
    +
    All Implemented Interfaces:
    org.apache.hadoop.fs.PathFilter
    +
    +
    +
    Enclosing class:
    FSUtils
    +
    +
    +
    +
    public static class FSUtils.HFileFilter
    extends Object
    implements org.apache.hadoop.fs.PathFilter
    + + +

    +Filter for HFiles that excludes reference files. +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Field Summary
    +static PatternhfilePattern + +
    +           
    +  + + + + + + + + + + +
    +Constructor Summary
    FSUtils.HFileFilter(org.apache.hadoop.fs.FileSystem fs) + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleanaccept(org.apache.hadoop.fs.Path rd) + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +hfilePattern

    +
    +public static final Pattern hfilePattern
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +FSUtils.HFileFilter

    +
    +public FSUtils.HFileFilter(org.apache.hadoop.fs.FileSystem fs)
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +accept

    +
    +public boolean accept(org.apache.hadoop.fs.Path rd)
    +
    +
    +
    Specified by:
    accept in interface org.apache.hadoop.fs.PathFilter
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.RegionDirFilter.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.RegionDirFilter.html new file mode 100644 index 00000000..62b0ee75 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.RegionDirFilter.html @@ -0,0 +1,302 @@ + + + + + + + +FSUtils.RegionDirFilter (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.hadoop.hbase.util +
    +Class FSUtils.RegionDirFilter

    +
    +java.lang.Object
+  extended by org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter
+
    +
    +
    All Implemented Interfaces:
    org.apache.hadoop.fs.PathFilter
    +
    +
    +
    Enclosing class:
    FSUtils
    +
    +
    +
    +
    public static class FSUtils.RegionDirFilter
    extends Object
    implements org.apache.hadoop.fs.PathFilter
    + + +

    +Filter for all dirs that don't start with '.' +

    + +

    +

    + +

    + + + + + + + + + + + +
    +Field Summary
    +static PatternregionDirPattern + +
    +           
    +  + + + + + + + + + + +
    +Constructor Summary
    FSUtils.RegionDirFilter(org.apache.hadoop.fs.FileSystem fs) + +
    +           
    +  + + + + + + + + + + + +
    +Method Summary
    + booleanaccept(org.apache.hadoop.fs.Path rd) + +
    +           
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

    + + + + + + + + +
    +Field Detail
    + +

    +regionDirPattern

    +
    +public static final Pattern regionDirPattern
    +
    +
    +
    +
    + + + + + + + + +
    +Constructor Detail
    + +

    +FSUtils.RegionDirFilter

    +
    +public FSUtils.RegionDirFilter(org.apache.hadoop.fs.FileSystem fs)
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +accept

    +
    +public boolean accept(org.apache.hadoop.fs.Path rd)
    +
    +
    +
    Specified by:
    accept in interface org.apache.hadoop.fs.PathFilter
    +
    +
    +
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.html new file mode 100644 index 00000000..cc0d4622 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/FSUtils.html @@ -0,0 +1,1343 @@ + + + + + + + +FSUtils (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.apache.hadoop.hbase.util +
    +Class FSUtils

    +
    +java.lang.Object
+  extended by org.apache.hadoop.hbase.util.FSUtils
+
    +
    +
    +
    public abstract class FSUtils
    extends Object
    + + +

    +Utility methods for interacting with the underlying file system. + +

    hbase-maven-plugin note: This file is identical to the version distributed with CDH4 + save for a fix to accept() to change a stack trace printed on stdout into a LOG.warn.

    + +

    The new behavior is similar to later versions of hbase and allows us to redirect this + harmless error message.

    +

    + +

    +

    + +

    + + + + + + + + + + + + + + + + + + + + + + + +
    +Nested Class Summary
    +static classFSUtils.DirFilter + +
    +          A PathFilter that returns directories.
    +static classFSUtils.FamilyDirFilter + +
    +          Filter for all dirs that are legal column family names.
    +static classFSUtils.HFileFilter + +
    +          Filter for HFiles that excludes reference files.
    +static classFSUtils.RegionDirFilter + +
    +          Filter for all dirs that don't start with '.'
    +  + + + + + + + + + + + +
    +Constructor Summary
    +protected FSUtils() + +
    +           
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static voidcheckAccess(org.apache.hadoop.security.UserGroupInformation ugi, + org.apache.hadoop.fs.FileStatus file, + org.apache.hadoop.fs.permission.FsAction action) + +
    +          Throw an exception if an action is not permitted by a user on a file.
    +static booleancheckClusterIdExists(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + int wait) + +
    +          Checks that a cluster ID file exists in the HBase root directory
    +static voidcheckDfsSafeMode(org.apache.hadoop.conf.Configuration conf) + +
    +          Check whether dfs is in safemode.
    + org.apache.hadoop.fs.Pathcheckdir(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path dir) + +
    +          Check if directory exists.
    +static voidcheckFileSystemAvailable(org.apache.hadoop.fs.FileSystem fs) + +
    +          Checks to see if the specified file system is available
    +static voidcheckVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + boolean message) + +
    +          Verifies current version of file system
    +static voidcheckVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + boolean message, + int wait, + int retries) + +
    +          Verifies current version of file system
    +static org.apache.hadoop.hbase.HDFSBlocksDistributioncomputeHDFSBlocksDistribution(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.FileStatus status, + long start, + long length) + +
    +          Compute HDFS blocks distribution of a given file, or a portion of the file
    +static org.apache.hadoop.fs.Pathcreate(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path p) + +
    +          Create file.
    +static booleandeleteDirectory(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path dir) + +
    +          Delete if exists.
    +static StringgetClusterId(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir) + +
    +          Returns the value of the unique cluster ID stored for this HBase instance.
    +static org.apache.hadoop.fs.FileSystemgetCurrentFileSystem(org.apache.hadoop.conf.Configuration conf) + +
    +           
    +static FSUtilsgetInstance(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.conf.Configuration conf) + +
    +           
    +static StringgetPath(org.apache.hadoop.fs.Path p) + +
    +          Return the 'path' component of a Path.
    +static List<org.apache.hadoop.fs.Path>getRegionDirs(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path tableDir) + +
    +          Given a particular table dir, return all the regiondirs inside it, excluding files such as + .tableinfo
    +static org.apache.hadoop.fs.PathgetRootDir(org.apache.hadoop.conf.Configuration c) + +
    +           
    +static List<org.apache.hadoop.fs.Path>getTableDirs(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir) + +
    +           
    +static Map<String,Integer>getTableFragmentation(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path hbaseRootDir) + +
    +          Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them.
    +static Map<String,Integer>getTableFragmentation(org.apache.hadoop.hbase.master.HMaster master) + +
    +          Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them.
    +static org.apache.hadoop.fs.PathgetTablePath(org.apache.hadoop.fs.Path rootdir, + byte[] tableName) + +
    +           
    +static org.apache.hadoop.fs.PathgetTablePath(org.apache.hadoop.fs.Path rootdir, + String tableName) + +
    +           
    +static Map<String,org.apache.hadoop.fs.Path>getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path hbaseRootDir) + +
    +          Runs through the HBase rootdir and creates a reverse lookup map for + table StoreFile names to the full Path.
    +static intgetTotalTableFragmentation(org.apache.hadoop.hbase.master.HMaster master) + +
    +          Returns the total overall fragmentation percentage.
    +static StringgetVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir) + +
    +          Verifies current version of file system
    +static booleanisHDFS(org.apache.hadoop.conf.Configuration conf) + +
    +           
    +static booleanisHflushSupported() + +
    +          Heuristic to determine whether is safe or not to open a file for hflush + Uses reflection to search for FSDataOutputStream.hflush()
    +static booleanisMajorCompacted(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path hbaseRootDir) + +
    +          Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted.
    +static booleanisMajorCompactedPre020(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path hbaseRootDir) + +
    +          Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted.
    +static booleanisPre020FileLayout(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path hbaseRootDir) + +
    +          Expects to find -ROOT- directory.
    +static booleanisSyncSupported() + +
    +          Heuristic to determine whether is safe or not to open a file for sync + Uses reflection to search for SequenceFile.Writer.syncFs()
    +static org.apache.hadoop.fs.FileStatus[]listStatus(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path dir, + org.apache.hadoop.fs.PathFilter filter) + +
    +          Calls fs.listStatus() and treats FileNotFoundException as non-fatal + This would accommodate difference in various hadoop versions
    +abstract  voidrecoverFileLease(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path p) + +
    +          Recover file lease.
    +static booleanrootRegionExists(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir) + +
    +          Checks if root region exists
    +static voidsetClusterId(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + String clusterId, + int wait) + +
    +          Writes a new unique identifier for this cluster to the "hbase.id" file + in the HBase root directory
    +static voidsetVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir) + +
    +          Sets version of file system
    +static voidsetVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + int wait, + int retries) + +
    +          Sets version of file system
    +static voidsetVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + String version, + int wait, + int retries) + +
    +          Sets version of file system
    +static org.apache.hadoop.fs.PathvalidateRootPath(org.apache.hadoop.fs.Path root) + +
    +          Verifies root directory path is a valid URI with a scheme
    +static voidwaitOnSafeMode(org.apache.hadoop.conf.Configuration conf, + long wait) + +
    +          If DFS, check safe mode and if so, wait until we clear it.
    +  + + + + + + + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +FSUtils

    +
    +protected FSUtils()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getInstance

    +
    +public static FSUtils getInstance(org.apache.hadoop.fs.FileSystem fs,
+                                  org.apache.hadoop.conf.Configuration conf)
    +
    +
    +
    +
    +
    +
    + +

    +deleteDirectory

    +
    +public static boolean deleteDirectory(org.apache.hadoop.fs.FileSystem fs,
+                                      org.apache.hadoop.fs.Path dir)
+                               throws IOException
    +
    +
    Delete if exists. +

    +

    +
    Parameters:
    fs - filesystem object
    dir - directory to delete +
    Returns:
    True if deleted dir +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +checkdir

    +
    +public org.apache.hadoop.fs.Path checkdir(org.apache.hadoop.fs.FileSystem fs,
+                                          org.apache.hadoop.fs.Path dir)
+                                   throws IOException
    +
    +
    Check if directory exists. If it does not, create it. +

    +

    +
    Parameters:
    fs - filesystem object
    dir - path to check +
    Returns:
    Path +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +create

    +
    +public static org.apache.hadoop.fs.Path create(org.apache.hadoop.fs.FileSystem fs,
+                                               org.apache.hadoop.fs.Path p)
+                                        throws IOException
    +
    +
    Create file. +

    +

    +
    Parameters:
    fs - filesystem object
    p - path to create +
    Returns:
    Path +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +checkFileSystemAvailable

    +
    +public static void checkFileSystemAvailable(org.apache.hadoop.fs.FileSystem fs)
+                                     throws IOException
    +
    +
    Checks to see if the specified file system is available +

    +

    +
    Parameters:
    fs - filesystem +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +checkDfsSafeMode

    +
    +public static void checkDfsSafeMode(org.apache.hadoop.conf.Configuration conf)
+                             throws IOException
    +
    +
    Check whether dfs is in safemode. +

    +

    +
    Parameters:
    conf - +
    Throws: +
    IOException
    +
    +
    +
    + +

    +getVersion

    +
    +public static String getVersion(org.apache.hadoop.fs.FileSystem fs,
+                                org.apache.hadoop.fs.Path rootdir)
+                         throws IOException
    +
    +
    Verifies current version of file system +

    +

    +
    Parameters:
    fs - filesystem object
    rootdir - root hbase directory +
    Returns:
    null if no version file exists, version string otherwise. +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +checkVersion

    +
    +public static void checkVersion(org.apache.hadoop.fs.FileSystem fs,
+                                org.apache.hadoop.fs.Path rootdir,
+                                boolean message)
+                         throws IOException
    +
    +
    Verifies current version of file system +

    +

    +
    Parameters:
    fs - file system
    rootdir - root directory of HBase installation
    message - if true, issues a message on System.out +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +checkVersion

    +
    +public static void checkVersion(org.apache.hadoop.fs.FileSystem fs,
+                                org.apache.hadoop.fs.Path rootdir,
+                                boolean message,
+                                int wait,
+                                int retries)
+                         throws IOException
    +
    +
    Verifies current version of file system +

    +

    +
    Parameters:
    fs - file system
    rootdir - root directory of HBase installation
    message - if true, issues a message on System.out
    wait - wait interval
    retries - number of times to retry +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +setVersion

    +
    +public static void setVersion(org.apache.hadoop.fs.FileSystem fs,
+                              org.apache.hadoop.fs.Path rootdir)
+                       throws IOException
    +
    +
    Sets version of file system +

    +

    +
    Parameters:
    fs - filesystem object
    rootdir - hbase root +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +setVersion

    +
    +public static void setVersion(org.apache.hadoop.fs.FileSystem fs,
+                              org.apache.hadoop.fs.Path rootdir,
+                              int wait,
+                              int retries)
+                       throws IOException
    +
    +
    Sets version of file system +

    +

    +
    Parameters:
    fs - filesystem object
    rootdir - hbase root
    wait - time to wait for retry
    retries - number of times to retry before failing +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +setVersion

    +
    +public static void setVersion(org.apache.hadoop.fs.FileSystem fs,
+                              org.apache.hadoop.fs.Path rootdir,
+                              String version,
+                              int wait,
+                              int retries)
+                       throws IOException
    +
    +
    Sets version of file system +

    +

    +
    Parameters:
    fs - filesystem object
    rootdir - hbase root directory
    version - version to set
    wait - time to wait for retry
    retries - number of times to retry before throwing an IOException +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +checkClusterIdExists

    +
    +public static boolean checkClusterIdExists(org.apache.hadoop.fs.FileSystem fs,
+                                           org.apache.hadoop.fs.Path rootdir,
+                                           int wait)
+                                    throws IOException
    +
    +
    Checks that a cluster ID file exists in the HBase root directory +

    +

    +
    Parameters:
    fs - the root directory FileSystem
    rootdir - the HBase root directory in HDFS
    wait - how long to wait between retries +
    Returns:
    true if the file exists, otherwise false +
    Throws: +
    IOException - if checking the FileSystem fails
    +
    +
    +
    + +

    +getClusterId

    +
    +public static String getClusterId(org.apache.hadoop.fs.FileSystem fs,
+                                  org.apache.hadoop.fs.Path rootdir)
+                           throws IOException
    +
    +
    Returns the value of the unique cluster ID stored for this HBase instance. +

    +

    +
    Parameters:
    fs - the root directory FileSystem
    rootdir - the path to the HBase root directory +
    Returns:
    the unique cluster identifier +
    Throws: +
    IOException - if reading the cluster ID file fails
    +
    +
    +
    + +

    +setClusterId

    +
    +public static void setClusterId(org.apache.hadoop.fs.FileSystem fs,
+                                org.apache.hadoop.fs.Path rootdir,
+                                String clusterId,
+                                int wait)
+                         throws IOException
    +
    +
    Writes a new unique identifier for this cluster to the "hbase.id" file + in the HBase root directory +

    +

    +
    Parameters:
    fs - the root directory FileSystem
    rootdir - the path to the HBase root directory
    clusterId - the unique identifier to store
    wait - how long (in milliseconds) to wait between retries +
    Throws: +
    IOException - if writing to the FileSystem fails and no wait value
    +
    +
    +
    + +

    +validateRootPath

    +
    +public static org.apache.hadoop.fs.Path validateRootPath(org.apache.hadoop.fs.Path root)
+                                                  throws IOException
    +
    +
    Verifies root directory path is a valid URI with a scheme +

    +

    +
    Parameters:
    root - root directory path +
    Returns:
    Passed root argument. +
    Throws: +
    IOException - if not a valid URI with a scheme
    +
    +
    +
    + +

    +waitOnSafeMode

    +
    +public static void waitOnSafeMode(org.apache.hadoop.conf.Configuration conf,
+                                  long wait)
+                           throws IOException
    +
    +
    If DFS, check safe mode and if so, wait until we clear it. +

    +

    +
    Parameters:
    conf - configuration
    wait - Sleep between retries +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +getPath

    +
    +public static String getPath(org.apache.hadoop.fs.Path p)
    +
    +
    Return the 'path' component of a Path. In Hadoop, Path is an URI. This + method returns the 'path' component of a Path's URI: e.g. If a Path is + hdfs://example.org:9000/hbase_trunk/TestTable/compaction.dir, + this method returns /hbase_trunk/TestTable/compaction.dir. + This method is useful if you want to print out a Path without qualifying + Filesystem instance. +

    +

    +
    Parameters:
    p - Filesystem Path whose 'path' component we are to return. +
    Returns:
    Path portion of the Filesystem
    +
    +
    +
    + +

    +getRootDir

    +
    +public static org.apache.hadoop.fs.Path getRootDir(org.apache.hadoop.conf.Configuration c)
+                                            throws IOException
    +
    +
    +
    Parameters:
    c - configuration +
    Returns:
    Path to hbase root directory: i.e. hbase.rootdir from + configuration as a qualified Path. +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +rootRegionExists

    +
    +public static boolean rootRegionExists(org.apache.hadoop.fs.FileSystem fs,
+                                       org.apache.hadoop.fs.Path rootdir)
+                                throws IOException
    +
    +
    Checks if root region exists +

    +

    +
    Parameters:
    fs - file system
    rootdir - root directory of HBase installation +
    Returns:
    true if exists +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +computeHDFSBlocksDistribution

    +
    +public static org.apache.hadoop.hbase.HDFSBlocksDistribution computeHDFSBlocksDistribution(org.apache.hadoop.fs.FileSystem fs,
+                                                                                           org.apache.hadoop.fs.FileStatus status,
+                                                                                           long start,
+                                                                                           long length)
+                                                                                    throws IOException
    +
    +
    Compute HDFS blocks distribution of a given file, or a portion of the file +

    +

    +
    Parameters:
    fs - file system
    status - file status of the file
    start - start position of the portion
    length - length of the portion +
    Returns:
    The HDFS blocks distribution +
    Throws: +
    IOException
    +
    +
    +
    + +

    +isMajorCompacted

    +
    +public static boolean isMajorCompacted(org.apache.hadoop.fs.FileSystem fs,
+                                       org.apache.hadoop.fs.Path hbaseRootDir)
+                                throws IOException
    +
    +
    Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted. Looks + at root and meta tables too. +

    +

    +
    Parameters:
    fs - filesystem
    hbaseRootDir - hbase root directory +
    Returns:
    True if this hbase install is major compacted. +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +getTotalTableFragmentation

    +
    +public static int getTotalTableFragmentation(org.apache.hadoop.hbase.master.HMaster master)
+                                      throws IOException
    +
    +
    Returns the total overall fragmentation percentage. Includes .META. and + -ROOT- as well. +

    +

    +
    Parameters:
    master - The master defining the HBase root and file system. +
    Returns:
    A map for each table and its percentage. +
    Throws: +
    IOException - When scanning the directory fails.
    +
    +
    +
    + +

    +getTableFragmentation

    +
    +public static Map<String,Integer> getTableFragmentation(org.apache.hadoop.hbase.master.HMaster master)
+                                                 throws IOException
    +
    +
    Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them. Checks -ROOT- and .META. too. The total + percentage across all tables is stored under the special key "-TOTAL-". +

    +

    +
    Parameters:
    master - The master defining the HBase root and file system. +
    Returns:
    A map for each table and its percentage. +
    Throws: +
    IOException - When scanning the directory fails.
    +
    +
    +
    + +

    +getTableFragmentation

    +
    +public static Map<String,Integer> getTableFragmentation(org.apache.hadoop.fs.FileSystem fs,
+                                                        org.apache.hadoop.fs.Path hbaseRootDir)
+                                                 throws IOException
    +
    +
    Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them. Checks -ROOT- and .META. too. The total + percentage across all tables is stored under the special key "-TOTAL-". +

    +

    +
    Parameters:
    fs - The file system to use.
    hbaseRootDir - The root directory to scan. +
    Returns:
    A map for each table and its percentage. +
    Throws: +
    IOException - When scanning the directory fails.
    +
    +
    +
    + +

    +isPre020FileLayout

    +
    +public static boolean isPre020FileLayout(org.apache.hadoop.fs.FileSystem fs,
+                                         org.apache.hadoop.fs.Path hbaseRootDir)
+                                  throws IOException
    +
    +
    Expects to find -ROOT- directory. +

    +

    +
    Parameters:
    fs - filesystem
    hbaseRootDir - hbase root directory +
    Returns:
    True if this a pre020 layout. +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +isMajorCompactedPre020

    +
    +public static boolean isMajorCompactedPre020(org.apache.hadoop.fs.FileSystem fs,
+                                             org.apache.hadoop.fs.Path hbaseRootDir)
+                                      throws IOException
    +
    +
    Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted. Looks + at root and meta tables too. This version differs from + isMajorCompacted(FileSystem, Path) in that it expects a + pre-0.20.0 hbase layout on the filesystem. Used migrating. +

    +

    +
    Parameters:
    fs - filesystem
    hbaseRootDir - hbase root directory +
    Returns:
    True if this hbase install is major compacted. +
    Throws: +
    IOException - e
    +
    +
    +
    + +

    +isSyncSupported

    +
    +public static boolean isSyncSupported()
    +
    +
    Heuristic to determine whether is safe or not to open a file for sync + Uses reflection to search for SequenceFile.Writer.syncFs() +

    +

    + +
    Returns:
    True if sync is supported
    +
    +
    +
    + +

    +isHflushSupported

    +
    +public static boolean isHflushSupported()
    +
    +
    Heuristic to determine whether is safe or not to open a file for hflush + Uses reflection to search for FSDataOutputStream.hflush() +

    +

    + +
    Returns:
    True if hflush is supported
    +
    +
    +
    + +

    +isHDFS

    +
    +public static boolean isHDFS(org.apache.hadoop.conf.Configuration conf)
+                      throws IOException
    +
    +
    +
    Parameters:
    conf - +
    Returns:
    True if this filesystem whose scheme is 'hdfs'. +
    Throws: +
    IOException
    +
    +
    +
    + +

    +recoverFileLease

    +
    +public abstract void recoverFileLease(org.apache.hadoop.fs.FileSystem fs,
+                                      org.apache.hadoop.fs.Path p)
+                               throws IOException
    +
    +
    Recover file lease. Used when a file might be suspect + to be had been left open by another process. +

    +

    +
    Parameters:
    fs - FileSystem handle
    p - Path of file to recover lease
    conf - Configuration handle +
    Throws: +
    IOException
    +
    +
    +
    + +

    +getTableDirs

    +
    +public static List<org.apache.hadoop.fs.Path> getTableDirs(org.apache.hadoop.fs.FileSystem fs,
+                                                           org.apache.hadoop.fs.Path rootdir)
+                                                    throws IOException
    +
    +
    +
    Parameters:
    fs -
    rootdir - +
    Returns:
    All the table directories under rootdir. Ignore non table hbase folders such as + .logs, .oldlogs, .corrupt, .META., and -ROOT- folders. +
    Throws: +
    IOException
    +
    +
    +
    + +

    +getTablePath

    +
    +public static org.apache.hadoop.fs.Path getTablePath(org.apache.hadoop.fs.Path rootdir,
+                                                     byte[] tableName)
    +
    +
    +
    +
    +
    +
    + +

    +getTablePath

    +
    +public static org.apache.hadoop.fs.Path getTablePath(org.apache.hadoop.fs.Path rootdir,
+                                                     String tableName)
    +
    +
    +
    +
    +
    +
    + +

    +checkAccess

    +
    +public static void checkAccess(org.apache.hadoop.security.UserGroupInformation ugi,
+                               org.apache.hadoop.fs.FileStatus file,
+                               org.apache.hadoop.fs.permission.FsAction action)
+                        throws org.apache.hadoop.security.AccessControlException
    +
    +
    Throw an exception if an action is not permitted by a user on a file. +

    +

    +
    Parameters:
    ugi - the user
    file - the file
    action - the action +
    Throws: +
    org.apache.hadoop.security.AccessControlException
    +
    +
    +
    + +

    +getRegionDirs

    +
    +public static List<org.apache.hadoop.fs.Path> getRegionDirs(org.apache.hadoop.fs.FileSystem fs,
+                                                            org.apache.hadoop.fs.Path tableDir)
+                                                     throws IOException
    +
    +
    Given a particular table dir, return all the regiondirs inside it, excluding files such as + .tableinfo +

    +

    +
    Parameters:
    fs - A file system for the Path
    tableDir - Path to a specific table directory / +
    Returns:
    List of paths to valid region directories in table dir. +
    Throws: +
    IOException
    +
    +
    +
    + +

    +getCurrentFileSystem

    +
    +public static org.apache.hadoop.fs.FileSystem getCurrentFileSystem(org.apache.hadoop.conf.Configuration conf)
+                                                            throws IOException
    +
    +
    +
    Parameters:
    conf - +
    Returns:
    Returns the filesystem of the hbase rootdir. +
    Throws: +
    IOException
    +
    +
    +
    + +

    +getTableStoreFilePathMap

    +
    +public static Map<String,org.apache.hadoop.fs.Path> getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem fs,
+                                                                             org.apache.hadoop.fs.Path hbaseRootDir)
+                                                                      throws IOException
    +
    +
    Runs through the HBase rootdir and creates a reverse lookup map for + table StoreFile names to the full Path. +
    + Example...
    + Key = 3944417774205889744
    + Value = hdfs://localhost:51169/user/userid/-ROOT-/70236052/info/3944417774205889744 +

    +

    +
    Parameters:
    fs - The file system to use.
    hbaseRootDir - The root directory to scan. +
    Returns:
    Map keyed by StoreFile name with a value of the full Path. +
    Throws: +
    IOException - When scanning the directory fails.
    +
    +
    +
    + +

    +listStatus

    +
    +public static org.apache.hadoop.fs.FileStatus[] listStatus(org.apache.hadoop.fs.FileSystem fs,
+                                                           org.apache.hadoop.fs.Path dir,
+                                                           org.apache.hadoop.fs.PathFilter filter)
+                                                    throws IOException
    +
    +
    Calls fs.listStatus() and treats FileNotFoundException as non-fatal + This would accommodate difference in various hadoop versions +

    +

    +
    Parameters:
    fs - file system
    dir - directory
    filter - path filter +
    Returns:
    null if tabledir doesn't exist, otherwise FileStatus array +
    Throws: +
    IOException
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.DirFilter.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.DirFilter.html new file mode 100644 index 00000000..1d1b4812 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.DirFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.util.FSUtils.DirFilter (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.apache.hadoop.hbase.util.FSUtils.DirFilter

    +
    +No usage of org.apache.hadoop.hbase.util.FSUtils.DirFilter +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.FamilyDirFilter.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.FamilyDirFilter.html new file mode 100644 index 00000000..d41762e5 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.FamilyDirFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter

    +
    +No usage of org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.HFileFilter.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.HFileFilter.html new file mode 100644 index 00000000..614ac4a8 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.HFileFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.util.FSUtils.HFileFilter (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.apache.hadoop.hbase.util.FSUtils.HFileFilter

    +
    +No usage of org.apache.hadoop.hbase.util.FSUtils.HFileFilter +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.RegionDirFilter.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.RegionDirFilter.html new file mode 100644 index 00000000..bf39dc43 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.RegionDirFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter

    +
    +No usage of org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.html new file mode 100644 index 00000000..389a8b0d --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/class-use/FSUtils.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.util.FSUtils (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.apache.hadoop.hbase.util.FSUtils

    +
    + + + + + + + + + +
    +Packages that use FSUtils
    org.apache.hadoop.hbase.util  
    +  +

    + + + + + +
    +Uses of FSUtils in org.apache.hadoop.hbase.util
    +  +

    + + + + + + + + + +
    Methods in org.apache.hadoop.hbase.util that return FSUtils
    +static FSUtilsFSUtils.getInstance(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.conf.Configuration conf) + +
    +           
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-frame.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-frame.html new file mode 100644 index 00000000..75f05db9 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-frame.html @@ -0,0 +1,41 @@ + + + + + + + +org.apache.hadoop.hbase.util (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + +org.apache.hadoop.hbase.util + + + + +
    +Classes  + +
    +FSUtils +
    +FSUtils.DirFilter +
    +FSUtils.FamilyDirFilter +
    +FSUtils.HFileFilter +
    +FSUtils.RegionDirFilter
    + + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-summary.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-summary.html new file mode 100644 index 00000000..86c8f3c0 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-summary.html @@ -0,0 +1,174 @@ + + + + + + + +org.apache.hadoop.hbase.util (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.apache.hadoop.hbase.util +

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    FSUtilsUtility methods for interacting with the underlying file system.
    FSUtils.DirFilterA PathFilter that returns directories.
    FSUtils.FamilyDirFilterFilter for all dirs that are legal column family names.
    FSUtils.HFileFilterFilter for HFiles that excludes reference files.
    FSUtils.RegionDirFilterFilter for all dirs that don't start with '.'
    +  + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-tree.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-tree.html new file mode 100644 index 00000000..a86c8dbb --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-tree.html @@ -0,0 +1,158 @@ + + + + + + + +org.apache.hadoop.hbase.util Class Hierarchy (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.apache.hadoop.hbase.util +

    +
    +
    +
    Package Hierarchies:
    All Packages
    +
    +

    +Class Hierarchy +

    + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-use.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-use.html new file mode 100644 index 00000000..ee4e4b39 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/apache/hadoop/hbase/util/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package org.apache.hadoop.hbase.util (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Package
    org.apache.hadoop.hbase.util

    +
    + + + + + + + + + +
    +Packages that use org.apache.hadoop.hbase.util
    org.apache.hadoop.hbase.util  
    +  +

    + + + + + + + + +
    +Classes in org.apache.hadoop.hbase.util used by org.apache.hadoop.hbase.util
    FSUtils + +
    +          Utility methods for interacting with the underlying file system.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + + + + + + + + + + +
    Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLoggable.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLoggable.html new file mode 100644 index 00000000..3311585b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLoggable.html @@ -0,0 +1,239 @@ + + + + +<<<<<<< HEAD + + + +MavenLoggable (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +MavenLoggable (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.maven.plugins.hbase +
    +Interface MavenLoggable

    +
    +
    All Known Implementing Classes:
    MavenLogged, MiniHBaseCluster, MiniHBaseClusterThread
    +
    +
    +
    +
    public interface MavenLoggable
    + + +

    +Interface for objects that can write to the maven log. +

    + +

    +

    + +

    + + + + + + + + + + + + +
    +Method Summary
    + org.apache.maven.plugin.logging.LoggetLog() + +
    +          Provides access to the maven log used to communicate with the user.
    +  +

    + + + + + + + + +
    +Method Detail
    + +

    +getLog

    +
    +org.apache.maven.plugin.logging.Log getLog()
    +
    +
    Provides access to the maven log used to communicate with the user. +

    +

    + +
    Returns:
    The maven log.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLogged.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLogged.html new file mode 100644 index 00000000..dc1007da --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLogged.html @@ -0,0 +1,312 @@ + + + + +<<<<<<< HEAD + + + +MavenLogged (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +MavenLogged (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.maven.plugins.hbase +
    +Class MavenLogged

    +
    +<<<<<<< HEAD
+java.lang.Object
+=======
+java.lang.Object
+>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10
+  extended by org.kiji.maven.plugins.hbase.MavenLogged
+
    +
    +
    All Implemented Interfaces:
    MavenLoggable
    +
    +
    +
    Direct Known Subclasses:
    MiniHBaseCluster
    +
    +
    +
    +<<<<<<< HEAD +
    public abstract class MavenLogged
    extends Object
    implements MavenLoggable
    +======= +
    public abstract class MavenLogged
    extends Object
    implements MavenLoggable
+>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10
+
    + +

    +An abstract base class for objects that write to the maven log. +

    + +

    +

    + +

    + + + + + + + + + + + + +
    +Constructor Summary
    +protected MavenLogged(org.apache.maven.plugin.logging.Log log) + +
    +          Constructor.
    +  + + + + + + + + + + + +
    +Method Summary
    + org.apache.maven.plugin.logging.LoggetLog() + +
    +          Provides access to the maven log used to communicate with the user.
    +  + + +<<<<<<< HEAD + + + + +======= + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +MavenLogged

    +
    +protected MavenLogged(org.apache.maven.plugin.logging.Log log)
    +
    +
    Constructor. +

    +

    +
    Parameters:
    log - The maven log.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getLog

    +
    +public org.apache.maven.plugin.logging.Log getLog()
    +
    +
    Provides access to the maven log used to communicate with the user. +

    +

    +
    Specified by:
    getLog in interface MavenLoggable
    +
    +
    + +
    Returns:
    The maven log.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseCluster.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseCluster.html new file mode 100644 index 00000000..c559d793 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseCluster.html @@ -0,0 +1,450 @@ + + + + +<<<<<<< HEAD + + + +MiniHBaseCluster (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +MiniHBaseCluster (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.maven.plugins.hbase +
    +Class MiniHBaseCluster

    +
    +<<<<<<< HEAD
+java.lang.Object
+=======
+java.lang.Object
+>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10
+  extended by org.kiji.maven.plugins.hbase.MavenLogged
+      extended by org.kiji.maven.plugins.hbase.MiniHBaseCluster
+
    +
    +
    All Implemented Interfaces:
    MavenLoggable
    +
    +
    +
    +
    public class MiniHBaseCluster
    extends MavenLogged
    + + +

    +A in-process mini HBase cluster that may be started and stopped. +

    + +

    +

    + +

    + + + + + + + + + + + + + + +
    +Constructor Summary
    MiniHBaseCluster(org.apache.maven.plugin.logging.Log log, + boolean enableMapReduce, + org.apache.hadoop.conf.Configuration conf) + +
    +          Creates a new MiniHBaseCluster instance.
    MiniHBaseCluster(org.apache.maven.plugin.logging.Log log, + boolean enableMapReduce, + org.apache.hadoop.hbase.HBaseTestingUtility hbaseTestUtil) + +
    +          Creates a new MiniHBaseCluster instance.
    +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    +static intfindOpenPort(int startPort) + +
    +          Find an available port.
    + org.apache.hadoop.conf.ConfigurationgetConfiguration() + +
    +          Provides access to the HBase cluster configuration.
    + booleanisRunning() + +
    +          Determine whether the cluster is running.
    + voidshutdown() + +
    +          Stops the cluster.
    + voidstartup() + +
    +          Starts the cluster.
    +  + + + + + + + +
    Methods inherited from class org.kiji.maven.plugins.hbase.MavenLogged
    getLog
    +  + + +<<<<<<< HEAD + + + + +======= + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +MiniHBaseCluster

    +
    +public MiniHBaseCluster(org.apache.maven.plugin.logging.Log log,
+                        boolean enableMapReduce,
+                        org.apache.hadoop.conf.Configuration conf)
    +
    +
    Creates a new MiniHBaseCluster instance. +

    +

    +
    Parameters:
    log - The maven log.
    enableMapReduce - Whether to also use a mini MapReduce cluster.
    conf - Hadoop configuration for the cluster.
    +
    +
    + +

    +MiniHBaseCluster

    +
    +public MiniHBaseCluster(org.apache.maven.plugin.logging.Log log,
+                        boolean enableMapReduce,
+                        org.apache.hadoop.hbase.HBaseTestingUtility hbaseTestUtil)
    +
    +
    Creates a new MiniHBaseCluster instance. +

    +

    +
    Parameters:
    log - The maven log.
    enableMapReduce - Whether to also use a mini MapReduce cluster.
    hbaseTestUtil - An HBase testing utility that can start and stop mini clusters.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +getConfiguration

    +
    +public org.apache.hadoop.conf.Configuration getConfiguration()
    +
    +
    Provides access to the HBase cluster configuration. +

    +

    + +
    Returns:
    The cluster configuration.
    +
    +
    +
    + +

    +isRunning

    +
    +public boolean isRunning()
    +
    +
    Determine whether the cluster is running. +

    +

    + +
    Returns:
    Whether the cluster is running.
    +
    +
    +
    + +

    +startup

    +
    +public void startup()
+<<<<<<< HEAD
+             throws Exception
    +======= + throws Exception +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    Starts the cluster. Blocks until ready. +

    +

    + +
    Throws: +<<<<<<< HEAD +
    Exception - If there is an error.
    +======= +
    Exception - If there is an error.
    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + +
    + +

    +shutdown

    +
    +public void shutdown()
+<<<<<<< HEAD
+              throws Exception
    +======= + throws Exception +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    Stops the cluster. Blocks until shut down. +

    +

    + +
    Throws: +<<<<<<< HEAD +
    Exception - If there is an error.
    +======= +
    Exception - If there is an error.
    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + +
    + +

    +findOpenPort

    +
    +public static int findOpenPort(int startPort)
    +
    +
    Find an available port. +

    +

    +
    Parameters:
    startPort - the starting port to check. +
    Returns:
    an open port number. +
    Throws: +<<<<<<< HEAD +
    IllegalArgumentException - if it can't find an open port.
    +======= +
    IllegalArgumentException - if it can't find an open port.
    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterSingleton.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterSingleton.html new file mode 100644 index 00000000..18f77257 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterSingleton.html @@ -0,0 +1,455 @@ + + + + +<<<<<<< HEAD + + + +MiniHBaseClusterSingleton (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +MiniHBaseClusterSingleton (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
    + + + +
    + +

    + +org.kiji.maven.plugins.hbase +
    +Enum MiniHBaseClusterSingleton

    +
    +<<<<<<< HEAD
+java.lang.Object
+  extended by java.lang.Enum<MiniHBaseClusterSingleton>
+      extended by org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton
+
    +
    +
    All Implemented Interfaces:
    Serializable, Comparable<MiniHBaseClusterSingleton>
    +
    +
    +
    +
    public enum MiniHBaseClusterSingleton
    extends Enum<MiniHBaseClusterSingleton>
    +======= +java.lang.Object + extended by java.lang.Enum<MiniHBaseClusterSingleton> + extended by org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton + +
    +
    All Implemented Interfaces:
    Serializable, Comparable<MiniHBaseClusterSingleton>
    +
    +
    +
    +
    public enum MiniHBaseClusterSingleton
    extends Enum<MiniHBaseClusterSingleton>
    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + +

    +A singleton instance of a mini HBase cluster. +

    + +

    +

    + +

    + + + + + + + + + + +
    +Enum Constant Summary
    INSTANCE + +
    +          The singleton instance.
    +  + + + + + + + + + + + + + + + + + + + + + +<<<<<<< HEAD + + + + + + +
    +Method Summary
    + org.apache.hadoop.conf.ConfigurationgetClusterConfiguration() + +
    +          Provides access to the cluster configuration after it has started.
    + voidstartAndWaitUntilReady(org.apache.maven.plugin.logging.Log log, + boolean alsoStartMapReduce, + org.apache.hadoop.conf.Configuration conf) + +
    +          Starts the HBase cluster and blocks until it is ready.
    + voidstop(org.apache.maven.plugin.logging.Log log) + +
    +          Stops the HBase cluster and blocks until is has been shutdown completely.
    +static MiniHBaseClusterSingletonvalueOf(String name) +======= +valueOf(String name) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    +          Returns the enum constant of this type with the specified name.
    +static MiniHBaseClusterSingleton[]values() + +
    +          Returns an array containing the constants of this enum type, in +the order they are declared.
    +  + + +<<<<<<< HEAD + + + + +======= + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    Methods inherited from class java.lang.Enum
    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOfMethods inherited from class java.lang.Enum
    clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
    +  + + +<<<<<<< HEAD + + + + +======= + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    Methods inherited from class java.lang.Object
    getClass, notify, notifyAll, wait, wait, waitMethods inherited from class java.lang.Object
    getClass, notify, notifyAll, wait, wait, wait
    +  +

    + + + + + + + + +
    +Enum Constant Detail
    + +

    +INSTANCE

    +
    +public static final MiniHBaseClusterSingleton INSTANCE
    +
    +
    The singleton instance. +

    +

    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +values

    +
    +public static MiniHBaseClusterSingleton[] values()
    +
    +
    Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
    +for (MiniHBaseClusterSingleton c : MiniHBaseClusterSingleton.values())
+    System.out.println(c);
+
    +

    +

    + +
    Returns:
    an array containing the constants of this enum type, in +the order they are declared
    +
    +
    +
    + +

    +valueOf

    +
    +<<<<<<< HEAD
+public static MiniHBaseClusterSingleton valueOf(String name)
    +======= +public static MiniHBaseClusterSingleton valueOf(String name) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

    +

    +
    Parameters:
    name - the name of the enum constant to be returned. +
    Returns:
    the enum constant with the specified name +
    Throws: +<<<<<<< HEAD +
    IllegalArgumentException - if this enum type has no constant +with the specified name +
    NullPointerException - if the argument is null
    +======= +
    IllegalArgumentException - if this enum type has no constant +with the specified name +
    NullPointerException - if the argument is null
    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + +
    + +

    +startAndWaitUntilReady

    +
    +public void startAndWaitUntilReady(org.apache.maven.plugin.logging.Log log,
+                                   boolean alsoStartMapReduce,
+                                   org.apache.hadoop.conf.Configuration conf)
+<<<<<<< HEAD
+                            throws IOException
    +======= + throws IOException +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    Starts the HBase cluster and blocks until it is ready. +

    +

    +
    Parameters:
    log - The maven log.
    alsoStartMapReduce - Whether to also start a mini MapReduce cluster.
    conf - Hadoop configuration for the cluster. +
    Throws: +<<<<<<< HEAD +
    IOException - If there is an error.
    +======= +
    IOException - If there is an error.
    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + +
    + +

    +getClusterConfiguration

    +
    +public org.apache.hadoop.conf.Configuration getClusterConfiguration()
    +
    +
    Provides access to the cluster configuration after it has started. +

    +

    + +
    Returns:
    The configuration.
    +
    +
    +
    + +

    +stop

    +
    +public void stop(org.apache.maven.plugin.logging.Log log)
    +
    +
    Stops the HBase cluster and blocks until is has been shutdown completely. +

    +

    +
    Parameters:
    log - The maven log.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterThread.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterThread.html new file mode 100644 index 00000000..601ad32f --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterThread.html @@ -0,0 +1,462 @@ + + + + +<<<<<<< HEAD + + + +MiniHBaseClusterThread (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +MiniHBaseClusterThread (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.maven.plugins.hbase +
    +Class MiniHBaseClusterThread

    +
    +<<<<<<< HEAD
+java.lang.Object
+  extended by java.lang.Thread
+      extended by org.kiji.maven.plugins.hbase.MiniHBaseClusterThread
+
    +
    +
    All Implemented Interfaces:
    Runnable, MavenLoggable
    +
    +
    +
    +
    public class MiniHBaseClusterThread
    extends Thread
    implements MavenLoggable
    +======= +java.lang.Object + extended by java.lang.Thread + extended by org.kiji.maven.plugins.hbase.MiniHBaseClusterThread + +
    +
    All Implemented Interfaces:
    Runnable, MavenLoggable
    +
    +
    +
    +
    public class MiniHBaseClusterThread
    extends Thread
    implements MavenLoggable
    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + +

    +A thread that starts and runs a mini HBase cluster. +

    + +

    +

    + +

    + + + + + + + +
    +Nested Class Summary
    +  + + +<<<<<<< HEAD + + + + +======= + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    Nested classes/interfaces inherited from class java.lang.Thread
    Thread.State, Thread.UncaughtExceptionHandlerNested classes/interfaces inherited from class java.lang.Thread
    Thread.State, Thread.UncaughtExceptionHandler
    +  + + + + + + + +
    +Field Summary
    +  + + +<<<<<<< HEAD + + + + +======= + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    Fields inherited from class java.lang.Thread
    MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITYFields inherited from class java.lang.Thread
    MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
    +  + + + + + + + + + + +
    +Constructor Summary
    MiniHBaseClusterThread(org.apache.maven.plugin.logging.Log log, + MiniHBaseCluster hbaseCluster) + +
    +          Creates a new MiniHBaseClusterThread instance.
    +  + + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + org.apache.maven.plugin.logging.LoggetLog() + +
    +          Provides access to the maven log used to communicate with the user.
    + booleanisClusterReady() + +
    +          Determine whether the HBase cluster is up and running.
    + voidrun() + +
    +          Runs the mini HBase cluster.
    + voidstopClusterGracefully() + +
    +          Stops the HBase cluster gracefully.
    +  + + +<<<<<<< HEAD + + + + +======= + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    Methods inherited from class java.lang.Thread
    activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yieldMethods inherited from class java.lang.Thread
    activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
    +  + + +<<<<<<< HEAD + + + + +======= + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    Methods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from class java.lang.Object
    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    +  +

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

    +MiniHBaseClusterThread

    +
    +public MiniHBaseClusterThread(org.apache.maven.plugin.logging.Log log,
+                              MiniHBaseCluster hbaseCluster)
    +
    +
    Creates a new MiniHBaseClusterThread instance. +

    +

    +
    Parameters:
    log - The maven log.
    hbaseCluster - The hbase cluster to run.
    +
    + + + + + + + + +
    +Method Detail
    + +

    +isClusterReady

    +
    +public boolean isClusterReady()
    +
    +
    Determine whether the HBase cluster is up and running. +

    +

    +
    +
    +
    + +
    Returns:
    Whether the cluster has completed startup.
    +
    +
    +
    + +

    +stopClusterGracefully

    +
    +public void stopClusterGracefully()
    +
    +
    Stops the HBase cluster gracefully. When it is fully shut down, the thread will exit. +

    +

    +
    +
    +
    +
    +
    +
    +
    + +

    +getLog

    +
    +public org.apache.maven.plugin.logging.Log getLog()
    +
    +
    Description copied from interface: MavenLoggable
    +
    Provides access to the maven log used to communicate with the user. +

    +

    +
    Specified by:
    getLog in interface MavenLoggable
    +
    +
    + +
    Returns:
    The maven log.
    +
    +
    +
    + +

    +run

    +
    +public void run()
    +
    +
    Runs the mini HBase cluster. + +

    This method blocks until stopClusterGracefully() is called.

    +

    +

    +<<<<<<< HEAD +
    Specified by:
    run in interface Runnable
    Overrides:
    run in class Thread
    +======= +
    Specified by:
    run in interface Runnable
    Overrides:
    run in class Thread
    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    +
    +
    + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/StartMojo.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/StartMojo.html new file mode 100644 index 00000000..c4bb292c --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/StartMojo.html @@ -0,0 +1,582 @@ + + + + +<<<<<<< HEAD + + + +StartMojo (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +StartMojo (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.maven.plugins.hbase +
    +Class StartMojo

    +
    +<<<<<<< HEAD
+java.lang.Object
+=======
+java.lang.Object
+>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10
+  extended by org.apache.maven.plugin.AbstractMojo
+      extended by org.kiji.maven.plugins.hbase.StartMojo
+
    +
    +
    All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    +
    +
    +
    +
    public class StartMojo
    extends org.apache.maven.plugin.AbstractMojo
    + + +

    +A maven goal that starts a mini HBase cluster in a new daemon thread. + +

    A new daemon thread is created that starts a mini HBase cluster. The main thread + blocks until the HBase cluster has full started. The daemon thread with the + in-process HBase cluster will continue to run in the background until stopped by the + 'stop' goal of the plugin.

    + +

    The configuration of the started mini HBase cluster will be written to a + hbase-site.xml file in the test classpath ('${basedir}/target/test-classes' by + default). The path to the generated configuration file may be customized with the + 'hbaseSiteFile' property

    + +

    A configuration index can be written by this goal. The configuration index is a file that + contains one line for each configuration file written by this goal, where the line contains the + path to the configuration file. By default, the goal does not write a configuration index. + Setting the property 'writeConfIndex' to true will cause a configuration index to be written. + By default, the configuration index will be written to + '${basedir}/target/test-classes/conf-index.conf'. The path to the generated configuration index + can be customized by setting the 'hbaseConfIndex' property.

    +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from interface org.apache.maven.plugin.Mojo
    ROLE
    +  + + + + + + + + + + +
    +Constructor Summary
    StartMojo() + +
    +           
    +  + + + + + + + + + + + + + +<<<<<<< HEAD + + + + +<<<<<<< HEAD + + + + +<<<<<<< HEAD + + + + +<<<<<<< HEAD + + + + + + + + + + + + + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          Starts a mini HBase cluster in a new thread.
    + voidsetCoreSiteFile(File coreSiteFile) +======= +setCoreSiteFile(File coreSiteFile) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    +          Sets the file that we should write the MapReduce/HDFS cluster configuration to.
    + voidsetHadoopConfiguration(Properties properties) +======= +setHadoopConfiguration(Properties properties) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    +          Sets Hadoop configuration properties.
    + voidsetHbaseConfIndex(File hbaseConfIndex) +======= +setHbaseConfIndex(File hbaseConfIndex) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    +          Sets the file that the HBase configuration index should be written to.
    + voidsetHbaseSiteFile(File hbaseSiteFile) +======= +setHbaseSiteFile(File hbaseSiteFile) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    +          Sets the file that we should write the HBase cluster configuration to.
    + voidsetMapReduceEnabled(boolean enabled) + +
    +          Sets whether we should start a mini MapReduce cluster in addition to the HBase cluster.
    + voidsetSaveHadoopTmpDir(boolean saveTempDir) + +
    +          Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown.
    + voidsetSeparateConfigurationFiles(boolean separateConfigurationFiles) + +
    +          Sets whether separate core-site.xml and hbase-site.xml files + should be generated (otherwise they are combined into a single + hbase-site.xml file).
    + voidsetSkip(boolean skip) + +
    +          Sets whether this goal should be a no-op.
    + voidsetWriteConfIndex(boolean writeConfIndex) + +
    +          Sets whether this goal should write a configuration index file.
    +  + + + + + + + +
    Methods inherited from class org.apache.maven.plugin.AbstractMojo
    getLog, getPluginContext, setLog, setPluginContext
    +  + + +<<<<<<< HEAD + + + + +======= + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +StartMojo

    +
    +public StartMojo()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setSkip

    +
    +public void setSkip(boolean skip)
    +
    +
    Sets whether this goal should be a no-op. +

    +

    +
    Parameters:
    skip - If true, this goal should do nothing.
    +
    +
    +
    + +

    +setSaveHadoopTmpDir

    +
    +public void setSaveHadoopTmpDir(boolean saveTempDir)
    +
    +
    Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +

    +

    +
    Parameters:
    saveTempDir - If true, the directory will be copied to the project build directory + before the cluster is shutdown.
    +
    +
    +
    + +

    +setHbaseSiteFile

    +
    +<<<<<<< HEAD
+public void setHbaseSiteFile(File hbaseSiteFile)
    +======= +public void setHbaseSiteFile(File hbaseSiteFile) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    Sets the file that we should write the HBase cluster configuration to. + +

    Note: The property "hbaseSiteFile" defined in this mojo means this method must be + named setHbaseSiteFile instead of setHBaseSiteFile.

    +

    +

    +
    Parameters:
    hbaseSiteFile - The file we should write to.
    +
    +
    +
    + +

    +setSeparateConfigurationFiles

    +
    +public void setSeparateConfigurationFiles(boolean separateConfigurationFiles)
    +
    +
    Sets whether separate core-site.xml and hbase-site.xml files + should be generated (otherwise they are combined into a single + hbase-site.xml file). +

    +

    +
    Parameters:
    separateConfigurationFiles - Whether they should be separated.
    +
    +
    +
    + +

    +setCoreSiteFile

    +
    +<<<<<<< HEAD
+public void setCoreSiteFile(File coreSiteFile)
    +======= +public void setCoreSiteFile(File coreSiteFile) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    Sets the file that we should write the MapReduce/HDFS cluster configuration to. +

    +

    +
    Parameters:
    coreSiteFile - The file we should write to.
    +
    +
    +
    + +

    +setWriteConfIndex

    +
    +public void setWriteConfIndex(boolean writeConfIndex)
    +
    +
    Sets whether this goal should write a configuration index file. +

    +

    +
    Parameters:
    writeConfIndex - True if an index file should be written, false otherwise.
    +
    +
    +
    + +

    +setHbaseConfIndex

    +
    +<<<<<<< HEAD
+public void setHbaseConfIndex(File hbaseConfIndex)
    +======= +public void setHbaseConfIndex(File hbaseConfIndex) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    Sets the file that the HBase configuration index should be written to. + +

    Note: The property "hbaseConfIndex" defined in this mojo means this method should be named + setHbaseConfIndex.

    +

    +

    +
    Parameters:
    hbaseConfIndex - The file we should write to.
    +
    +
    +
    + +

    +setMapReduceEnabled

    +
    +public void setMapReduceEnabled(boolean enabled)
    +
    +
    Sets whether we should start a mini MapReduce cluster in addition to the HBase cluster. +

    +

    +
    Parameters:
    enabled - Whether to start a mini MapReduce cluster.
    +
    +
    +
    + +

    +setHadoopConfiguration

    +
    +<<<<<<< HEAD
+public void setHadoopConfiguration(Properties properties)
    +======= +public void setHadoopConfiguration(Properties properties) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    Sets Hadoop configuration properties. +

    +

    +
    Parameters:
    properties - Hadoop configuration properties to use in the mini cluster.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws org.apache.maven.plugin.MojoExecutionException
    +
    +
    Starts a mini HBase cluster in a new thread. + +

    This method is called by the maven plugin framework to run the goal.

    +

    +

    + +
    Throws: +
    org.apache.maven.plugin.MojoExecutionException - If there is a fatal error during this goal's execution.
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/StopMojo.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/StopMojo.html new file mode 100644 index 00000000..13c17c4a --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/StopMojo.html @@ -0,0 +1,402 @@ + + + + +<<<<<<< HEAD + + + +StopMojo (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +StopMojo (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    + +

    + +org.kiji.maven.plugins.hbase +
    +Class StopMojo

    +
    +<<<<<<< HEAD
+java.lang.Object
+=======
+java.lang.Object
+>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10
+  extended by org.apache.maven.plugin.AbstractMojo
+      extended by org.kiji.maven.plugins.hbase.StopMojo
+
    +
    +
    All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
    +
    +
    +
    +
    public class StopMojo
    extends org.apache.maven.plugin.AbstractMojo
    + + +

    +A maven goal that stops the mini HBase cluster started by the 'start' goal. +

    + +

    +

    + +

    + + + + + + + +
    +Field Summary
    +  + + + + + + + +
    Fields inherited from interface org.apache.maven.plugin.Mojo
    ROLE
    +  + + + + + + + + + + +
    +Constructor Summary
    StopMojo() + +
    +           
    +  + + + + + + + + + + + + + +<<<<<<< HEAD + + + + + + + + + + +
    +Method Summary
    + voidexecute() + +
    +          
    + voidsetProjectBuildDir(String dir) +======= +setProjectBuildDir(String dir) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    +          Sets the output directory for the project's build.
    + voidsetSaveHadoopTmpDir(boolean saveTempDir) + +
    +          Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown.
    + voidsetSkip(boolean skip) + +
    +          Sets whether this goal should be a no-op.
    +  + + + + + + + +
    Methods inherited from class org.apache.maven.plugin.AbstractMojo
    getLog, getPluginContext, setLog, setPluginContext
    +  + + +<<<<<<< HEAD + + + + +======= + + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    +  +

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

    +StopMojo

    +
    +public StopMojo()
    +
    +
    + + + + + + + + +
    +Method Detail
    + +

    +setProjectBuildDir

    +
    +<<<<<<< HEAD
+public void setProjectBuildDir(String dir)
    +======= +public void setProjectBuildDir(String dir) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
    +
    Sets the output directory for the project's build. +

    +

    +
    Parameters:
    dir - The path to the output directory.
    +
    +
    +
    + +

    +setSkip

    +
    +public void setSkip(boolean skip)
    +
    +
    Sets whether this goal should be a no-op. +

    +

    +
    Parameters:
    skip - If true, this goal should do nothing.
    +
    +
    +
    + +

    +setSaveHadoopTmpDir

    +
    +public void setSaveHadoopTmpDir(boolean saveTempDir)
    +
    +
    Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +

    +

    +
    Parameters:
    saveTempDir - If true, the directory will be copied to the project build directory + before the cluster is shutdown.
    +
    +
    +
    + +

    +execute

    +
    +public void execute()
+             throws org.apache.maven.plugin.MojoExecutionException
    +
    +
    +

    +

    + +
    Throws: +
    org.apache.maven.plugin.MojoExecutionException
    +
    +
    + +
    + + + + + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
    + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLoggable.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLoggable.html new file mode 100644 index 00000000..c5d8c093 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLoggable.html @@ -0,0 +1,222 @@ + + + + +<<<<<<< HEAD + + + +Uses of Interface org.kiji.maven.plugins.hbase.MavenLoggable (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Uses of Interface org.kiji.maven.plugins.hbase.MavenLoggable (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Interface
    org.kiji.maven.plugins.hbase.MavenLoggable

    +
    +<<<<<<< HEAD +======= + + + + + + + + + +
    +Packages that use MavenLoggable
    org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster. 
    +  +

    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + +
    +Uses of MavenLoggable in org.kiji.maven.plugins.hbase
    +  +

    + + + + + + + + + + + + + + + + + +
    Classes in org.kiji.maven.plugins.hbase that implement MavenLoggable
    + classMavenLogged + +
    +          An abstract base class for objects that write to the maven log.
    + classMiniHBaseCluster + +
    +          A in-process mini HBase cluster that may be started and stopped.
    + classMiniHBaseClusterThread + +
    +          A thread that starts and runs a mini HBase cluster.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLogged.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLogged.html new file mode 100644 index 00000000..61082051 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLogged.html @@ -0,0 +1,206 @@ + + + + +<<<<<<< HEAD + + + +Uses of Class org.kiji.maven.plugins.hbase.MavenLogged (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Uses of Class org.kiji.maven.plugins.hbase.MavenLogged (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.maven.plugins.hbase.MavenLogged

    +
    +<<<<<<< HEAD +======= + + + + + + + + + +
    +Packages that use MavenLogged
    org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster. 
    +  +

    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + +
    +Uses of MavenLogged in org.kiji.maven.plugins.hbase
    +  +

    + + + + + + + + + +
    Subclasses of MavenLogged in org.kiji.maven.plugins.hbase
    + classMiniHBaseCluster + +
    +          A in-process mini HBase cluster that may be started and stopped.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseCluster.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseCluster.html new file mode 100644 index 00000000..31a17be1 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseCluster.html @@ -0,0 +1,205 @@ + + + + +<<<<<<< HEAD + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseCluster (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseCluster (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.maven.plugins.hbase.MiniHBaseCluster

    +
    +<<<<<<< HEAD +======= + + + + + + + + + +
    +Packages that use MiniHBaseCluster
    org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster. 
    +  +

    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + +
    +Uses of MiniHBaseCluster in org.kiji.maven.plugins.hbase
    +  +

    + + + + + + + + +
    Constructors in org.kiji.maven.plugins.hbase with parameters of type MiniHBaseCluster
    MiniHBaseClusterThread(org.apache.maven.plugin.logging.Log log, + MiniHBaseCluster hbaseCluster) + +
    +          Creates a new MiniHBaseClusterThread instance.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterSingleton.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterSingleton.html new file mode 100644 index 00000000..f427e570 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterSingleton.html @@ -0,0 +1,219 @@ + + + + +<<<<<<< HEAD + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton

    +
    +<<<<<<< HEAD +======= + + + + + + + + + +
    +Packages that use MiniHBaseClusterSingleton
    org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster. 
    +  +

    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + +
    +Uses of MiniHBaseClusterSingleton in org.kiji.maven.plugins.hbase
    +  +

    + + + + + + + +<<<<<<< HEAD + + + + + + +
    Methods in org.kiji.maven.plugins.hbase that return MiniHBaseClusterSingleton
    +static MiniHBaseClusterSingletonMiniHBaseClusterSingleton.valueOf(String name) +======= +MiniHBaseClusterSingleton.valueOf(String name) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
    +          Returns the enum constant of this type with the specified name.
    +static MiniHBaseClusterSingleton[]MiniHBaseClusterSingleton.values() + +
    +          Returns an array containing the constants of this enum type, in +the order they are declared.
    +  +

    +

    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterThread.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterThread.html new file mode 100644 index 00000000..dcfc4c71 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterThread.html @@ -0,0 +1,167 @@ + + + + +<<<<<<< HEAD + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.maven.plugins.hbase.MiniHBaseClusterThread

    +
    +No usage of org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +

    +

    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StartMojo.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StartMojo.html new file mode 100644 index 00000000..acfd648a --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StartMojo.html @@ -0,0 +1,167 @@ + + + + +<<<<<<< HEAD + + + +Uses of Class org.kiji.maven.plugins.hbase.StartMojo (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Uses of Class org.kiji.maven.plugins.hbase.StartMojo (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.maven.plugins.hbase.StartMojo

    +
    +No usage of org.kiji.maven.plugins.hbase.StartMojo +

    +

    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StopMojo.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StopMojo.html new file mode 100644 index 00000000..e79f6d8b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StopMojo.html @@ -0,0 +1,167 @@ + + + + +<<<<<<< HEAD + + + +Uses of Class org.kiji.maven.plugins.hbase.StopMojo (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Uses of Class org.kiji.maven.plugins.hbase.StopMojo (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Uses of Class
    org.kiji.maven.plugins.hbase.StopMojo

    +
    +No usage of org.kiji.maven.plugins.hbase.StopMojo +

    +

    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
    +    		 + +
    + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-frame.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-frame.html new file mode 100644 index 00000000..de80692a --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-frame.html @@ -0,0 +1,73 @@ + + + + +<<<<<<< HEAD + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + +org.kiji.maven.plugins.hbase + + + + +
    +Interfaces  + +
    +MavenLoggable
    + + + + + + +
    +Classes  + +
    +MavenLogged +
    +MiniHBaseCluster +
    +MiniHBaseClusterThread +
    +StartMojo +
    +StopMojo
    + + + + + + +
    +Enums  + +
    +MiniHBaseClusterSingleton
    + + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-summary.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-summary.html new file mode 100644 index 00000000..9477956e --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-summary.html @@ -0,0 +1,247 @@ + + + + +<<<<<<< HEAD + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    +<<<<<<< HEAD + PREV PACKAGE  +======= + PREV PACKAGE  +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +

    +Package org.kiji.maven.plugins.hbase +

    +A maven plugin that allows integration tests to run with a mini-hbase cluster. +

    +See: +
    +          Description +

    + + + + + + + + + +
    +Interface Summary
    MavenLoggableInterface for objects that can write to the maven log.
    +  + +

    + + + + + + + + + + + + + + + + + + + + + + + + + +
    +Class Summary
    MavenLoggedAn abstract base class for objects that write to the maven log.
    MiniHBaseClusterA in-process mini HBase cluster that may be started and stopped.
    MiniHBaseClusterThreadA thread that starts and runs a mini HBase cluster.
    StartMojoA maven goal that starts a mini HBase cluster in a new daemon thread.
    StopMojoA maven goal that stops the mini HBase cluster started by the 'start' goal.
    +  + +

    + + + + + + + + + +
    +Enum Summary
    MiniHBaseClusterSingletonA singleton instance of a mini HBase cluster.
    +  + +

    +

    +Package org.kiji.maven.plugins.hbase Description +

    + +

    +A maven plugin that allows integration tests to run with a mini-hbase cluster. +

    + +

    +

    +
    +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
    +    		 + +
    +<<<<<<< HEAD + PREV PACKAGE  +======= + PREV PACKAGE  +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-tree.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-tree.html new file mode 100644 index 00000000..b9eae3b7 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-tree.html @@ -0,0 +1,225 @@ + + + + +<<<<<<< HEAD + + + +org.kiji.maven.plugins.hbase Class Hierarchy (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +org.kiji.maven.plugins.hbase Class Hierarchy (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
    + + + + + + + + + + + + + + + +
    + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
    Package  Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
    +    		 + +
    +<<<<<<< HEAD + PREV  +======= + PREV  +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + NEXT + FRAMES   + NO FRAMES   +  + + + +
    + + + +
    +
    +

    +Hierarchy For Package org.kiji.maven.plugins.hbase +

    +
    +<<<<<<< HEAD +======= +
    +
    Package Hierarchies:
    All Packages
    +
    +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +

    +Class Hierarchy +

    +
      +<<<<<<< HEAD +
    • java.lang.Object
        +======= +
      • java.lang.Object
          +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
        • org.apache.maven.plugin.AbstractMojo (implements org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo) + +
        • org.kiji.maven.plugins.hbase.MavenLogged (implements org.kiji.maven.plugins.hbase.MavenLoggable) + +<<<<<<< HEAD +
        • java.lang.Thread (implements java.lang.Runnable) +======= +
        • java.lang.Thread (implements java.lang.Runnable) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
        +
      +

      +Interface Hierarchy +

      + +

      +Enum Hierarchy +

      +
        +<<<<<<< HEAD +
      • java.lang.Object +
        + + + + + + + + + + + + + + + +
        + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
        Package  Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
        +        		 + +
        +<<<<<<< HEAD + PREV  +======= + PREV  +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-use.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-use.html new file mode 100644 index 00000000..0009347a --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-use.html @@ -0,0 +1,214 @@ + + + + +<<<<<<< HEAD + + + +Uses of Package org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Uses of Package org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
        + + + + + + + + + + + + + + + +
        + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
        Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Uses of Package
        org.kiji.maven.plugins.hbase

        +
        +<<<<<<< HEAD +======= + + + + + + + + + +
        +Packages that use org.kiji.maven.plugins.hbase
        org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster. 
        +  +

        +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + + + + + + + + + +
        +Classes in org.kiji.maven.plugins.hbase used by org.kiji.maven.plugins.hbase
        MavenLoggable + +
        +          Interface for objects that can write to the maven log.
        MavenLogged + +
        +          An abstract base class for objects that write to the maven log.
        MiniHBaseCluster + +
        +          A in-process mini HBase cluster that may be started and stopped.
        MiniHBaseClusterSingleton + +
        +          A singleton instance of a mini HBase cluster.
        +  +

        +

        + + + + + + + + + + + + + + + +
        + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
        Package  Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/overview-frame.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/overview-frame.html new file mode 100644 index 00000000..22dc7c50 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/overview-frame.html @@ -0,0 +1,45 @@ + + + + + + + +Overview List (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + + + + +
        +
        + + + + + +
        All Classes +

        + +Packages +
        +org.apache.hadoop.hbase.util +
        +org.kiji.maven.plugins.hbase +
        +

        + +

        +  + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/overview-summary.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/overview-summary.html new file mode 100644 index 00000000..ed6b392d --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/overview-summary.html @@ -0,0 +1,161 @@ + + + + + + + +Overview (hbase-maven-plugin 1.0.10-cdh4 API) + + + + + + + + + + + + +

        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + +
         Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +hbase-maven-plugin 1.0.10-cdh4 API +

        +
        + + + + + + + + + + + + + +
        +Packages
        org.apache.hadoop.hbase.util 
        org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster.
        + +

        + 

        + + + + + + + + + + + + + + + +
        + + + + + + + + + + + + +
         Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/overview-tree.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/overview-tree.html new file mode 100644 index 00000000..3ae24afc --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/overview-tree.html @@ -0,0 +1,224 @@ + + + + +<<<<<<< HEAD + + + +Class Hierarchy (hbase-maven-plugin 1.0.10-hadoop1 API) + + + +======= + + + +Class Hierarchy (hbase-maven-plugin 1.0.10-cdh4 API) + + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + + + +
        + + + + + + + + + + + + + + + +
        + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
        Package  Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
        +        		 + +
        + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
        + + + +
        +
        +

        +Hierarchy For All Packages

        +
        +
        +<<<<<<< HEAD +
        Package Hierarchies:
        org.kiji.maven.plugins.hbase
        +======= +
        Package Hierarchies:
        org.apache.hadoop.hbase.util, org.kiji.maven.plugins.hbase +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +
        +

        +Class Hierarchy +

        +
          +<<<<<<< HEAD +
        • java.lang.Object
            +
          • org.apache.maven.plugin.AbstractMojo (implements org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo) + +
          • org.kiji.maven.plugins.hbase.MavenLogged (implements org.kiji.maven.plugins.hbase.MavenLoggable) + +
          • java.lang.Thread (implements java.lang.Runnable) +======= +
          • java.lang.Object
              +
            • org.apache.maven.plugin.AbstractMojo (implements org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo) + +
            • org.apache.hadoop.hbase.util.FSUtils
            • org.apache.hadoop.hbase.util.FSUtils.DirFilter (implements org.apache.hadoop.fs.PathFilter) +
            • org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter (implements org.apache.hadoop.fs.PathFilter) +
            • org.apache.hadoop.hbase.util.FSUtils.HFileFilter (implements org.apache.hadoop.fs.PathFilter) +
            • org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter (implements org.apache.hadoop.fs.PathFilter) +
            • org.kiji.maven.plugins.hbase.MavenLogged (implements org.kiji.maven.plugins.hbase.MavenLoggable) + +
            • java.lang.Thread (implements java.lang.Runnable) +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + +
            +
          +

          +Interface Hierarchy +

          + +

          +Enum Hierarchy +

          +
            +<<<<<<< HEAD +
          • java.lang.Object +
            + + + + + + + + + + + + + + + +
            + + + +<<<<<<< HEAD + +======= + + +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 + + + + + + + +
            Package  Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/package-list b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/package-list new file mode 100644 index 00000000..129f7ec9 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/package-list @@ -0,0 +1,5 @@ +<<<<<<< HEAD +======= +org.apache.hadoop.hbase.util +>>>>>>> Updates docs of hbase-maven-plugin to 1.0.10 +org.kiji.maven.plugins.hbase diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/resources/inherit.gif b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/resources/inherit.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/stylesheet.css b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/apidocs/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/maven-base.css b/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/maven-base.css new file mode 100644 index 00000000..780cbb35 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/maven-base.css @@ -0,0 +1,155 @@ +body { + margin: 0px; + padding: 0px; +} +img { + border:none; +} +table { + padding:0px; + width: 100%; + margin-left: -2px; + margin-right: -2px; +} +acronym { + cursor: help; + border-bottom: 1px dotted #feb; +} +table.bodyTable th, table.bodyTable td { + padding: 2px 4px 2px 4px; + vertical-align: top; +} +div.clear{ + clear:both; + visibility: hidden; +} +div.clear hr{ + display: none; +} +#bannerLeft, #bannerRight { + font-size: xx-large; + font-weight: bold; +} +#bannerLeft img, #bannerRight img { + margin: 0px; +} +.xleft, #bannerLeft img { + float:left; +} +.xright, #bannerRight { + float:right; +} +#banner { + padding: 0px; +} +#banner img { + border: none; +} +#breadcrumbs { + padding: 3px 10px 3px 10px; +} +#leftColumn { + width: 170px; + float:left; + overflow: auto; +} +#bodyColumn { + margin-right: 1.5em; + margin-left: 197px; +} +#legend { + padding: 8px 0 8px 0; +} +#navcolumn { + padding: 8px 4px 0 8px; +} +#navcolumn h5 { + margin: 0; + padding: 0; + font-size: small; +} +#navcolumn ul { + margin: 0; + padding: 0; + font-size: small; +} +#navcolumn li { + list-style-type: none; + background-image: none; + background-repeat: no-repeat; + background-position: 0 0.4em; + padding-left: 16px; + list-style-position: outside; + line-height: 1.2em; + font-size: smaller; +} +#navcolumn li.expanded { + background-image: url(../images/expanded.gif); +} +#navcolumn li.collapsed { + background-image: url(../images/collapsed.gif); +} +#navcolumn li.none { + text-indent: -1em; + margin-left: 1em; +} +#poweredBy { + text-align: center; +} +#navcolumn img { + margin-top: 10px; + margin-bottom: 3px; +} +#poweredBy img { + display:block; + margin: 20px 0 20px 17px; +} +#search img { + margin: 0px; + display: block; +} +#search #q, #search #btnG { + border: 1px solid #999; + margin-bottom:10px; +} +#search form { + margin: 0px; +} +#lastPublished { + font-size: x-small; +} +.navSection { + margin-bottom: 2px; + padding: 8px; +} +.navSectionHead { + font-weight: bold; + font-size: x-small; +} +.section { + padding: 4px; +} +#footer { + padding: 3px 10px 3px 10px; + font-size: x-small; +} +#breadcrumbs { + font-size: x-small; + margin: 0pt; +} +.source { + padding: 12px; + margin: 1em 7px 1em 7px; +} +.source pre { + margin: 0px; + padding: 0px; +} +#navcolumn img.imageLink, .imageLink { + padding-left: 0px; + padding-bottom: 0px; + padding-top: 0px; + padding-right: 2px; + border: 0px; + margin: 0px; +} diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/maven-theme.css b/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/maven-theme.css new file mode 100644 index 00000000..c982168b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/maven-theme.css @@ -0,0 +1,141 @@ +body { + padding: 0px 0px 10px 0px; +} +body, td, select, input, li{ + font-family: Verdana, Helvetica, Arial, sans-serif; + font-size: 13px; +} +code{ + font-family: Courier, monospace; + font-size: 13px; +} +a { + text-decoration: none; +} +a:link { + color:#36a; +} +a:visited { + color:#47a; +} +a:active, a:hover { + color:#69c; +} +#legend li.externalLink { + background: url(../images/external.png) left top no-repeat; + padding-left: 18px; +} +a.externalLink, a.externalLink:link, a.externalLink:visited, a.externalLink:active, a.externalLink:hover { + background: url(../images/external.png) right center no-repeat; + padding-right: 18px; +} +#legend li.newWindow { + background: url(../images/newwindow.png) left top no-repeat; + padding-left: 18px; +} +a.newWindow, a.newWindow:link, a.newWindow:visited, a.newWindow:active, a.newWindow:hover { + background: url(../images/newwindow.png) right center no-repeat; + padding-right: 18px; +} +h2 { + padding: 4px 4px 4px 6px; + border: 1px solid #999; + color: #900; + background-color: #ddd; + font-weight:900; + font-size: x-large; +} +h3 { + padding: 4px 4px 4px 6px; + border: 1px solid #aaa; + color: #900; + background-color: #eee; + font-weight: normal; + font-size: large; +} +h4 { + padding: 4px 4px 4px 6px; + border: 1px solid #bbb; + color: #900; + background-color: #fff; + font-weight: normal; + font-size: large; +} +h5 { + padding: 4px 4px 4px 6px; + color: #900; + font-size: normal; +} +p { + line-height: 1.3em; + font-size: small; +} +#breadcrumbs { + border-top: 1px solid #aaa; + border-bottom: 1px solid #aaa; + background-color: #ccc; +} +#leftColumn { + margin: 10px 0 0 5px; + border: 1px solid #999; + background-color: #eee; +} +#navcolumn h5 { + font-size: smaller; + border-bottom: 1px solid #aaaaaa; + padding-top: 2px; + color: #000; +} + +table.bodyTable th { + color: white; + background-color: #bbb; + text-align: left; + font-weight: bold; +} + +table.bodyTable th, table.bodyTable td { + font-size: 1em; +} + +table.bodyTable tr.a { + background-color: #ddd; +} + +table.bodyTable tr.b { + background-color: #eee; +} + +.source { + border: 1px solid #999; +} +dl { + padding: 4px 4px 4px 6px; + border: 1px solid #aaa; + background-color: #ffc; +} +dt { + color: #900; +} +#organizationLogo img, #projectLogo img, #projectLogo span{ + margin: 8px; +} +#banner { + border-bottom: 1px solid #fff; +} +.errormark, .warningmark, .donemark, .infomark { + background: url(../images/icon_error_sml.gif) no-repeat; +} + +.warningmark { + background-image: url(../images/icon_warning_sml.gif); +} + +.donemark { + background-image: url(../images/icon_success_sml.gif); +} + +.infomark { + background-image: url(../images/icon_info_sml.gif); +} + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/print.css b/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/print.css new file mode 100644 index 00000000..26ad7f0b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/print.css @@ -0,0 +1,7 @@ +#banner, #footer, #leftcol, #breadcrumbs, .docs #toc, .docs .courtesylinks, #leftColumn, #navColumn { + display: none !important; +} +#bodyColumn, body.docs div.docs { + margin: 0 !important; + border: none !important +} diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/site.css b/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/site.css new file mode 100644 index 00000000..055e7e28 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/css/site.css @@ -0,0 +1 @@ +/* You can override this file with your own styles */ \ No newline at end of file diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/findbugs.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/findbugs.html new file mode 100644 index 00000000..7d9e0ff1 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/findbugs.html @@ -0,0 +1,106 @@ + + + + + + hbase-maven-plugin - FindBugs Bug Detector Report + + + + + + + + + +
            + +
            +
            +
            +

            FindBugs Bug Detector Report

            The following document contains the results of FindBugs Report

            FindBugs Version is 1.3.9

            Threshold is low

            Effort is max

            Summary

            ClassesBugsErrorsMissing Classes
            7001

            Files

            ClassBugs
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/collapsed.gif b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/collapsed.gif new file mode 100644 index 00000000..6e710840 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/collapsed.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/expanded.gif b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/expanded.gif new file mode 100644 index 00000000..0fef3d89 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/expanded.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/external.png b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/external.png new file mode 100644 index 00000000..3f999fc8 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/external.png differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_error_sml.gif b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_error_sml.gif new file mode 100644 index 00000000..61132ef2 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_error_sml.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_info_sml.gif b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_info_sml.gif new file mode 100644 index 00000000..c6cb9ad7 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_info_sml.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_success_sml.gif b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_success_sml.gif new file mode 100644 index 00000000..52e85a43 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_success_sml.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_warning_sml.gif b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_warning_sml.gif new file mode 100644 index 00000000..873bbb52 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/icon_warning_sml.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/logos/build-by-maven-black.png b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/logos/build-by-maven-black.png new file mode 100644 index 00000000..919fd0f6 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/logos/build-by-maven-black.png differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/logos/build-by-maven-white.png b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/logos/build-by-maven-white.png new file mode 100644 index 00000000..7d44c9c2 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/logos/build-by-maven-white.png differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/logos/maven-feather.png b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/logos/maven-feather.png new file mode 100644 index 00000000..b5ada836 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/logos/maven-feather.png differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/newwindow.png b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/newwindow.png new file mode 100644 index 00000000..6287f72b Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/images/newwindow.png differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/index.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/index.html new file mode 100644 index 00000000..2e61a5bf --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/index.html @@ -0,0 +1,103 @@ + + + + + + hbase-maven-plugin - About + + + + + + + + + +
            + +
            +
            +
            +

            About hbase-maven-plugin

            A maven plugin to start/stop a mini HBase cluster.

            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/license.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/license.html new file mode 100644 index 00000000..d55b3aa4 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/license.html @@ -0,0 +1,305 @@ + + + + + + hbase-maven-plugin - Project License + + + + + + + + + +
            + +
            +
            +
            +

            Overview

            Typically the licenses listed for the project are that of the project itself, and not of dependencies.

            Project License

            Apache 2

            +                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/plugin-info.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/plugin-info.html new file mode 100644 index 00000000..7909a8c5 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/plugin-info.html @@ -0,0 +1,154 @@ + + + + + + hbase-maven-plugin - Plugin Documentation + + + + + + + + + +
            + +
            +
            +
            +

            Plugin Documentation

            Goals available for this plugin:

            GoalDescription
            hbase:startA maven goal that starts a mini HBase cluster in a new daemon +thread. +

            A new daemon thread is created that starts a mini HBase cluster. +The main thread blocks until the HBase cluster has full started. +The daemon thread with the in-process HBase cluster will continue +to run in the background until stopped by the 'stop' goal of the +plugin.

            +

            The configuration of the started mini HBase cluster will be +written to a hbase-site.xml file in the test classpath +('${basedir}/target/test-classes' by default). The path to the +generated configuration file may be customized with the +'hbaseSiteFile' property

            +

            A configuration index can be written by this goal. The +configuration index is a file that contains one line for each +configuration file written by this goal, where the line contains +the path to the configuration file. By default, the goal does not +write a configuration index. Setting the property 'writeConfIndex' +to true will cause a configuration index to be written. By default, +the configuration index will be written to +'${basedir}/target/test-classes/conf-index.conf'. The path to the +generated configuration index can be customized by setting the +'hbaseConfIndex' property.

            hbase:stopA maven goal that stops the mini HBase cluster started by the +'start' goal.

            System Requirements

            The following specifies the minimum requirements to run this Maven plugin:

            Maven2.0
            JDKDefault target for maven-compiler-plugin version 2.3.2
            MemoryNo minimum requirement.
            Disk SpaceNo minimum requirement.

            Usage

            You should specify the version in your project's plugin configuration:

            <project>
+  ...
+  <build>
+    <!-- To define the plugin version in your parent POM -->
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <groupId>org.kiji.maven.plugins</groupId>
+          <artifactId>hbase-maven-plugin</artifactId>
+          <version>1.0.10-hadoop1</version>
+        </plugin>
+        ...
+      </plugins>
+    </pluginManagement>
+    <!-- To use the plugin goals in your POM or parent POM -->
+    <plugins>
+      <plugin>
+        <groupId>org.kiji.maven.plugins</groupId>
+        <artifactId>hbase-maven-plugin</artifactId>
+        <version>1.0.10-hadoop1</version>
+      </plugin>
+      ...
+    </plugins>
+  </build>
+  ...
+</project>
+

            For more information, see "Guide to Configuring Plug-ins"

            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/project-info.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/project-info.html new file mode 100644 index 00000000..d9092746 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/project-info.html @@ -0,0 +1,103 @@ + + + + + + hbase-maven-plugin - Project Information + + + + + + + + + +
            + +
            +
            +
            +

            Project Information

            This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by Maven on behalf of the project.

            Overview

            DocumentDescription
            AboutA maven plugin to start/stop a mini HBase cluster.
            Project LicenseThis is a link to the definitions of project licenses.
            Project SummaryThis document lists other related information of this project
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/project-reports.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/project-reports.html new file mode 100644 index 00000000..1a15cea2 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/project-reports.html @@ -0,0 +1,106 @@ + + + + + + hbase-maven-plugin - Generated Reports + + + + + + + + + +
            + +
            +
            +
            +

            Generated Reports

            This document provides an overview of the various reports that are automatically generated by Maven . Each report is briefly described below.

            Overview

            DocumentDescription
            JavaDocsJavaDoc API documentation.
            Test JavaDocsTest JavaDoc API documentation.
            Plugin DocumentationThis report provides goals and parameters documentation of a plugin.
            FindBugs ReportGenerates a source code report with the FindBugs Library.
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/project-summary.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/project-summary.html new file mode 100644 index 00000000..11e6f257 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/project-summary.html @@ -0,0 +1,103 @@ + + + + + + hbase-maven-plugin - Project Summary + + + + + + + + + +
            + +
            +
            +
            +

            Project Summary

            Project Information

            FieldValue
            Namehbase-maven-plugin
            DescriptionA maven plugin to start/stop a mini HBase cluster.
            Homepage-

            Project Organization

            FieldValue
            NameWibiData, Inc.
            URLhttp://www.wibidata.com

            Build Information

            FieldValue
            GroupIdorg.kiji.maven.plugins
            ArtifactIdhbase-maven-plugin
            Version1.0.10-hadoop1
            Typemaven-plugin
            JDK Rev-
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/start-mojo.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/start-mojo.html new file mode 100644 index 00000000..db9b6d99 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/start-mojo.html @@ -0,0 +1,290 @@ + + + + + + hbase-maven-plugin - + hbase:start + + + + + + + + + +
            + +
            +
            +
            + + +

            hbase:start

            +

            Full name:

            +

            org.kiji.maven.plugins:hbase-maven-plugin:1.0.10-hadoop1:start

            +

            Description:

            +
            A maven goal that starts a mini HBase cluster in a new daemon +thread. +

            A new daemon thread is created that starts a mini HBase cluster. +The main thread blocks until the HBase cluster has full started. +The daemon thread with the in-process HBase cluster will continue +to run in the background until stopped by the 'stop' goal of the +plugin.

            +

            The configuration of the started mini HBase cluster will be +written to a hbase-site.xml file in the test classpath +('${basedir}/target/test-classes' by default). The path to the +generated configuration file may be customized with the +'hbaseSiteFile' property

            +

            A configuration index can be written by this goal. The +configuration index is a file that contains one line for each +configuration file written by this goal, where the line contains +the path to the configuration file. By default, the goal does not +write a configuration index. Setting the property 'writeConfIndex' +to true will cause a configuration index to be written. By default, +the configuration index will be written to +'${basedir}/target/test-classes/conf-index.conf'. The path to the +generated configuration index can be customized by setting the +'hbaseConfIndex' property.

            +

            Attributes:

            +
              +
            • Requires a Maven project to be executed.
              • +
            • Requires dependency resolution of artifacts in scope: test.
              • +
            • Binds by default to the lifecycle phase: pre-integration-test.
              • +
            +

            Required Parameters

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            NameTypeSinceDescription
            coreSiteFileFile-The file that will store the configuration required to connect to +the started mini HDFS and MapReduce clusters. This file will be +generated by the goal.
            Default value is: ${project.build.testOutputDirectory}/core-site.xml.
            hbaseSiteFileFile-The file that will store the configuration required to connect to +the started mini HBase cluster. This file will be generated by the +goal.
            Default value is: ${project.build.testOutputDirectory}/hbase-site.xml.
            saveHadoopTmpDirboolean-If true, the Hadoop temporary directory (given by Hadoop +configuration property hadoop.tmp .dir) will be cleared before the +cluster is started, then copied to the project's build directory +before the cluster is shutdown.
            Default value is: false.
            +
            +

            Optional Parameters

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            NameTypeSinceDescription
            hbaseConfIndexFile-The file that will store paths to the configuration files generated +by the goal. This file will be generated by the goal and will +contain one line for each configuration file giving the path to +that configuration file.
            Default value is: ${project.build.testOutputDirectory}/conf-index.conf.
            hadoopConfigurationProperties-Extra Hadoop configuration properties to use.
            mapReduceEnabledboolean-If true, also start a mini MapReduce cluster.
            Default value is: false.
            separateConfigurationFilesboolean-Whether two separate XML configuration files should be generated +(one for HDFS+MapReduce, and one for HBase).
            Default value is: true.
            skipboolean-If true, this goal should be a no-op.
            Default value is: false.
            writeConfIndexboolean-If true, this goal should write an index file that provides the +paths to the HBase configuration files written by this goal.
            Default value is: false.
            +
            +

            Parameter Details

            +

            coreSiteFile:

            +
            The file that will store the configuration required to connect to +the started mini HDFS and MapReduce clusters. This file will be +generated by the goal.
            +
              +
            • Type: java.io.File
              • +
            • Required: Yes
              • +
            • Expression: ${core.site.file}
              • +
            • Default: ${project.build.testOutputDirectory}/core-site.xml
              • +

            hbaseConfIndex:

            +
            The file that will store paths to the configuration files generated +by the goal. This file will be generated by the goal and will +contain one line for each configuration file giving the path to +that configuration file.
            +
              +
            • Type: java.io.File
              • +
            • Required: No
              • +
            • Expression: ${hbase.conf.index.file}
              • +
            • Default: ${project.build.testOutputDirectory}/conf-index.conf
              • +

            hbaseSiteFile:

            +
            The file that will store the configuration required to connect to +the started mini HBase cluster. This file will be generated by the +goal.
            +
              +
            • Type: java.io.File
              • +
            • Required: Yes
              • +
            • Expression: ${hbase.site.file}
              • +
            • Default: ${project.build.testOutputDirectory}/hbase-site.xml
              • +

            hadoopConfiguration:

            +
            Extra Hadoop configuration properties to use.
            +
              +
            • Type: java.util.Properties
              • +
            • Required: No
              • +

            mapReduceEnabled:

            +
            If true, also start a mini MapReduce cluster.
            +
              +
            • Type: boolean
              • +
            • Required: No
              • +
            • Expression: ${mapreduce.enabled}
              • +
            • Default: false
              • +

            saveHadoopTmpDir:

            +
            If true, the Hadoop temporary directory (given by Hadoop +configuration property hadoop.tmp .dir) will be cleared before the +cluster is started, then copied to the project's build directory +before the cluster is shutdown.
            +
              +
            • Type: boolean
              • +
            • Required: Yes
              • +
            • Expression: ${save.hadoop.tmp}
              • +
            • Default: false
              • +

            separateConfigurationFiles:

            +
            Whether two separate XML configuration files should be generated +(one for HDFS+MapReduce, and one for HBase).
            +
              +
            • Type: boolean
              • +
            • Required: No
              • +
            • Expression: ${separate.configuration.files}
              • +
            • Default: true
              • +

            skip:

            +
            If true, this goal should be a no-op.
            +
              +
            • Type: boolean
              • +
            • Required: No
              • +
            • Default: false
              • +

            writeConfIndex:

            +
            If true, this goal should write an index file that provides the +paths to the HBase configuration files written by this goal.
            +
              +
            • Type: boolean
              • +
            • Required: No
              • +
            • Expression: ${hbase.conf.index}
              • +
            • Default: false
              • +
            +
            +
            + + +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/stop-mojo.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/stop-mojo.html new file mode 100644 index 00000000..013fd252 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/stop-mojo.html @@ -0,0 +1,174 @@ + + + + + + hbase-maven-plugin - + hbase:stop + + + + + + + + + +
            + +
            +
            +
            + + +

            hbase:stop

            +

            Full name:

            +

            org.kiji.maven.plugins:hbase-maven-plugin:1.0.10-hadoop1:stop

            +

            Description:

            +
            A maven goal that stops the mini HBase cluster started by the +'start' goal.
            +

            Attributes:

            +
              +
            • Requires a Maven project to be executed.
              • +
            • Binds by default to the lifecycle phase: post-integration-test.
              • +
            +

            Required Parameters

            + + + + + + + + + + + + + + + + + + + +
            NameTypeSinceDescription
            projectBuildDirString-The build directory for this project.
            Default value is: ${project.build.directory}.
            saveHadoopTmpDirboolean-If true, the Hadoop temporary directory (given by Hadoop +configuration property hadoop.tmp .dir) will be cleared before the +cluster is started, then copied to the project's build directory +before the cluster is shutdown.
            Default value is: false.
            +
            +

            Optional Parameters

            + + + + + + + + + + + + + +
            NameTypeSinceDescription
            skipboolean-If true, this goal should be a no-op.
            Default value is: false.
            +
            +

            Parameter Details

            +

            projectBuildDir:

            +
            The build directory for this project.
            +
              +
            • Type: java.lang.String
              • +
            • Required: Yes
              • +
            • Default: ${project.build.directory}
              • +

            saveHadoopTmpDir:

            +
            If true, the Hadoop temporary directory (given by Hadoop +configuration property hadoop.tmp .dir) will be cleared before the +cluster is started, then copied to the project's build directory +before the cluster is shutdown.
            +
              +
            • Type: boolean
              • +
            • Required: Yes
              • +
            • Expression: ${save.hadoop.tmp}
              • +
            • Default: false
              • +

            skip:

            +
            If true, this goal should be a no-op.
            +
              +
            • Type: boolean
              • +
            • Required: No
              • +
            • Default: false
              • +
            +
            +
            + + +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/allclasses-frame.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/allclasses-frame.html new file mode 100644 index 00000000..13a12976 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/allclasses-frame.html @@ -0,0 +1,34 @@ + + + + + + + +All Classes (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + +All Classes +
            + + + + + +
            TestMiniHBaseCluster +
            +TestMiniHBaseClusterThread +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/allclasses-noframe.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/allclasses-noframe.html new file mode 100644 index 00000000..dce83145 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/allclasses-noframe.html @@ -0,0 +1,34 @@ + + + + + + + +All Classes (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + +All Classes +
            + + + + + +
            TestMiniHBaseCluster +
            +TestMiniHBaseClusterThread +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/constant-values.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/constant-values.html new file mode 100644 index 00000000..38556009 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/constant-values.html @@ -0,0 +1,145 @@ + + + + + + + +Constant Field Values (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/deprecated-list.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/deprecated-list.html new file mode 100644 index 00000000..c390486b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/help-doc.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/help-doc.html new file mode 100644 index 00000000..3ef35fb5 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/index-all.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/index-all.html new file mode 100644 index 00000000..508573c9 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/index-all.html @@ -0,0 +1,175 @@ + + + + + + + +Index (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +C O T
            +

            +C

            +
            +
            createMocks() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            +
            +

            +O

            +
            +
            org.kiji.maven.plugins.hbase - package org.kiji.maven.plugins.hbase
             
            +
            +

            +T

            +
            +
            testListenerOccupied() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            testListenerOpen() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            TestMiniHBaseCluster - Class in org.kiji.maven.plugins.hbase
             
            TestMiniHBaseCluster() - +Constructor for class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            TestMiniHBaseClusterThread - Class in org.kiji.maven.plugins.hbase
             
            TestMiniHBaseClusterThread() - +Constructor for class org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread +
              +
            testThreadStartupAndShutdown() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread +
            Tests that the thread can be started up and shut down gracefully. +
            testWithMapReduceDisabled() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            testWithMapReduceEnabled() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            +
            +C O T + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/index.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/index.html new file mode 100644 index 00000000..828051aa --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/index.html @@ -0,0 +1,37 @@ + + + + + + + +hbase-maven-plugin 1.0.10-hadoop1 Test API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/maven/plugins/hbase/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseCluster.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseCluster.html new file mode 100644 index 00000000..0cffbc71 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseCluster.html @@ -0,0 +1,339 @@ + + + + + + + +TestMiniHBaseCluster (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class TestMiniHBaseCluster

            +
            +java.lang.Object
+  extended by org.kiji.maven.plugins.hbase.TestMiniHBaseCluster
+
            +
            +
            +
            public class TestMiniHBaseCluster
            extends Object
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            TestMiniHBaseCluster() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidcreateMocks() + +
            +           
            + voidtestListenerOccupied() + +
            +           
            + voidtestListenerOpen() + +
            +           
            + voidtestWithMapReduceDisabled() + +
            +           
            + voidtestWithMapReduceEnabled() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +TestMiniHBaseCluster

            +
            +public TestMiniHBaseCluster()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createMocks

            +
            +public void createMocks()
            +
            +
            +
            +
            +
            +
            + +

            +testWithMapReduceDisabled

            +
            +public void testWithMapReduceDisabled()
+                               throws Exception
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +testWithMapReduceEnabled

            +
            +public void testWithMapReduceEnabled()
+                              throws Exception
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +testListenerOccupied

            +
            +public void testListenerOccupied()
+                          throws Exception
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +testListenerOpen

            +
            +public void testListenerOpen()
+                      throws Exception
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseClusterThread.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseClusterThread.html new file mode 100644 index 00000000..2182d9f4 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseClusterThread.html @@ -0,0 +1,256 @@ + + + + + + + +TestMiniHBaseClusterThread (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class TestMiniHBaseClusterThread

            +
            +java.lang.Object
+  extended by org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread
+
            +
            +
            +
            public class TestMiniHBaseClusterThread
            extends Object
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            TestMiniHBaseClusterThread() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + voidtestThreadStartupAndShutdown() + +
            +          Tests that the thread can be started up and shut down gracefully.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +TestMiniHBaseClusterThread

            +
            +public TestMiniHBaseClusterThread()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +testThreadStartupAndShutdown

            +
            +public void testThreadStartupAndShutdown()
+                                  throws Exception
            +
            +
            Tests that the thread can be started up and shut down gracefully. +

            +

            + +
            Throws: +
            Exception
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseCluster.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseCluster.html new file mode 100644 index 00000000..ad831857 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseCluster.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.TestMiniHBaseCluster

            +
            +No usage of org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseClusterThread.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseClusterThread.html new file mode 100644 index 00000000..668e874f --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseClusterThread.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread

            +
            +No usage of org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-frame.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-frame.html new file mode 100644 index 00000000..4e66352c --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + +org.kiji.maven.plugins.hbase + + + + +
            +Classes  + +
            +TestMiniHBaseCluster +
            +TestMiniHBaseClusterThread
            + + + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-summary.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-summary.html new file mode 100644 index 00000000..342d0444 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-summary.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.maven.plugins.hbase +

            + + + + + + + + + + + + + +
            +Class Summary
            TestMiniHBaseCluster 
            TestMiniHBaseClusterThread 
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-tree.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-tree.html new file mode 100644 index 00000000..785b33ce --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-tree.html @@ -0,0 +1,149 @@ + + + + + + + +org.kiji.maven.plugins.hbase Class Hierarchy (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.maven.plugins.hbase +

            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-use.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-use.html new file mode 100644 index 00000000..a53e0618 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-use.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Package org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.maven.plugins.hbase

            +
            +No usage of org.kiji.maven.plugins.hbase +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/overview-tree.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/overview-tree.html new file mode 100644 index 00000000..476026ea --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/overview-tree.html @@ -0,0 +1,151 @@ + + + + + + + +Class Hierarchy (hbase-maven-plugin 1.0.10-hadoop1 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.kiji.maven.plugins.hbase
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/package-list b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/package-list new file mode 100644 index 00000000..fff7c709 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/package-list @@ -0,0 +1 @@ +org.kiji.maven.plugins.hbase diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/resources/inherit.gif b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/resources/inherit.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/stylesheet.css b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/testapidocs/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/hbase-maven-plugin/1.0.10-cdh4/usage.html b/apidocs/hbase-maven-plugin/1.0.10-cdh4/usage.html new file mode 100644 index 00000000..f344a567 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.10-cdh4/usage.html @@ -0,0 +1,163 @@ + + + + + + hbase-maven-plugin - + + + + + + + + + +
            + +
            +
            +
            +

            Usage

            This plugin is useful for integration testing code that interacts with an HBase cluster. Typically, you will bind the `start` goal to your `pre-integration-test` phase and the `stop` goal to the `post-integration-test` phase of the maven build lifecycle.

            Referencing the maven repository hosted by WibiData

            Built artifacts are hosted on WibiData's maven repository, so you don't need to download the source and install the plugin manually. To tell maven about the repository from which to download this plugin, add the following to your ~/.m2/settings.xml or your project's pom.xml:

                <pluginRepositories>
+      <pluginRepository>
+        <id>kiji-plugins</id>
+        <name>kiji-plugins</name>
+        <url>https://repo.wibidata.com/artifactory/kiji</url>
+      </pluginRepository>
+    </pluginRepositories>

            Start HBase during the integration-test phase

            To bind the goals to their default phases (pre- and post-integration-test), add the following to the build plugins section of your pom.xml file:

                <build>
+      <plugins>
+        <!-- ... -->
+        <plugin>
+          <groupId>org.kiji.maven.plugins</groupId>
+          <artifactId>hbase-maven-plugin</artifactId>
+          <version>${version}</version>
+          <executions>
+            <execution>
+              <goals>
+                <goal>start</goal>
+                <goal>stop</goal>
+              </goals>
+            </execution>
+          </executions>
+        </plugin>
+        <!-- ... -->
+      </plugins>
+    </build>

            Start a MapReduce cluster during the integration-test phase

            You may also require a mini MapReduce cluster to be started alongside your HBase cluster. To configure the plugin to do so, set mapReduceEnabled to true in your configuration:

                <plugin>
+      <groupId>org.kiji.maven.plugins</groupId>
+      <artifactId>hbase-maven-plugin</artifactId>
+      <version>${version}</version>
+      <configuration>
+        <mapReduceEnabled>true</mapReduceEnabled>
+      </configuration>
+      <!-- ... -->
+    </plugin>

            Hadoop configuration for your cluster

            You might want to specify additional server-side Hadoop configuration for the cluster. You may use the hadoopConfiguration properties to set them. For example, to increase the number of map and reduce task slots:

                <plugin>
+      <groupId>org.kiji.maven.plugins</groupId>
+      <artifactId>hbase-maven-plugin</artifactId>
+      <version>${version}</version>
+      <configuration>
+        <hadoopConfiguration>
+          <property>
+            <name>mapred.tasktracker.map.tasks.maximum</name>
+            <value>16</value>
+          </property>
+          <property>
+            <name>mapred.tasktracker.reduce.tasks.maximum</name>
+            <value>8</value>
+          </property>
+        </hadoopConfiguration>
+        <mapReduceEnabled>true</mapReduceEnabled>
+      </configuration>
+      <!-- ... -->
+    </plugin>

            Using the mini cluster from your Java tests

            The `start` goal will write an XML configuration file named `hbase-site.xml` to your `target/test-classes` directory, which appears on the classpath when your tests are run. Hence, an `org.apache.hadoop.conf.Configuration` object created via `HBaseConfiguration.create()` will load the HBase cluster configuration automatically.

                Configuration conf = HBaseConfiguration.create();
+    HTable mytable = new HTable(conf, "mytable");
+    // Operate on mytable as usual...

            Logging

            By default, the plugin and the clusters it starts write their logs to the following locations within your project:

            • target/hbase-maven-plugin.log - The plugin log.
            • target/hbase.log - The HBase log.
            • target/mapred.log - The MapReduce log.

            MapReduce task logs

            Jobs run on the MapReduce cluster started by the plugin produce task logs that may be useful for debugging but that are deleted when the cluster is shutdown. These logs are written to the location given by the Hadoop configuration property `hadoop.tmp.dir`. Setting `saveHadoopTmpDir` to `true` in the plugin's configuration or setting `-Dsave.hadoop.tmp=true` on the command line will clear the directory given by `hadoop.tmp.dir` before the cluster is started and copy the contents of `hadoop.tmp.dir` to the directory `hadoop-tmp` in your project's build directory. Task logs can be found at `$project.build.directory/hadoop-tmp/userlogs`.

                <plugin>
+      <groupId>org.kiji.maven.plugins</groupId>
+      <artifactId>hbase-maven-plugin</artifactId>
+      <version>${version}</version>
+      <configuration>
+        <hadoopConfiguration>
+          <property>
+            <name>mapred.tasktracker.map.tasks.maximum</name>
+            <value>16</value>
+          </property>
+          <property>
+            <name>mapred.tasktracker.reduce.tasks.maximum</name>
+            <value>8</value>
+          </property>
+        </hadoopConfiguration>
+        <mapReduceEnabled>true</mapReduceEnabled>
+        <saveHadoopTmpDir>true</saveHadoopTmpDir>
+      </configuration>
+      <!-- ... -->
+    </plugin>
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/allclasses-frame.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/allclasses-frame.html new file mode 100644 index 00000000..0677378c --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/allclasses-frame.html @@ -0,0 +1,54 @@ + + + + + + + +All Classes (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + +All Classes +
            + + + + + +
            FSUtils +
            +FSUtils.DirFilter +
            +FSUtils.FamilyDirFilter +
            +FSUtils.HFileFilter +
            +FSUtils.RegionDirFilter +
            +MavenLoggable +
            +MavenLogged +
            +MiniHBaseCluster +
            +MiniHBaseClusterSingleton +
            +MiniHBaseClusterThread +
            +StartMojo +
            +StopMojo +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/allclasses-noframe.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/allclasses-noframe.html new file mode 100644 index 00000000..adf4e03f --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/allclasses-noframe.html @@ -0,0 +1,54 @@ + + + + + + + +All Classes (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + +All Classes +
            + + + + + +
            FSUtils +
            +FSUtils.DirFilter +
            +FSUtils.FamilyDirFilter +
            +FSUtils.HFileFilter +
            +FSUtils.RegionDirFilter +
            +MavenLoggable +
            +MavenLogged +
            +MiniHBaseCluster +
            +MiniHBaseClusterSingleton +
            +MiniHBaseClusterThread +
            +StartMojo +
            +StopMojo +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/constant-values.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/constant-values.html new file mode 100644 index 00000000..d8e3800a --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/constant-values.html @@ -0,0 +1,147 @@ + + + + + + + +Constant Field Values (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/deprecated-list.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/deprecated-list.html new file mode 100644 index 00000000..94fac99b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/deprecated-list.html @@ -0,0 +1,147 @@ + + + + + + + +Deprecated List (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/help-doc.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/help-doc.html new file mode 100644 index 00000000..3e4a3ee7 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/help-doc.html @@ -0,0 +1,224 @@ + + + + + + + +API Help (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Overview

            +
            + +

            +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

            +

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/index-all.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/index-all.html new file mode 100644 index 00000000..bca33037 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/index-all.html @@ -0,0 +1,488 @@ + + + + + + + +Index (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +A C D E F G H I L M O R S V W
            +

            +A

            +
            +
            accept(Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils.DirFilter +
              +
            accept(Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter +
              +
            accept(Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils.HFileFilter +
              +
            accept(Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter +
              +
            +
            +

            +C

            +
            +
            checkAccess(UserGroupInformation, FileStatus, FsAction) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Throw an exception if an action is not permitted by a user on a file. +
            checkClusterIdExists(FileSystem, Path, int) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Checks that a cluster ID file exists in the HBase root directory +
            checkDfsSafeMode(Configuration) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Check whether dfs is in safemode. +
            checkdir(FileSystem, Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils +
            Check if directory exists. +
            checkFileSystemAvailable(FileSystem) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Checks to see if the specified file system is available +
            checkVersion(FileSystem, Path, boolean) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Verifies current version of file system +
            checkVersion(FileSystem, Path, boolean, int, int) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Verifies current version of file system +
            computeHDFSBlocksDistribution(FileSystem, FileStatus, long, long) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Compute HDFS blocks distribution of a given file, or a portion of the file +
            create(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Create file. +
            +
            +

            +D

            +
            +
            deleteDirectory(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Delete if exists. +
            +
            +

            +E

            +
            +
            execute() - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Starts a mini HBase cluster in a new thread. +
            execute() - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
            +
            +
            +

            +F

            +
            +
            findOpenPort(int) - +Static method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Find an available port. +
            FSUtils - Class in org.apache.hadoop.hbase.util
            Utility methods for interacting with the underlying file system.
            FSUtils() - +Constructor for class org.apache.hadoop.hbase.util.FSUtils +
              +
            FSUtils.DirFilter - Class in org.apache.hadoop.hbase.util
            A PathFilter that returns directories.
            FSUtils.DirFilter(FileSystem) - +Constructor for class org.apache.hadoop.hbase.util.FSUtils.DirFilter +
              +
            FSUtils.FamilyDirFilter - Class in org.apache.hadoop.hbase.util
            Filter for all dirs that are legal column family names.
            FSUtils.FamilyDirFilter(FileSystem) - +Constructor for class org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter +
              +
            FSUtils.HFileFilter - Class in org.apache.hadoop.hbase.util
            Filter for HFiles that excludes reference files.
            FSUtils.HFileFilter(FileSystem) - +Constructor for class org.apache.hadoop.hbase.util.FSUtils.HFileFilter +
              +
            FSUtils.RegionDirFilter - Class in org.apache.hadoop.hbase.util
            Filter for all dirs that don't start with '.'
            FSUtils.RegionDirFilter(FileSystem) - +Constructor for class org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter +
              +
            +
            +

            +G

            +
            +
            getClusterConfiguration() - +Method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
            Provides access to the cluster configuration after it has started. +
            getClusterId(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Returns the value of the unique cluster ID stored for this HBase instance. +
            getConfiguration() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Provides access to the HBase cluster configuration. +
            getCurrentFileSystem(Configuration) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
              +
            getInstance(FileSystem, Configuration) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
              +
            getLog() - +Method in interface org.kiji.maven.plugins.hbase.MavenLoggable +
            Provides access to the maven log used to communicate with the user. +
            getLog() - +Method in class org.kiji.maven.plugins.hbase.MavenLogged +
            Provides access to the maven log used to communicate with the user. +
            getLog() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
              +
            getPath(Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Return the 'path' component of a Path. +
            getRegionDirs(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Given a particular table dir, return all the regiondirs inside it, excluding files such as + .tableinfo +
            getRootDir(Configuration) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
              +
            getTableDirs(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
              +
            getTableFragmentation(HMaster) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them. +
            getTableFragmentation(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them. +
            getTablePath(Path, byte[]) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
              +
            getTablePath(Path, String) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
              +
            getTableStoreFilePathMap(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Runs through the HBase rootdir and creates a reverse lookup map for + table StoreFile names to the full Path. +
            getTotalTableFragmentation(HMaster) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Returns the total overall fragmentation percentage. +
            getVersion(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Verifies current version of file system +
            +
            +

            +H

            +
            +
            hfilePattern - +Static variable in class org.apache.hadoop.hbase.util.FSUtils.HFileFilter +
              +
            +
            +

            +I

            +
            +
            isClusterReady() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
            Determine whether the HBase cluster is up and running. +
            isHDFS(Configuration) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
              +
            isHflushSupported() - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Heuristic to determine whether is safe or not to open a file for hflush + Uses reflection to search for FSDataOutputStream.hflush() +
            isMajorCompacted(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted. +
            isMajorCompactedPre020(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted. +
            isPre020FileLayout(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Expects to find -ROOT- directory. +
            isRunning() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Determine whether the cluster is running. +
            isSyncSupported() - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Heuristic to determine whether is safe or not to open a file for sync + Uses reflection to search for SequenceFile.Writer.syncFs() +
            +
            +

            +L

            +
            +
            listStatus(FileSystem, Path, PathFilter) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Calls fs.listStatus() and treats FileNotFoundException as non-fatal + This would accommodate difference in various hadoop versions +
            +
            +

            +M

            +
            +
            MavenLoggable - Interface in org.kiji.maven.plugins.hbase
            Interface for objects that can write to the maven log.
            MavenLogged - Class in org.kiji.maven.plugins.hbase
            An abstract base class for objects that write to the maven log.
            MavenLogged(Log) - +Constructor for class org.kiji.maven.plugins.hbase.MavenLogged +
            Constructor. +
            MiniHBaseCluster - Class in org.kiji.maven.plugins.hbase
            A in-process mini HBase cluster that may be started and stopped.
            MiniHBaseCluster(Log, boolean, Configuration) - +Constructor for class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Creates a new MiniHBaseCluster instance. +
            MiniHBaseCluster(Log, boolean, HBaseTestingUtility) - +Constructor for class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Creates a new MiniHBaseCluster instance. +
            MiniHBaseClusterSingleton - Enum in org.kiji.maven.plugins.hbase
            A singleton instance of a mini HBase cluster.
            MiniHBaseClusterThread - Class in org.kiji.maven.plugins.hbase
            A thread that starts and runs a mini HBase cluster.
            MiniHBaseClusterThread(Log, MiniHBaseCluster) - +Constructor for class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
            Creates a new MiniHBaseClusterThread instance. +
            +
            +

            +O

            +
            +
            org.apache.hadoop.hbase.util - package org.apache.hadoop.hbase.util
             
            org.kiji.maven.plugins.hbase - package org.kiji.maven.plugins.hbase
            A maven plugin that allows integration tests to run with a mini-hbase cluster.
            +
            +

            +R

            +
            +
            recoverFileLease(FileSystem, Path) - +Method in class org.apache.hadoop.hbase.util.FSUtils +
            Recover file lease. +
            regionDirPattern - +Static variable in class org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter +
              +
            rootRegionExists(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Checks if root region exists +
            run() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
            Runs the mini HBase cluster. +
            +
            +

            +S

            +
            +
            setClusterId(FileSystem, Path, String, int) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Writes a new unique identifier for this cluster to the "hbase.id" file + in the HBase root directory +
            setCoreSiteFile(File) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets the file that we should write the MapReduce/HDFS cluster configuration to. +
            setHadoopConfiguration(Properties) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets Hadoop configuration properties. +
            setHbaseConfIndex(File) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets the file that the HBase configuration index should be written to. +
            setHbaseSiteFile(File) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets the file that we should write the HBase cluster configuration to. +
            setMapReduceEnabled(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets whether we should start a mini MapReduce cluster in addition to the HBase cluster. +
            setProjectBuildDir(String) - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
            Sets the output directory for the project's build. +
            setSaveHadoopTmpDir(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +
            setSaveHadoopTmpDir(boolean) - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
            Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +
            setSeparateConfigurationFiles(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets whether separate core-site.xml and hbase-site.xml files + should be generated (otherwise they are combined into a single + hbase-site.xml file). +
            setSkip(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets whether this goal should be a no-op. +
            setSkip(boolean) - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
            Sets whether this goal should be a no-op. +
            setVersion(FileSystem, Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Sets version of file system +
            setVersion(FileSystem, Path, int, int) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Sets version of file system +
            setVersion(FileSystem, Path, String, int, int) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Sets version of file system +
            setWriteConfIndex(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets whether this goal should write a configuration index file. +
            shutdown() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Stops the cluster. +
            startAndWaitUntilReady(Log, boolean, Configuration) - +Method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
            Starts the HBase cluster and blocks until it is ready. +
            StartMojo - Class in org.kiji.maven.plugins.hbase
            A maven goal that starts a mini HBase cluster in a new daemon thread.
            StartMojo() - +Constructor for class org.kiji.maven.plugins.hbase.StartMojo +
              +
            startup() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Starts the cluster. +
            stop(Log) - +Method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
            Stops the HBase cluster and blocks until is has been shutdown completely. +
            stopClusterGracefully() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
            Stops the HBase cluster gracefully. +
            StopMojo - Class in org.kiji.maven.plugins.hbase
            A maven goal that stops the mini HBase cluster started by the 'start' goal.
            StopMojo() - +Constructor for class org.kiji.maven.plugins.hbase.StopMojo +
              +
            +
            +

            +V

            +
            +
            validateRootPath(Path) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            Verifies root directory path is a valid URI with a scheme +
            valueOf(String) - +Static method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
            Returns the enum constant of this type with the specified name. +
            values() - +Static method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            +
            +

            +W

            +
            +
            waitOnSafeMode(Configuration, long) - +Static method in class org.apache.hadoop.hbase.util.FSUtils +
            If DFS, check safe mode and if so, wait until we clear it. +
            +
            +A C D E F G H I L M O R S V W + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/index.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/index.html new file mode 100644 index 00000000..b2eda2ca --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/index.html @@ -0,0 +1,40 @@ + + + + + + + +hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.DirFilter.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.DirFilter.html new file mode 100644 index 00000000..2f6b40b0 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.DirFilter.html @@ -0,0 +1,266 @@ + + + + + + + +FSUtils.DirFilter (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.hbase.util +
            +Class FSUtils.DirFilter

            +
            +java.lang.Object
+  extended by org.apache.hadoop.hbase.util.FSUtils.DirFilter
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.fs.PathFilter
            +
            +
            +
            Enclosing class:
            FSUtils
            +
            +
            +
            +
            public static class FSUtils.DirFilter
            extends Object
            implements org.apache.hadoop.fs.PathFilter
            + + +

            +A PathFilter that returns directories. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            FSUtils.DirFilter(org.apache.hadoop.fs.FileSystem fs) + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + booleanaccept(org.apache.hadoop.fs.Path p) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +FSUtils.DirFilter

            +
            +public FSUtils.DirFilter(org.apache.hadoop.fs.FileSystem fs)
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +accept

            +
            +public boolean accept(org.apache.hadoop.fs.Path p)
            +
            +
            +
            Specified by:
            accept in interface org.apache.hadoop.fs.PathFilter
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.FamilyDirFilter.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.FamilyDirFilter.html new file mode 100644 index 00000000..7c0cbed9 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.FamilyDirFilter.html @@ -0,0 +1,267 @@ + + + + + + + +FSUtils.FamilyDirFilter (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.hbase.util +
            +Class FSUtils.FamilyDirFilter

            +
            +java.lang.Object
+  extended by org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.fs.PathFilter
            +
            +
            +
            Enclosing class:
            FSUtils
            +
            +
            +
            +
            public static class FSUtils.FamilyDirFilter
            extends Object
            implements org.apache.hadoop.fs.PathFilter
            + + +

            +Filter for all dirs that are legal column family names. This is generally used for colfam + dirs ///. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            FSUtils.FamilyDirFilter(org.apache.hadoop.fs.FileSystem fs) + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + booleanaccept(org.apache.hadoop.fs.Path rd) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +FSUtils.FamilyDirFilter

            +
            +public FSUtils.FamilyDirFilter(org.apache.hadoop.fs.FileSystem fs)
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +accept

            +
            +public boolean accept(org.apache.hadoop.fs.Path rd)
            +
            +
            +
            Specified by:
            accept in interface org.apache.hadoop.fs.PathFilter
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.HFileFilter.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.HFileFilter.html new file mode 100644 index 00000000..a6a530f2 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.HFileFilter.html @@ -0,0 +1,302 @@ + + + + + + + +FSUtils.HFileFilter (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.hbase.util +
            +Class FSUtils.HFileFilter

            +
            +java.lang.Object
+  extended by org.apache.hadoop.hbase.util.FSUtils.HFileFilter
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.fs.PathFilter
            +
            +
            +
            Enclosing class:
            FSUtils
            +
            +
            +
            +
            public static class FSUtils.HFileFilter
            extends Object
            implements org.apache.hadoop.fs.PathFilter
            + + +

            +Filter for HFiles that excludes reference files. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static PatternhfilePattern + +
            +           
            +  + + + + + + + + + + +
            +Constructor Summary
            FSUtils.HFileFilter(org.apache.hadoop.fs.FileSystem fs) + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + booleanaccept(org.apache.hadoop.fs.Path rd) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +hfilePattern

            +
            +public static final Pattern hfilePattern
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +FSUtils.HFileFilter

            +
            +public FSUtils.HFileFilter(org.apache.hadoop.fs.FileSystem fs)
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +accept

            +
            +public boolean accept(org.apache.hadoop.fs.Path rd)
            +
            +
            +
            Specified by:
            accept in interface org.apache.hadoop.fs.PathFilter
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.RegionDirFilter.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.RegionDirFilter.html new file mode 100644 index 00000000..6181a276 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.RegionDirFilter.html @@ -0,0 +1,302 @@ + + + + + + + +FSUtils.RegionDirFilter (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.hbase.util +
            +Class FSUtils.RegionDirFilter

            +
            +java.lang.Object
+  extended by org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.fs.PathFilter
            +
            +
            +
            Enclosing class:
            FSUtils
            +
            +
            +
            +
            public static class FSUtils.RegionDirFilter
            extends Object
            implements org.apache.hadoop.fs.PathFilter
            + + +

            +Filter for all dirs that don't start with '.' +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static PatternregionDirPattern + +
            +           
            +  + + + + + + + + + + +
            +Constructor Summary
            FSUtils.RegionDirFilter(org.apache.hadoop.fs.FileSystem fs) + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + booleanaccept(org.apache.hadoop.fs.Path rd) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +regionDirPattern

            +
            +public static final Pattern regionDirPattern
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +FSUtils.RegionDirFilter

            +
            +public FSUtils.RegionDirFilter(org.apache.hadoop.fs.FileSystem fs)
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +accept

            +
            +public boolean accept(org.apache.hadoop.fs.Path rd)
            +
            +
            +
            Specified by:
            accept in interface org.apache.hadoop.fs.PathFilter
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.html new file mode 100644 index 00000000..3e22d400 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/FSUtils.html @@ -0,0 +1,1343 @@ + + + + + + + +FSUtils (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.hbase.util +
            +Class FSUtils

            +
            +java.lang.Object
+  extended by org.apache.hadoop.hbase.util.FSUtils
+
            +
            +
            +
            public abstract class FSUtils
            extends Object
            + + +

            +Utility methods for interacting with the underlying file system. + +

            hbase-maven-plugin note: This file is identical to the version distributed with CDH4 + save for a fix to accept() to change a stack trace printed on stdout into a LOG.warn.

            + +

            The new behavior is similar to later versions of hbase and allows us to redirect this + harmless error message.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Nested Class Summary
            +static classFSUtils.DirFilter + +
            +          A PathFilter that returns directories.
            +static classFSUtils.FamilyDirFilter + +
            +          Filter for all dirs that are legal column family names.
            +static classFSUtils.HFileFilter + +
            +          Filter for HFiles that excludes reference files.
            +static classFSUtils.RegionDirFilter + +
            +          Filter for all dirs that don't start with '.'
            +  + + + + + + + + + + + +
            +Constructor Summary
            +protected FSUtils() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidcheckAccess(org.apache.hadoop.security.UserGroupInformation ugi, + org.apache.hadoop.fs.FileStatus file, + org.apache.hadoop.fs.permission.FsAction action) + +
            +          Throw an exception if an action is not permitted by a user on a file.
            +static booleancheckClusterIdExists(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + int wait) + +
            +          Checks that a cluster ID file exists in the HBase root directory
            +static voidcheckDfsSafeMode(org.apache.hadoop.conf.Configuration conf) + +
            +          Check whether dfs is in safemode.
            + org.apache.hadoop.fs.Pathcheckdir(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path dir) + +
            +          Check if directory exists.
            +static voidcheckFileSystemAvailable(org.apache.hadoop.fs.FileSystem fs) + +
            +          Checks to see if the specified file system is available
            +static voidcheckVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + boolean message) + +
            +          Verifies current version of file system
            +static voidcheckVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + boolean message, + int wait, + int retries) + +
            +          Verifies current version of file system
            +static org.apache.hadoop.hbase.HDFSBlocksDistributioncomputeHDFSBlocksDistribution(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.FileStatus status, + long start, + long length) + +
            +          Compute HDFS blocks distribution of a given file, or a portion of the file
            +static org.apache.hadoop.fs.Pathcreate(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path p) + +
            +          Create file.
            +static booleandeleteDirectory(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path dir) + +
            +          Delete if exists.
            +static StringgetClusterId(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir) + +
            +          Returns the value of the unique cluster ID stored for this HBase instance.
            +static org.apache.hadoop.fs.FileSystemgetCurrentFileSystem(org.apache.hadoop.conf.Configuration conf) + +
            +           
            +static FSUtilsgetInstance(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.conf.Configuration conf) + +
            +           
            +static StringgetPath(org.apache.hadoop.fs.Path p) + +
            +          Return the 'path' component of a Path.
            +static List<org.apache.hadoop.fs.Path>getRegionDirs(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path tableDir) + +
            +          Given a particular table dir, return all the regiondirs inside it, excluding files such as + .tableinfo
            +static org.apache.hadoop.fs.PathgetRootDir(org.apache.hadoop.conf.Configuration c) + +
            +           
            +static List<org.apache.hadoop.fs.Path>getTableDirs(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir) + +
            +           
            +static Map<String,Integer>getTableFragmentation(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path hbaseRootDir) + +
            +          Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them.
            +static Map<String,Integer>getTableFragmentation(org.apache.hadoop.hbase.master.HMaster master) + +
            +          Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them.
            +static org.apache.hadoop.fs.PathgetTablePath(org.apache.hadoop.fs.Path rootdir, + byte[] tableName) + +
            +           
            +static org.apache.hadoop.fs.PathgetTablePath(org.apache.hadoop.fs.Path rootdir, + String tableName) + +
            +           
            +static Map<String,org.apache.hadoop.fs.Path>getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path hbaseRootDir) + +
            +          Runs through the HBase rootdir and creates a reverse lookup map for + table StoreFile names to the full Path.
            +static intgetTotalTableFragmentation(org.apache.hadoop.hbase.master.HMaster master) + +
            +          Returns the total overall fragmentation percentage.
            +static StringgetVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir) + +
            +          Verifies current version of file system
            +static booleanisHDFS(org.apache.hadoop.conf.Configuration conf) + +
            +           
            +static booleanisHflushSupported() + +
            +          Heuristic to determine whether is safe or not to open a file for hflush + Uses reflection to search for FSDataOutputStream.hflush()
            +static booleanisMajorCompacted(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path hbaseRootDir) + +
            +          Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted.
            +static booleanisMajorCompactedPre020(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path hbaseRootDir) + +
            +          Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted.
            +static booleanisPre020FileLayout(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path hbaseRootDir) + +
            +          Expects to find -ROOT- directory.
            +static booleanisSyncSupported() + +
            +          Heuristic to determine whether is safe or not to open a file for sync + Uses reflection to search for SequenceFile.Writer.syncFs()
            +static org.apache.hadoop.fs.FileStatus[]listStatus(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path dir, + org.apache.hadoop.fs.PathFilter filter) + +
            +          Calls fs.listStatus() and treats FileNotFoundException as non-fatal + This would accommodate difference in various hadoop versions
            +abstract  voidrecoverFileLease(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path p) + +
            +          Recover file lease.
            +static booleanrootRegionExists(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir) + +
            +          Checks if root region exists
            +static voidsetClusterId(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + String clusterId, + int wait) + +
            +          Writes a new unique identifier for this cluster to the "hbase.id" file + in the HBase root directory
            +static voidsetVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir) + +
            +          Sets version of file system
            +static voidsetVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + int wait, + int retries) + +
            +          Sets version of file system
            +static voidsetVersion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + String version, + int wait, + int retries) + +
            +          Sets version of file system
            +static org.apache.hadoop.fs.PathvalidateRootPath(org.apache.hadoop.fs.Path root) + +
            +          Verifies root directory path is a valid URI with a scheme
            +static voidwaitOnSafeMode(org.apache.hadoop.conf.Configuration conf, + long wait) + +
            +          If DFS, check safe mode and if so, wait until we clear it.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +FSUtils

            +
            +protected FSUtils()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getInstance

            +
            +public static FSUtils getInstance(org.apache.hadoop.fs.FileSystem fs,
+                                  org.apache.hadoop.conf.Configuration conf)
            +
            +
            +
            +
            +
            +
            + +

            +deleteDirectory

            +
            +public static boolean deleteDirectory(org.apache.hadoop.fs.FileSystem fs,
+                                      org.apache.hadoop.fs.Path dir)
+                               throws IOException
            +
            +
            Delete if exists. +

            +

            +
            Parameters:
            fs - filesystem object
            dir - directory to delete +
            Returns:
            True if deleted dir +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +checkdir

            +
            +public org.apache.hadoop.fs.Path checkdir(org.apache.hadoop.fs.FileSystem fs,
+                                          org.apache.hadoop.fs.Path dir)
+                                   throws IOException
            +
            +
            Check if directory exists. If it does not, create it. +

            +

            +
            Parameters:
            fs - filesystem object
            dir - path to check +
            Returns:
            Path +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +create

            +
            +public static org.apache.hadoop.fs.Path create(org.apache.hadoop.fs.FileSystem fs,
+                                               org.apache.hadoop.fs.Path p)
+                                        throws IOException
            +
            +
            Create file. +

            +

            +
            Parameters:
            fs - filesystem object
            p - path to create +
            Returns:
            Path +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +checkFileSystemAvailable

            +
            +public static void checkFileSystemAvailable(org.apache.hadoop.fs.FileSystem fs)
+                                     throws IOException
            +
            +
            Checks to see if the specified file system is available +

            +

            +
            Parameters:
            fs - filesystem +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +checkDfsSafeMode

            +
            +public static void checkDfsSafeMode(org.apache.hadoop.conf.Configuration conf)
+                             throws IOException
            +
            +
            Check whether dfs is in safemode. +

            +

            +
            Parameters:
            conf - +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getVersion

            +
            +public static String getVersion(org.apache.hadoop.fs.FileSystem fs,
+                                org.apache.hadoop.fs.Path rootdir)
+                         throws IOException
            +
            +
            Verifies current version of file system +

            +

            +
            Parameters:
            fs - filesystem object
            rootdir - root hbase directory +
            Returns:
            null if no version file exists, version string otherwise. +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +checkVersion

            +
            +public static void checkVersion(org.apache.hadoop.fs.FileSystem fs,
+                                org.apache.hadoop.fs.Path rootdir,
+                                boolean message)
+                         throws IOException
            +
            +
            Verifies current version of file system +

            +

            +
            Parameters:
            fs - file system
            rootdir - root directory of HBase installation
            message - if true, issues a message on System.out +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +checkVersion

            +
            +public static void checkVersion(org.apache.hadoop.fs.FileSystem fs,
+                                org.apache.hadoop.fs.Path rootdir,
+                                boolean message,
+                                int wait,
+                                int retries)
+                         throws IOException
            +
            +
            Verifies current version of file system +

            +

            +
            Parameters:
            fs - file system
            rootdir - root directory of HBase installation
            message - if true, issues a message on System.out
            wait - wait interval
            retries - number of times to retry +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +setVersion

            +
            +public static void setVersion(org.apache.hadoop.fs.FileSystem fs,
+                              org.apache.hadoop.fs.Path rootdir)
+                       throws IOException
            +
            +
            Sets version of file system +

            +

            +
            Parameters:
            fs - filesystem object
            rootdir - hbase root +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +setVersion

            +
            +public static void setVersion(org.apache.hadoop.fs.FileSystem fs,
+                              org.apache.hadoop.fs.Path rootdir,
+                              int wait,
+                              int retries)
+                       throws IOException
            +
            +
            Sets version of file system +

            +

            +
            Parameters:
            fs - filesystem object
            rootdir - hbase root
            wait - time to wait for retry
            retries - number of times to retry before failing +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +setVersion

            +
            +public static void setVersion(org.apache.hadoop.fs.FileSystem fs,
+                              org.apache.hadoop.fs.Path rootdir,
+                              String version,
+                              int wait,
+                              int retries)
+                       throws IOException
            +
            +
            Sets version of file system +

            +

            +
            Parameters:
            fs - filesystem object
            rootdir - hbase root directory
            version - version to set
            wait - time to wait for retry
            retries - number of times to retry before throwing an IOException +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +checkClusterIdExists

            +
            +public static boolean checkClusterIdExists(org.apache.hadoop.fs.FileSystem fs,
+                                           org.apache.hadoop.fs.Path rootdir,
+                                           int wait)
+                                    throws IOException
            +
            +
            Checks that a cluster ID file exists in the HBase root directory +

            +

            +
            Parameters:
            fs - the root directory FileSystem
            rootdir - the HBase root directory in HDFS
            wait - how long to wait between retries +
            Returns:
            true if the file exists, otherwise false +
            Throws: +
            IOException - if checking the FileSystem fails
            +
            +
            +
            + +

            +getClusterId

            +
            +public static String getClusterId(org.apache.hadoop.fs.FileSystem fs,
+                                  org.apache.hadoop.fs.Path rootdir)
+                           throws IOException
            +
            +
            Returns the value of the unique cluster ID stored for this HBase instance. +

            +

            +
            Parameters:
            fs - the root directory FileSystem
            rootdir - the path to the HBase root directory +
            Returns:
            the unique cluster identifier +
            Throws: +
            IOException - if reading the cluster ID file fails
            +
            +
            +
            + +

            +setClusterId

            +
            +public static void setClusterId(org.apache.hadoop.fs.FileSystem fs,
+                                org.apache.hadoop.fs.Path rootdir,
+                                String clusterId,
+                                int wait)
+                         throws IOException
            +
            +
            Writes a new unique identifier for this cluster to the "hbase.id" file + in the HBase root directory +

            +

            +
            Parameters:
            fs - the root directory FileSystem
            rootdir - the path to the HBase root directory
            clusterId - the unique identifier to store
            wait - how long (in milliseconds) to wait between retries +
            Throws: +
            IOException - if writing to the FileSystem fails and no wait value
            +
            +
            +
            + +

            +validateRootPath

            +
            +public static org.apache.hadoop.fs.Path validateRootPath(org.apache.hadoop.fs.Path root)
+                                                  throws IOException
            +
            +
            Verifies root directory path is a valid URI with a scheme +

            +

            +
            Parameters:
            root - root directory path +
            Returns:
            Passed root argument. +
            Throws: +
            IOException - if not a valid URI with a scheme
            +
            +
            +
            + +

            +waitOnSafeMode

            +
            +public static void waitOnSafeMode(org.apache.hadoop.conf.Configuration conf,
+                                  long wait)
+                           throws IOException
            +
            +
            If DFS, check safe mode and if so, wait until we clear it. +

            +

            +
            Parameters:
            conf - configuration
            wait - Sleep between retries +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +getPath

            +
            +public static String getPath(org.apache.hadoop.fs.Path p)
            +
            +
            Return the 'path' component of a Path. In Hadoop, Path is an URI. This + method returns the 'path' component of a Path's URI: e.g. If a Path is + hdfs://example.org:9000/hbase_trunk/TestTable/compaction.dir, + this method returns /hbase_trunk/TestTable/compaction.dir. + This method is useful if you want to print out a Path without qualifying + Filesystem instance. +

            +

            +
            Parameters:
            p - Filesystem Path whose 'path' component we are to return. +
            Returns:
            Path portion of the Filesystem
            +
            +
            +
            + +

            +getRootDir

            +
            +public static org.apache.hadoop.fs.Path getRootDir(org.apache.hadoop.conf.Configuration c)
+                                            throws IOException
            +
            +
            +
            Parameters:
            c - configuration +
            Returns:
            Path to hbase root directory: i.e. hbase.rootdir from + configuration as a qualified Path. +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +rootRegionExists

            +
            +public static boolean rootRegionExists(org.apache.hadoop.fs.FileSystem fs,
+                                       org.apache.hadoop.fs.Path rootdir)
+                                throws IOException
            +
            +
            Checks if root region exists +

            +

            +
            Parameters:
            fs - file system
            rootdir - root directory of HBase installation +
            Returns:
            true if exists +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +computeHDFSBlocksDistribution

            +
            +public static org.apache.hadoop.hbase.HDFSBlocksDistribution computeHDFSBlocksDistribution(org.apache.hadoop.fs.FileSystem fs,
+                                                                                           org.apache.hadoop.fs.FileStatus status,
+                                                                                           long start,
+                                                                                           long length)
+                                                                                    throws IOException
            +
            +
            Compute HDFS blocks distribution of a given file, or a portion of the file +

            +

            +
            Parameters:
            fs - file system
            status - file status of the file
            start - start position of the portion
            length - length of the portion +
            Returns:
            The HDFS blocks distribution +
            Throws: +
            IOException
            +
            +
            +
            + +

            +isMajorCompacted

            +
            +public static boolean isMajorCompacted(org.apache.hadoop.fs.FileSystem fs,
+                                       org.apache.hadoop.fs.Path hbaseRootDir)
+                                throws IOException
            +
            +
            Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted. Looks + at root and meta tables too. +

            +

            +
            Parameters:
            fs - filesystem
            hbaseRootDir - hbase root directory +
            Returns:
            True if this hbase install is major compacted. +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +getTotalTableFragmentation

            +
            +public static int getTotalTableFragmentation(org.apache.hadoop.hbase.master.HMaster master)
+                                      throws IOException
            +
            +
            Returns the total overall fragmentation percentage. Includes .META. and + -ROOT- as well. +

            +

            +
            Parameters:
            master - The master defining the HBase root and file system. +
            Returns:
            A map for each table and its percentage. +
            Throws: +
            IOException - When scanning the directory fails.
            +
            +
            +
            + +

            +getTableFragmentation

            +
            +public static Map<String,Integer> getTableFragmentation(org.apache.hadoop.hbase.master.HMaster master)
+                                                 throws IOException
            +
            +
            Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them. Checks -ROOT- and .META. too. The total + percentage across all tables is stored under the special key "-TOTAL-". +

            +

            +
            Parameters:
            master - The master defining the HBase root and file system. +
            Returns:
            A map for each table and its percentage. +
            Throws: +
            IOException - When scanning the directory fails.
            +
            +
            +
            + +

            +getTableFragmentation

            +
            +public static Map<String,Integer> getTableFragmentation(org.apache.hadoop.fs.FileSystem fs,
+                                                        org.apache.hadoop.fs.Path hbaseRootDir)
+                                                 throws IOException
            +
            +
            Runs through the HBase rootdir and checks how many stores for each table + have more than one file in them. Checks -ROOT- and .META. too. The total + percentage across all tables is stored under the special key "-TOTAL-". +

            +

            +
            Parameters:
            fs - The file system to use.
            hbaseRootDir - The root directory to scan. +
            Returns:
            A map for each table and its percentage. +
            Throws: +
            IOException - When scanning the directory fails.
            +
            +
            +
            + +

            +isPre020FileLayout

            +
            +public static boolean isPre020FileLayout(org.apache.hadoop.fs.FileSystem fs,
+                                         org.apache.hadoop.fs.Path hbaseRootDir)
+                                  throws IOException
            +
            +
            Expects to find -ROOT- directory. +

            +

            +
            Parameters:
            fs - filesystem
            hbaseRootDir - hbase root directory +
            Returns:
            True if this a pre020 layout. +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +isMajorCompactedPre020

            +
            +public static boolean isMajorCompactedPre020(org.apache.hadoop.fs.FileSystem fs,
+                                             org.apache.hadoop.fs.Path hbaseRootDir)
+                                      throws IOException
            +
            +
            Runs through the hbase rootdir and checks all stores have only + one file in them -- that is, they've been major compacted. Looks + at root and meta tables too. This version differs from + isMajorCompacted(FileSystem, Path) in that it expects a + pre-0.20.0 hbase layout on the filesystem. Used migrating. +

            +

            +
            Parameters:
            fs - filesystem
            hbaseRootDir - hbase root directory +
            Returns:
            True if this hbase install is major compacted. +
            Throws: +
            IOException - e
            +
            +
            +
            + +

            +isSyncSupported

            +
            +public static boolean isSyncSupported()
            +
            +
            Heuristic to determine whether is safe or not to open a file for sync + Uses reflection to search for SequenceFile.Writer.syncFs() +

            +

            + +
            Returns:
            True if sync is supported
            +
            +
            +
            + +

            +isHflushSupported

            +
            +public static boolean isHflushSupported()
            +
            +
            Heuristic to determine whether is safe or not to open a file for hflush + Uses reflection to search for FSDataOutputStream.hflush() +

            +

            + +
            Returns:
            True if hflush is supported
            +
            +
            +
            + +

            +isHDFS

            +
            +public static boolean isHDFS(org.apache.hadoop.conf.Configuration conf)
+                      throws IOException
            +
            +
            +
            Parameters:
            conf - +
            Returns:
            True if this filesystem whose scheme is 'hdfs'. +
            Throws: +
            IOException
            +
            +
            +
            + +

            +recoverFileLease

            +
            +public abstract void recoverFileLease(org.apache.hadoop.fs.FileSystem fs,
+                                      org.apache.hadoop.fs.Path p)
+                               throws IOException
            +
            +
            Recover file lease. Used when a file might be suspect + to be had been left open by another process. +

            +

            +
            Parameters:
            fs - FileSystem handle
            p - Path of file to recover lease
            conf - Configuration handle +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getTableDirs

            +
            +public static List<org.apache.hadoop.fs.Path> getTableDirs(org.apache.hadoop.fs.FileSystem fs,
+                                                           org.apache.hadoop.fs.Path rootdir)
+                                                    throws IOException
            +
            +
            +
            Parameters:
            fs -
            rootdir - +
            Returns:
            All the table directories under rootdir. Ignore non table hbase folders such as + .logs, .oldlogs, .corrupt, .META., and -ROOT- folders. +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getTablePath

            +
            +public static org.apache.hadoop.fs.Path getTablePath(org.apache.hadoop.fs.Path rootdir,
+                                                     byte[] tableName)
            +
            +
            +
            +
            +
            +
            + +

            +getTablePath

            +
            +public static org.apache.hadoop.fs.Path getTablePath(org.apache.hadoop.fs.Path rootdir,
+                                                     String tableName)
            +
            +
            +
            +
            +
            +
            + +

            +checkAccess

            +
            +public static void checkAccess(org.apache.hadoop.security.UserGroupInformation ugi,
+                               org.apache.hadoop.fs.FileStatus file,
+                               org.apache.hadoop.fs.permission.FsAction action)
+                        throws org.apache.hadoop.security.AccessControlException
            +
            +
            Throw an exception if an action is not permitted by a user on a file. +

            +

            +
            Parameters:
            ugi - the user
            file - the file
            action - the action +
            Throws: +
            org.apache.hadoop.security.AccessControlException
            +
            +
            +
            + +

            +getRegionDirs

            +
            +public static List<org.apache.hadoop.fs.Path> getRegionDirs(org.apache.hadoop.fs.FileSystem fs,
+                                                            org.apache.hadoop.fs.Path tableDir)
+                                                     throws IOException
            +
            +
            Given a particular table dir, return all the regiondirs inside it, excluding files such as + .tableinfo +

            +

            +
            Parameters:
            fs - A file system for the Path
            tableDir - Path to a specific table directory / +
            Returns:
            List of paths to valid region directories in table dir. +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getCurrentFileSystem

            +
            +public static org.apache.hadoop.fs.FileSystem getCurrentFileSystem(org.apache.hadoop.conf.Configuration conf)
+                                                            throws IOException
            +
            +
            +
            Parameters:
            conf - +
            Returns:
            Returns the filesystem of the hbase rootdir. +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getTableStoreFilePathMap

            +
            +public static Map<String,org.apache.hadoop.fs.Path> getTableStoreFilePathMap(org.apache.hadoop.fs.FileSystem fs,
+                                                                             org.apache.hadoop.fs.Path hbaseRootDir)
+                                                                      throws IOException
            +
            +
            Runs through the HBase rootdir and creates a reverse lookup map for + table StoreFile names to the full Path. +
            + Example...
            + Key = 3944417774205889744
            + Value = hdfs://localhost:51169/user/userid/-ROOT-/70236052/info/3944417774205889744 +

            +

            +
            Parameters:
            fs - The file system to use.
            hbaseRootDir - The root directory to scan. +
            Returns:
            Map keyed by StoreFile name with a value of the full Path. +
            Throws: +
            IOException - When scanning the directory fails.
            +
            +
            +
            + +

            +listStatus

            +
            +public static org.apache.hadoop.fs.FileStatus[] listStatus(org.apache.hadoop.fs.FileSystem fs,
+                                                           org.apache.hadoop.fs.Path dir,
+                                                           org.apache.hadoop.fs.PathFilter filter)
+                                                    throws IOException
            +
            +
            Calls fs.listStatus() and treats FileNotFoundException as non-fatal + This would accommodate difference in various hadoop versions +

            +

            +
            Parameters:
            fs - file system
            dir - directory
            filter - path filter +
            Returns:
            null if tabledir doesn't exist, otherwise FileStatus array +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.DirFilter.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.DirFilter.html new file mode 100644 index 00000000..ec1f578d --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.DirFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.util.FSUtils.DirFilter (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.hbase.util.FSUtils.DirFilter

            +
            +No usage of org.apache.hadoop.hbase.util.FSUtils.DirFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.FamilyDirFilter.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.FamilyDirFilter.html new file mode 100644 index 00000000..29f1820f --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.FamilyDirFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter

            +
            +No usage of org.apache.hadoop.hbase.util.FSUtils.FamilyDirFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.HFileFilter.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.HFileFilter.html new file mode 100644 index 00000000..2c3be383 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.HFileFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.util.FSUtils.HFileFilter (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.hbase.util.FSUtils.HFileFilter

            +
            +No usage of org.apache.hadoop.hbase.util.FSUtils.HFileFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.RegionDirFilter.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.RegionDirFilter.html new file mode 100644 index 00000000..99009b20 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.RegionDirFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter

            +
            +No usage of org.apache.hadoop.hbase.util.FSUtils.RegionDirFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.html new file mode 100644 index 00000000..b9d9693f --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/class-use/FSUtils.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.util.FSUtils (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.hbase.util.FSUtils

            +
            + + + + + + + + + +
            +Packages that use FSUtils
            org.apache.hadoop.hbase.util  
            +  +

            + + + + + +
            +Uses of FSUtils in org.apache.hadoop.hbase.util
            +  +

            + + + + + + + + + +
            Methods in org.apache.hadoop.hbase.util that return FSUtils
            +static FSUtilsFSUtils.getInstance(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.conf.Configuration conf) + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-frame.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-frame.html new file mode 100644 index 00000000..e4433249 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-frame.html @@ -0,0 +1,41 @@ + + + + + + + +org.apache.hadoop.hbase.util (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + +org.apache.hadoop.hbase.util + + + + +
            +Classes  + +
            +FSUtils +
            +FSUtils.DirFilter +
            +FSUtils.FamilyDirFilter +
            +FSUtils.HFileFilter +
            +FSUtils.RegionDirFilter
            + + + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-summary.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-summary.html new file mode 100644 index 00000000..b677913e --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-summary.html @@ -0,0 +1,174 @@ + + + + + + + +org.apache.hadoop.hbase.util (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.apache.hadoop.hbase.util +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            FSUtilsUtility methods for interacting with the underlying file system.
            FSUtils.DirFilterA PathFilter that returns directories.
            FSUtils.FamilyDirFilterFilter for all dirs that are legal column family names.
            FSUtils.HFileFilterFilter for HFiles that excludes reference files.
            FSUtils.RegionDirFilterFilter for all dirs that don't start with '.'
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-tree.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-tree.html new file mode 100644 index 00000000..6a6eb257 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-tree.html @@ -0,0 +1,158 @@ + + + + + + + +org.apache.hadoop.hbase.util Class Hierarchy (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.apache.hadoop.hbase.util +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-use.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-use.html new file mode 100644 index 00000000..8036591e --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/apache/hadoop/hbase/util/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package org.apache.hadoop.hbase.util (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.apache.hadoop.hbase.util

            +
            + + + + + + + + + +
            +Packages that use org.apache.hadoop.hbase.util
            org.apache.hadoop.hbase.util  
            +  +

            + + + + + + + + +
            +Classes in org.apache.hadoop.hbase.util used by org.apache.hadoop.hbase.util
            FSUtils + +
            +          Utility methods for interacting with the underlying file system.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MavenLoggable.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MavenLoggable.html new file mode 100644 index 00000000..e8510a1a --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MavenLoggable.html @@ -0,0 +1,217 @@ + + + + + + + +MavenLoggable (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Interface MavenLoggable

            +
            +
            All Known Implementing Classes:
            MavenLogged, MiniHBaseCluster, MiniHBaseClusterThread
            +
            +
            +
            +
            public interface MavenLoggable
            + + +

            +Interface for objects that can write to the maven log. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + org.apache.maven.plugin.logging.LoggetLog() + +
            +          Provides access to the maven log used to communicate with the user.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getLog

            +
            +org.apache.maven.plugin.logging.Log getLog()
            +
            +
            Provides access to the maven log used to communicate with the user. +

            +

            + +
            Returns:
            The maven log.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MavenLogged.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MavenLogged.html new file mode 100644 index 00000000..0118ce65 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MavenLogged.html @@ -0,0 +1,275 @@ + + + + + + + +MavenLogged (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class MavenLogged

            +
            +java.lang.Object
+  extended by org.kiji.maven.plugins.hbase.MavenLogged
+
            +
            +
            All Implemented Interfaces:
            MavenLoggable
            +
            +
            +
            Direct Known Subclasses:
            MiniHBaseCluster
            +
            +
            +
            +
            public abstract class MavenLogged
            extends Object
            implements MavenLoggable
            + + +

            +An abstract base class for objects that write to the maven log. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected MavenLogged(org.apache.maven.plugin.logging.Log log) + +
            +          Constructor.
            +  + + + + + + + + + + + +
            +Method Summary
            + org.apache.maven.plugin.logging.LoggetLog() + +
            +          Provides access to the maven log used to communicate with the user.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MavenLogged

            +
            +protected MavenLogged(org.apache.maven.plugin.logging.Log log)
            +
            +
            Constructor. +

            +

            +
            Parameters:
            log - The maven log.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getLog

            +
            +public org.apache.maven.plugin.logging.Log getLog()
            +
            +
            Provides access to the maven log used to communicate with the user. +

            +

            +
            Specified by:
            getLog in interface MavenLoggable
            +
            +
            + +
            Returns:
            The maven log.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MiniHBaseCluster.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MiniHBaseCluster.html new file mode 100644 index 00000000..ee252858 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MiniHBaseCluster.html @@ -0,0 +1,397 @@ + + + + + + + +MiniHBaseCluster (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class MiniHBaseCluster

            +
            +java.lang.Object
+  extended by org.kiji.maven.plugins.hbase.MavenLogged
+      extended by org.kiji.maven.plugins.hbase.MiniHBaseCluster
+
            +
            +
            All Implemented Interfaces:
            MavenLoggable
            +
            +
            +
            +
            public class MiniHBaseCluster
            extends MavenLogged
            + + +

            +A in-process mini HBase cluster that may be started and stopped. +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            MiniHBaseCluster(org.apache.maven.plugin.logging.Log log, + boolean enableMapReduce, + org.apache.hadoop.conf.Configuration conf) + +
            +          Creates a new MiniHBaseCluster instance.
            MiniHBaseCluster(org.apache.maven.plugin.logging.Log log, + boolean enableMapReduce, + org.apache.hadoop.hbase.HBaseTestingUtility hbaseTestUtil) + +
            +          Creates a new MiniHBaseCluster instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static intfindOpenPort(int startPort) + +
            +          Find an available port.
            + org.apache.hadoop.conf.ConfigurationgetConfiguration() + +
            +          Provides access to the HBase cluster configuration.
            + booleanisRunning() + +
            +          Determine whether the cluster is running.
            + voidshutdown() + +
            +          Stops the cluster.
            + voidstartup() + +
            +          Starts the cluster.
            +  + + + + + + + +
            Methods inherited from class org.kiji.maven.plugins.hbase.MavenLogged
            getLog
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MiniHBaseCluster

            +
            +public MiniHBaseCluster(org.apache.maven.plugin.logging.Log log,
+                        boolean enableMapReduce,
+                        org.apache.hadoop.conf.Configuration conf)
            +
            +
            Creates a new MiniHBaseCluster instance. +

            +

            +
            Parameters:
            log - The maven log.
            enableMapReduce - Whether to also use a mini MapReduce cluster.
            conf - Hadoop configuration for the cluster.
            +
            +
            + +

            +MiniHBaseCluster

            +
            +public MiniHBaseCluster(org.apache.maven.plugin.logging.Log log,
+                        boolean enableMapReduce,
+                        org.apache.hadoop.hbase.HBaseTestingUtility hbaseTestUtil)
            +
            +
            Creates a new MiniHBaseCluster instance. +

            +

            +
            Parameters:
            log - The maven log.
            enableMapReduce - Whether to also use a mini MapReduce cluster.
            hbaseTestUtil - An HBase testing utility that can start and stop mini clusters.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getConfiguration

            +
            +public org.apache.hadoop.conf.Configuration getConfiguration()
            +
            +
            Provides access to the HBase cluster configuration. +

            +

            + +
            Returns:
            The cluster configuration.
            +
            +
            +
            + +

            +isRunning

            +
            +public boolean isRunning()
            +
            +
            Determine whether the cluster is running. +

            +

            + +
            Returns:
            Whether the cluster is running.
            +
            +
            +
            + +

            +startup

            +
            +public void startup()
+             throws Exception
            +
            +
            Starts the cluster. Blocks until ready. +

            +

            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +shutdown

            +
            +public void shutdown()
+              throws Exception
            +
            +
            Stops the cluster. Blocks until shut down. +

            +

            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +findOpenPort

            +
            +public static int findOpenPort(int startPort)
            +
            +
            Find an available port. +

            +

            +
            Parameters:
            startPort - the starting port to check. +
            Returns:
            an open port number. +
            Throws: +
            IllegalArgumentException - if it can't find an open port.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MiniHBaseClusterSingleton.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MiniHBaseClusterSingleton.html new file mode 100644 index 00000000..87707777 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MiniHBaseClusterSingleton.html @@ -0,0 +1,384 @@ + + + + + + + +MiniHBaseClusterSingleton (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Enum MiniHBaseClusterSingleton

            +
            +java.lang.Object
+  extended by java.lang.Enum<MiniHBaseClusterSingleton>
+      extended by org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<MiniHBaseClusterSingleton>
            +
            +
            +
            +
            public enum MiniHBaseClusterSingleton
            extends Enum<MiniHBaseClusterSingleton>
            + + +

            +A singleton instance of a mini HBase cluster. +

            + +

            +

            + +

            + + + + + + + + + + +
            +Enum Constant Summary
            INSTANCE + +
            +          The singleton instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.apache.hadoop.conf.ConfigurationgetClusterConfiguration() + +
            +          Provides access to the cluster configuration after it has started.
            + voidstartAndWaitUntilReady(org.apache.maven.plugin.logging.Log log, + boolean alsoStartMapReduce, + org.apache.hadoop.conf.Configuration conf) + +
            +          Starts the HBase cluster and blocks until it is ready.
            + voidstop(org.apache.maven.plugin.logging.Log log) + +
            +          Stops the HBase cluster and blocks until is has been shutdown completely.
            +static MiniHBaseClusterSingletonvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static MiniHBaseClusterSingleton[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +INSTANCE

            +
            +public static final MiniHBaseClusterSingleton INSTANCE
            +
            +
            The singleton instance. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static MiniHBaseClusterSingleton[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (MiniHBaseClusterSingleton c : MiniHBaseClusterSingleton.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static MiniHBaseClusterSingleton valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            +
            + +

            +startAndWaitUntilReady

            +
            +public void startAndWaitUntilReady(org.apache.maven.plugin.logging.Log log,
+                                   boolean alsoStartMapReduce,
+                                   org.apache.hadoop.conf.Configuration conf)
+                            throws IOException
            +
            +
            Starts the HBase cluster and blocks until it is ready. +

            +

            +
            Parameters:
            log - The maven log.
            alsoStartMapReduce - Whether to also start a mini MapReduce cluster.
            conf - Hadoop configuration for the cluster. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getClusterConfiguration

            +
            +public org.apache.hadoop.conf.Configuration getClusterConfiguration()
            +
            +
            Provides access to the cluster configuration after it has started. +

            +

            + +
            Returns:
            The configuration.
            +
            +
            +
            + +

            +stop

            +
            +public void stop(org.apache.maven.plugin.logging.Log log)
            +
            +
            Stops the HBase cluster and blocks until is has been shutdown completely. +

            +

            +
            Parameters:
            log - The maven log.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MiniHBaseClusterThread.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MiniHBaseClusterThread.html new file mode 100644 index 00000000..c94ca9af --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/MiniHBaseClusterThread.html @@ -0,0 +1,395 @@ + + + + + + + +MiniHBaseClusterThread (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class MiniHBaseClusterThread

            +
            +java.lang.Object
+  extended by java.lang.Thread
+      extended by org.kiji.maven.plugins.hbase.MiniHBaseClusterThread
+
            +
            +
            All Implemented Interfaces:
            Runnable, MavenLoggable
            +
            +
            +
            +
            public class MiniHBaseClusterThread
            extends Thread
            implements MavenLoggable
            + + +

            +A thread that starts and runs a mini HBase cluster. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class java.lang.Thread
            Thread.State, Thread.UncaughtExceptionHandler
            +  + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class java.lang.Thread
            MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
            +  + + + + + + + + + + +
            +Constructor Summary
            MiniHBaseClusterThread(org.apache.maven.plugin.logging.Log log, + MiniHBaseCluster hbaseCluster) + +
            +          Creates a new MiniHBaseClusterThread instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.apache.maven.plugin.logging.LoggetLog() + +
            +          Provides access to the maven log used to communicate with the user.
            + booleanisClusterReady() + +
            +          Determine whether the HBase cluster is up and running.
            + voidrun() + +
            +          Runs the mini HBase cluster.
            + voidstopClusterGracefully() + +
            +          Stops the HBase cluster gracefully.
            +  + + + + + + + +
            Methods inherited from class java.lang.Thread
            activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +MiniHBaseClusterThread

            +
            +public MiniHBaseClusterThread(org.apache.maven.plugin.logging.Log log,
+                              MiniHBaseCluster hbaseCluster)
            +
            +
            Creates a new MiniHBaseClusterThread instance. +

            +

            +
            Parameters:
            log - The maven log.
            hbaseCluster - The hbase cluster to run.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +isClusterReady

            +
            +public boolean isClusterReady()
            +
            +
            Determine whether the HBase cluster is up and running. +

            +

            +
            +
            +
            + +
            Returns:
            Whether the cluster has completed startup.
            +
            +
            +
            + +

            +stopClusterGracefully

            +
            +public void stopClusterGracefully()
            +
            +
            Stops the HBase cluster gracefully. When it is fully shut down, the thread will exit. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLog

            +
            +public org.apache.maven.plugin.logging.Log getLog()
            +
            +
            Description copied from interface: MavenLoggable
            +
            Provides access to the maven log used to communicate with the user. +

            +

            +
            Specified by:
            getLog in interface MavenLoggable
            +
            +
            + +
            Returns:
            The maven log.
            +
            +
            +
            + +

            +run

            +
            +public void run()
            +
            +
            Runs the mini HBase cluster. + +

            This method blocks until stopClusterGracefully() is called.

            +

            +

            +
            Specified by:
            run in interface Runnable
            Overrides:
            run in class Thread
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/StartMojo.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/StartMojo.html new file mode 100644 index 00000000..62e7545c --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/StartMojo.html @@ -0,0 +1,517 @@ + + + + + + + +StartMojo (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class StartMojo

            +
            +java.lang.Object
+  extended by org.apache.maven.plugin.AbstractMojo
+      extended by org.kiji.maven.plugins.hbase.StartMojo
+
            +
            +
            All Implemented Interfaces:
            org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
            +
            +
            +
            +
            public class StartMojo
            extends org.apache.maven.plugin.AbstractMojo
            + + +

            +A maven goal that starts a mini HBase cluster in a new daemon thread. + +

            A new daemon thread is created that starts a mini HBase cluster. The main thread + blocks until the HBase cluster has full started. The daemon thread with the + in-process HBase cluster will continue to run in the background until stopped by the + 'stop' goal of the plugin.

            + +

            The configuration of the started mini HBase cluster will be written to a + hbase-site.xml file in the test classpath ('${basedir}/target/test-classes' by + default). The path to the generated configuration file may be customized with the + 'hbaseSiteFile' property

            + +

            A configuration index can be written by this goal. The configuration index is a file that + contains one line for each configuration file written by this goal, where the line contains the + path to the configuration file. By default, the goal does not write a configuration index. + Setting the property 'writeConfIndex' to true will cause a configuration index to be written. + By default, the configuration index will be written to + '${basedir}/target/test-classes/conf-index.conf'. The path to the generated configuration index + can be customized by setting the 'hbaseConfIndex' property.

            +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from interface org.apache.maven.plugin.Mojo
            ROLE
            +  + + + + + + + + + + +
            +Constructor Summary
            StartMojo() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidexecute() + +
            +          Starts a mini HBase cluster in a new thread.
            + voidsetCoreSiteFile(File coreSiteFile) + +
            +          Sets the file that we should write the MapReduce/HDFS cluster configuration to.
            + voidsetHadoopConfiguration(Properties properties) + +
            +          Sets Hadoop configuration properties.
            + voidsetHbaseConfIndex(File hbaseConfIndex) + +
            +          Sets the file that the HBase configuration index should be written to.
            + voidsetHbaseSiteFile(File hbaseSiteFile) + +
            +          Sets the file that we should write the HBase cluster configuration to.
            + voidsetMapReduceEnabled(boolean enabled) + +
            +          Sets whether we should start a mini MapReduce cluster in addition to the HBase cluster.
            + voidsetSaveHadoopTmpDir(boolean saveTempDir) + +
            +          Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown.
            + voidsetSeparateConfigurationFiles(boolean separateConfigurationFiles) + +
            +          Sets whether separate core-site.xml and hbase-site.xml files + should be generated (otherwise they are combined into a single + hbase-site.xml file).
            + voidsetSkip(boolean skip) + +
            +          Sets whether this goal should be a no-op.
            + voidsetWriteConfIndex(boolean writeConfIndex) + +
            +          Sets whether this goal should write a configuration index file.
            +  + + + + + + + +
            Methods inherited from class org.apache.maven.plugin.AbstractMojo
            getLog, getPluginContext, setLog, setPluginContext
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +StartMojo

            +
            +public StartMojo()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setSkip

            +
            +public void setSkip(boolean skip)
            +
            +
            Sets whether this goal should be a no-op. +

            +

            +
            Parameters:
            skip - If true, this goal should do nothing.
            +
            +
            +
            + +

            +setSaveHadoopTmpDir

            +
            +public void setSaveHadoopTmpDir(boolean saveTempDir)
            +
            +
            Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +

            +

            +
            Parameters:
            saveTempDir - If true, the directory will be copied to the project build directory + before the cluster is shutdown.
            +
            +
            +
            + +

            +setHbaseSiteFile

            +
            +public void setHbaseSiteFile(File hbaseSiteFile)
            +
            +
            Sets the file that we should write the HBase cluster configuration to. + +

            Note: The property "hbaseSiteFile" defined in this mojo means this method must be + named setHbaseSiteFile instead of setHBaseSiteFile.

            +

            +

            +
            Parameters:
            hbaseSiteFile - The file we should write to.
            +
            +
            +
            + +

            +setSeparateConfigurationFiles

            +
            +public void setSeparateConfigurationFiles(boolean separateConfigurationFiles)
            +
            +
            Sets whether separate core-site.xml and hbase-site.xml files + should be generated (otherwise they are combined into a single + hbase-site.xml file). +

            +

            +
            Parameters:
            separateConfigurationFiles - Whether they should be separated.
            +
            +
            +
            + +

            +setCoreSiteFile

            +
            +public void setCoreSiteFile(File coreSiteFile)
            +
            +
            Sets the file that we should write the MapReduce/HDFS cluster configuration to. +

            +

            +
            Parameters:
            coreSiteFile - The file we should write to.
            +
            +
            +
            + +

            +setWriteConfIndex

            +
            +public void setWriteConfIndex(boolean writeConfIndex)
            +
            +
            Sets whether this goal should write a configuration index file. +

            +

            +
            Parameters:
            writeConfIndex - True if an index file should be written, false otherwise.
            +
            +
            +
            + +

            +setHbaseConfIndex

            +
            +public void setHbaseConfIndex(File hbaseConfIndex)
            +
            +
            Sets the file that the HBase configuration index should be written to. + +

            Note: The property "hbaseConfIndex" defined in this mojo means this method should be named + setHbaseConfIndex.

            +

            +

            +
            Parameters:
            hbaseConfIndex - The file we should write to.
            +
            +
            +
            + +

            +setMapReduceEnabled

            +
            +public void setMapReduceEnabled(boolean enabled)
            +
            +
            Sets whether we should start a mini MapReduce cluster in addition to the HBase cluster. +

            +

            +
            Parameters:
            enabled - Whether to start a mini MapReduce cluster.
            +
            +
            +
            + +

            +setHadoopConfiguration

            +
            +public void setHadoopConfiguration(Properties properties)
            +
            +
            Sets Hadoop configuration properties. +

            +

            +
            Parameters:
            properties - Hadoop configuration properties to use in the mini cluster.
            +
            +
            +
            + +

            +execute

            +
            +public void execute()
+             throws org.apache.maven.plugin.MojoExecutionException
            +
            +
            Starts a mini HBase cluster in a new thread. + +

            This method is called by the maven plugin framework to run the goal.

            +

            +

            + +
            Throws: +
            org.apache.maven.plugin.MojoExecutionException - If there is a fatal error during this goal's execution.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/StopMojo.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/StopMojo.html new file mode 100644 index 00000000..3e42922f --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/StopMojo.html @@ -0,0 +1,361 @@ + + + + + + + +StopMojo (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class StopMojo

            +
            +java.lang.Object
+  extended by org.apache.maven.plugin.AbstractMojo
+      extended by org.kiji.maven.plugins.hbase.StopMojo
+
            +
            +
            All Implemented Interfaces:
            org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
            +
            +
            +
            +
            public class StopMojo
            extends org.apache.maven.plugin.AbstractMojo
            + + +

            +A maven goal that stops the mini HBase cluster started by the 'start' goal. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from interface org.apache.maven.plugin.Mojo
            ROLE
            +  + + + + + + + + + + +
            +Constructor Summary
            StopMojo() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidexecute() + +
            +          
            + voidsetProjectBuildDir(String dir) + +
            +          Sets the output directory for the project's build.
            + voidsetSaveHadoopTmpDir(boolean saveTempDir) + +
            +          Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown.
            + voidsetSkip(boolean skip) + +
            +          Sets whether this goal should be a no-op.
            +  + + + + + + + +
            Methods inherited from class org.apache.maven.plugin.AbstractMojo
            getLog, getPluginContext, setLog, setPluginContext
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +StopMojo

            +
            +public StopMojo()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setProjectBuildDir

            +
            +public void setProjectBuildDir(String dir)
            +
            +
            Sets the output directory for the project's build. +

            +

            +
            Parameters:
            dir - The path to the output directory.
            +
            +
            +
            + +

            +setSkip

            +
            +public void setSkip(boolean skip)
            +
            +
            Sets whether this goal should be a no-op. +

            +

            +
            Parameters:
            skip - If true, this goal should do nothing.
            +
            +
            +
            + +

            +setSaveHadoopTmpDir

            +
            +public void setSaveHadoopTmpDir(boolean saveTempDir)
            +
            +
            Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +

            +

            +
            Parameters:
            saveTempDir - If true, the directory will be copied to the project build directory + before the cluster is shutdown.
            +
            +
            +
            + +

            +execute

            +
            +public void execute()
+             throws org.apache.maven.plugin.MojoExecutionException
            +
            +
            +

            +

            + +
            Throws: +
            org.apache.maven.plugin.MojoExecutionException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MavenLoggable.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MavenLoggable.html new file mode 100644 index 00000000..9ee9d093 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MavenLoggable.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Interface org.kiji.maven.plugins.hbase.MavenLoggable (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.maven.plugins.hbase.MavenLoggable

            +
            + + + + + + + + + +
            +Packages that use MavenLoggable
            org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster. 
            +  +

            + + + + + +
            +Uses of MavenLoggable in org.kiji.maven.plugins.hbase
            +  +

            + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.maven.plugins.hbase that implement MavenLoggable
            + classMavenLogged + +
            +          An abstract base class for objects that write to the maven log.
            + classMiniHBaseCluster + +
            +          A in-process mini HBase cluster that may be started and stopped.
            + classMiniHBaseClusterThread + +
            +          A thread that starts and runs a mini HBase cluster.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MavenLogged.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MavenLogged.html new file mode 100644 index 00000000..9236294e --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MavenLogged.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.MavenLogged (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.MavenLogged

            +
            + + + + + + + + + +
            +Packages that use MavenLogged
            org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster. 
            +  +

            + + + + + +
            +Uses of MavenLogged in org.kiji.maven.plugins.hbase
            +  +

            + + + + + + + + + +
            Subclasses of MavenLogged in org.kiji.maven.plugins.hbase
            + classMiniHBaseCluster + +
            +          A in-process mini HBase cluster that may be started and stopped.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MiniHBaseCluster.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MiniHBaseCluster.html new file mode 100644 index 00000000..e901b87e --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MiniHBaseCluster.html @@ -0,0 +1,180 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseCluster (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.MiniHBaseCluster

            +
            + + + + + + + + + +
            +Packages that use MiniHBaseCluster
            org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster. 
            +  +

            + + + + + +
            +Uses of MiniHBaseCluster in org.kiji.maven.plugins.hbase
            +  +

            + + + + + + + + +
            Constructors in org.kiji.maven.plugins.hbase with parameters of type MiniHBaseCluster
            MiniHBaseClusterThread(org.apache.maven.plugin.logging.Log log, + MiniHBaseCluster hbaseCluster) + +
            +          Creates a new MiniHBaseClusterThread instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterSingleton.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterSingleton.html new file mode 100644 index 00000000..1f15bb22 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterSingleton.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton

            +
            + + + + + + + + + +
            +Packages that use MiniHBaseClusterSingleton
            org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster. 
            +  +

            + + + + + +
            +Uses of MiniHBaseClusterSingleton in org.kiji.maven.plugins.hbase
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.maven.plugins.hbase that return MiniHBaseClusterSingleton
            +static MiniHBaseClusterSingletonMiniHBaseClusterSingleton.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static MiniHBaseClusterSingleton[]MiniHBaseClusterSingleton.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterThread.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterThread.html new file mode 100644 index 00000000..8264bba3 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterThread.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.MiniHBaseClusterThread

            +
            +No usage of org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/StartMojo.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/StartMojo.html new file mode 100644 index 00000000..8447fcde --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/StartMojo.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.StartMojo (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.StartMojo

            +
            +No usage of org.kiji.maven.plugins.hbase.StartMojo +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/StopMojo.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/StopMojo.html new file mode 100644 index 00000000..a8cfebea --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/class-use/StopMojo.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.StopMojo (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.StopMojo

            +
            +No usage of org.kiji.maven.plugins.hbase.StopMojo +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-frame.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-frame.html new file mode 100644 index 00000000..525f76e6 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-frame.html @@ -0,0 +1,63 @@ + + + + + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + +org.kiji.maven.plugins.hbase + + + + +
            +Interfaces  + +
            +MavenLoggable
            + + + + + + +
            +Classes  + +
            +MavenLogged +
            +MiniHBaseCluster +
            +MiniHBaseClusterThread +
            +StartMojo +
            +StopMojo
            + + + + + + +
            +Enums  + +
            +MiniHBaseClusterSingleton
            + + + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-summary.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-summary.html new file mode 100644 index 00000000..d2d31bc0 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-summary.html @@ -0,0 +1,217 @@ + + + + + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.maven.plugins.hbase +

            +A maven plugin that allows integration tests to run with a mini-hbase cluster. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            MavenLoggableInterface for objects that can write to the maven log.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            MavenLoggedAn abstract base class for objects that write to the maven log.
            MiniHBaseClusterA in-process mini HBase cluster that may be started and stopped.
            MiniHBaseClusterThreadA thread that starts and runs a mini HBase cluster.
            StartMojoA maven goal that starts a mini HBase cluster in a new daemon thread.
            StopMojoA maven goal that stops the mini HBase cluster started by the 'start' goal.
            +  + +

            + + + + + + + + + +
            +Enum Summary
            MiniHBaseClusterSingletonA singleton instance of a mini HBase cluster.
            +  + +

            +

            +Package org.kiji.maven.plugins.hbase Description +

            + +

            +A maven plugin that allows integration tests to run with a mini-hbase cluster. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-tree.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-tree.html new file mode 100644 index 00000000..8544927b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-tree.html @@ -0,0 +1,179 @@ + + + + + + + +org.kiji.maven.plugins.hbase Class Hierarchy (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.maven.plugins.hbase +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-use.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-use.html new file mode 100644 index 00000000..5c8781c4 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/org/kiji/maven/plugins/hbase/package-use.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Package org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.maven.plugins.hbase

            +
            + + + + + + + + + +
            +Packages that use org.kiji.maven.plugins.hbase
            org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster. 
            +  +

            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.maven.plugins.hbase used by org.kiji.maven.plugins.hbase
            MavenLoggable + +
            +          Interface for objects that can write to the maven log.
            MavenLogged + +
            +          An abstract base class for objects that write to the maven log.
            MiniHBaseCluster + +
            +          A in-process mini HBase cluster that may be started and stopped.
            MiniHBaseClusterSingleton + +
            +          A singleton instance of a mini HBase cluster.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/overview-frame.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/overview-frame.html new file mode 100644 index 00000000..a0465d1a --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/overview-frame.html @@ -0,0 +1,45 @@ + + + + + + + +Overview List (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + + + + +
            +
            + + + + + +
            All Classes +

            + +Packages +
            +org.apache.hadoop.hbase.util +
            +org.kiji.maven.plugins.hbase +
            +

            + +

            +  + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/overview-summary.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/overview-summary.html new file mode 100644 index 00000000..6b364afd --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/overview-summary.html @@ -0,0 +1,161 @@ + + + + + + + +Overview (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API +

            +
            + + + + + + + + + + + + + +
            +Packages
            org.apache.hadoop.hbase.util 
            org.kiji.maven.plugins.hbaseA maven plugin that allows integration tests to run with a mini-hbase cluster.
            + +

            + 

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/overview-tree.html b/apidocs/hbase-maven-plugin/1.0.11-cdh4/overview-tree.html new file mode 100644 index 00000000..482947ec --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/overview-tree.html @@ -0,0 +1,182 @@ + + + + + + + +Class Hierarchy (hbase-maven-plugin 1.0.11-cdh4-SNAPSHOT API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.apache.hadoop.hbase.util, org.kiji.maven.plugins.hbase
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/package-list b/apidocs/hbase-maven-plugin/1.0.11-cdh4/package-list new file mode 100644 index 00000000..740dabdf --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/package-list @@ -0,0 +1,2 @@ +org.apache.hadoop.hbase.util +org.kiji.maven.plugins.hbase diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/resources/inherit.gif b/apidocs/hbase-maven-plugin/1.0.11-cdh4/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.11-cdh4/resources/inherit.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.11-cdh4/stylesheet.css b/apidocs/hbase-maven-plugin/1.0.11-cdh4/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.11-cdh4/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/allclasses-frame.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/allclasses-frame.html new file mode 100644 index 00000000..8d22f841 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/allclasses-frame.html @@ -0,0 +1,44 @@ + + + + + + + +All Classes (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            MavenLoggable +
            +MavenLogged +
            +MiniHBaseCluster +
            +MiniHBaseClusterSingleton +
            +MiniHBaseClusterThread +
            +StartMojo +
            +StopMojo +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/allclasses-noframe.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/allclasses-noframe.html new file mode 100644 index 00000000..f01dafe4 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/allclasses-noframe.html @@ -0,0 +1,44 @@ + + + + + + + +All Classes (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            MavenLoggable +
            +MavenLogged +
            +MiniHBaseCluster +
            +MiniHBaseClusterSingleton +
            +MiniHBaseClusterThread +
            +StartMojo +
            +StopMojo +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/constant-values.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/constant-values.html new file mode 100644 index 00000000..8d33436e --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/constant-values.html @@ -0,0 +1,145 @@ + + + + + + + +Constant Field Values (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/deprecated-list.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/deprecated-list.html new file mode 100644 index 00000000..036cf5e2 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/help-doc.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/help-doc.html new file mode 100644 index 00000000..9c43b658 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/index-all.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/index-all.html new file mode 100644 index 00000000..a63b024f --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/index-all.html @@ -0,0 +1,296 @@ + + + + + + + +Index (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +E F G I M O R S V
            +

            +E

            +
            +
            execute() - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Starts a mini HBase cluster in a new thread. +
            execute() - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
            +
            +
            +

            +F

            +
            +
            findOpenPort(int) - +Static method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Find an available port. +
            +
            +

            +G

            +
            +
            getClusterConfiguration() - +Method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
            Provides access to the cluster configuration after it has started. +
            getConfiguration() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Provides access to the HBase cluster configuration. +
            getLog() - +Method in interface org.kiji.maven.plugins.hbase.MavenLoggable +
            Provides access to the maven log used to communicate with the user. +
            getLog() - +Method in class org.kiji.maven.plugins.hbase.MavenLogged +
            Provides access to the maven log used to communicate with the user. +
            getLog() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
              +
            +
            +

            +I

            +
            +
            isClusterReady() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
            Determine whether the HBase cluster is up and running. +
            isRunning() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Determine whether the cluster is running. +
            +
            +

            +M

            +
            +
            MavenLoggable - Interface in org.kiji.maven.plugins.hbase
            Interface for objects that can write to the maven log.
            MavenLogged - Class in org.kiji.maven.plugins.hbase
            An abstract base class for objects that write to the maven log.
            MavenLogged(Log) - +Constructor for class org.kiji.maven.plugins.hbase.MavenLogged +
            Constructor. +
            MiniHBaseCluster - Class in org.kiji.maven.plugins.hbase
            A in-process mini HBase cluster that may be started and stopped.
            MiniHBaseCluster(Log, boolean, Configuration) - +Constructor for class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Creates a new MiniHBaseCluster instance. +
            MiniHBaseCluster(Log, boolean, HBaseTestingUtility) - +Constructor for class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Creates a new MiniHBaseCluster instance. +
            MiniHBaseClusterSingleton - Enum in org.kiji.maven.plugins.hbase
            A singleton instance of a mini HBase cluster.
            MiniHBaseClusterThread - Class in org.kiji.maven.plugins.hbase
            A thread that starts and runs a mini HBase cluster.
            MiniHBaseClusterThread(Log, MiniHBaseCluster) - +Constructor for class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
            Creates a new MiniHBaseClusterThread instance. +
            +
            +

            +O

            +
            +
            org.kiji.maven.plugins.hbase - package org.kiji.maven.plugins.hbase
            A maven plugin that allows integration tests to run with a mini-hbase cluster.
            +
            +

            +R

            +
            +
            run() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
            Runs the mini HBase cluster. +
            +
            +

            +S

            +
            +
            setCoreSiteFile(File) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets the file that we should write the MapReduce/HDFS cluster configuration to. +
            setHadoopConfiguration(Properties) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets Hadoop configuration properties. +
            setHbaseConfIndex(File) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets the file that the HBase configuration index should be written to. +
            setHbaseSiteFile(File) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets the file that we should write the HBase cluster configuration to. +
            setMapReduceEnabled(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets whether we should start a mini MapReduce cluster in addition to the HBase cluster. +
            setProjectBuildDir(String) - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
            Sets the output directory for the project's build. +
            setSaveHadoopTmpDir(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +
            setSaveHadoopTmpDir(boolean) - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
            Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +
            setSeparateConfigurationFiles(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets whether separate core-site.xml and hbase-site.xml files + should be generated (otherwise they are combined into a single + hbase-site.xml file). +
            setSkip(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets whether this goal should be a no-op. +
            setSkip(boolean) - +Method in class org.kiji.maven.plugins.hbase.StopMojo +
            Sets whether this goal should be a no-op. +
            setWriteConfIndex(boolean) - +Method in class org.kiji.maven.plugins.hbase.StartMojo +
            Sets whether this goal should write a configuration index file. +
            shutdown() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Stops the cluster. +
            startAndWaitUntilReady(Log, boolean, Configuration) - +Method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
            Starts the HBase cluster and blocks until it is ready. +
            StartMojo - Class in org.kiji.maven.plugins.hbase
            A maven goal that starts a mini HBase cluster in a new daemon thread.
            StartMojo() - +Constructor for class org.kiji.maven.plugins.hbase.StartMojo +
              +
            startup() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseCluster +
            Starts the cluster. +
            stop(Log) - +Method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
            Stops the HBase cluster and blocks until is has been shutdown completely. +
            stopClusterGracefully() - +Method in class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +
            Stops the HBase cluster gracefully. +
            StopMojo - Class in org.kiji.maven.plugins.hbase
            A maven goal that stops the mini HBase cluster started by the 'start' goal.
            StopMojo() - +Constructor for class org.kiji.maven.plugins.hbase.StopMojo +
              +
            +
            +

            +V

            +
            +
            valueOf(String) - +Static method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
            Returns the enum constant of this type with the specified name. +
            values() - +Static method in enum org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            +
            +E F G I M O R S V + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/index.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/index.html new file mode 100644 index 00000000..c5e17fb3 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/index.html @@ -0,0 +1,37 @@ + + + + + + + +hbase-maven-plugin 1.0.9-cdh4 API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/maven/plugins/hbase/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLoggable.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLoggable.html new file mode 100644 index 00000000..51df626d --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLoggable.html @@ -0,0 +1,215 @@ + + + + + + + +MavenLoggable (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Interface MavenLoggable

            +
            +
            All Known Implementing Classes:
            MavenLogged, MiniHBaseCluster, MiniHBaseClusterThread
            +
            +
            +
            +
            public interface MavenLoggable
            + + +

            +Interface for objects that can write to the maven log. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + org.apache.maven.plugin.logging.LoggetLog() + +
            +          Provides access to the maven log used to communicate with the user.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getLog

            +
            +org.apache.maven.plugin.logging.Log getLog()
            +
            +
            Provides access to the maven log used to communicate with the user. +

            +

            + +
            Returns:
            The maven log.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLogged.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLogged.html new file mode 100644 index 00000000..2358e2ef --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MavenLogged.html @@ -0,0 +1,273 @@ + + + + + + + +MavenLogged (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class MavenLogged

            +
            +java.lang.Object
+  extended by org.kiji.maven.plugins.hbase.MavenLogged
+
            +
            +
            All Implemented Interfaces:
            MavenLoggable
            +
            +
            +
            Direct Known Subclasses:
            MiniHBaseCluster
            +
            +
            +
            +
            public abstract class MavenLogged
            extends Object
            implements MavenLoggable
            + + +

            +An abstract base class for objects that write to the maven log. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected MavenLogged(org.apache.maven.plugin.logging.Log log) + +
            +          Constructor.
            +  + + + + + + + + + + + +
            +Method Summary
            + org.apache.maven.plugin.logging.LoggetLog() + +
            +          Provides access to the maven log used to communicate with the user.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MavenLogged

            +
            +protected MavenLogged(org.apache.maven.plugin.logging.Log log)
            +
            +
            Constructor. +

            +

            +
            Parameters:
            log - The maven log.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getLog

            +
            +public org.apache.maven.plugin.logging.Log getLog()
            +
            +
            Provides access to the maven log used to communicate with the user. +

            +

            +
            Specified by:
            getLog in interface MavenLoggable
            +
            +
            + +
            Returns:
            The maven log.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseCluster.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseCluster.html new file mode 100644 index 00000000..466151c9 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseCluster.html @@ -0,0 +1,395 @@ + + + + + + + +MiniHBaseCluster (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class MiniHBaseCluster

            +
            +java.lang.Object
+  extended by org.kiji.maven.plugins.hbase.MavenLogged
+      extended by org.kiji.maven.plugins.hbase.MiniHBaseCluster
+
            +
            +
            All Implemented Interfaces:
            MavenLoggable
            +
            +
            +
            +
            public class MiniHBaseCluster
            extends MavenLogged
            + + +

            +A in-process mini HBase cluster that may be started and stopped. +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            MiniHBaseCluster(org.apache.maven.plugin.logging.Log log, + boolean enableMapReduce, + org.apache.hadoop.conf.Configuration conf) + +
            +          Creates a new MiniHBaseCluster instance.
            MiniHBaseCluster(org.apache.maven.plugin.logging.Log log, + boolean enableMapReduce, + org.apache.hadoop.hbase.HBaseTestingUtility hbaseTestUtil) + +
            +          Creates a new MiniHBaseCluster instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static intfindOpenPort(int startPort) + +
            +          Find an available port.
            + org.apache.hadoop.conf.ConfigurationgetConfiguration() + +
            +          Provides access to the HBase cluster configuration.
            + booleanisRunning() + +
            +          Determine whether the cluster is running.
            + voidshutdown() + +
            +          Stops the cluster.
            + voidstartup() + +
            +          Starts the cluster.
            +  + + + + + + + +
            Methods inherited from class org.kiji.maven.plugins.hbase.MavenLogged
            getLog
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MiniHBaseCluster

            +
            +public MiniHBaseCluster(org.apache.maven.plugin.logging.Log log,
+                        boolean enableMapReduce,
+                        org.apache.hadoop.conf.Configuration conf)
            +
            +
            Creates a new MiniHBaseCluster instance. +

            +

            +
            Parameters:
            log - The maven log.
            enableMapReduce - Whether to also use a mini MapReduce cluster.
            conf - Hadoop configuration for the cluster.
            +
            +
            + +

            +MiniHBaseCluster

            +
            +public MiniHBaseCluster(org.apache.maven.plugin.logging.Log log,
+                        boolean enableMapReduce,
+                        org.apache.hadoop.hbase.HBaseTestingUtility hbaseTestUtil)
            +
            +
            Creates a new MiniHBaseCluster instance. +

            +

            +
            Parameters:
            log - The maven log.
            enableMapReduce - Whether to also use a mini MapReduce cluster.
            hbaseTestUtil - An HBase testing utility that can start and stop mini clusters.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getConfiguration

            +
            +public org.apache.hadoop.conf.Configuration getConfiguration()
            +
            +
            Provides access to the HBase cluster configuration. +

            +

            + +
            Returns:
            The cluster configuration.
            +
            +
            +
            + +

            +isRunning

            +
            +public boolean isRunning()
            +
            +
            Determine whether the cluster is running. +

            +

            + +
            Returns:
            Whether the cluster is running.
            +
            +
            +
            + +

            +startup

            +
            +public void startup()
+             throws Exception
            +
            +
            Starts the cluster. Blocks until ready. +

            +

            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +shutdown

            +
            +public void shutdown()
+              throws Exception
            +
            +
            Stops the cluster. Blocks until shut down. +

            +

            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +findOpenPort

            +
            +public static int findOpenPort(int startPort)
            +
            +
            Find an available port. +

            +

            +
            Parameters:
            startPort - the starting port to check. +
            Returns:
            an open port number. +
            Throws: +
            IllegalArgumentException - if it can't find an open port.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterSingleton.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterSingleton.html new file mode 100644 index 00000000..cdcad3fa --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterSingleton.html @@ -0,0 +1,382 @@ + + + + + + + +MiniHBaseClusterSingleton (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Enum MiniHBaseClusterSingleton

            +
            +java.lang.Object
+  extended by java.lang.Enum<MiniHBaseClusterSingleton>
+      extended by org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<MiniHBaseClusterSingleton>
            +
            +
            +
            +
            public enum MiniHBaseClusterSingleton
            extends Enum<MiniHBaseClusterSingleton>
            + + +

            +A singleton instance of a mini HBase cluster. +

            + +

            +

            + +

            + + + + + + + + + + +
            +Enum Constant Summary
            INSTANCE + +
            +          The singleton instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.apache.hadoop.conf.ConfigurationgetClusterConfiguration() + +
            +          Provides access to the cluster configuration after it has started.
            + voidstartAndWaitUntilReady(org.apache.maven.plugin.logging.Log log, + boolean alsoStartMapReduce, + org.apache.hadoop.conf.Configuration conf) + +
            +          Starts the HBase cluster and blocks until it is ready.
            + voidstop(org.apache.maven.plugin.logging.Log log) + +
            +          Stops the HBase cluster and blocks until is has been shutdown completely.
            +static MiniHBaseClusterSingletonvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static MiniHBaseClusterSingleton[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +INSTANCE

            +
            +public static final MiniHBaseClusterSingleton INSTANCE
            +
            +
            The singleton instance. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static MiniHBaseClusterSingleton[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (MiniHBaseClusterSingleton c : MiniHBaseClusterSingleton.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static MiniHBaseClusterSingleton valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            +
            + +

            +startAndWaitUntilReady

            +
            +public void startAndWaitUntilReady(org.apache.maven.plugin.logging.Log log,
+                                   boolean alsoStartMapReduce,
+                                   org.apache.hadoop.conf.Configuration conf)
+                            throws IOException
            +
            +
            Starts the HBase cluster and blocks until it is ready. +

            +

            +
            Parameters:
            log - The maven log.
            alsoStartMapReduce - Whether to also start a mini MapReduce cluster.
            conf - Hadoop configuration for the cluster. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getClusterConfiguration

            +
            +public org.apache.hadoop.conf.Configuration getClusterConfiguration()
            +
            +
            Provides access to the cluster configuration after it has started. +

            +

            + +
            Returns:
            The configuration.
            +
            +
            +
            + +

            +stop

            +
            +public void stop(org.apache.maven.plugin.logging.Log log)
            +
            +
            Stops the HBase cluster and blocks until is has been shutdown completely. +

            +

            +
            Parameters:
            log - The maven log.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterThread.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterThread.html new file mode 100644 index 00000000..fdb8b1af --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/MiniHBaseClusterThread.html @@ -0,0 +1,393 @@ + + + + + + + +MiniHBaseClusterThread (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class MiniHBaseClusterThread

            +
            +java.lang.Object
+  extended by java.lang.Thread
+      extended by org.kiji.maven.plugins.hbase.MiniHBaseClusterThread
+
            +
            +
            All Implemented Interfaces:
            Runnable, MavenLoggable
            +
            +
            +
            +
            public class MiniHBaseClusterThread
            extends Thread
            implements MavenLoggable
            + + +

            +A thread that starts and runs a mini HBase cluster. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class java.lang.Thread
            Thread.State, Thread.UncaughtExceptionHandler
            +  + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class java.lang.Thread
            MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY
            +  + + + + + + + + + + +
            +Constructor Summary
            MiniHBaseClusterThread(org.apache.maven.plugin.logging.Log log, + MiniHBaseCluster hbaseCluster) + +
            +          Creates a new MiniHBaseClusterThread instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.apache.maven.plugin.logging.LoggetLog() + +
            +          Provides access to the maven log used to communicate with the user.
            + booleanisClusterReady() + +
            +          Determine whether the HBase cluster is up and running.
            + voidrun() + +
            +          Runs the mini HBase cluster.
            + voidstopClusterGracefully() + +
            +          Stops the HBase cluster gracefully.
            +  + + + + + + + +
            Methods inherited from class java.lang.Thread
            activeCount, checkAccess, clone, countStackFrames, currentThread, destroy, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, stop, suspend, toString, yield
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +MiniHBaseClusterThread

            +
            +public MiniHBaseClusterThread(org.apache.maven.plugin.logging.Log log,
+                              MiniHBaseCluster hbaseCluster)
            +
            +
            Creates a new MiniHBaseClusterThread instance. +

            +

            +
            Parameters:
            log - The maven log.
            hbaseCluster - The hbase cluster to run.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +isClusterReady

            +
            +public boolean isClusterReady()
            +
            +
            Determine whether the HBase cluster is up and running. +

            +

            +
            +
            +
            + +
            Returns:
            Whether the cluster has completed startup.
            +
            +
            +
            + +

            +stopClusterGracefully

            +
            +public void stopClusterGracefully()
            +
            +
            Stops the HBase cluster gracefully. When it is fully shut down, the thread will exit. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLog

            +
            +public org.apache.maven.plugin.logging.Log getLog()
            +
            +
            Description copied from interface: MavenLoggable
            +
            Provides access to the maven log used to communicate with the user. +

            +

            +
            Specified by:
            getLog in interface MavenLoggable
            +
            +
            + +
            Returns:
            The maven log.
            +
            +
            +
            + +

            +run

            +
            +public void run()
            +
            +
            Runs the mini HBase cluster. + +

            This method blocks until stopClusterGracefully() is called.

            +

            +

            +
            Specified by:
            run in interface Runnable
            Overrides:
            run in class Thread
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/StartMojo.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/StartMojo.html new file mode 100644 index 00000000..dc5d82f2 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/StartMojo.html @@ -0,0 +1,515 @@ + + + + + + + +StartMojo (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class StartMojo

            +
            +java.lang.Object
+  extended by org.apache.maven.plugin.AbstractMojo
+      extended by org.kiji.maven.plugins.hbase.StartMojo
+
            +
            +
            All Implemented Interfaces:
            org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
            +
            +
            +
            +
            public class StartMojo
            extends org.apache.maven.plugin.AbstractMojo
            + + +

            +A maven goal that starts a mini HBase cluster in a new daemon thread. + +

            A new daemon thread is created that starts a mini HBase cluster. The main thread + blocks until the HBase cluster has full started. The daemon thread with the + in-process HBase cluster will continue to run in the background until stopped by the + 'stop' goal of the plugin.

            + +

            The configuration of the started mini HBase cluster will be written to a + hbase-site.xml file in the test classpath ('${basedir}/target/test-classes' by + default). The path to the generated configuration file may be customized with the + 'hbaseSiteFile' property

            + +

            A configuration index can be written by this goal. The configuration index is a file that + contains one line for each configuration file written by this goal, where the line contains the + path to the configuration file. By default, the goal does not write a configuration index. + Setting the property 'writeConfIndex' to true will cause a configuration index to be written. + By default, the configuration index will be written to + '${basedir}/target/test-classes/conf-index.conf'. The path to the generated configuration index + can be customized by setting the 'hbaseConfIndex' property.

            +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from interface org.apache.maven.plugin.Mojo
            ROLE
            +  + + + + + + + + + + +
            +Constructor Summary
            StartMojo() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidexecute() + +
            +          Starts a mini HBase cluster in a new thread.
            + voidsetCoreSiteFile(File coreSiteFile) + +
            +          Sets the file that we should write the MapReduce/HDFS cluster configuration to.
            + voidsetHadoopConfiguration(Properties properties) + +
            +          Sets Hadoop configuration properties.
            + voidsetHbaseConfIndex(File hbaseConfIndex) + +
            +          Sets the file that the HBase configuration index should be written to.
            + voidsetHbaseSiteFile(File hbaseSiteFile) + +
            +          Sets the file that we should write the HBase cluster configuration to.
            + voidsetMapReduceEnabled(boolean enabled) + +
            +          Sets whether we should start a mini MapReduce cluster in addition to the HBase cluster.
            + voidsetSaveHadoopTmpDir(boolean saveTempDir) + +
            +          Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown.
            + voidsetSeparateConfigurationFiles(boolean separateConfigurationFiles) + +
            +          Sets whether separate core-site.xml and hbase-site.xml files + should be generated (otherwise they are combined into a single + hbase-site.xml file).
            + voidsetSkip(boolean skip) + +
            +          Sets whether this goal should be a no-op.
            + voidsetWriteConfIndex(boolean writeConfIndex) + +
            +          Sets whether this goal should write a configuration index file.
            +  + + + + + + + +
            Methods inherited from class org.apache.maven.plugin.AbstractMojo
            getLog, getPluginContext, setLog, setPluginContext
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +StartMojo

            +
            +public StartMojo()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setSkip

            +
            +public void setSkip(boolean skip)
            +
            +
            Sets whether this goal should be a no-op. +

            +

            +
            Parameters:
            skip - If true, this goal should do nothing.
            +
            +
            +
            + +

            +setSaveHadoopTmpDir

            +
            +public void setSaveHadoopTmpDir(boolean saveTempDir)
            +
            +
            Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +

            +

            +
            Parameters:
            saveTempDir - If true, the directory will be copied to the project build directory + before the cluster is shutdown.
            +
            +
            +
            + +

            +setHbaseSiteFile

            +
            +public void setHbaseSiteFile(File hbaseSiteFile)
            +
            +
            Sets the file that we should write the HBase cluster configuration to. + +

            Note: The property "hbaseSiteFile" defined in this mojo means this method must be + named setHbaseSiteFile instead of setHBaseSiteFile.

            +

            +

            +
            Parameters:
            hbaseSiteFile - The file we should write to.
            +
            +
            +
            + +

            +setSeparateConfigurationFiles

            +
            +public void setSeparateConfigurationFiles(boolean separateConfigurationFiles)
            +
            +
            Sets whether separate core-site.xml and hbase-site.xml files + should be generated (otherwise they are combined into a single + hbase-site.xml file). +

            +

            +
            Parameters:
            separateConfigurationFiles - Whether they should be separated.
            +
            +
            +
            + +

            +setCoreSiteFile

            +
            +public void setCoreSiteFile(File coreSiteFile)
            +
            +
            Sets the file that we should write the MapReduce/HDFS cluster configuration to. +

            +

            +
            Parameters:
            coreSiteFile - The file we should write to.
            +
            +
            +
            + +

            +setWriteConfIndex

            +
            +public void setWriteConfIndex(boolean writeConfIndex)
            +
            +
            Sets whether this goal should write a configuration index file. +

            +

            +
            Parameters:
            writeConfIndex - True if an index file should be written, false otherwise.
            +
            +
            +
            + +

            +setHbaseConfIndex

            +
            +public void setHbaseConfIndex(File hbaseConfIndex)
            +
            +
            Sets the file that the HBase configuration index should be written to. + +

            Note: The property "hbaseConfIndex" defined in this mojo means this method should be named + setHbaseConfIndex.

            +

            +

            +
            Parameters:
            hbaseConfIndex - The file we should write to.
            +
            +
            +
            + +

            +setMapReduceEnabled

            +
            +public void setMapReduceEnabled(boolean enabled)
            +
            +
            Sets whether we should start a mini MapReduce cluster in addition to the HBase cluster. +

            +

            +
            Parameters:
            enabled - Whether to start a mini MapReduce cluster.
            +
            +
            +
            + +

            +setHadoopConfiguration

            +
            +public void setHadoopConfiguration(Properties properties)
            +
            +
            Sets Hadoop configuration properties. +

            +

            +
            Parameters:
            properties - Hadoop configuration properties to use in the mini cluster.
            +
            +
            +
            + +

            +execute

            +
            +public void execute()
+             throws org.apache.maven.plugin.MojoExecutionException
            +
            +
            Starts a mini HBase cluster in a new thread. + +

            This method is called by the maven plugin framework to run the goal.

            +

            +

            + +
            Throws: +
            org.apache.maven.plugin.MojoExecutionException - If there is a fatal error during this goal's execution.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/StopMojo.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/StopMojo.html new file mode 100644 index 00000000..364348e3 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/StopMojo.html @@ -0,0 +1,359 @@ + + + + + + + +StopMojo (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class StopMojo

            +
            +java.lang.Object
+  extended by org.apache.maven.plugin.AbstractMojo
+      extended by org.kiji.maven.plugins.hbase.StopMojo
+
            +
            +
            All Implemented Interfaces:
            org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo
            +
            +
            +
            +
            public class StopMojo
            extends org.apache.maven.plugin.AbstractMojo
            + + +

            +A maven goal that stops the mini HBase cluster started by the 'start' goal. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from interface org.apache.maven.plugin.Mojo
            ROLE
            +  + + + + + + + + + + +
            +Constructor Summary
            StopMojo() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidexecute() + +
            +          
            + voidsetProjectBuildDir(String dir) + +
            +          Sets the output directory for the project's build.
            + voidsetSaveHadoopTmpDir(boolean saveTempDir) + +
            +          Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown.
            + voidsetSkip(boolean skip) + +
            +          Sets whether this goal should be a no-op.
            +  + + + + + + + +
            Methods inherited from class org.apache.maven.plugin.AbstractMojo
            getLog, getPluginContext, setLog, setPluginContext
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +StopMojo

            +
            +public StopMojo()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setProjectBuildDir

            +
            +public void setProjectBuildDir(String dir)
            +
            +
            Sets the output directory for the project's build. +

            +

            +
            Parameters:
            dir - The path to the output directory.
            +
            +
            +
            + +

            +setSkip

            +
            +public void setSkip(boolean skip)
            +
            +
            Sets whether this goal should be a no-op. +

            +

            +
            Parameters:
            skip - If true, this goal should do nothing.
            +
            +
            +
            + +

            +setSaveHadoopTmpDir

            +
            +public void setSaveHadoopTmpDir(boolean saveTempDir)
            +
            +
            Sets whether the Hadoop temporary directory, given by hadoop.tmp.dir, should be cleared + before the cluster is started and copied to the project build directory before the cluster + is shutdown. +

            +

            +
            Parameters:
            saveTempDir - If true, the directory will be copied to the project build directory + before the cluster is shutdown.
            +
            +
            +
            + +

            +execute

            +
            +public void execute()
+             throws org.apache.maven.plugin.MojoExecutionException
            +
            +
            +

            +

            + +
            Throws: +
            org.apache.maven.plugin.MojoExecutionException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLoggable.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLoggable.html new file mode 100644 index 00000000..4c42dc06 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLoggable.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Interface org.kiji.maven.plugins.hbase.MavenLoggable (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.maven.plugins.hbase.MavenLoggable

            +
            + + + + + +
            +Uses of MavenLoggable in org.kiji.maven.plugins.hbase
            +  +

            + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.maven.plugins.hbase that implement MavenLoggable
            + classMavenLogged + +
            +          An abstract base class for objects that write to the maven log.
            + classMiniHBaseCluster + +
            +          A in-process mini HBase cluster that may be started and stopped.
            + classMiniHBaseClusterThread + +
            +          A thread that starts and runs a mini HBase cluster.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLogged.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLogged.html new file mode 100644 index 00000000..9993d5b5 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MavenLogged.html @@ -0,0 +1,166 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.MavenLogged (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.MavenLogged

            +
            + + + + + +
            +Uses of MavenLogged in org.kiji.maven.plugins.hbase
            +  +

            + + + + + + + + + +
            Subclasses of MavenLogged in org.kiji.maven.plugins.hbase
            + classMiniHBaseCluster + +
            +          A in-process mini HBase cluster that may be started and stopped.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseCluster.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseCluster.html new file mode 100644 index 00000000..82cf13f0 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseCluster.html @@ -0,0 +1,165 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseCluster (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.MiniHBaseCluster

            +
            + + + + + +
            +Uses of MiniHBaseCluster in org.kiji.maven.plugins.hbase
            +  +

            + + + + + + + + +
            Constructors in org.kiji.maven.plugins.hbase with parameters of type MiniHBaseCluster
            MiniHBaseClusterThread(org.apache.maven.plugin.logging.Log log, + MiniHBaseCluster hbaseCluster) + +
            +          Creates a new MiniHBaseClusterThread instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterSingleton.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterSingleton.html new file mode 100644 index 00000000..33952e6b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterSingleton.html @@ -0,0 +1,175 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.MiniHBaseClusterSingleton

            +
            + + + + + +
            +Uses of MiniHBaseClusterSingleton in org.kiji.maven.plugins.hbase
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.maven.plugins.hbase that return MiniHBaseClusterSingleton
            +static MiniHBaseClusterSingletonMiniHBaseClusterSingleton.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static MiniHBaseClusterSingleton[]MiniHBaseClusterSingleton.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterThread.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterThread.html new file mode 100644 index 00000000..0f7a00fd --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/MiniHBaseClusterThread.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.MiniHBaseClusterThread (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.MiniHBaseClusterThread

            +
            +No usage of org.kiji.maven.plugins.hbase.MiniHBaseClusterThread +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StartMojo.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StartMojo.html new file mode 100644 index 00000000..8479261a --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StartMojo.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.StartMojo (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.StartMojo

            +
            +No usage of org.kiji.maven.plugins.hbase.StartMojo +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StopMojo.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StopMojo.html new file mode 100644 index 00000000..911c4d6f --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/class-use/StopMojo.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.StopMojo (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.StopMojo

            +
            +No usage of org.kiji.maven.plugins.hbase.StopMojo +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-frame.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-frame.html new file mode 100644 index 00000000..119ad738 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-frame.html @@ -0,0 +1,63 @@ + + + + + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + +org.kiji.maven.plugins.hbase + + + + +
            +Interfaces  + +
            +MavenLoggable
            + + + + + + +
            +Classes  + +
            +MavenLogged +
            +MiniHBaseCluster +
            +MiniHBaseClusterThread +
            +StartMojo +
            +StopMojo
            + + + + + + +
            +Enums  + +
            +MiniHBaseClusterSingleton
            + + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-summary.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-summary.html new file mode 100644 index 00000000..29ee4bcd --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-summary.html @@ -0,0 +1,215 @@ + + + + + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.maven.plugins.hbase +

            +A maven plugin that allows integration tests to run with a mini-hbase cluster. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            MavenLoggableInterface for objects that can write to the maven log.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            MavenLoggedAn abstract base class for objects that write to the maven log.
            MiniHBaseClusterA in-process mini HBase cluster that may be started and stopped.
            MiniHBaseClusterThreadA thread that starts and runs a mini HBase cluster.
            StartMojoA maven goal that starts a mini HBase cluster in a new daemon thread.
            StopMojoA maven goal that stops the mini HBase cluster started by the 'start' goal.
            +  + +

            + + + + + + + + + +
            +Enum Summary
            MiniHBaseClusterSingletonA singleton instance of a mini HBase cluster.
            +  + +

            +

            +Package org.kiji.maven.plugins.hbase Description +

            + +

            +A maven plugin that allows integration tests to run with a mini-hbase cluster. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-tree.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-tree.html new file mode 100644 index 00000000..7891d742 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-tree.html @@ -0,0 +1,174 @@ + + + + + + + +org.kiji.maven.plugins.hbase Class Hierarchy (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.maven.plugins.hbase +

            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-use.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-use.html new file mode 100644 index 00000000..3092effe --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/org/kiji/maven/plugins/hbase/package-use.html @@ -0,0 +1,174 @@ + + + + + + + +Uses of Package org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.maven.plugins.hbase

            +
            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.maven.plugins.hbase used by org.kiji.maven.plugins.hbase
            MavenLoggable + +
            +          Interface for objects that can write to the maven log.
            MavenLogged + +
            +          An abstract base class for objects that write to the maven log.
            MiniHBaseCluster + +
            +          A in-process mini HBase cluster that may be started and stopped.
            MiniHBaseClusterSingleton + +
            +          A singleton instance of a mini HBase cluster.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/overview-tree.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/overview-tree.html new file mode 100644 index 00000000..9ef62cb1 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/overview-tree.html @@ -0,0 +1,176 @@ + + + + + + + +Class Hierarchy (hbase-maven-plugin 1.0.9-cdh4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.kiji.maven.plugins.hbase
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/package-list b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/package-list new file mode 100644 index 00000000..fff7c709 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/package-list @@ -0,0 +1 @@ +org.kiji.maven.plugins.hbase diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/resources/inherit.gif b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/resources/inherit.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/stylesheet.css b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/apidocs/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/maven-base.css b/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/maven-base.css new file mode 100644 index 00000000..780cbb35 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/maven-base.css @@ -0,0 +1,155 @@ +body { + margin: 0px; + padding: 0px; +} +img { + border:none; +} +table { + padding:0px; + width: 100%; + margin-left: -2px; + margin-right: -2px; +} +acronym { + cursor: help; + border-bottom: 1px dotted #feb; +} +table.bodyTable th, table.bodyTable td { + padding: 2px 4px 2px 4px; + vertical-align: top; +} +div.clear{ + clear:both; + visibility: hidden; +} +div.clear hr{ + display: none; +} +#bannerLeft, #bannerRight { + font-size: xx-large; + font-weight: bold; +} +#bannerLeft img, #bannerRight img { + margin: 0px; +} +.xleft, #bannerLeft img { + float:left; +} +.xright, #bannerRight { + float:right; +} +#banner { + padding: 0px; +} +#banner img { + border: none; +} +#breadcrumbs { + padding: 3px 10px 3px 10px; +} +#leftColumn { + width: 170px; + float:left; + overflow: auto; +} +#bodyColumn { + margin-right: 1.5em; + margin-left: 197px; +} +#legend { + padding: 8px 0 8px 0; +} +#navcolumn { + padding: 8px 4px 0 8px; +} +#navcolumn h5 { + margin: 0; + padding: 0; + font-size: small; +} +#navcolumn ul { + margin: 0; + padding: 0; + font-size: small; +} +#navcolumn li { + list-style-type: none; + background-image: none; + background-repeat: no-repeat; + background-position: 0 0.4em; + padding-left: 16px; + list-style-position: outside; + line-height: 1.2em; + font-size: smaller; +} +#navcolumn li.expanded { + background-image: url(../images/expanded.gif); +} +#navcolumn li.collapsed { + background-image: url(../images/collapsed.gif); +} +#navcolumn li.none { + text-indent: -1em; + margin-left: 1em; +} +#poweredBy { + text-align: center; +} +#navcolumn img { + margin-top: 10px; + margin-bottom: 3px; +} +#poweredBy img { + display:block; + margin: 20px 0 20px 17px; +} +#search img { + margin: 0px; + display: block; +} +#search #q, #search #btnG { + border: 1px solid #999; + margin-bottom:10px; +} +#search form { + margin: 0px; +} +#lastPublished { + font-size: x-small; +} +.navSection { + margin-bottom: 2px; + padding: 8px; +} +.navSectionHead { + font-weight: bold; + font-size: x-small; +} +.section { + padding: 4px; +} +#footer { + padding: 3px 10px 3px 10px; + font-size: x-small; +} +#breadcrumbs { + font-size: x-small; + margin: 0pt; +} +.source { + padding: 12px; + margin: 1em 7px 1em 7px; +} +.source pre { + margin: 0px; + padding: 0px; +} +#navcolumn img.imageLink, .imageLink { + padding-left: 0px; + padding-bottom: 0px; + padding-top: 0px; + padding-right: 2px; + border: 0px; + margin: 0px; +} diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/maven-theme.css b/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/maven-theme.css new file mode 100644 index 00000000..c982168b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/maven-theme.css @@ -0,0 +1,141 @@ +body { + padding: 0px 0px 10px 0px; +} +body, td, select, input, li{ + font-family: Verdana, Helvetica, Arial, sans-serif; + font-size: 13px; +} +code{ + font-family: Courier, monospace; + font-size: 13px; +} +a { + text-decoration: none; +} +a:link { + color:#36a; +} +a:visited { + color:#47a; +} +a:active, a:hover { + color:#69c; +} +#legend li.externalLink { + background: url(../images/external.png) left top no-repeat; + padding-left: 18px; +} +a.externalLink, a.externalLink:link, a.externalLink:visited, a.externalLink:active, a.externalLink:hover { + background: url(../images/external.png) right center no-repeat; + padding-right: 18px; +} +#legend li.newWindow { + background: url(../images/newwindow.png) left top no-repeat; + padding-left: 18px; +} +a.newWindow, a.newWindow:link, a.newWindow:visited, a.newWindow:active, a.newWindow:hover { + background: url(../images/newwindow.png) right center no-repeat; + padding-right: 18px; +} +h2 { + padding: 4px 4px 4px 6px; + border: 1px solid #999; + color: #900; + background-color: #ddd; + font-weight:900; + font-size: x-large; +} +h3 { + padding: 4px 4px 4px 6px; + border: 1px solid #aaa; + color: #900; + background-color: #eee; + font-weight: normal; + font-size: large; +} +h4 { + padding: 4px 4px 4px 6px; + border: 1px solid #bbb; + color: #900; + background-color: #fff; + font-weight: normal; + font-size: large; +} +h5 { + padding: 4px 4px 4px 6px; + color: #900; + font-size: normal; +} +p { + line-height: 1.3em; + font-size: small; +} +#breadcrumbs { + border-top: 1px solid #aaa; + border-bottom: 1px solid #aaa; + background-color: #ccc; +} +#leftColumn { + margin: 10px 0 0 5px; + border: 1px solid #999; + background-color: #eee; +} +#navcolumn h5 { + font-size: smaller; + border-bottom: 1px solid #aaaaaa; + padding-top: 2px; + color: #000; +} + +table.bodyTable th { + color: white; + background-color: #bbb; + text-align: left; + font-weight: bold; +} + +table.bodyTable th, table.bodyTable td { + font-size: 1em; +} + +table.bodyTable tr.a { + background-color: #ddd; +} + +table.bodyTable tr.b { + background-color: #eee; +} + +.source { + border: 1px solid #999; +} +dl { + padding: 4px 4px 4px 6px; + border: 1px solid #aaa; + background-color: #ffc; +} +dt { + color: #900; +} +#organizationLogo img, #projectLogo img, #projectLogo span{ + margin: 8px; +} +#banner { + border-bottom: 1px solid #fff; +} +.errormark, .warningmark, .donemark, .infomark { + background: url(../images/icon_error_sml.gif) no-repeat; +} + +.warningmark { + background-image: url(../images/icon_warning_sml.gif); +} + +.donemark { + background-image: url(../images/icon_success_sml.gif); +} + +.infomark { + background-image: url(../images/icon_info_sml.gif); +} + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/print.css b/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/print.css new file mode 100644 index 00000000..26ad7f0b --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/print.css @@ -0,0 +1,7 @@ +#banner, #footer, #leftcol, #breadcrumbs, .docs #toc, .docs .courtesylinks, #leftColumn, #navColumn { + display: none !important; +} +#bodyColumn, body.docs div.docs { + margin: 0 !important; + border: none !important +} diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/site.css b/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/site.css new file mode 100644 index 00000000..055e7e28 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/css/site.css @@ -0,0 +1 @@ +/* You can override this file with your own styles */ \ No newline at end of file diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/findbugs.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/findbugs.html new file mode 100644 index 00000000..316bbb05 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/findbugs.html @@ -0,0 +1,106 @@ + + + + + + hbase-maven-plugin - FindBugs Bug Detector Report + + + + + + + + + +
            + +
            +
            +
            +

            FindBugs Bug Detector Report

            The following document contains the results of FindBugs Report

            FindBugs Version is 1.3.9

            Threshold is low

            Effort is max

            Summary

            ClassesBugsErrorsMissing Classes
            7001

            Files

            ClassBugs
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/collapsed.gif b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/collapsed.gif new file mode 100644 index 00000000..6e710840 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/collapsed.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/expanded.gif b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/expanded.gif new file mode 100644 index 00000000..0fef3d89 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/expanded.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/external.png b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/external.png new file mode 100644 index 00000000..3f999fc8 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/external.png differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_error_sml.gif b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_error_sml.gif new file mode 100644 index 00000000..61132ef2 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_error_sml.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_info_sml.gif b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_info_sml.gif new file mode 100644 index 00000000..c6cb9ad7 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_info_sml.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_success_sml.gif b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_success_sml.gif new file mode 100644 index 00000000..52e85a43 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_success_sml.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_warning_sml.gif b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_warning_sml.gif new file mode 100644 index 00000000..873bbb52 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/icon_warning_sml.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/logos/build-by-maven-black.png b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/logos/build-by-maven-black.png new file mode 100644 index 00000000..919fd0f6 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/logos/build-by-maven-black.png differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/logos/build-by-maven-white.png b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/logos/build-by-maven-white.png new file mode 100644 index 00000000..7d44c9c2 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/logos/build-by-maven-white.png differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/logos/maven-feather.png b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/logos/maven-feather.png new file mode 100644 index 00000000..b5ada836 Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/logos/maven-feather.png differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/newwindow.png b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/newwindow.png new file mode 100644 index 00000000..6287f72b Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/images/newwindow.png differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/index.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/index.html new file mode 100644 index 00000000..501b41af --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/index.html @@ -0,0 +1,103 @@ + + + + + + hbase-maven-plugin - About + + + + + + + + + +
            + +
            +
            +
            +

            About hbase-maven-plugin

            A maven plugin to start/stop a mini HBase cluster.

            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/license.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/license.html new file mode 100644 index 00000000..dc0b0e74 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/license.html @@ -0,0 +1,305 @@ + + + + + + hbase-maven-plugin - Project License + + + + + + + + + +
            + +
            +
            +
            +

            Overview

            Typically the licenses listed for the project are that of the project itself, and not of dependencies.

            Project License

            Apache 2

            +                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/plugin-info.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/plugin-info.html new file mode 100644 index 00000000..e3e7b1c7 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/plugin-info.html @@ -0,0 +1,154 @@ + + + + + + hbase-maven-plugin - Plugin Documentation + + + + + + + + + +
            + +
            +
            +
            +

            Plugin Documentation

            Goals available for this plugin:

            GoalDescription
            hbase:startA maven goal that starts a mini HBase cluster in a new daemon +thread. +

            A new daemon thread is created that starts a mini HBase cluster. +The main thread blocks until the HBase cluster has full started. +The daemon thread with the in-process HBase cluster will continue +to run in the background until stopped by the 'stop' goal of the +plugin.

            +

            The configuration of the started mini HBase cluster will be +written to a hbase-site.xml file in the test classpath +('${basedir}/target/test-classes' by default). The path to the +generated configuration file may be customized with the +'hbaseSiteFile' property

            +

            A configuration index can be written by this goal. The +configuration index is a file that contains one line for each +configuration file written by this goal, where the line contains +the path to the configuration file. By default, the goal does not +write a configuration index. Setting the property 'writeConfIndex' +to true will cause a configuration index to be written. By default, +the configuration index will be written to +'${basedir}/target/test-classes/conf-index.conf'. The path to the +generated configuration index can be customized by setting the +'hbaseConfIndex' property.

            hbase:stopA maven goal that stops the mini HBase cluster started by the +'start' goal.

            System Requirements

            The following specifies the minimum requirements to run this Maven plugin:

            Maven2.0
            JDKDefault target for maven-compiler-plugin version 2.0.2
            MemoryNo minimum requirement.
            Disk SpaceNo minimum requirement.

            Usage

            You should specify the version in your project's plugin configuration:

            <project>
+  ...
+  <build>
+    <!-- To define the plugin version in your parent POM -->
+    <pluginManagement>
+      <plugins>
+        <plugin>
+          <groupId>org.kiji.maven.plugins</groupId>
+          <artifactId>hbase-maven-plugin</artifactId>
+          <version>1.0.9-cdh4</version>
+        </plugin>
+        ...
+      </plugins>
+    </pluginManagement>
+    <!-- To use the plugin goals in your POM or parent POM -->
+    <plugins>
+      <plugin>
+        <groupId>org.kiji.maven.plugins</groupId>
+        <artifactId>hbase-maven-plugin</artifactId>
+        <version>1.0.9-cdh4</version>
+      </plugin>
+      ...
+    </plugins>
+  </build>
+  ...
+</project>
+

            For more information, see "Guide to Configuring Plug-ins"

            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/project-info.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/project-info.html new file mode 100644 index 00000000..08e23421 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/project-info.html @@ -0,0 +1,103 @@ + + + + + + hbase-maven-plugin - Project Information + + + + + + + + + +
            + +
            +
            +
            +

            Project Information

            This document provides an overview of the various documents and links that are part of this project's general information. All of this content is automatically generated by Maven on behalf of the project.

            Overview

            DocumentDescription
            AboutA maven plugin to start/stop a mini HBase cluster.
            Project LicenseThis is a link to the definitions of project licenses.
            Project SummaryThis document lists other related information of this project
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/project-reports.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/project-reports.html new file mode 100644 index 00000000..414ec741 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/project-reports.html @@ -0,0 +1,106 @@ + + + + + + hbase-maven-plugin - Generated Reports + + + + + + + + + +
            + +
            +
            +
            +

            Generated Reports

            This document provides an overview of the various reports that are automatically generated by Maven . Each report is briefly described below.

            Overview

            DocumentDescription
            JavaDocsJavaDoc API documentation.
            Test JavaDocsTest JavaDoc API documentation.
            Plugin DocumentationThis report provides goals and parameters documentation of a plugin.
            FindBugs ReportGenerates a source code report with the FindBugs Library.
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/project-summary.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/project-summary.html new file mode 100644 index 00000000..0e333af2 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/project-summary.html @@ -0,0 +1,103 @@ + + + + + + hbase-maven-plugin - Project Summary + + + + + + + + + +
            + +
            +
            +
            +

            Project Summary

            Project Information

            FieldValue
            Namehbase-maven-plugin
            DescriptionA maven plugin to start/stop a mini HBase cluster.
            Homepage-

            Project Organization

            FieldValue
            NameWibiData, Inc.
            URLhttp://www.wibidata.com

            Build Information

            FieldValue
            GroupIdorg.kiji.maven.plugins
            ArtifactIdhbase-maven-plugin
            Version1.0.9-cdh4
            Typemaven-plugin
            JDK Rev-
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/start-mojo.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/start-mojo.html new file mode 100644 index 00000000..d5723668 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/start-mojo.html @@ -0,0 +1,290 @@ + + + + + + hbase-maven-plugin - + hbase:start + + + + + + + + + +
            + +
            +
            +
            + + +

            hbase:start

            +

            Full name:

            +

            org.kiji.maven.plugins:hbase-maven-plugin:1.0.9-cdh4:start

            +

            Description:

            +
            A maven goal that starts a mini HBase cluster in a new daemon +thread. +

            A new daemon thread is created that starts a mini HBase cluster. +The main thread blocks until the HBase cluster has full started. +The daemon thread with the in-process HBase cluster will continue +to run in the background until stopped by the 'stop' goal of the +plugin.

            +

            The configuration of the started mini HBase cluster will be +written to a hbase-site.xml file in the test classpath +('${basedir}/target/test-classes' by default). The path to the +generated configuration file may be customized with the +'hbaseSiteFile' property

            +

            A configuration index can be written by this goal. The +configuration index is a file that contains one line for each +configuration file written by this goal, where the line contains +the path to the configuration file. By default, the goal does not +write a configuration index. Setting the property 'writeConfIndex' +to true will cause a configuration index to be written. By default, +the configuration index will be written to +'${basedir}/target/test-classes/conf-index.conf'. The path to the +generated configuration index can be customized by setting the +'hbaseConfIndex' property.

            +

            Attributes:

            +
              +
            • Requires a Maven project to be executed.
              • +
            • Requires dependency resolution of artifacts in scope: test.
              • +
            • Binds by default to the lifecycle phase: pre-integration-test.
              • +
            +

            Required Parameters

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            NameTypeSinceDescription
            coreSiteFileFile-The file that will store the configuration required to connect to +the started mini HDFS and MapReduce clusters. This file will be +generated by the goal.
            Default value is: ${project.build.testOutputDirectory}/core-site.xml.
            hbaseSiteFileFile-The file that will store the configuration required to connect to +the started mini HBase cluster. This file will be generated by the +goal.
            Default value is: ${project.build.testOutputDirectory}/hbase-site.xml.
            saveHadoopTmpDirboolean-If true, the Hadoop temporary directory (given by Hadoop +configuration property hadoop.tmp .dir) will be cleared before the +cluster is started, then copied to the project's build directory +before the cluster is shutdown.
            Default value is: false.
            +
            +

            Optional Parameters

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            NameTypeSinceDescription
            hbaseConfIndexFile-The file that will store paths to the configuration files generated +by the goal. This file will be generated by the goal and will +contain one line for each configuration file giving the path to +that configuration file.
            Default value is: ${project.build.testOutputDirectory}/conf-index.conf.
            hadoopConfigurationProperties-Extra Hadoop configuration properties to use.
            mapReduceEnabledboolean-If true, also start a mini MapReduce cluster.
            Default value is: false.
            separateConfigurationFilesboolean-Whether two separate XML configuration files should be generated +(one for HDFS+MapReduce, and one for HBase).
            Default value is: true.
            skipboolean-If true, this goal should be a no-op.
            Default value is: false.
            writeConfIndexboolean-If true, this goal should write an index file that provides the +paths to the HBase configuration files written by this goal.
            Default value is: false.
            +
            +

            Parameter Details

            +

            coreSiteFile:

            +
            The file that will store the configuration required to connect to +the started mini HDFS and MapReduce clusters. This file will be +generated by the goal.
            +
              +
            • Type: java.io.File
              • +
            • Required: Yes
              • +
            • Expression: ${core.site.file}
              • +
            • Default: ${project.build.testOutputDirectory}/core-site.xml
              • +

            hbaseConfIndex:

            +
            The file that will store paths to the configuration files generated +by the goal. This file will be generated by the goal and will +contain one line for each configuration file giving the path to +that configuration file.
            +
              +
            • Type: java.io.File
              • +
            • Required: No
              • +
            • Expression: ${hbase.conf.index.file}
              • +
            • Default: ${project.build.testOutputDirectory}/conf-index.conf
              • +

            hbaseSiteFile:

            +
            The file that will store the configuration required to connect to +the started mini HBase cluster. This file will be generated by the +goal.
            +
              +
            • Type: java.io.File
              • +
            • Required: Yes
              • +
            • Expression: ${hbase.site.file}
              • +
            • Default: ${project.build.testOutputDirectory}/hbase-site.xml
              • +

            hadoopConfiguration:

            +
            Extra Hadoop configuration properties to use.
            +
              +
            • Type: java.util.Properties
              • +
            • Required: No
              • +

            mapReduceEnabled:

            +
            If true, also start a mini MapReduce cluster.
            +
              +
            • Type: boolean
              • +
            • Required: No
              • +
            • Expression: ${mapreduce.enabled}
              • +
            • Default: false
              • +

            saveHadoopTmpDir:

            +
            If true, the Hadoop temporary directory (given by Hadoop +configuration property hadoop.tmp .dir) will be cleared before the +cluster is started, then copied to the project's build directory +before the cluster is shutdown.
            +
              +
            • Type: boolean
              • +
            • Required: Yes
              • +
            • Expression: ${save.hadoop.tmp}
              • +
            • Default: false
              • +

            separateConfigurationFiles:

            +
            Whether two separate XML configuration files should be generated +(one for HDFS+MapReduce, and one for HBase).
            +
              +
            • Type: boolean
              • +
            • Required: No
              • +
            • Expression: ${separate.configuration.files}
              • +
            • Default: true
              • +

            skip:

            +
            If true, this goal should be a no-op.
            +
              +
            • Type: boolean
              • +
            • Required: No
              • +
            • Default: false
              • +

            writeConfIndex:

            +
            If true, this goal should write an index file that provides the +paths to the HBase configuration files written by this goal.
            +
              +
            • Type: boolean
              • +
            • Required: No
              • +
            • Expression: ${hbase.conf.index}
              • +
            • Default: false
              • +
            +
            +
            + + +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/stop-mojo.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/stop-mojo.html new file mode 100644 index 00000000..e7e8bee9 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/stop-mojo.html @@ -0,0 +1,174 @@ + + + + + + hbase-maven-plugin - + hbase:stop + + + + + + + + + +
            + +
            +
            +
            + + +

            hbase:stop

            +

            Full name:

            +

            org.kiji.maven.plugins:hbase-maven-plugin:1.0.9-cdh4:stop

            +

            Description:

            +
            A maven goal that stops the mini HBase cluster started by the +'start' goal.
            +

            Attributes:

            +
              +
            • Requires a Maven project to be executed.
              • +
            • Binds by default to the lifecycle phase: post-integration-test.
              • +
            +

            Required Parameters

            + + + + + + + + + + + + + + + + + + + +
            NameTypeSinceDescription
            projectBuildDirString-The build directory for this project.
            Default value is: ${project.build.directory}.
            saveHadoopTmpDirboolean-If true, the Hadoop temporary directory (given by Hadoop +configuration property hadoop.tmp .dir) will be cleared before the +cluster is started, then copied to the project's build directory +before the cluster is shutdown.
            Default value is: false.
            +
            +

            Optional Parameters

            + + + + + + + + + + + + + +
            NameTypeSinceDescription
            skipboolean-If true, this goal should be a no-op.
            Default value is: false.
            +
            +

            Parameter Details

            +

            projectBuildDir:

            +
            The build directory for this project.
            +
              +
            • Type: java.lang.String
              • +
            • Required: Yes
              • +
            • Default: ${project.build.directory}
              • +

            saveHadoopTmpDir:

            +
            If true, the Hadoop temporary directory (given by Hadoop +configuration property hadoop.tmp .dir) will be cleared before the +cluster is started, then copied to the project's build directory +before the cluster is shutdown.
            +
              +
            • Type: boolean
              • +
            • Required: Yes
              • +
            • Expression: ${save.hadoop.tmp}
              • +
            • Default: false
              • +

            skip:

            +
            If true, this goal should be a no-op.
            +
              +
            • Type: boolean
              • +
            • Required: No
              • +
            • Default: false
              • +
            +
            +
            + + +
            +
            +
            +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/allclasses-frame.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/allclasses-frame.html new file mode 100644 index 00000000..42e1e319 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/allclasses-frame.html @@ -0,0 +1,34 @@ + + + + + + + +All Classes (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + +All Classes +
            + + + + + +
            TestMiniHBaseCluster +
            +TestMiniHBaseClusterThread +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/allclasses-noframe.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/allclasses-noframe.html new file mode 100644 index 00000000..1d174ab0 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/allclasses-noframe.html @@ -0,0 +1,34 @@ + + + + + + + +All Classes (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + +All Classes +
            + + + + + +
            TestMiniHBaseCluster +
            +TestMiniHBaseClusterThread +
            +
            + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/constant-values.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/constant-values.html new file mode 100644 index 00000000..20f116af --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/constant-values.html @@ -0,0 +1,145 @@ + + + + + + + +Constant Field Values (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/deprecated-list.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/deprecated-list.html new file mode 100644 index 00000000..1f971bb7 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/help-doc.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/help-doc.html new file mode 100644 index 00000000..9afafe8d --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/index-all.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/index-all.html new file mode 100644 index 00000000..a4df2e95 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/index-all.html @@ -0,0 +1,175 @@ + + + + + + + +Index (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +C O T
            +

            +C

            +
            +
            createMocks() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            +
            +

            +O

            +
            +
            org.kiji.maven.plugins.hbase - package org.kiji.maven.plugins.hbase
             
            +
            +

            +T

            +
            +
            testListenerOccupied() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            testListenerOpen() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            TestMiniHBaseCluster - Class in org.kiji.maven.plugins.hbase
             
            TestMiniHBaseCluster() - +Constructor for class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            TestMiniHBaseClusterThread - Class in org.kiji.maven.plugins.hbase
             
            TestMiniHBaseClusterThread() - +Constructor for class org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread +
              +
            testThreadStartupAndShutdown() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread +
            Tests that the thread can be started up and shut down gracefully. +
            testWithMapReduceDisabled() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            testWithMapReduceEnabled() - +Method in class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +
              +
            +
            +C O T + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/index.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/index.html new file mode 100644 index 00000000..18db3995 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/index.html @@ -0,0 +1,37 @@ + + + + + + + +hbase-maven-plugin 1.0.9-cdh4 Test API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/maven/plugins/hbase/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseCluster.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseCluster.html new file mode 100644 index 00000000..809369d0 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseCluster.html @@ -0,0 +1,339 @@ + + + + + + + +TestMiniHBaseCluster (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class TestMiniHBaseCluster

            +
            +java.lang.Object
+  extended by org.kiji.maven.plugins.hbase.TestMiniHBaseCluster
+
            +
            +
            +
            public class TestMiniHBaseCluster
            extends Object
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            TestMiniHBaseCluster() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidcreateMocks() + +
            +           
            + voidtestListenerOccupied() + +
            +           
            + voidtestListenerOpen() + +
            +           
            + voidtestWithMapReduceDisabled() + +
            +           
            + voidtestWithMapReduceEnabled() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +TestMiniHBaseCluster

            +
            +public TestMiniHBaseCluster()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createMocks

            +
            +public void createMocks()
            +
            +
            +
            +
            +
            +
            + +

            +testWithMapReduceDisabled

            +
            +public void testWithMapReduceDisabled()
+                               throws Exception
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +testWithMapReduceEnabled

            +
            +public void testWithMapReduceEnabled()
+                              throws Exception
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +testListenerOccupied

            +
            +public void testListenerOccupied()
+                          throws Exception
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +testListenerOpen

            +
            +public void testListenerOpen()
+                      throws Exception
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseClusterThread.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseClusterThread.html new file mode 100644 index 00000000..3f8bd82d --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/TestMiniHBaseClusterThread.html @@ -0,0 +1,256 @@ + + + + + + + +TestMiniHBaseClusterThread (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.maven.plugins.hbase +
            +Class TestMiniHBaseClusterThread

            +
            +java.lang.Object
+  extended by org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread
+
            +
            +
            +
            public class TestMiniHBaseClusterThread
            extends Object
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            TestMiniHBaseClusterThread() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + voidtestThreadStartupAndShutdown() + +
            +          Tests that the thread can be started up and shut down gracefully.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +TestMiniHBaseClusterThread

            +
            +public TestMiniHBaseClusterThread()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +testThreadStartupAndShutdown

            +
            +public void testThreadStartupAndShutdown()
+                                  throws Exception
            +
            +
            Tests that the thread can be started up and shut down gracefully. +

            +

            + +
            Throws: +
            Exception
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseCluster.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseCluster.html new file mode 100644 index 00000000..3e24cda1 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseCluster.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.TestMiniHBaseCluster (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.TestMiniHBaseCluster

            +
            +No usage of org.kiji.maven.plugins.hbase.TestMiniHBaseCluster +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseClusterThread.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseClusterThread.html new file mode 100644 index 00000000..7dbce2a6 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/class-use/TestMiniHBaseClusterThread.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread

            +
            +No usage of org.kiji.maven.plugins.hbase.TestMiniHBaseClusterThread +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-frame.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-frame.html new file mode 100644 index 00000000..0e8d94a5 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + +org.kiji.maven.plugins.hbase + + + + +
            +Classes  + +
            +TestMiniHBaseCluster +
            +TestMiniHBaseClusterThread
            + + + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-summary.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-summary.html new file mode 100644 index 00000000..dd62552e --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-summary.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.maven.plugins.hbase +

            + + + + + + + + + + + + + +
            +Class Summary
            TestMiniHBaseCluster 
            TestMiniHBaseClusterThread 
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-tree.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-tree.html new file mode 100644 index 00000000..94d24a4d --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-tree.html @@ -0,0 +1,149 @@ + + + + + + + +org.kiji.maven.plugins.hbase Class Hierarchy (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.maven.plugins.hbase +

            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-use.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-use.html new file mode 100644 index 00000000..aa742e57 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/org/kiji/maven/plugins/hbase/package-use.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Package org.kiji.maven.plugins.hbase (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.maven.plugins.hbase

            +
            +No usage of org.kiji.maven.plugins.hbase +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/overview-tree.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/overview-tree.html new file mode 100644 index 00000000..70762829 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/overview-tree.html @@ -0,0 +1,151 @@ + + + + + + + +Class Hierarchy (hbase-maven-plugin 1.0.9-cdh4 Test API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.kiji.maven.plugins.hbase
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/package-list b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/package-list new file mode 100644 index 00000000..fff7c709 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/package-list @@ -0,0 +1 @@ +org.kiji.maven.plugins.hbase diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/resources/inherit.gif b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/resources/inherit.gif differ diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/stylesheet.css b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/testapidocs/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/hbase-maven-plugin/1.0.9-cdh4/usage.html b/apidocs/hbase-maven-plugin/1.0.9-cdh4/usage.html new file mode 100644 index 00000000..f36d991f --- /dev/null +++ b/apidocs/hbase-maven-plugin/1.0.9-cdh4/usage.html @@ -0,0 +1,163 @@ + + + + + + hbase-maven-plugin - + + + + + + + + + +
            + +
            +
            +
            +

            Usage

            This plugin is useful for integration testing code that interacts with an HBase cluster. Typically, you will bind the `start` goal to your `pre-integration-test` phase and the `stop` goal to the `post-integration-test` phase of the maven build lifecycle.

            Referencing the maven repository hosted by WibiData

            Built artifacts are hosted on WibiData's maven repository, so you don't need to download the source and install the plugin manually. To tell maven about the repository from which to download this plugin, add the following to your ~/.m2/settings.xml or your project's pom.xml:

                <pluginRepositories>
+      <pluginRepository>
+        <id>kiji-plugins</id>
+        <name>kiji-plugins</name>
+        <url>https://repo.wibidata.com/artifactory/kiji</url>
+      </pluginRepository>
+    </pluginRepositories>

            Start HBase during the integration-test phase

            To bind the goals to their default phases (pre- and post-integration-test), add the following to the build plugins section of your pom.xml file:

                <build>
+      <plugins>
+        <!-- ... -->
+        <plugin>
+          <groupId>org.kiji.maven.plugins</groupId>
+          <artifactId>hbase-maven-plugin</artifactId>
+          <version>${version}</version>
+          <executions>
+            <execution>
+              <goals>
+                <goal>start</goal>
+                <goal>stop</goal>
+              </goals>
+            </execution>
+          </executions>
+        </plugin>
+        <!-- ... -->
+      </plugins>
+    </build>

            Start a MapReduce cluster during the integration-test phase

            You may also require a mini MapReduce cluster to be started alongside your HBase cluster. To configure the plugin to do so, set mapReduceEnabled to true in your configuration:

                <plugin>
+      <groupId>org.kiji.maven.plugins</groupId>
+      <artifactId>hbase-maven-plugin</artifactId>
+      <version>${version}</version>
+      <configuration>
+        <mapReduceEnabled>true</mapReduceEnabled>
+      </configuration>
+      <!-- ... -->
+    </plugin>

            Hadoop configuration for your cluster

            You might want to specify additional server-side Hadoop configuration for the cluster. You may use the hadoopConfiguration properties to set them. For example, to increase the number of map and reduce task slots:

                <plugin>
+      <groupId>org.kiji.maven.plugins</groupId>
+      <artifactId>hbase-maven-plugin</artifactId>
+      <version>${version}</version>
+      <configuration>
+        <hadoopConfiguration>
+          <property>
+            <name>mapred.tasktracker.map.tasks.maximum</name>
+            <value>16</value>
+          </property>
+          <property>
+            <name>mapred.tasktracker.reduce.tasks.maximum</name>
+            <value>8</value>
+          </property>
+        </hadoopConfiguration>
+        <mapReduceEnabled>true</mapReduceEnabled>
+      </configuration>
+      <!-- ... -->
+    </plugin>

            Using the mini cluster from your Java tests

            The `start` goal will write an XML configuration file named `hbase-site.xml` to your `target/test-classes` directory, which appears on the classpath when your tests are run. Hence, an `org.apache.hadoop.conf.Configuration` object created via `HBaseConfiguration.create()` will load the HBase cluster configuration automatically.

                Configuration conf = HBaseConfiguration.create();
+    HTable mytable = new HTable(conf, "mytable");
+    // Operate on mytable as usual...

            Logging

            By default, the plugin and the clusters it starts write their logs to the following locations within your project:

            • target/hbase-maven-plugin.log - The plugin log.
            • target/hbase.log - The HBase log.
            • target/mapred.log - The MapReduce log.

            MapReduce task logs

            Jobs run on the MapReduce cluster started by the plugin produce task logs that may be useful for debugging but that are deleted when the cluster is shutdown. These logs are written to the location given by the Hadoop configuration property `hadoop.tmp.dir`. Setting `saveHadoopTmpDir` to `true` in the plugin's configuration or setting `-Dsave.hadoop.tmp=true` on the command line will clear the directory given by `hadoop.tmp.dir` before the cluster is started and copy the contents of `hadoop.tmp.dir` to the directory `hadoop-tmp` in your project's build directory. Task logs can be found at `$project.build.directory/hadoop-tmp/userlogs`.

                <plugin>
+      <groupId>org.kiji.maven.plugins</groupId>
+      <artifactId>hbase-maven-plugin</artifactId>
+      <version>${version}</version>
+      <configuration>
+        <hadoopConfiguration>
+          <property>
+            <name>mapred.tasktracker.map.tasks.maximum</name>
+            <value>16</value>
+          </property>
+          <property>
+            <name>mapred.tasktracker.reduce.tasks.maximum</name>
+            <value>8</value>
+          </property>
+        </hadoopConfiguration>
+        <mapReduceEnabled>true</mapReduceEnabled>
+        <saveHadoopTmpDir>true</saveHadoopTmpDir>
+      </configuration>
+      <!-- ... -->
+    </plugin>
            +
            +
            +
            +
            +
            + + + diff --git a/apidocs/index.md b/apidocs/index.md new file mode 100644 index 00000000..7891d516 --- /dev/null +++ b/apidocs/index.md @@ -0,0 +1,61 @@ +--- +layout: page +title: API Reference +--- + +The Kiji framework contains several components; documentation for their +APIs is provided through the links below. + +## Core Kiji Framework Modules + +Primary APIs for use by clients of the Kiji framework. Clients should +only depend on APIs listed as @ApiAudience.Public. Contributors +to other Kiji framework components may use @ApiAudience.Framework +APIs, but beware that they may change between minor versions. + + +* [KijiSchema](kiji-schema/1.0.0-rc4) (latest) + \[[1.0.0-rc4](kiji-schema/1.0.0-rc4)\] + \[[1.0.0-rc3](kiji-schema/1.0.0-rc3)\] + \[[1.0.0-rc2](kiji-schema/1.0.0-rc2)\] + \[[1.0.0-rc1](kiji-schema/1.0.0-rc1)\] + +* [KijiMR](kiji-mapreduce/1.0.0-rc4) (latest) + \[[1.0.0-rc4](kiji-mapreduce/1.0.0-rc4)\] + +* [KijiMR Library](kiji-mapreduce-lib/1.0.0-rc4) (latest) + \[[1.0.0-rc4](kiji-mapreduce-lib/1.0.0-rc4)\] + +## Extended Framework Tools +Additional APIs for use by clients of the Kiji framework. Modules in this section +are intended for testing, or as convenience APIs. + + + + + +## Internal Framework Components +APIs used internally between framework modules. Clients should not directly +depend on any APIs in here; these are intended for the framework author audience +only. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/allclasses-frame.html b/apidocs/kiji-delegation/1.0.0-rc2/allclasses-frame.html new file mode 100644 index 00000000..ac6b91d3 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/allclasses-frame.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            Lookup +
            +Lookups +
            +NoSuchProviderException +
            +Priority +
            +PriorityProvider +
            +
            + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/allclasses-noframe.html b/apidocs/kiji-delegation/1.0.0-rc2/allclasses-noframe.html new file mode 100644 index 00000000..d39af0fb --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/allclasses-noframe.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            Lookup +
            +Lookups +
            +NoSuchProviderException +
            +Priority +
            +PriorityProvider +
            +
            + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/constant-values.html b/apidocs/kiji-delegation/1.0.0-rc2/constant-values.html new file mode 100644 index 00000000..7b6071b6 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/constant-values.html @@ -0,0 +1,215 @@ + + + + + + + +Constant Field Values (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents + + + + + + +
            +org.kiji.*
            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.delegation.Priority
            +public static final intDISABLED0
            +public static final intHIGH2000
            +public static final intLOW500
            +public static final intMAX2147483647
            +public static final intMIN1
            +public static final intNORMAL1000
            +public static final intVERY_HIGH50000
            +public static final intVERY_LOW100
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/deprecated-list.html b/apidocs/kiji-delegation/1.0.0-rc2/deprecated-list.html new file mode 100644 index 00000000..579bf45d --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/help-doc.html b/apidocs/kiji-delegation/1.0.0-rc2/help-doc.html new file mode 100644 index 00000000..dba2c568 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/index-all.html b/apidocs/kiji-delegation/1.0.0-rc2/index-all.html new file mode 100644 index 00000000..48951354 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/index-all.html @@ -0,0 +1,252 @@ + + + + + + + +Index (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +D G H I L M N O P V
            +

            +D

            +
            +
            DISABLED - +Static variable in class org.kiji.delegation.Priority +
            A priority value indicating that a provider should not be used. +
            +
            +

            +G

            +
            +
            get(Class<T>) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +
            get(Class<T>, ClassLoader) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +
            getPriority(Class<T>) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. +
            getPriority(Class<T>, ClassLoader) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. +
            getPriority(Map<String, String>) - +Method in interface org.kiji.delegation.PriorityProvider +
            Returns the priority that this instance believes it has. +
            +
            +

            +H

            +
            +
            HIGH - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that a service provider is better-suited + than most providers indicating "Normal" priority. +
            +
            +

            +I

            +
            +
            iterator() - +Method in class org.kiji.delegation.Lookup +
              +
            iterator(Map<String, String>) - +Method in class org.kiji.delegation.Lookup +
              +
            +
            +

            +L

            +
            +
            Lookup<T> - Class in org.kiji.delegation
            Allows you to lookup provider implementations of interfaces or abstract classes.
            lookup() - +Method in class org.kiji.delegation.Lookup +
            Lookup a provider instance for the specified clazz and return an instance. +
            lookup(Map<String, String>) - +Method in class org.kiji.delegation.Lookup +
            Lookup a provider instance for the specified clazz and return an instance. +
            Lookups - Class in org.kiji.delegation
            Factory methods that create Lookup instances that allow + you to lookup provider implementations of interfaces or abstract classes.
            LOW - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that a service provider can fulfill the + runtime requirements, but should defer to other providers advertising + normal priority level and capability. +
            +
            +

            +M

            +
            +
            MAX - +Static variable in class org.kiji.delegation.Priority +
            Maximum legal priority value. +
            MIN - +Static variable in class org.kiji.delegation.Priority +
            The lowest priority that could still be active. +
            +
            +

            +N

            +
            +
            NORMAL - +Static variable in class org.kiji.delegation.Priority +
            The priority level that most instances should return. +
            NoSuchProviderException - Exception in org.kiji.delegation
            Thrown by a Lookup object when we cannot find a provider + for the specified interface or abstract class.
            +
            +

            +O

            +
            +
            org.kiji.delegation - package org.kiji.delegation
            A lightweight service loading library based on java.util.ServiceLoader that + can be used by Kiji framework modules for dynamically loading different + service provider implementations at runtime.
            +
            +

            +P

            +
            +
            Priority - Class in org.kiji.delegation
            Canonical priority levels for use by PriorityProvider implementations.
            PriorityProvider - Interface in org.kiji.delegation
            A service that can be selected based on its relative priority.
            +
            +

            +V

            +
            +
            VERY_HIGH - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that this provider should be preferred + except in extenuating circumstances. +
            VERY_LOW - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that a service provider has minimal + ability to fulfill the runtime requirements, and may only do so partially. +
            +
            +D G H I L M N O P V + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/index.html b/apidocs/kiji-delegation/1.0.0-rc2/index.html new file mode 100644 index 00000000..a2fc9908 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/index.html @@ -0,0 +1,37 @@ + + + + + + + +Kiji Dynamic Binding Library 1.0.0-rc2 API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/delegation/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/Lookup.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/Lookup.html new file mode 100644 index 00000000..33254248 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/Lookup.html @@ -0,0 +1,333 @@ + + + + + + + +Lookup (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class Lookup<T>

            +
            +java.lang.Object
+  extended by org.kiji.delegation.Lookup<T>
+
            +
            +
            Type Parameters:
            T - the type that this Lookup instance provides.
            +
            +
            All Implemented Interfaces:
            Iterable<T>
            +
            +
            +
            +
            @ApiAudience.Framework
+public abstract class Lookup<T>
            extends Object
            implements Iterable<T>
            + + +

            +Allows you to lookup provider implementations of interfaces or abstract classes. + This is used for late binding / dependency injection throughout the Kiji project. + You can use this mechanism to discover runtime-provided implementations of + necessary interfaces or services. + +

            To use this system:

            +
              +
            1. Create an interface you want to dynamically bind (public interface IFoo). + You can also use an abstract class here.
              2. +
            2. Create one or more implementations of this interface. + (public class MyFoo implements IFoo) This probably happens in another + module that depends on the IFoo API.
              3. +
            3. The module declaring MyFoo includes a file named + src/main/resources/META-INF/services/IFoo. It contains the word MyFoo + on a single line. If you have multiple IFoo implementations in your + module, list them all, one per line.
              4. +
            4. At runtime, a class that needs a concrete implementation of IFoo could + run: IFoo fooInstance = Lookup.get(IFoo.class).lookup();.
              5. +
            5. You will get an unchecked NoSuchProviderException if no suitable IFoo + instance could be found.
              6. +
            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  Iterator<T>iterator() + +
            +           
            +abstract  Iterator<T>iterator(Map<String,String> runtimeHints) + +
            +           
            +abstract  Tlookup() + +
            +          Lookup a provider instance for the specified clazz and return an instance.
            +abstract  Tlookup(Map<String,String> runtimeHints) + +
            +          Lookup a provider instance for the specified clazz and return an instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +lookup

            +
            +public abstract T lookup()
            +
            +
            Lookup a provider instance for the specified clazz and return an instance. +

            +

            +
            +
            +
            + +
            Returns:
            a provider instance for clazz we discover. +
            Throws: +
            NoSuchProviderException - if no runtime provider for the interface + can be found.
            +
            +
            +
            + +

            +lookup

            +
            +public abstract T lookup(Map<String,String> runtimeHints)
            +
            +
            Lookup a provider instance for the specified clazz and return an instance. +

            +

            +
            +
            +
            +
            Parameters:
            runtimeHints - parameters that may be used by Lookup instances or their + targets to evaluate the best provider to return. +
            Returns:
            a provider instance for clazz we discover. +
            Throws: +
            NoSuchProviderException - if no runtime provider for the interface + can be found.
            +
            +
            +
            + +

            +iterator

            +
            +public abstract Iterator<T> iterator()
            +
            +
            +
            Specified by:
            iterator in interface Iterable<T>
            +
            +
            + +
            Returns:
            an iterator of all provider instances for the specified class.
            +
            +
            +
            + +

            +iterator

            +
            +public abstract Iterator<T> iterator(Map<String,String> runtimeHints)
            +
            +
            +
            +
            +
            +
            Parameters:
            runtimeHints - parameters that may be used by Lookup instances or their + targets to evaluate the best way to order the returned providers. +
            Returns:
            an iterator of all provider instances for the specified class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/Lookups.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/Lookups.html new file mode 100644 index 00000000..9e1d5a05 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/Lookups.html @@ -0,0 +1,341 @@ + + + + + + + +Lookups (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class Lookups

            +
            +java.lang.Object
+  extended by org.kiji.delegation.Lookups
+
            +
            +
            +
            @ApiAudience.Framework
+public final class Lookups
            extends Object
            + + +

            +Factory methods that create Lookup instances that allow + you to lookup provider implementations of interfaces or abstract classes. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<T> Lookup<T>
            +            		get(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T> Lookup<T>
            +            		get(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		getPriority(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		getPriority(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static <T> Lookup<T> get(Class<T> clazz)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for. +
            Returns:
            a new Lookup instance that uses the current thread's context classloader.
            +
            +
            +
            + +

            +get

            +
            +public static <T> Lookup<T> get(Class<T> clazz,
+                                ClassLoader classLoader)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for.
            classLoader - the classloader to use to resolve service lookups. +
            Returns:
            a new Lookup instance that uses the specified classloader.
            +
            +
            +
            + +

            +getPriority

            +
            +public static <T extends PriorityProvider> Lookup<T> getPriority(Class<T> clazz)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. See PriorityProvider. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for. +
            Returns:
            a new Lookup instance that uses the current thread's context classloader.
            +
            +
            +
            + +

            +getPriority

            +
            +public static <T extends PriorityProvider> Lookup<T> getPriority(Class<T> clazz,
+                                                                 ClassLoader classLoader)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. See PriorityProvider. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for.
            classLoader - the classloader to use to resolve service lookups. +
            Returns:
            a new Lookup instance that uses the current thread's context classloader.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/NoSuchProviderException.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/NoSuchProviderException.html new file mode 100644 index 00000000..85844561 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/NoSuchProviderException.html @@ -0,0 +1,213 @@ + + + + + + + +NoSuchProviderException (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class NoSuchProviderException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.delegation.NoSuchProviderException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NoSuchProviderException
            extends RuntimeException
            + + +

            +Thrown by a Lookup object when we cannot find a provider + for the specified interface or abstract class. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

            + +

            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/Priority.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/Priority.html new file mode 100644 index 00000000..0e9086f5 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/Priority.html @@ -0,0 +1,383 @@ + + + + + + + +Priority (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class Priority

            +
            +java.lang.Object
+  extended by org.kiji.delegation.Priority
+
            +
            +
            +
            @ApiAudience.Framework
+public final class Priority
            extends Object
            + + +

            +Canonical priority levels for use by PriorityProvider implementations. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static intDISABLED + +
            +          A priority value indicating that a provider should not be used.
            +static intHIGH + +
            +          A priority level indicating that a service provider is better-suited + than most providers indicating "Normal" priority.
            +static intLOW + +
            +          A priority level indicating that a service provider can fulfill the + runtime requirements, but should defer to other providers advertising + normal priority level and capability.
            +static intMAX + +
            +          Maximum legal priority value.
            +static intMIN + +
            +          The lowest priority that could still be active.
            +static intNORMAL + +
            +          The priority level that most instances should return.
            +static intVERY_HIGH + +
            +          A priority level indicating that this provider should be preferred + except in extenuating circumstances.
            +static intVERY_LOW + +
            +          A priority level indicating that a service provider has minimal + ability to fulfill the runtime requirements, and may only do so partially.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +MAX

            +
            +public static final int MAX
            +
            +
            Maximum legal priority value. Trumps all other providers. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +VERY_HIGH

            +
            +public static final int VERY_HIGH
            +
            +
            A priority level indicating that this provider should be preferred + except in extenuating circumstances. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +HIGH

            +
            +public static final int HIGH
            +
            +
            A priority level indicating that a service provider is better-suited + than most providers indicating "Normal" priority. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +NORMAL

            +
            +public static final int NORMAL
            +
            +
            The priority level that most instances should return. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +LOW

            +
            +public static final int LOW
            +
            +
            A priority level indicating that a service provider can fulfill the + runtime requirements, but should defer to other providers advertising + normal priority level and capability. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +VERY_LOW

            +
            +public static final int VERY_LOW
            +
            +
            A priority level indicating that a service provider has minimal + ability to fulfill the runtime requirements, and may only do so partially. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +MIN

            +
            +public static final int MIN
            +
            +
            The lowest priority that could still be active. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DISABLED

            +
            +public static final int DISABLED
            +
            +
            A priority value indicating that a provider should not be used. +

            +

            +
            See Also:
            Constant Field Values
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/PriorityProvider.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/PriorityProvider.html new file mode 100644 index 00000000..645d7cfb --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/PriorityProvider.html @@ -0,0 +1,240 @@ + + + + + + + +PriorityProvider (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Interface PriorityProvider

            +
            +
            +
            @ApiAudience.Public
+public interface PriorityProvider
            + + +

            +A service that can be selected based on its relative priority. + +

            Lookup is often used to select a "factory service" that actually + creates an instance of a real class. This level of indirection is often + necessary if you do not want to actually classload multiple providers of the + "true" service into the same JVM, because they may both compete for resources, + or trigger further classloading of incompatible class definitions.

            + +

            Where one or more factory services may all potentially create incompatible + versions of a true interface, an arbitration mechanism (called a priority) + is used to select the best factory service available at runtime.

            + +

            This interface is used by the PriorityLookup implementation. + All factory service implementations (which implement PriorityProvider) + are loaded by the PriorityLookup instance; they are each queried for their + priority -- how confident they are that they can provide the best implementation + for the current runtime environment. The instance that volunteers the highest priority + is then selected. This factory instance can then classload and create the true + service instance using its own API.

            +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + intgetPriority(Map<String,String> runtimeHints) + +
            +          Returns the priority that this instance believes it has.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getPriority

            +
            +int getPriority(Map<String,String> runtimeHints)
            +
            +
            Returns the priority that this instance believes it has. Higher priorities + indicate a better fit for the current runtime environment. The instance + may inspect as much of the runtime environment as it can to establish its fitness; + classes may also provide a collection of runtime "hints" that describe the + environment more precisely. + +

            A priority of 0 or less indicates that the instance will not be used. The + highest priority instance is used.

            +

            +

            +
            Parameters:
            runtimeHints - hints provided by the client that establish the parameters + of the current runtime environment. +
            Returns:
            a value greater than or equal to zero indicating the confidence that this + is the best instance to use.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/Lookup.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/Lookup.html new file mode 100644 index 00000000..0edf6597 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/Lookup.html @@ -0,0 +1,230 @@ + + + + + + + +Uses of Class org.kiji.delegation.Lookup (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.Lookup

            +
            + + + + + +
            +Uses of Lookup in org.kiji.delegation
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.delegation that return Lookup
            +static + + + + +
            +<T> Lookup<T>
            +            		Lookups.get(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T> Lookup<T>
            +            		Lookups.get(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/Lookups.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/Lookups.html new file mode 100644 index 00000000..58e9edb0 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/Lookups.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.delegation.Lookups (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.Lookups

            +
            +No usage of org.kiji.delegation.Lookups +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/NoSuchProviderException.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/NoSuchProviderException.html new file mode 100644 index 00000000..1c134274 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/NoSuchProviderException.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.delegation.NoSuchProviderException (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.NoSuchProviderException

            +
            +No usage of org.kiji.delegation.NoSuchProviderException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/Priority.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/Priority.html new file mode 100644 index 00000000..8133d422 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/Priority.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.delegation.Priority (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.Priority

            +
            +No usage of org.kiji.delegation.Priority +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/PriorityProvider.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/PriorityProvider.html new file mode 100644 index 00000000..73dd0136 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/class-use/PriorityProvider.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Interface org.kiji.delegation.PriorityProvider (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.delegation.PriorityProvider

            +
            + + + + + +
            +Uses of PriorityProvider in org.kiji.delegation
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.delegation with type parameters of type PriorityProvider
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-frame.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-frame.html new file mode 100644 index 00000000..59ec2f1f --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-frame.html @@ -0,0 +1,59 @@ + + + + + + + +org.kiji.delegation (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.delegation + + + + +
            +Interfaces  + +
            +PriorityProvider
            + + + + + + +
            +Classes  + +
            +Lookup +
            +Lookups +
            +Priority
            + + + + + + +
            +Exceptions  + +
            +NoSuchProviderException
            + + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-summary.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-summary.html new file mode 100644 index 00000000..0fb52dbb --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-summary.html @@ -0,0 +1,218 @@ + + + + + + + +org.kiji.delegation (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.delegation +

            +A lightweight service loading library based on java.util.ServiceLoader that + can be used by Kiji framework modules for dynamically loading different + service provider implementations at runtime. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            PriorityProviderA service that can be selected based on its relative priority.
            +  + +

            + + + + + + + + + + + + + + + + + +
            +Class Summary
            Lookup<T>Allows you to lookup provider implementations of interfaces or abstract classes.
            LookupsFactory methods that create Lookup instances that allow + you to lookup provider implementations of interfaces or abstract classes.
            PriorityCanonical priority levels for use by PriorityProvider implementations.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            NoSuchProviderExceptionThrown by a Lookup object when we cannot find a provider + for the specified interface or abstract class.
            +  + +

            +

            +Package org.kiji.delegation Description +

            + +

            +A lightweight service loading library based on java.util.ServiceLoader that + can be used by Kiji framework modules for dynamically loading different + service provider implementations at runtime. This delegates functionality + required by "upstream" modules to downstream runtime implementations. + +

            The main client class is Lookup, + which provides an API for lookups, as well as factory methods for + lookup service implementations.

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-tree.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-tree.html new file mode 100644 index 00000000..62f82ec0 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.delegation Class Hierarchy (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.delegation +

            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-use.html b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-use.html new file mode 100644 index 00000000..2433c1c5 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/org/kiji/delegation/package-use.html @@ -0,0 +1,162 @@ + + + + + + + +Uses of Package org.kiji.delegation (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.delegation

            +
            + + + + + + + + + + + +
            +Classes in org.kiji.delegation used by org.kiji.delegation
            Lookup + +
            +          Allows you to lookup provider implementations of interfaces or abstract classes.
            PriorityProvider + +
            +          A service that can be selected based on its relative priority.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/overview-tree.html b/apidocs/kiji-delegation/1.0.0-rc2/overview-tree.html new file mode 100644 index 00000000..b50b399f --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/overview-tree.html @@ -0,0 +1,164 @@ + + + + + + + +Class Hierarchy (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.kiji.delegation
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/package-list b/apidocs/kiji-delegation/1.0.0-rc2/package-list new file mode 100644 index 00000000..4e58ba79 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/package-list @@ -0,0 +1 @@ +org.kiji.delegation diff --git a/apidocs/kiji-delegation/1.0.0-rc2/resources/inherit.gif b/apidocs/kiji-delegation/1.0.0-rc2/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/kiji-delegation/1.0.0-rc2/resources/inherit.gif differ diff --git a/apidocs/kiji-delegation/1.0.0-rc2/serialized-form.html b/apidocs/kiji-delegation/1.0.0-rc2/serialized-form.html new file mode 100644 index 00000000..acbcb136 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/serialized-form.html @@ -0,0 +1,162 @@ + + + + + + + +Serialized Form (Kiji Dynamic Binding Library 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Serialized Form

            +
            +
            + + + + + +
            +Package org.kiji.delegation
            + +

            + + + + + +
            +Class org.kiji.delegation.NoSuchProviderException extends RuntimeException implements Serializable
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc2/stylesheet.css b/apidocs/kiji-delegation/1.0.0-rc2/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc2/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/allclasses-frame.html b/apidocs/kiji-delegation/1.0.0-rc3/allclasses-frame.html new file mode 100644 index 00000000..e685c8e9 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/allclasses-frame.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            Lookup +
            +Lookups +
            +NoSuchProviderException +
            +Priority +
            +PriorityProvider +
            +
            + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/allclasses-noframe.html b/apidocs/kiji-delegation/1.0.0-rc3/allclasses-noframe.html new file mode 100644 index 00000000..b69f849f --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/allclasses-noframe.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            Lookup +
            +Lookups +
            +NoSuchProviderException +
            +Priority +
            +PriorityProvider +
            +
            + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/constant-values.html b/apidocs/kiji-delegation/1.0.0-rc3/constant-values.html new file mode 100644 index 00000000..d0b01469 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/constant-values.html @@ -0,0 +1,215 @@ + + + + + + + +Constant Field Values (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents + + + + + + +
            +org.kiji.*
            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.delegation.Priority
            +public static final intDISABLED0
            +public static final intHIGH2000
            +public static final intLOW500
            +public static final intMAX2147483647
            +public static final intMIN1
            +public static final intNORMAL1000
            +public static final intVERY_HIGH50000
            +public static final intVERY_LOW100
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/deprecated-list.html b/apidocs/kiji-delegation/1.0.0-rc3/deprecated-list.html new file mode 100644 index 00000000..6eaddb88 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/help-doc.html b/apidocs/kiji-delegation/1.0.0-rc3/help-doc.html new file mode 100644 index 00000000..9d4aa261 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/index-all.html b/apidocs/kiji-delegation/1.0.0-rc3/index-all.html new file mode 100644 index 00000000..cd93b113 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/index-all.html @@ -0,0 +1,252 @@ + + + + + + + +Index (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +D G H I L M N O P V
            +

            +D

            +
            +
            DISABLED - +Static variable in class org.kiji.delegation.Priority +
            A priority value indicating that a provider should not be used. +
            +
            +

            +G

            +
            +
            get(Class<T>) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +
            get(Class<T>, ClassLoader) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +
            getPriority(Class<T>) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. +
            getPriority(Class<T>, ClassLoader) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. +
            getPriority(Map<String, String>) - +Method in interface org.kiji.delegation.PriorityProvider +
            Returns the priority that this instance believes it has. +
            +
            +

            +H

            +
            +
            HIGH - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that a service provider is better-suited + than most providers indicating "Normal" priority. +
            +
            +

            +I

            +
            +
            iterator() - +Method in class org.kiji.delegation.Lookup +
              +
            iterator(Map<String, String>) - +Method in class org.kiji.delegation.Lookup +
              +
            +
            +

            +L

            +
            +
            Lookup<T> - Class in org.kiji.delegation
            Allows you to lookup provider implementations of interfaces or abstract classes.
            lookup() - +Method in class org.kiji.delegation.Lookup +
            Lookup a provider instance for the specified clazz and return an instance. +
            lookup(Map<String, String>) - +Method in class org.kiji.delegation.Lookup +
            Lookup a provider instance for the specified clazz and return an instance. +
            Lookups - Class in org.kiji.delegation
            Factory methods that create Lookup instances that allow + you to lookup provider implementations of interfaces or abstract classes.
            LOW - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that a service provider can fulfill the + runtime requirements, but should defer to other providers advertising + normal priority level and capability. +
            +
            +

            +M

            +
            +
            MAX - +Static variable in class org.kiji.delegation.Priority +
            Maximum legal priority value. +
            MIN - +Static variable in class org.kiji.delegation.Priority +
            The lowest priority that could still be active. +
            +
            +

            +N

            +
            +
            NORMAL - +Static variable in class org.kiji.delegation.Priority +
            The priority level that most instances should return. +
            NoSuchProviderException - Exception in org.kiji.delegation
            Thrown by a Lookup object when we cannot find a provider + for the specified interface or abstract class.
            +
            +

            +O

            +
            +
            org.kiji.delegation - package org.kiji.delegation
            A lightweight service loading library based on java.util.ServiceLoader that + can be used by Kiji framework modules for dynamically loading different + service provider implementations at runtime.
            +
            +

            +P

            +
            +
            Priority - Class in org.kiji.delegation
            Canonical priority levels for use by PriorityProvider implementations.
            PriorityProvider - Interface in org.kiji.delegation
            A service that can be selected based on its relative priority.
            +
            +

            +V

            +
            +
            VERY_HIGH - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that this provider should be preferred + except in extenuating circumstances. +
            VERY_LOW - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that a service provider has minimal + ability to fulfill the runtime requirements, and may only do so partially. +
            +
            +D G H I L M N O P V + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/index.html b/apidocs/kiji-delegation/1.0.0-rc3/index.html new file mode 100644 index 00000000..3dbb4e98 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/index.html @@ -0,0 +1,37 @@ + + + + + + + +Kiji Dynamic Binding Library 1.0.0-rc3 API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/delegation/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/Lookup.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/Lookup.html new file mode 100644 index 00000000..1f7b3e49 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/Lookup.html @@ -0,0 +1,333 @@ + + + + + + + +Lookup (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class Lookup<T>

            +
            +java.lang.Object
+  extended by org.kiji.delegation.Lookup<T>
+
            +
            +
            Type Parameters:
            T - the type that this Lookup instance provides.
            +
            +
            All Implemented Interfaces:
            Iterable<T>
            +
            +
            +
            +
            @ApiAudience.Framework
+public abstract class Lookup<T>
            extends Object
            implements Iterable<T>
            + + +

            +Allows you to lookup provider implementations of interfaces or abstract classes. + This is used for late binding / dependency injection throughout the Kiji project. + You can use this mechanism to discover runtime-provided implementations of + necessary interfaces or services. + +

            To use this system:

            +
              +
            1. Create an interface you want to dynamically bind (public interface IFoo). + You can also use an abstract class here.
              2. +
            2. Create one or more implementations of this interface. + (public class MyFoo implements IFoo) This probably happens in another + module that depends on the IFoo API.
              3. +
            3. The module declaring MyFoo includes a file named + src/main/resources/META-INF/services/IFoo. It contains the word MyFoo + on a single line. If you have multiple IFoo implementations in your + module, list them all, one per line.
              4. +
            4. At runtime, a class that needs a concrete implementation of IFoo could + run: IFoo fooInstance = Lookup.get(IFoo.class).lookup();.
              5. +
            5. You will get an unchecked NoSuchProviderException if no suitable IFoo + instance could be found.
              6. +
            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  Iterator<T>iterator() + +
            +           
            +abstract  Iterator<T>iterator(Map<String,String> runtimeHints) + +
            +           
            +abstract  Tlookup() + +
            +          Lookup a provider instance for the specified clazz and return an instance.
            +abstract  Tlookup(Map<String,String> runtimeHints) + +
            +          Lookup a provider instance for the specified clazz and return an instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +lookup

            +
            +public abstract T lookup()
            +
            +
            Lookup a provider instance for the specified clazz and return an instance. +

            +

            +
            +
            +
            + +
            Returns:
            a provider instance for clazz we discover. +
            Throws: +
            NoSuchProviderException - if no runtime provider for the interface + can be found.
            +
            +
            +
            + +

            +lookup

            +
            +public abstract T lookup(Map<String,String> runtimeHints)
            +
            +
            Lookup a provider instance for the specified clazz and return an instance. +

            +

            +
            +
            +
            +
            Parameters:
            runtimeHints - parameters that may be used by Lookup instances or their + targets to evaluate the best provider to return. +
            Returns:
            a provider instance for clazz we discover. +
            Throws: +
            NoSuchProviderException - if no runtime provider for the interface + can be found.
            +
            +
            +
            + +

            +iterator

            +
            +public abstract Iterator<T> iterator()
            +
            +
            +
            Specified by:
            iterator in interface Iterable<T>
            +
            +
            + +
            Returns:
            an iterator of all provider instances for the specified class.
            +
            +
            +
            + +

            +iterator

            +
            +public abstract Iterator<T> iterator(Map<String,String> runtimeHints)
            +
            +
            +
            +
            +
            +
            Parameters:
            runtimeHints - parameters that may be used by Lookup instances or their + targets to evaluate the best way to order the returned providers. +
            Returns:
            an iterator of all provider instances for the specified class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/Lookups.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/Lookups.html new file mode 100644 index 00000000..3a8df90b --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/Lookups.html @@ -0,0 +1,341 @@ + + + + + + + +Lookups (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class Lookups

            +
            +java.lang.Object
+  extended by org.kiji.delegation.Lookups
+
            +
            +
            +
            @ApiAudience.Framework
+public final class Lookups
            extends Object
            + + +

            +Factory methods that create Lookup instances that allow + you to lookup provider implementations of interfaces or abstract classes. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<T> Lookup<T>
            +            		get(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T> Lookup<T>
            +            		get(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		getPriority(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		getPriority(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static <T> Lookup<T> get(Class<T> clazz)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for. +
            Returns:
            a new Lookup instance that uses the current thread's context classloader.
            +
            +
            +
            + +

            +get

            +
            +public static <T> Lookup<T> get(Class<T> clazz,
+                                ClassLoader classLoader)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for.
            classLoader - the classloader to use to resolve service lookups. +
            Returns:
            a new Lookup instance that uses the specified classloader.
            +
            +
            +
            + +

            +getPriority

            +
            +public static <T extends PriorityProvider> Lookup<T> getPriority(Class<T> clazz)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. See PriorityProvider. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for. +
            Returns:
            a new Lookup instance that uses the current thread's context classloader.
            +
            +
            +
            + +

            +getPriority

            +
            +public static <T extends PriorityProvider> Lookup<T> getPriority(Class<T> clazz,
+                                                                 ClassLoader classLoader)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. See PriorityProvider. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for.
            classLoader - the classloader to use to resolve service lookups. +
            Returns:
            a new Lookup instance that uses the current thread's context classloader.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/NoSuchProviderException.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/NoSuchProviderException.html new file mode 100644 index 00000000..fc9186d9 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/NoSuchProviderException.html @@ -0,0 +1,213 @@ + + + + + + + +NoSuchProviderException (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class NoSuchProviderException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.delegation.NoSuchProviderException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NoSuchProviderException
            extends RuntimeException
            + + +

            +Thrown by a Lookup object when we cannot find a provider + for the specified interface or abstract class. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

            + +

            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/Priority.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/Priority.html new file mode 100644 index 00000000..381d7afd --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/Priority.html @@ -0,0 +1,383 @@ + + + + + + + +Priority (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class Priority

            +
            +java.lang.Object
+  extended by org.kiji.delegation.Priority
+
            +
            +
            +
            @ApiAudience.Framework
+public final class Priority
            extends Object
            + + +

            +Canonical priority levels for use by PriorityProvider implementations. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static intDISABLED + +
            +          A priority value indicating that a provider should not be used.
            +static intHIGH + +
            +          A priority level indicating that a service provider is better-suited + than most providers indicating "Normal" priority.
            +static intLOW + +
            +          A priority level indicating that a service provider can fulfill the + runtime requirements, but should defer to other providers advertising + normal priority level and capability.
            +static intMAX + +
            +          Maximum legal priority value.
            +static intMIN + +
            +          The lowest priority that could still be active.
            +static intNORMAL + +
            +          The priority level that most instances should return.
            +static intVERY_HIGH + +
            +          A priority level indicating that this provider should be preferred + except in extenuating circumstances.
            +static intVERY_LOW + +
            +          A priority level indicating that a service provider has minimal + ability to fulfill the runtime requirements, and may only do so partially.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +MAX

            +
            +public static final int MAX
            +
            +
            Maximum legal priority value. Trumps all other providers. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +VERY_HIGH

            +
            +public static final int VERY_HIGH
            +
            +
            A priority level indicating that this provider should be preferred + except in extenuating circumstances. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +HIGH

            +
            +public static final int HIGH
            +
            +
            A priority level indicating that a service provider is better-suited + than most providers indicating "Normal" priority. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +NORMAL

            +
            +public static final int NORMAL
            +
            +
            The priority level that most instances should return. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +LOW

            +
            +public static final int LOW
            +
            +
            A priority level indicating that a service provider can fulfill the + runtime requirements, but should defer to other providers advertising + normal priority level and capability. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +VERY_LOW

            +
            +public static final int VERY_LOW
            +
            +
            A priority level indicating that a service provider has minimal + ability to fulfill the runtime requirements, and may only do so partially. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +MIN

            +
            +public static final int MIN
            +
            +
            The lowest priority that could still be active. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DISABLED

            +
            +public static final int DISABLED
            +
            +
            A priority value indicating that a provider should not be used. +

            +

            +
            See Also:
            Constant Field Values
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/PriorityProvider.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/PriorityProvider.html new file mode 100644 index 00000000..3a68583c --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/PriorityProvider.html @@ -0,0 +1,240 @@ + + + + + + + +PriorityProvider (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Interface PriorityProvider

            +
            +
            +
            @ApiAudience.Public
+public interface PriorityProvider
            + + +

            +A service that can be selected based on its relative priority. + +

            Lookup is often used to select a "factory service" that actually + creates an instance of a real class. This level of indirection is often + necessary if you do not want to actually classload multiple providers of the + "true" service into the same JVM, because they may both compete for resources, + or trigger further classloading of incompatible class definitions.

            + +

            Where one or more factory services may all potentially create incompatible + versions of a true interface, an arbitration mechanism (called a priority) + is used to select the best factory service available at runtime.

            + +

            This interface is used by the PriorityLookup implementation. + All factory service implementations (which implement PriorityProvider) + are loaded by the PriorityLookup instance; they are each queried for their + priority -- how confident they are that they can provide the best implementation + for the current runtime environment. The instance that volunteers the highest priority + is then selected. This factory instance can then classload and create the true + service instance using its own API.

            +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + intgetPriority(Map<String,String> runtimeHints) + +
            +          Returns the priority that this instance believes it has.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getPriority

            +
            +int getPriority(Map<String,String> runtimeHints)
            +
            +
            Returns the priority that this instance believes it has. Higher priorities + indicate a better fit for the current runtime environment. The instance + may inspect as much of the runtime environment as it can to establish its fitness; + classes may also provide a collection of runtime "hints" that describe the + environment more precisely. + +

            A priority of 0 or less indicates that the instance will not be used. The + highest priority instance is used.

            +

            +

            +
            Parameters:
            runtimeHints - hints provided by the client that establish the parameters + of the current runtime environment. +
            Returns:
            a value greater than or equal to zero indicating the confidence that this + is the best instance to use.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/Lookup.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/Lookup.html new file mode 100644 index 00000000..0537bccb --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/Lookup.html @@ -0,0 +1,230 @@ + + + + + + + +Uses of Class org.kiji.delegation.Lookup (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.Lookup

            +
            + + + + + +
            +Uses of Lookup in org.kiji.delegation
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.delegation that return Lookup
            +static + + + + +
            +<T> Lookup<T>
            +            		Lookups.get(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T> Lookup<T>
            +            		Lookups.get(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/Lookups.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/Lookups.html new file mode 100644 index 00000000..23795630 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/Lookups.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.delegation.Lookups (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.Lookups

            +
            +No usage of org.kiji.delegation.Lookups +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/NoSuchProviderException.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/NoSuchProviderException.html new file mode 100644 index 00000000..283405b6 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/NoSuchProviderException.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.delegation.NoSuchProviderException (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.NoSuchProviderException

            +
            +No usage of org.kiji.delegation.NoSuchProviderException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/Priority.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/Priority.html new file mode 100644 index 00000000..8ddd5188 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/Priority.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.delegation.Priority (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.Priority

            +
            +No usage of org.kiji.delegation.Priority +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/PriorityProvider.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/PriorityProvider.html new file mode 100644 index 00000000..050c4aaf --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/class-use/PriorityProvider.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Interface org.kiji.delegation.PriorityProvider (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.delegation.PriorityProvider

            +
            + + + + + +
            +Uses of PriorityProvider in org.kiji.delegation
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.delegation with type parameters of type PriorityProvider
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-frame.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-frame.html new file mode 100644 index 00000000..fc8ae891 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-frame.html @@ -0,0 +1,59 @@ + + + + + + + +org.kiji.delegation (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.delegation + + + + +
            +Interfaces  + +
            +PriorityProvider
            + + + + + + +
            +Classes  + +
            +Lookup +
            +Lookups +
            +Priority
            + + + + + + +
            +Exceptions  + +
            +NoSuchProviderException
            + + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-summary.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-summary.html new file mode 100644 index 00000000..dc09b3d8 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-summary.html @@ -0,0 +1,218 @@ + + + + + + + +org.kiji.delegation (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.delegation +

            +A lightweight service loading library based on java.util.ServiceLoader that + can be used by Kiji framework modules for dynamically loading different + service provider implementations at runtime. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            PriorityProviderA service that can be selected based on its relative priority.
            +  + +

            + + + + + + + + + + + + + + + + + +
            +Class Summary
            Lookup<T>Allows you to lookup provider implementations of interfaces or abstract classes.
            LookupsFactory methods that create Lookup instances that allow + you to lookup provider implementations of interfaces or abstract classes.
            PriorityCanonical priority levels for use by PriorityProvider implementations.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            NoSuchProviderExceptionThrown by a Lookup object when we cannot find a provider + for the specified interface or abstract class.
            +  + +

            +

            +Package org.kiji.delegation Description +

            + +

            +A lightweight service loading library based on java.util.ServiceLoader that + can be used by Kiji framework modules for dynamically loading different + service provider implementations at runtime. This delegates functionality + required by "upstream" modules to downstream runtime implementations. + +

            The main client class is Lookup, + which provides an API for lookups, as well as factory methods for + lookup service implementations.

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-tree.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-tree.html new file mode 100644 index 00000000..e3833e26 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.delegation Class Hierarchy (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.delegation +

            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-use.html b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-use.html new file mode 100644 index 00000000..b9acab8d --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/org/kiji/delegation/package-use.html @@ -0,0 +1,162 @@ + + + + + + + +Uses of Package org.kiji.delegation (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.delegation

            +
            + + + + + + + + + + + +
            +Classes in org.kiji.delegation used by org.kiji.delegation
            Lookup + +
            +          Allows you to lookup provider implementations of interfaces or abstract classes.
            PriorityProvider + +
            +          A service that can be selected based on its relative priority.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/overview-tree.html b/apidocs/kiji-delegation/1.0.0-rc3/overview-tree.html new file mode 100644 index 00000000..93130689 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/overview-tree.html @@ -0,0 +1,164 @@ + + + + + + + +Class Hierarchy (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.kiji.delegation
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/package-list b/apidocs/kiji-delegation/1.0.0-rc3/package-list new file mode 100644 index 00000000..4e58ba79 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/package-list @@ -0,0 +1 @@ +org.kiji.delegation diff --git a/apidocs/kiji-delegation/1.0.0-rc3/resources/inherit.gif b/apidocs/kiji-delegation/1.0.0-rc3/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/kiji-delegation/1.0.0-rc3/resources/inherit.gif differ diff --git a/apidocs/kiji-delegation/1.0.0-rc3/serialized-form.html b/apidocs/kiji-delegation/1.0.0-rc3/serialized-form.html new file mode 100644 index 00000000..7015ead9 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/serialized-form.html @@ -0,0 +1,162 @@ + + + + + + + +Serialized Form (Kiji Dynamic Binding Library 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Serialized Form

            +
            +
            + + + + + +
            +Package org.kiji.delegation
            + +

            + + + + + +
            +Class org.kiji.delegation.NoSuchProviderException extends RuntimeException implements Serializable
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc3/stylesheet.css b/apidocs/kiji-delegation/1.0.0-rc3/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc3/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/allclasses-frame.html b/apidocs/kiji-delegation/1.0.0-rc4/allclasses-frame.html new file mode 100644 index 00000000..80e1a411 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/allclasses-frame.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            Lookup +
            +Lookups +
            +NoSuchProviderException +
            +Priority +
            +PriorityProvider +
            +
            + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/allclasses-noframe.html b/apidocs/kiji-delegation/1.0.0-rc4/allclasses-noframe.html new file mode 100644 index 00000000..44b39320 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/allclasses-noframe.html @@ -0,0 +1,40 @@ + + + + + + + +All Classes (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            Lookup +
            +Lookups +
            +NoSuchProviderException +
            +Priority +
            +PriorityProvider +
            +
            + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/constant-values.html b/apidocs/kiji-delegation/1.0.0-rc4/constant-values.html new file mode 100644 index 00000000..3e4fd6cb --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/constant-values.html @@ -0,0 +1,215 @@ + + + + + + + +Constant Field Values (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents + + + + + + +
            +org.kiji.*
            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.delegation.Priority
            +public static final intDISABLED0
            +public static final intHIGH2000
            +public static final intLOW500
            +public static final intMAX2147483647
            +public static final intMIN1
            +public static final intNORMAL1000
            +public static final intVERY_HIGH50000
            +public static final intVERY_LOW100
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/deprecated-list.html b/apidocs/kiji-delegation/1.0.0-rc4/deprecated-list.html new file mode 100644 index 00000000..6a0642e0 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/deprecated-list.html @@ -0,0 +1,145 @@ + + + + + + + +Deprecated List (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/help-doc.html b/apidocs/kiji-delegation/1.0.0-rc4/help-doc.html new file mode 100644 index 00000000..67570f5c --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/help-doc.html @@ -0,0 +1,216 @@ + + + + + + + +API Help (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/index-all.html b/apidocs/kiji-delegation/1.0.0-rc4/index-all.html new file mode 100644 index 00000000..80875123 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/index-all.html @@ -0,0 +1,252 @@ + + + + + + + +Index (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +D G H I L M N O P V
            +

            +D

            +
            +
            DISABLED - +Static variable in class org.kiji.delegation.Priority +
            A priority value indicating that a provider should not be used. +
            +
            +

            +G

            +
            +
            get(Class<T>) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +
            get(Class<T>, ClassLoader) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +
            getPriority(Class<T>) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. +
            getPriority(Class<T>, ClassLoader) - +Static method in class org.kiji.delegation.Lookups +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. +
            getPriority(Map<String, String>) - +Method in interface org.kiji.delegation.PriorityProvider +
            Returns the priority that this instance believes it has. +
            +
            +

            +H

            +
            +
            HIGH - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that a service provider is better-suited + than most providers indicating "Normal" priority. +
            +
            +

            +I

            +
            +
            iterator() - +Method in class org.kiji.delegation.Lookup +
              +
            iterator(Map<String, String>) - +Method in class org.kiji.delegation.Lookup +
              +
            +
            +

            +L

            +
            +
            Lookup<T> - Class in org.kiji.delegation
            Allows you to lookup provider implementations of interfaces or abstract classes.
            lookup() - +Method in class org.kiji.delegation.Lookup +
            Lookup a provider instance for the specified clazz and return an instance. +
            lookup(Map<String, String>) - +Method in class org.kiji.delegation.Lookup +
            Lookup a provider instance for the specified clazz and return an instance. +
            Lookups - Class in org.kiji.delegation
            Factory methods that create Lookup instances that allow + you to lookup provider implementations of interfaces or abstract classes.
            LOW - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that a service provider can fulfill the + runtime requirements, but should defer to other providers advertising + normal priority level and capability. +
            +
            +

            +M

            +
            +
            MAX - +Static variable in class org.kiji.delegation.Priority +
            Maximum legal priority value. +
            MIN - +Static variable in class org.kiji.delegation.Priority +
            The lowest priority that could still be active. +
            +
            +

            +N

            +
            +
            NORMAL - +Static variable in class org.kiji.delegation.Priority +
            The priority level that most instances should return. +
            NoSuchProviderException - Exception in org.kiji.delegation
            Thrown by a Lookup object when we cannot find a provider + for the specified interface or abstract class.
            +
            +

            +O

            +
            +
            org.kiji.delegation - package org.kiji.delegation
            A lightweight service loading library based on java.util.ServiceLoader that + can be used by Kiji framework modules for dynamically loading different + service provider implementations at runtime.
            +
            +

            +P

            +
            +
            Priority - Class in org.kiji.delegation
            Canonical priority levels for use by PriorityProvider implementations.
            PriorityProvider - Interface in org.kiji.delegation
            A service that can be selected based on its relative priority.
            +
            +

            +V

            +
            +
            VERY_HIGH - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that this provider should be preferred + except in extenuating circumstances. +
            VERY_LOW - +Static variable in class org.kiji.delegation.Priority +
            A priority level indicating that a service provider has minimal + ability to fulfill the runtime requirements, and may only do so partially. +
            +
            +D G H I L M N O P V + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/index.html b/apidocs/kiji-delegation/1.0.0-rc4/index.html new file mode 100644 index 00000000..a476bf7b --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/index.html @@ -0,0 +1,37 @@ + + + + + + + +Kiji Dynamic Binding Library 1.0.0-rc4 API + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="org/kiji/delegation/package-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/Lookup.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/Lookup.html new file mode 100644 index 00000000..b883e552 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/Lookup.html @@ -0,0 +1,333 @@ + + + + + + + +Lookup (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class Lookup<T>

            +
            +java.lang.Object
+  extended by org.kiji.delegation.Lookup<T>
+
            +
            +
            Type Parameters:
            T - the type that this Lookup instance provides.
            +
            +
            All Implemented Interfaces:
            Iterable<T>
            +
            +
            +
            +
            @ApiAudience.Framework
+public abstract class Lookup<T>
            extends Object
            implements Iterable<T>
            + + +

            +Allows you to lookup provider implementations of interfaces or abstract classes. + This is used for late binding / dependency injection throughout the Kiji project. + You can use this mechanism to discover runtime-provided implementations of + necessary interfaces or services. + +

            To use this system:

            +
              +
            1. Create an interface you want to dynamically bind (public interface IFoo). + You can also use an abstract class here.
              2. +
            2. Create one or more implementations of this interface. + (public class MyFoo implements IFoo) This probably happens in another + module that depends on the IFoo API.
              3. +
            3. The module declaring MyFoo includes a file named + src/main/resources/META-INF/services/IFoo. It contains the word MyFoo + on a single line. If you have multiple IFoo implementations in your + module, list them all, one per line.
              4. +
            4. At runtime, a class that needs a concrete implementation of IFoo could + run: IFoo fooInstance = Lookup.get(IFoo.class).lookup();.
              5. +
            5. You will get an unchecked NoSuchProviderException if no suitable IFoo + instance could be found.
              6. +
            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  Iterator<T>iterator() + +
            +           
            +abstract  Iterator<T>iterator(Map<String,String> runtimeHints) + +
            +           
            +abstract  Tlookup() + +
            +          Lookup a provider instance for the specified clazz and return an instance.
            +abstract  Tlookup(Map<String,String> runtimeHints) + +
            +          Lookup a provider instance for the specified clazz and return an instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +lookup

            +
            +public abstract T lookup()
            +
            +
            Lookup a provider instance for the specified clazz and return an instance. +

            +

            +
            +
            +
            + +
            Returns:
            a provider instance for clazz we discover. +
            Throws: +
            NoSuchProviderException - if no runtime provider for the interface + can be found.
            +
            +
            +
            + +

            +lookup

            +
            +public abstract T lookup(Map<String,String> runtimeHints)
            +
            +
            Lookup a provider instance for the specified clazz and return an instance. +

            +

            +
            +
            +
            +
            Parameters:
            runtimeHints - parameters that may be used by Lookup instances or their + targets to evaluate the best provider to return. +
            Returns:
            a provider instance for clazz we discover. +
            Throws: +
            NoSuchProviderException - if no runtime provider for the interface + can be found.
            +
            +
            +
            + +

            +iterator

            +
            +public abstract Iterator<T> iterator()
            +
            +
            +
            Specified by:
            iterator in interface Iterable<T>
            +
            +
            + +
            Returns:
            an iterator of all provider instances for the specified class.
            +
            +
            +
            + +

            +iterator

            +
            +public abstract Iterator<T> iterator(Map<String,String> runtimeHints)
            +
            +
            +
            +
            +
            +
            Parameters:
            runtimeHints - parameters that may be used by Lookup instances or their + targets to evaluate the best way to order the returned providers. +
            Returns:
            an iterator of all provider instances for the specified class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/Lookups.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/Lookups.html new file mode 100644 index 00000000..42848553 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/Lookups.html @@ -0,0 +1,341 @@ + + + + + + + +Lookups (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class Lookups

            +
            +java.lang.Object
+  extended by org.kiji.delegation.Lookups
+
            +
            +
            +
            @ApiAudience.Framework
+public final class Lookups
            extends Object
            + + +

            +Factory methods that create Lookup instances that allow + you to lookup provider implementations of interfaces or abstract classes. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<T> Lookup<T>
            +            		get(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T> Lookup<T>
            +            		get(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		getPriority(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		getPriority(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static <T> Lookup<T> get(Class<T> clazz)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for. +
            Returns:
            a new Lookup instance that uses the current thread's context classloader.
            +
            +
            +
            + +

            +get

            +
            +public static <T> Lookup<T> get(Class<T> clazz,
+                                ClassLoader classLoader)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for.
            classLoader - the classloader to use to resolve service lookups. +
            Returns:
            a new Lookup instance that uses the specified classloader.
            +
            +
            +
            + +

            +getPriority

            +
            +public static <T extends PriorityProvider> Lookup<T> getPriority(Class<T> clazz)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. See PriorityProvider. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for. +
            Returns:
            a new Lookup instance that uses the current thread's context classloader.
            +
            +
            +
            + +

            +getPriority

            +
            +public static <T extends PriorityProvider> Lookup<T> getPriority(Class<T> clazz,
+                                                                 ClassLoader classLoader)
            +
            +
            Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider. See PriorityProvider. +

            +

            +
            Type Parameters:
            T - the type that this Lookup instance should provide.
            Parameters:
            clazz - the abstract class or interface to lookup a provider for.
            classLoader - the classloader to use to resolve service lookups. +
            Returns:
            a new Lookup instance that uses the current thread's context classloader.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/NoSuchProviderException.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/NoSuchProviderException.html new file mode 100644 index 00000000..8a88a885 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/NoSuchProviderException.html @@ -0,0 +1,213 @@ + + + + + + + +NoSuchProviderException (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class NoSuchProviderException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.delegation.NoSuchProviderException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NoSuchProviderException
            extends RuntimeException
            + + +

            +Thrown by a Lookup object when we cannot find a provider + for the specified interface or abstract class. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

            + +

            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/Priority.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/Priority.html new file mode 100644 index 00000000..0a430ef0 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/Priority.html @@ -0,0 +1,383 @@ + + + + + + + +Priority (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Class Priority

            +
            +java.lang.Object
+  extended by org.kiji.delegation.Priority
+
            +
            +
            +
            @ApiAudience.Framework
+public final class Priority
            extends Object
            + + +

            +Canonical priority levels for use by PriorityProvider implementations. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static intDISABLED + +
            +          A priority value indicating that a provider should not be used.
            +static intHIGH + +
            +          A priority level indicating that a service provider is better-suited + than most providers indicating "Normal" priority.
            +static intLOW + +
            +          A priority level indicating that a service provider can fulfill the + runtime requirements, but should defer to other providers advertising + normal priority level and capability.
            +static intMAX + +
            +          Maximum legal priority value.
            +static intMIN + +
            +          The lowest priority that could still be active.
            +static intNORMAL + +
            +          The priority level that most instances should return.
            +static intVERY_HIGH + +
            +          A priority level indicating that this provider should be preferred + except in extenuating circumstances.
            +static intVERY_LOW + +
            +          A priority level indicating that a service provider has minimal + ability to fulfill the runtime requirements, and may only do so partially.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +MAX

            +
            +public static final int MAX
            +
            +
            Maximum legal priority value. Trumps all other providers. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +VERY_HIGH

            +
            +public static final int VERY_HIGH
            +
            +
            A priority level indicating that this provider should be preferred + except in extenuating circumstances. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +HIGH

            +
            +public static final int HIGH
            +
            +
            A priority level indicating that a service provider is better-suited + than most providers indicating "Normal" priority. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +NORMAL

            +
            +public static final int NORMAL
            +
            +
            The priority level that most instances should return. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +LOW

            +
            +public static final int LOW
            +
            +
            A priority level indicating that a service provider can fulfill the + runtime requirements, but should defer to other providers advertising + normal priority level and capability. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +VERY_LOW

            +
            +public static final int VERY_LOW
            +
            +
            A priority level indicating that a service provider has minimal + ability to fulfill the runtime requirements, and may only do so partially. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +MIN

            +
            +public static final int MIN
            +
            +
            The lowest priority that could still be active. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DISABLED

            +
            +public static final int DISABLED
            +
            +
            A priority value indicating that a provider should not be used. +

            +

            +
            See Also:
            Constant Field Values
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/PriorityProvider.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/PriorityProvider.html new file mode 100644 index 00000000..ab0dbbb8 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/PriorityProvider.html @@ -0,0 +1,240 @@ + + + + + + + +PriorityProvider (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.delegation +
            +Interface PriorityProvider

            +
            +
            +
            @ApiAudience.Public
+public interface PriorityProvider
            + + +

            +A service that can be selected based on its relative priority. + +

            Lookup is often used to select a "factory service" that actually + creates an instance of a real class. This level of indirection is often + necessary if you do not want to actually classload multiple providers of the + "true" service into the same JVM, because they may both compete for resources, + or trigger further classloading of incompatible class definitions.

            + +

            Where one or more factory services may all potentially create incompatible + versions of a true interface, an arbitration mechanism (called a priority) + is used to select the best factory service available at runtime.

            + +

            This interface is used by the PriorityLookup implementation. + All factory service implementations (which implement PriorityProvider) + are loaded by the PriorityLookup instance; they are each queried for their + priority -- how confident they are that they can provide the best implementation + for the current runtime environment. The instance that volunteers the highest priority + is then selected. This factory instance can then classload and create the true + service instance using its own API.

            +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + intgetPriority(Map<String,String> runtimeHints) + +
            +          Returns the priority that this instance believes it has.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getPriority

            +
            +int getPriority(Map<String,String> runtimeHints)
            +
            +
            Returns the priority that this instance believes it has. Higher priorities + indicate a better fit for the current runtime environment. The instance + may inspect as much of the runtime environment as it can to establish its fitness; + classes may also provide a collection of runtime "hints" that describe the + environment more precisely. + +

            A priority of 0 or less indicates that the instance will not be used. The + highest priority instance is used.

            +

            +

            +
            Parameters:
            runtimeHints - hints provided by the client that establish the parameters + of the current runtime environment. +
            Returns:
            a value greater than or equal to zero indicating the confidence that this + is the best instance to use.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/Lookup.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/Lookup.html new file mode 100644 index 00000000..23008b2e --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/Lookup.html @@ -0,0 +1,230 @@ + + + + + + + +Uses of Class org.kiji.delegation.Lookup (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.Lookup

            +
            + + + + + +
            +Uses of Lookup in org.kiji.delegation
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.delegation that return Lookup
            +static + + + + +
            +<T> Lookup<T>
            +            		Lookups.get(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T> Lookup<T>
            +            		Lookups.get(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/Lookups.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/Lookups.html new file mode 100644 index 00000000..d3b3d5c7 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/Lookups.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.delegation.Lookups (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.Lookups

            +
            +No usage of org.kiji.delegation.Lookups +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/NoSuchProviderException.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/NoSuchProviderException.html new file mode 100644 index 00000000..06d90a1b --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/NoSuchProviderException.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.delegation.NoSuchProviderException (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.NoSuchProviderException

            +
            +No usage of org.kiji.delegation.NoSuchProviderException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/Priority.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/Priority.html new file mode 100644 index 00000000..1e834310 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/Priority.html @@ -0,0 +1,143 @@ + + + + + + + +Uses of Class org.kiji.delegation.Priority (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.delegation.Priority

            +
            +No usage of org.kiji.delegation.Priority +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/PriorityProvider.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/PriorityProvider.html new file mode 100644 index 00000000..c4a6de85 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/class-use/PriorityProvider.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Interface org.kiji.delegation.PriorityProvider (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.delegation.PriorityProvider

            +
            + + + + + +
            +Uses of PriorityProvider in org.kiji.delegation
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.delegation with type parameters of type PriorityProvider
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +static + + + + +
            +<T extends PriorityProvider> +
            +Lookup<T>
            +            		Lookups.getPriority(Class<T> clazz, + ClassLoader classLoader) + +
            +          Creates a lookup instance that can resolve providers for the specified class + or interface, by using a priority method to establish which is the best + provider.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-frame.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-frame.html new file mode 100644 index 00000000..7e9550a6 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-frame.html @@ -0,0 +1,59 @@ + + + + + + + +org.kiji.delegation (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.delegation + + + + +
            +Interfaces  + +
            +PriorityProvider
            + + + + + + +
            +Classes  + +
            +Lookup +
            +Lookups +
            +Priority
            + + + + + + +
            +Exceptions  + +
            +NoSuchProviderException
            + + + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-summary.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-summary.html new file mode 100644 index 00000000..a40157b1 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-summary.html @@ -0,0 +1,218 @@ + + + + + + + +org.kiji.delegation (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.delegation +

            +A lightweight service loading library based on java.util.ServiceLoader that + can be used by Kiji framework modules for dynamically loading different + service provider implementations at runtime. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            PriorityProviderA service that can be selected based on its relative priority.
            +  + +

            + + + + + + + + + + + + + + + + + +
            +Class Summary
            Lookup<T>Allows you to lookup provider implementations of interfaces or abstract classes.
            LookupsFactory methods that create Lookup instances that allow + you to lookup provider implementations of interfaces or abstract classes.
            PriorityCanonical priority levels for use by PriorityProvider implementations.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            NoSuchProviderExceptionThrown by a Lookup object when we cannot find a provider + for the specified interface or abstract class.
            +  + +

            +

            +Package org.kiji.delegation Description +

            + +

            +A lightweight service loading library based on java.util.ServiceLoader that + can be used by Kiji framework modules for dynamically loading different + service provider implementations at runtime. This delegates functionality + required by "upstream" modules to downstream runtime implementations. + +

            The main client class is Lookup, + which provides an API for lookups, as well as factory methods for + lookup service implementations.

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-tree.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-tree.html new file mode 100644 index 00000000..d2ab14df --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.delegation Class Hierarchy (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.delegation +

            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-use.html b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-use.html new file mode 100644 index 00000000..be06aae5 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/org/kiji/delegation/package-use.html @@ -0,0 +1,162 @@ + + + + + + + +Uses of Package org.kiji.delegation (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.delegation

            +
            + + + + + + + + + + + +
            +Classes in org.kiji.delegation used by org.kiji.delegation
            Lookup + +
            +          Allows you to lookup provider implementations of interfaces or abstract classes.
            PriorityProvider + +
            +          A service that can be selected based on its relative priority.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/overview-tree.html b/apidocs/kiji-delegation/1.0.0-rc4/overview-tree.html new file mode 100644 index 00000000..f8290388 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/overview-tree.html @@ -0,0 +1,164 @@ + + + + + + + +Class Hierarchy (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.kiji.delegation
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/package-list b/apidocs/kiji-delegation/1.0.0-rc4/package-list new file mode 100644 index 00000000..4e58ba79 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/package-list @@ -0,0 +1 @@ +org.kiji.delegation diff --git a/apidocs/kiji-delegation/1.0.0-rc4/resources/inherit.gif b/apidocs/kiji-delegation/1.0.0-rc4/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/kiji-delegation/1.0.0-rc4/resources/inherit.gif differ diff --git a/apidocs/kiji-delegation/1.0.0-rc4/serialized-form.html b/apidocs/kiji-delegation/1.0.0-rc4/serialized-form.html new file mode 100644 index 00000000..96b307da --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/serialized-form.html @@ -0,0 +1,162 @@ + + + + + + + +Serialized Form (Kiji Dynamic Binding Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Serialized Form

            +
            +
            + + + + + +
            +Package org.kiji.delegation
            + +

            + + + + + +
            +Class org.kiji.delegation.NoSuchProviderException extends RuntimeException implements Serializable
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + +
            Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-delegation/1.0.0-rc4/stylesheet.css b/apidocs/kiji-delegation/1.0.0-rc4/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/kiji-delegation/1.0.0-rc4/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/allclasses-frame.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/allclasses-frame.html new file mode 100644 index 00000000..6970e490 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/allclasses-frame.html @@ -0,0 +1,108 @@ + + + + + + + +All Classes (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            AllVersionsSingleInputProducer +
            +AvroReducer +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +CommonLogBulkImporter +
            +CommonLogParser +
            +CommonLogParser.Field +
            +ConfiguredRegexProducer +
            +CSVBulkImporter +
            +CSVParser +
            +DescribedInputTextBulkImporter +
            +DoubleSumReducer +
            +EmailDomainCountGatherer +
            +EmailDomainCountGatherJob +
            +EmailDomainPopularityJob +
            +EmailDomainPopularityJob.DescendingIntWritableComparator +
            +EmailDomainProduceJob +
            +EmailDomainProducer +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +IdentityProducer +
            +IntSumReducer +
            +InvalidTableImportDescriptorException +
            +InvertCountMapper +
            +JSONBulkImporter +
            +KeyPassThroughReducer +
            +KijiTableImportDescriptor +
            +KijiTableImportDescriptor.FamilyLayout +
            +KijiTableImportDescriptorRecords +
            +KijiTableImportDescriptorRecords.Callback +
            +LongSumReducer +
            +MapTypeDelimitedFileGatherer +
            +News20BulkImporter +
            +RegexProducer +
            +SingleInputProducer +
            +TableImportDescriptorDesc +
            +TableImportDescriptorDesc.Builder +
            +TextFlatteningMapper +
            +TextListReducer +
            +
            + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/allclasses-noframe.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/allclasses-noframe.html new file mode 100644 index 00000000..61f6376d --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/allclasses-noframe.html @@ -0,0 +1,108 @@ + + + + + + + +All Classes (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            AllVersionsSingleInputProducer +
            +AvroReducer +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +CommonLogBulkImporter +
            +CommonLogParser +
            +CommonLogParser.Field +
            +ConfiguredRegexProducer +
            +CSVBulkImporter +
            +CSVParser +
            +DescribedInputTextBulkImporter +
            +DoubleSumReducer +
            +EmailDomainCountGatherer +
            +EmailDomainCountGatherJob +
            +EmailDomainPopularityJob +
            +EmailDomainPopularityJob.DescendingIntWritableComparator +
            +EmailDomainProduceJob +
            +EmailDomainProducer +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +IdentityProducer +
            +IntSumReducer +
            +InvalidTableImportDescriptorException +
            +InvertCountMapper +
            +JSONBulkImporter +
            +KeyPassThroughReducer +
            +KijiTableImportDescriptor +
            +KijiTableImportDescriptor.FamilyLayout +
            +KijiTableImportDescriptorRecords +
            +KijiTableImportDescriptorRecords.Callback +
            +LongSumReducer +
            +MapTypeDelimitedFileGatherer +
            +News20BulkImporter +
            +RegexProducer +
            +SingleInputProducer +
            +TableImportDescriptorDesc +
            +TableImportDescriptorDesc.Builder +
            +TextFlatteningMapper +
            +TextListReducer +
            +
            + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/constant-values.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/constant-values.html new file mode 100644 index 00000000..f509e508 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/constant-values.html @@ -0,0 +1,295 @@ + + + + + + + +Constant Field Values (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents + + + + + + +
            +org.kiji.*
            + +

            + + + + + + + + + + + + + + + + + +
            org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter
            +public static final StringCONF_FIELD_DELIMITER"kiji.import.text.field.separator"
            +public static final StringCONF_INPUT_HEADER_ROW"kiji.import.text.column.header_row"
            + +

            + +

            + + + + + + + + + + + + + + + + + +
            org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
            +public static final StringCONF_FILE"kiji.import.text.input.descriptor.path"
            +public static final StringCONF_LOG_RATE"kiji.import.text.log.rate"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.mapreduce.lib.examples.News20BulkImporter
            +public static final StringARTICLE_NAME_QUALIFIER"name"
            +public static final StringCATEGORY_QUALIFIER"category"
            +public static final StringFAMILY"info"
            +public static final StringRAW_ARTICLE_QUALIFIER"raw_article"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer
            +public static final StringCONF_INPUT_COLUMN"kiji.regexproducer.input.column"
            +public static final StringCONF_OUTPUT_COLUMN"kiji.regexproducer.output.column"
            +public static final StringCONF_REGEX"kiji.regexproducer.regex"
            + +

            + +

            + + + + + + + + + + + + + + + + + +
            org.kiji.mapreduce.lib.produce.IdentityProducer
            +public static final StringCONF_INPUT"identity.producer.input"
            +public static final StringCONF_OUTPUT"identity.producer.output"
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/deprecated-list.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/deprecated-list.html new file mode 100644 index 00000000..bc1ac704 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/deprecated-list.html @@ -0,0 +1,202 @@ + + + + + + + +Deprecated List (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Deprecated Fields
            org.kiji.mapreduce.lib.avro.FamilyDesc.columns +
            +           
            org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.entityIdSource +
            +           
            org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.families +
            +           
            org.kiji.mapreduce.lib.avro.FamilyDesc.name +
            +           
            org.kiji.mapreduce.lib.avro.ColumnDesc.name +
            +           
            org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.name +
            +           
            org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.overrideTimestampSource +
            +           
            org.kiji.mapreduce.lib.avro.ColumnDesc.source +
            +           
            org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.version +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/help-doc.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/help-doc.html new file mode 100644 index 00000000..6a3cfe16 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/help-doc.html @@ -0,0 +1,224 @@ + + + + + + + +API Help (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Overview

            +
            + +

            +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

            +

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/index-all.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/index-all.html new file mode 100644 index 00000000..9e767c34 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/index-all.html @@ -0,0 +1,1042 @@ + + + + + + + +Index (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +A B C D E F G H I J K L M N O P R S T V W
            +

            +A

            +
            +
            AllVersionsSingleInputProducer - Class in org.kiji.mapreduce.lib.produce
            Base class for producers that read all versions from a single input column.
            AllVersionsSingleInputProducer() - +Constructor for class org.kiji.mapreduce.lib.produce.AllVersionsSingleInputProducer +
              +
            ARTICLE_NAME_QUALIFIER - +Static variable in class org.kiji.mapreduce.lib.examples.News20BulkImporter +
            Qualifier storing the article name. +
            AvroReducer<K,V,T> - Class in org.kiji.mapreduce.lib.reduce
            Base class for reducers used with AvroOutputFormat to write Avro container files.
            AvroReducer() - +Constructor for class org.kiji.mapreduce.lib.reduce.AvroReducer +
              +
            +
            +

            +B

            +
            +
            build() - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc.Builder +
              +
            build() - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc.Builder +
              +
            build() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
              +
            +
            +

            +C

            +
            +
            CATEGORY_QUALIFIER - +Static variable in class org.kiji.mapreduce.lib.examples.News20BulkImporter +
            Qualifier storing the article category. +
            cleanup(KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Subclasses should implement the DescribedInputTextBulkImporter.cleanupImporter(KijiTableContext) method instead. +
            cleanupImporter(KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Extensible version of KijiBulkImporter.cleanup(org.kiji.mapreduce.KijiTableContext) for subclasses of + DescribedInputTextBulkImporter. +
            clearColumns() - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc.Builder +
            Clears the value of the 'columns' field +
            clearEntityIdSource() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Clears the value of the 'entityIdSource' field +
            clearFamilies() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Clears the value of the 'families' field +
            clearName() - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Clears the value of the 'name' field +
            clearOverrideTimestampSource() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Clears the value of the 'overrideTimestampSource' field +
            clearSource() - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc.Builder +
            Clears the value of the 'source' field +
            clearVersion() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Clears the value of the 'version' field +
            ColumnDesc - Class in org.kiji.mapreduce.lib.avro
             
            ColumnDesc() - +Constructor for class org.kiji.mapreduce.lib.avro.ColumnDesc +
            Default constructor. +
            ColumnDesc(String, String) - +Constructor for class org.kiji.mapreduce.lib.avro.ColumnDesc +
            All-args constructor. +
            ColumnDesc.Builder - Class in org.kiji.mapreduce.lib.avro
            RecordBuilder for ColumnDesc instances.
            columns - +Variable in class org.kiji.mapreduce.lib.avro.FamilyDesc +
            Deprecated.  +
            CommonLogBulkImporter - Class in org.kiji.mapreduce.lib.bulkimport
            Bulk importer that takes lines from an NCSA/Apache common logs and can produce a row for each + entry in the log file.
            CommonLogBulkImporter() - +Constructor for class org.kiji.mapreduce.lib.bulkimport.CommonLogBulkImporter +
              +
            CommonLogParser - Class in org.kiji.mapreduce.lib.util
            Parser that extracts fields from the NCSA Common Log Format.
            CommonLogParser.Field - Enum in org.kiji.mapreduce.lib.util
            Fields that can be extracted via the Common Log Format.
            compare(byte[], int, int, byte[], int, int) - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob.DescendingIntWritableComparator +
              +
            CONF_FIELD_DELIMITER - +Static variable in class org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter +
            Configuration variable that specifies the cell value separator in the text input files. +
            CONF_FILE - +Static variable in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Location of writer layout file. +
            CONF_INPUT - +Static variable in class org.kiji.mapreduce.lib.produce.IdentityProducer +
              +
            CONF_INPUT_COLUMN - +Static variable in class org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer +
              +
            CONF_INPUT_HEADER_ROW - +Static variable in class org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter +
            Configuration variable for a header row containing delimited string of names of fields. +
            CONF_LOG_RATE - +Static variable in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
              +
            CONF_OUTPUT - +Static variable in class org.kiji.mapreduce.lib.produce.IdentityProducer +
              +
            CONF_OUTPUT_COLUMN - +Static variable in class org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer +
              +
            CONF_REGEX - +Static variable in class org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer +
              +
            ConfiguredRegexProducer - Class in org.kiji.mapreduce.lib.produce
            A regex producer that is ready to use "out of the box." All you + need to do is specify a couple of configuration values.
            ConfiguredRegexProducer() - +Constructor for class org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer +
              +
            convert(KijiColumnName, String) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Converts the value into an object of the type associated with the specified column. +
            createFromEffectiveJson(InputStream) - +Static method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
            Loads a table import mapping from the specified JSON text. +
            createFromEffectiveJsonResource(String) - +Static method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
            Loads a table import mapping from the specified resource as JSON. +
            CSVBulkImporter - Class in org.kiji.mapreduce.lib.bulkimport
            Bulk importer that handles comma separated files.
            CSVBulkImporter() - +Constructor for class org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter +
              +
            CSVParser - Class in org.kiji.mapreduce.lib.util
            Parser that extracts fields from RFC 4180 (http://tools.ietf.org/html/rfc4180) compliant + CSV and TSV lines of text.
            +
            +

            +D

            +
            +
            DescribedInputTextBulkImporter - Class in org.kiji.mapreduce.lib.bulkimport
            DescribedInputTextBulkImporter is an abstract class that provides methods to bulk importers for + mapping from source fields in the import lines to destination Kiji columns.
            DescribedInputTextBulkImporter() - +Constructor for class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
              +
            DoubleSumReducer<K> - Class in org.kiji.mapreduce.lib.reduce
            A KijiReducer that works of key/value pairs where the value is + an DoubleWritable.
            DoubleSumReducer() - +Constructor for class org.kiji.mapreduce.lib.reduce.DoubleSumReducer +
              +
            +
            +

            +E

            +
            +
            EmailDomainCountGatherer - Class in org.kiji.mapreduce.lib.examples
            Computes the domain from the email, and outputs it as the key with an int count of 1.
            EmailDomainCountGatherer() - +Constructor for class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer +
              +
            EmailDomainCountGatherJob - Class in org.kiji.mapreduce.lib.examples
            A program that runs the EmailDomainCountGatherer + over a Kiji table.
            EmailDomainCountGatherJob() - +Constructor for class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherJob +
              +
            EmailDomainPopularityJob - Class in org.kiji.mapreduce.lib.examples
            A program that generates an Avro file of email domains sorted by decreasing popularity.
            EmailDomainPopularityJob() - +Constructor for class org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob +
              +
            EmailDomainPopularityJob.DescendingIntWritableComparator - Class in org.kiji.mapreduce.lib.examples
            A comparator that sorts IntWritables in descending order.
            EmailDomainPopularityJob.DescendingIntWritableComparator() - +Constructor for class org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob.DescendingIntWritableComparator +
              +
            EmailDomainProduceJob - Class in org.kiji.mapreduce.lib.examples
            A program that runs the EmailDomainProducer + over a Kiji table.
            EmailDomainProduceJob() - +Constructor for class org.kiji.mapreduce.lib.examples.EmailDomainProduceJob +
              +
            EmailDomainProducer - Class in org.kiji.mapreduce.lib.examples
            Extracts the domain of a user by reading their email address from the info:email column.
            EmailDomainProducer() - +Constructor for class org.kiji.mapreduce.lib.examples.EmailDomainProducer +
              +
            entityIdSource - +Variable in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Deprecated.  +
            equals(Object) - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
            +
            +
            +

            +F

            +
            +
            families - +Variable in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Deprecated.  +
            FAMILY - +Static variable in class org.kiji.mapreduce.lib.examples.News20BulkImporter +
            The family to write input data to. +
            FamilyDesc - Class in org.kiji.mapreduce.lib.avro
             
            FamilyDesc() - +Constructor for class org.kiji.mapreduce.lib.avro.FamilyDesc +
            Default constructor. +
            FamilyDesc(String, List<ColumnDesc>) - +Constructor for class org.kiji.mapreduce.lib.avro.FamilyDesc +
            All-args constructor. +
            FamilyDesc.Builder - Class in org.kiji.mapreduce.lib.avro
            RecordBuilder for FamilyDesc instances.
            +
            +

            +G

            +
            +
            gather(KijiRowData, GathererContext) - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer +
            +
            gather(KijiRowData, GathererContext) - +Method in class org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer +
            Outputs flattened data without schema definitions. +
            get(int) - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc +
              +
            get(int) - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc +
              +
            get(int) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
              +
            get() - +Static method in class org.kiji.mapreduce.lib.util.CommonLogParser +
              +
            getAvroKeyWriterSchema() - +Method in class org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer +
            +
            getAvroValueWriterSchema() - +Method in class org.kiji.mapreduce.lib.examples.TextListReducer +
            +
            getColumnMap() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout +
              +
            getColumnNameSourceMap() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
              +
            getColumns() - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc.Builder +
            Gets the value of the 'columns' field +
            getColumns() - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc +
            Gets the value of the 'columns' field. +
            getColumns() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout +
              +
            getConf() - +Method in class org.kiji.mapreduce.lib.examples.TextListReducer +
            +
            getConf() - +Method in class org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer +
            +
            getDataRequest() - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer +
            +
            getDataRequest() - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainProducer +
            +
            getDataRequest() - +Method in class org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer +
              +
            getDataRequest() - +Method in class org.kiji.mapreduce.lib.produce.AllVersionsSingleInputProducer +
              +
            getDataRequest() - +Method in class org.kiji.mapreduce.lib.produce.IdentityProducer +
            +
            getDataRequest() - +Method in class org.kiji.mapreduce.lib.produce.SingleInputProducer +
            +
            getDestinationColumns() - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
              +
            getEntityId(List<String>, KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter +
            Generates the entity id for this imported line using the source from the import descriptor. +
            getEntityIdSource() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Gets the value of the 'entityIdSource' field +
            getEntityIdSource() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Gets the value of the 'entityIdSource' field. +
            getEntityIdSource() - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
              +
            getEntityIdSource() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
              +
            getFamilies() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Gets the value of the 'families' field +
            getFamilies() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Gets the value of the 'families' field. +
            getFamily() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout.ColumnLayout +
              +
            getInputColumn() - +Method in class org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer +
              +
            getInputColumn() - +Method in class org.kiji.mapreduce.lib.produce.SingleInputProducer +
              +
            getInputColumnName() - +Method in class org.kiji.mapreduce.lib.produce.SingleInputProducer +
              +
            getName() - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout.ColumnLayout +
              +
            getName() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout +
              +
            getName() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
              +
            getOutputColumn() - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainProducer +
            +
            getOutputColumn() - +Method in class org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer +
              +
            getOutputColumn() - +Method in class org.kiji.mapreduce.lib.produce.IdentityProducer +
            +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer +
            +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.lib.examples.InvertCountMapper +
            +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.lib.examples.TextListReducer +
            +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer +
              +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.lib.map.TextFlatteningMapper +
            +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.lib.reduce.AvroReducer +
            +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.lib.examples.InvertCountMapper +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.lib.examples.TextListReducer +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer +
              +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.lib.map.TextFlatteningMapper +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.lib.reduce.AvroReducer +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.lib.reduce.DoubleSumReducer +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.lib.reduce.IntSumReducer +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.lib.reduce.LongSumReducer +
            +
            getOverrideTimestampSource() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Gets the value of the 'overrideTimestampSource' field +
            getOverrideTimestampSource() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Gets the value of the 'overrideTimestampSource' field. +
            getOverrideTimestampSource() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
              +
            getRegex() - +Method in class org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer +
              +
            getRegex() - +Method in class org.kiji.mapreduce.lib.produce.RegexProducer +
              +
            getSchema() - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc +
              +
            getSchema() - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc +
              +
            getSchema() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
              +
            getSource() - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc.Builder +
            Gets the value of the 'source' field +
            getSource() - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc +
            Gets the value of the 'source' field. +
            getSource(KijiColumnName) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Returns the source for the specified column, or null if the specified column is not a + destination column for this importer. +
            getSource() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout.ColumnLayout +
              +
            getTimestamp(List<String>) - +Method in class org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter +
            Generates the timestamp for this imported line using the source from the import descriptor. +
            getTimestampSource() - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
              +
            getVersion() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Gets the value of the 'version' field +
            getVersion() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Gets the value of the 'version' field. +
            +
            +

            +H

            +
            +
            hasColumns() - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc.Builder +
            Checks whether the 'columns' field has been set +
            hasEntityIdSource() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Checks whether the 'entityIdSource' field has been set +
            hasFamilies() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Checks whether the 'families' field has been set +
            hashCode() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
            +
            hasName() - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Checks whether the 'name' field has been set +
            hasOverrideTimestampSource() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Checks whether the 'overrideTimestampSource' field has been set +
            hasSource() - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc.Builder +
            Checks whether the 'source' field has been set +
            hasVersion() - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Checks whether the 'version' field has been set +
            +
            +

            +I

            +
            +
            IdentityProducer - Class in org.kiji.mapreduce.lib.produce
            This producer copies data from one family or column to another without modification.
            IdentityProducer() - +Constructor for class org.kiji.mapreduce.lib.produce.IdentityProducer +
              +
            incomplete(Text, KijiTableContext, String) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Post-processes incomplete lines(Logging, keeping count, etc). +
            IntSumReducer<K> - Class in org.kiji.mapreduce.lib.reduce
            A KijiReducer that works on key/value pairs where the value is + an IntWritable.
            IntSumReducer() - +Constructor for class org.kiji.mapreduce.lib.reduce.IntSumReducer +
              +
            InvalidTableImportDescriptorException - Exception in org.kiji.mapreduce.lib.bulkimport
            Thrown when an invalid Kiji table import descriptor is encountered.
            InvalidTableImportDescriptorException(String) - +Constructor for exception org.kiji.mapreduce.lib.bulkimport.InvalidTableImportDescriptorException +
            Creates a new InvalidTableImportDescriptorException with the specified reason. +
            InvertCountMapper - Class in org.kiji.mapreduce.lib.examples
            A map that inverts its (Text, IntWritable) records into (IntWritable, Text) records.
            InvertCountMapper() - +Constructor for class org.kiji.mapreduce.lib.examples.InvertCountMapper +
              +
            isOverrideTimestamp() - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
              +
            +
            +

            +J

            +
            +
            JSONBulkImporter - Class in org.kiji.mapreduce.lib.bulkimport
            Bulk importer that handles JSON files.
            JSONBulkImporter() - +Constructor for class org.kiji.mapreduce.lib.bulkimport.JSONBulkImporter +
              +
            +
            +

            +K

            +
            +
            KeyPassThroughReducer<K,INVALUE,OUTVALUE> - Class in org.kiji.mapreduce.lib.reduce
            An abstract KijiReducer to encapsulate common functionality among + reducers that pass the key from the map phase through unchanged.
            KeyPassThroughReducer() - +Constructor for class org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer +
              +
            KijiTableImportDescriptor - Class in org.kiji.mapreduce.lib.bulkimport
            Mapping of input schema to Kiji table layouts for bulk importers.
            KijiTableImportDescriptor(TableImportDescriptorDesc) - +Constructor for class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
            Constructs a KijiTableImportDescriptor from an Avro descriptor. +
            KijiTableImportDescriptor.FamilyLayout - Class in org.kiji.mapreduce.lib.bulkimport
            Concrete layout of a family.
            KijiTableImportDescriptor.FamilyLayout(FamilyDesc) - +Constructor for class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout +
            Builds a new family layout instance. +
            KijiTableImportDescriptor.FamilyLayout.ColumnLayout - Class in org.kiji.mapreduce.lib.bulkimport
            Concrete layout of a column.
            KijiTableImportDescriptor.FamilyLayout.ColumnLayout(ColumnDesc) - +Constructor for class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout.ColumnLayout +
            Builds a new column layout instance from a descriptor. +
            KijiTableImportDescriptorRecords - Interface in org.kiji.mapreduce.lib.avro
             
            KijiTableImportDescriptorRecords.Callback - Interface in org.kiji.mapreduce.lib.avro
             
            +
            +

            +L

            +
            +
            LongSumReducer<K> - Class in org.kiji.mapreduce.lib.reduce
            A KijiReducer that works of key/value pairs where the value is + an LongWritable.
            LongSumReducer() - +Constructor for class org.kiji.mapreduce.lib.reduce.LongSumReducer +
              +
            +
            +

            +M

            +
            +
            main(String[]) - +Static method in class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherJob +
            The program's entry point. +
            main(String[]) - +Static method in class org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob +
            The program's entry point. +
            main(String[]) - +Static method in class org.kiji.mapreduce.lib.examples.EmailDomainProduceJob +
            The program's entry point. +
            map(Text, IntWritable, Mapper<Text, IntWritable, IntWritable, Text>.Context) - +Method in class org.kiji.mapreduce.lib.examples.InvertCountMapper +
            +
            map(Text, Text, Mapper<Text, Text, Text, Text>.Context) - +Method in class org.kiji.mapreduce.lib.map.TextFlatteningMapper +
            Converts The Bytes stored in fileContents to a single String with all new-line + characters removed. +
            MapTypeDelimitedFileGatherer - Class in org.kiji.mapreduce.lib.gather
            Gatherer to flatten a map-type family into a delimited file in HDFS.
            MapTypeDelimitedFileGatherer() - +Constructor for class org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer +
              +
            +
            +

            +N

            +
            +
            name - +Variable in class org.kiji.mapreduce.lib.avro.ColumnDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.mapreduce.lib.avro.FamilyDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Deprecated.  +
            newBuilder() - +Static method in class org.kiji.mapreduce.lib.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder +
            newBuilder(ColumnDesc.Builder) - +Static method in class org.kiji.mapreduce.lib.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder by copying an existing Builder +
            newBuilder(ColumnDesc) - +Static method in class org.kiji.mapreduce.lib.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance +
            newBuilder() - +Static method in class org.kiji.mapreduce.lib.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder +
            newBuilder(FamilyDesc.Builder) - +Static method in class org.kiji.mapreduce.lib.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder by copying an existing Builder +
            newBuilder(FamilyDesc) - +Static method in class org.kiji.mapreduce.lib.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance +
            newBuilder() - +Static method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Creates a new TableImportDescriptorDesc RecordBuilder +
            newBuilder(TableImportDescriptorDesc.Builder) - +Static method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Creates a new TableImportDescriptorDesc RecordBuilder by copying an existing Builder +
            newBuilder(TableImportDescriptorDesc) - +Static method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Creates a new TableImportDescriptorDesc RecordBuilder by copying an existing TableImportDescriptorDesc instance +
            News20BulkImporter - Class in org.kiji.mapreduce.lib.examples
            A bulk importer that takes qualified_path/raw_article key/value pairs, + and loads these into kiji.
            News20BulkImporter() - +Constructor for class org.kiji.mapreduce.lib.examples.News20BulkImporter +
              +
            +
            +

            +O

            +
            +
            org.kiji.mapreduce.lib.avro - package org.kiji.mapreduce.lib.avro
             
            org.kiji.mapreduce.lib.bulkimport - package org.kiji.mapreduce.lib.bulkimport
            Bulk importers for KijiMR.
            org.kiji.mapreduce.lib.examples - package org.kiji.mapreduce.lib.examples
            Simple examples of using the KijiMR library API to write gatherers, producers, + and importers.
            org.kiji.mapreduce.lib.gather - package org.kiji.mapreduce.lib.gather
            Gatherers for KijiMR.
            org.kiji.mapreduce.lib.map - package org.kiji.mapreduce.lib.map
            Mappers for KijiMR.
            org.kiji.mapreduce.lib.produce - package org.kiji.mapreduce.lib.produce
            Producers for KijiMR.
            org.kiji.mapreduce.lib.reduce - package org.kiji.mapreduce.lib.reduce
            Reducers for KijiMR.
            org.kiji.mapreduce.lib.util - package org.kiji.mapreduce.lib.util
            Utility classes (for example, parsers) which may be useful to clients when running MapReduce + jobs that use the Kiji system.
            overrideTimestampSource - +Variable in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Deprecated.  +
            +
            +

            +P

            +
            +
            parseCommonLog(String) - +Method in class org.kiji.mapreduce.lib.util.CommonLogParser +
            Parses the input text with the specified delimiter. +
            parseCSV(String) - +Static method in class org.kiji.mapreduce.lib.util.CSVParser +
            Parses the input text using comma as the delimiter. +
            parseTSV(String) - +Static method in class org.kiji.mapreduce.lib.util.CSVParser +
            Parses the input text using tab as the delimiter. +
            produce(Text, KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.CommonLogBulkImporter +
            Converts a line of text to a set of writes to context, and + an EntityId for the row. +
            produce(Text, KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter +
            Converts a line of text to a set of writes to context, and + an EntityId for the row. +
            produce(Text, KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Converts a line of text to a set of writes to context, and + an EntityId for the row. +
            produce(LongWritable, Text, KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Subclasses should implement the produce(Text line, KijiTableContext context) method instead. +
            produce(Text, KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.JSONBulkImporter +
            Converts a line of text to a set of writes to context, and + an EntityId for the row. +
            produce(KijiRowData, ProducerContext) - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainProducer +
            +
            produce(Text, Text, KijiTableContext) - +Method in class org.kiji.mapreduce.lib.examples.News20BulkImporter +
            Reads a single news article, and writes its contents to a new kiji row, + indexed by the article's name (A string consisting of the parent folder, and + this article's hash), and the a priori categorization of this article. +
            produce(KijiRowData, ProducerContext) - +Method in class org.kiji.mapreduce.lib.produce.IdentityProducer +
            +
            produce(KijiRowData, ProducerContext) - +Method in class org.kiji.mapreduce.lib.produce.RegexProducer +
            +
            PROTOCOL - +Static variable in interface org.kiji.mapreduce.lib.avro.KijiTableImportDescriptorRecords.Callback +
              +
            PROTOCOL - +Static variable in interface org.kiji.mapreduce.lib.avro.KijiTableImportDescriptorRecords +
              +
            put(int, Object) - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc +
              +
            put(int, Object) - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc +
              +
            put(int, Object) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
              +
            +
            +

            +R

            +
            +
            RAW_ARTICLE_QUALIFIER - +Static variable in class org.kiji.mapreduce.lib.examples.News20BulkImporter +
            Qualifier storing the raw text of an article. +
            readTableImportDescriptorDescFromJSON(String) - +Static method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
            Reads a table import mapping descriptor from its JSON serialized form. +
            readTableImportMappingDescFromJSON(InputStream) - +Static method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
            Reads a table import mapping descriptor from its JSON serialized form. +
            reduce(K, Iterable<Text>, Reducer<K, Text, K, AvroValue<List<CharSequence>>>.Context) - +Method in class org.kiji.mapreduce.lib.examples.TextListReducer +
            +
            reduce(K, Iterable<DoubleWritable>, Reducer<K, DoubleWritable, K, DoubleWritable>.Context) - +Method in class org.kiji.mapreduce.lib.reduce.DoubleSumReducer +
            +
            reduce(K, Iterable<IntWritable>, Reducer<K, IntWritable, K, IntWritable>.Context) - +Method in class org.kiji.mapreduce.lib.reduce.IntSumReducer +
            +
            reduce(K, Iterable<LongWritable>, Reducer<K, LongWritable, K, LongWritable>.Context) - +Method in class org.kiji.mapreduce.lib.reduce.LongSumReducer +
            +
            RegexProducer - Class in org.kiji.mapreduce.lib.produce
            A producer which uses a full regular expression match on a string + input column to generate a new column.
            RegexProducer() - +Constructor for class org.kiji.mapreduce.lib.produce.RegexProducer +
              +
            reject(Text, KijiTableContext, String) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Post-processes rejected lines(Logging, keeping count, etc). +
            run(String[]) - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherJob +
            +
            run(String[]) - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob +
            +
            run(String[]) - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainProduceJob +
            +
            +
            +

            +S

            +
            +
            SCHEMA$ - +Static variable in class org.kiji.mapreduce.lib.avro.ColumnDesc +
              +
            SCHEMA$ - +Static variable in class org.kiji.mapreduce.lib.avro.FamilyDesc +
              +
            SCHEMA$ - +Static variable in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
              +
            setColumns(List<ColumnDesc>) - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc.Builder +
            Sets the value of the 'columns' field +
            setColumns(List<ColumnDesc>) - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc +
            Sets the value of the 'columns' field. +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.lib.examples.TextListReducer +
            +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer +
            Initializes internal state from the Configuration. +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer +
              +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.lib.produce.IdentityProducer +
            +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer +
            +
            setEntityIdSource(String) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Sets the value of the 'entityIdSource' field +
            setEntityIdSource(String) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Sets the value of the 'entityIdSource' field. +
            setFamilies(List<FamilyDesc>) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Sets the value of the 'families' field +
            setFamilies(List<FamilyDesc>) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Sets the value of the 'families' field. +
            setFamily(String) - +Method in class org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer +
            Sets the family. +
            setFieldDelimiter(String) - +Method in class org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer +
            Sets the delimiter. +
            setInputColumn(String) - +Method in class org.kiji.mapreduce.lib.produce.IdentityProducer +
            Sets the input column name. +
            setInputDescriptorPath(String) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Sets the input descriptor. +
            setLogRate(String) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Sets the log rate - the number of lines between log statements for incomplete/rejected lines. +
            setName(String) - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.mapreduce.lib.avro.FamilyDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Sets the value of the 'name' field. +
            setOutputColumn(String) - +Method in class org.kiji.mapreduce.lib.produce.IdentityProducer +
            Sets the output column name. +
            setOverrideTimestampSource(String) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Sets the value of the 'overrideTimestampSource' field +
            setOverrideTimestampSource(String) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Sets the value of the 'overrideTimestampSource' field. +
            setSource(String) - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc.Builder +
            Sets the value of the 'source' field +
            setSource(String) - +Method in class org.kiji.mapreduce.lib.avro.ColumnDesc +
            Sets the value of the 'source' field. +
            setup(KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Performs validation that this table import descriptor can be applied to the output table. +
            setup(GathererContext) - +Method in class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer +
            +
            setup(Reducer<K, Text, K, AvroValue<List<CharSequence>>>.Context) - +Method in class org.kiji.mapreduce.lib.examples.TextListReducer +
            +
            setup(GathererContext) - +Method in class org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer +
              +
            setup(Mapper<Text, Text, Text, Text>.Context) - +Method in class org.kiji.mapreduce.lib.map.TextFlatteningMapper +
            Prepares internal state for executing map tasks. +
            setup(KijiContext) - +Method in class org.kiji.mapreduce.lib.produce.RegexProducer +
            +
            setup(KijiContext) - +Method in class org.kiji.mapreduce.lib.produce.SingleInputProducer +
            +
            setup(Reducer<K, V, AvroKey<T>, NullWritable>.Context) - +Method in class org.kiji.mapreduce.lib.reduce.AvroReducer +
            +
            setup(Reducer<K, DoubleWritable, K, DoubleWritable>.Context) - +Method in class org.kiji.mapreduce.lib.reduce.DoubleSumReducer +
            +
            setup(Reducer<K, IntWritable, K, IntWritable>.Context) - +Method in class org.kiji.mapreduce.lib.reduce.IntSumReducer +
            +
            setup(Reducer<K, LongWritable, K, LongWritable>.Context) - +Method in class org.kiji.mapreduce.lib.reduce.LongSumReducer +
            +
            setupImporter(KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter +
            Extensible version of KijiBulkImporter.setup(org.kiji.mapreduce.KijiTableContext) for subclasses of + DescribedInputTextBulkImporter. +
            setupImporter(KijiTableContext) - +Method in class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter +
            Extensible version of KijiBulkImporter.setup(org.kiji.mapreduce.KijiTableContext) for subclasses of + DescribedInputTextBulkImporter. +
            setVersion(String) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder +
            Sets the value of the 'version' field +
            setVersion(String) - +Method in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Sets the value of the 'version' field. +
            SingleInputProducer - Class in org.kiji.mapreduce.lib.produce
            Base class for producers that read from the most recent value of a single input column.
            SingleInputProducer() - +Constructor for class org.kiji.mapreduce.lib.produce.SingleInputProducer +
              +
            source - +Variable in class org.kiji.mapreduce.lib.avro.ColumnDesc +
            Deprecated.  +
            +
            +

            +T

            +
            +
            TableImportDescriptorDesc - Class in org.kiji.mapreduce.lib.avro
             
            TableImportDescriptorDesc() - +Constructor for class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Default constructor. +
            TableImportDescriptorDesc(String, List<FamilyDesc>, String, String, String) - +Constructor for class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            All-args constructor. +
            TableImportDescriptorDesc.Builder - Class in org.kiji.mapreduce.lib.avro
            RecordBuilder for TableImportDescriptorDesc instances.
            TextFlatteningMapper - Class in org.kiji.mapreduce.lib.map
            A Mapper that takes name/text records, and outputs name/flattened-text pairs.
            TextFlatteningMapper() - +Constructor for class org.kiji.mapreduce.lib.map.TextFlatteningMapper +
              +
            TextListReducer<K> - Class in org.kiji.mapreduce.lib.examples
            A reducer that aggregates its text input values into a list.
            TextListReducer() - +Constructor for class org.kiji.mapreduce.lib.examples.TextListReducer +
              +
            toString() - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
            +
            +
            +

            +V

            +
            +
            validateDestination(KijiTableLayout) - +Method in class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor +
            Validates that this table import descriptor can import data into the specified layout. +
            valueOf(String) - +Static method in enum org.kiji.mapreduce.lib.util.CommonLogParser.Field +
            Returns the enum constant of this type with the specified name. +
            values() - +Static method in enum org.kiji.mapreduce.lib.util.CommonLogParser.Field +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            version - +Variable in class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc +
            Deprecated.  +
            +
            +

            +W

            +
            +
            write(T, Reducer<K, V, AvroKey<T>, NullWritable>.Context) - +Method in class org.kiji.mapreduce.lib.reduce.AvroReducer +
            Subclasses can use this instead of context.write() to output Avro + messages directly instead of having to wrap them in AvroKey + container objects. +
            +
            +A B C D E F G H I J K L M N O P R S T V W + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/index.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/index.html new file mode 100644 index 00000000..106118b0 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/index.html @@ -0,0 +1,40 @@ + + + + + + + +The KijiMR Library 1.0.0-rc4 API + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/ColumnDesc.Builder.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/ColumnDesc.Builder.html new file mode 100644 index 00000000..ad1ab5e3 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/ColumnDesc.Builder.html @@ -0,0 +1,436 @@ + + + + + + + +ColumnDesc.Builder (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.avro +
            +Class ColumnDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<ColumnDesc>
+          extended by org.kiji.mapreduce.lib.avro.ColumnDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<ColumnDesc>
            +
            +
            +
            Enclosing class:
            ColumnDesc
            +
            +
            +
            +
            public static class ColumnDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<ColumnDesc>
            implements org.apache.avro.data.RecordBuilder<ColumnDesc>
            + + +

            +RecordBuilder for ColumnDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + ColumnDescbuild() + +
            +           
            + ColumnDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + ColumnDesc.BuilderclearSource() + +
            +          Clears the value of the 'source' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetSource() + +
            +          Gets the value of the 'source' field
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasSource() + +
            +          Checks whether the 'source' field has been set
            + ColumnDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + ColumnDesc.BuildersetSource(String value) + +
            +          Sets the value of the 'source' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public ColumnDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public ColumnDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSource

            +
            +public String getSource()
            +
            +
            Gets the value of the 'source' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSource

            +
            +public ColumnDesc.Builder setSource(String value)
            +
            +
            Sets the value of the 'source' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasSource

            +
            +public boolean hasSource()
            +
            +
            Checks whether the 'source' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearSource

            +
            +public ColumnDesc.Builder clearSource()
            +
            +
            Clears the value of the 'source' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public ColumnDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<ColumnDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/ColumnDesc.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/ColumnDesc.html new file mode 100644 index 00000000..df1e6fcf --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/ColumnDesc.html @@ -0,0 +1,602 @@ + + + + + + + +ColumnDesc (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.avro +
            +Class ColumnDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.mapreduce.lib.avro.ColumnDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class ColumnDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classColumnDesc.Builder + +
            +          RecordBuilder for ColumnDesc instances.
            +  + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringname + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + Stringsource + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            ColumnDesc() + +
            +          Default constructor.
            ColumnDesc(String name, + String source) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + StringgetSource() + +
            +          Gets the value of the 'source' field.
            +static ColumnDesc.BuildernewBuilder() + +
            +          Creates a new ColumnDesc RecordBuilder
            +static ColumnDesc.BuildernewBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +static ColumnDesc.BuildernewBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetSource(String value) + +
            +          Sets the value of the 'source' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +source

            +
            +@Deprecated
+public String source
            +
            +
            Deprecated. 
            Source for column ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

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

            +ColumnDesc

            +
            +public ColumnDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +ColumnDesc

            +
            +public ColumnDesc(String name,
+                  String source)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSource

            +
            +public String getSource()
            +
            +
            Gets the value of the 'source' field. + Source for column ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSource

            +
            +public void setSource(String value)
            +
            +
            Sets the value of the 'source' field. + Source for column ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder()
            +
            +
            Creates a new ColumnDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder(ColumnDesc.Builder other)
            +
            +
            Creates a new ColumnDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder(ColumnDesc other)
            +
            +
            Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/FamilyDesc.Builder.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/FamilyDesc.Builder.html new file mode 100644 index 00000000..43187a9e --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/FamilyDesc.Builder.html @@ -0,0 +1,436 @@ + + + + + + + +FamilyDesc.Builder (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.avro +
            +Class FamilyDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<FamilyDesc>
+          extended by org.kiji.mapreduce.lib.avro.FamilyDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<FamilyDesc>
            +
            +
            +
            Enclosing class:
            FamilyDesc
            +
            +
            +
            +
            public static class FamilyDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<FamilyDesc>
            implements org.apache.avro.data.RecordBuilder<FamilyDesc>
            + + +

            +RecordBuilder for FamilyDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + FamilyDescbuild() + +
            +           
            + FamilyDesc.BuilderclearColumns() + +
            +          Clears the value of the 'columns' field
            + FamilyDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + List<ColumnDesc>getColumns() + +
            +          Gets the value of the 'columns' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + booleanhasColumns() + +
            +          Checks whether the 'columns' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + FamilyDesc.BuildersetColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            + FamilyDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public FamilyDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public FamilyDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumns

            +
            +public List<ColumnDesc> getColumns()
            +
            +
            Gets the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumns

            +
            +public FamilyDesc.Builder setColumns(List<ColumnDesc> value)
            +
            +
            Sets the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasColumns

            +
            +public boolean hasColumns()
            +
            +
            Checks whether the 'columns' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearColumns

            +
            +public FamilyDesc.Builder clearColumns()
            +
            +
            Clears the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public FamilyDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<FamilyDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/FamilyDesc.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/FamilyDesc.html new file mode 100644 index 00000000..d1a19ba3 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/FamilyDesc.html @@ -0,0 +1,602 @@ + + + + + + + +FamilyDesc (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.avro +
            +Class FamilyDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.mapreduce.lib.avro.FamilyDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class FamilyDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classFamilyDesc.Builder + +
            +          RecordBuilder for FamilyDesc instances.
            +  + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<ColumnDesc>columns + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            FamilyDesc() + +
            +          Default constructor.
            FamilyDesc(String name, + List<ColumnDesc> columns) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<ColumnDesc>getColumns() + +
            +          Gets the value of the 'columns' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static FamilyDesc.BuildernewBuilder() + +
            +          Creates a new FamilyDesc RecordBuilder
            +static FamilyDesc.BuildernewBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +static FamilyDesc.BuildernewBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +columns

            +
            +@Deprecated
+public List<ColumnDesc> columns
            +
            +
            Deprecated. 
            Columns, for group-type families only. Empty for map-type families. +

            +

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

            +FamilyDesc

            +
            +public FamilyDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +FamilyDesc

            +
            +public FamilyDesc(String name,
+                  List<ColumnDesc> columns)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumns

            +
            +public List<ColumnDesc> getColumns()
            +
            +
            Gets the value of the 'columns' field. + Columns, for group-type families only. Empty for map-type families. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumns

            +
            +public void setColumns(List<ColumnDesc> value)
            +
            +
            Sets the value of the 'columns' field. + Columns, for group-type families only. Empty for map-type families. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder()
            +
            +
            Creates a new FamilyDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder(FamilyDesc.Builder other)
            +
            +
            Creates a new FamilyDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder(FamilyDesc other)
            +
            +
            Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/KijiTableImportDescriptorRecords.Callback.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/KijiTableImportDescriptorRecords.Callback.html new file mode 100644 index 00000000..cc94462d --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/KijiTableImportDescriptorRecords.Callback.html @@ -0,0 +1,230 @@ + + + + + + + +KijiTableImportDescriptorRecords.Callback (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.avro +
            +Interface KijiTableImportDescriptorRecords.Callback

            +
            +
            All Superinterfaces:
            KijiTableImportDescriptorRecords
            +
            +
            +
            Enclosing interface:
            KijiTableImportDescriptorRecords
            +
            +
            +
            +
            public static interface KijiTableImportDescriptorRecords.Callback
            extends KijiTableImportDescriptorRecords
            + + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.mapreduce.lib.avro.KijiTableImportDescriptorRecords
            KijiTableImportDescriptorRecords.Callback
            +  + + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.ProtocolPROTOCOL + +
            +           
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +PROTOCOL

            +
            +static final org.apache.avro.Protocol PROTOCOL
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/KijiTableImportDescriptorRecords.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/KijiTableImportDescriptorRecords.html new file mode 100644 index 00000000..24a9bd77 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/KijiTableImportDescriptorRecords.html @@ -0,0 +1,225 @@ + + + + + + + +KijiTableImportDescriptorRecords (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.avro +
            +Interface KijiTableImportDescriptorRecords

            +
            +
            All Known Subinterfaces:
            KijiTableImportDescriptorRecords.Callback
            +
            +
            +
            +
            public interface KijiTableImportDescriptorRecords
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static interfaceKijiTableImportDescriptorRecords.Callback + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.ProtocolPROTOCOL + +
            +           
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +PROTOCOL

            +
            +static final org.apache.avro.Protocol PROTOCOL
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/TableImportDescriptorDesc.Builder.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/TableImportDescriptorDesc.Builder.html new file mode 100644 index 00000000..7b5bf329 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/TableImportDescriptorDesc.Builder.html @@ -0,0 +1,724 @@ + + + + + + + +TableImportDescriptorDesc.Builder (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.avro +
            +Class TableImportDescriptorDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<TableImportDescriptorDesc>
+          extended by org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<TableImportDescriptorDesc>
            +
            +
            +
            Enclosing class:
            TableImportDescriptorDesc
            +
            +
            +
            +
            public static class TableImportDescriptorDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<TableImportDescriptorDesc>
            implements org.apache.avro.data.RecordBuilder<TableImportDescriptorDesc>
            + + +

            +RecordBuilder for TableImportDescriptorDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TableImportDescriptorDescbuild() + +
            +           
            + TableImportDescriptorDesc.BuilderclearEntityIdSource() + +
            +          Clears the value of the 'entityIdSource' field
            + TableImportDescriptorDesc.BuilderclearFamilies() + +
            +          Clears the value of the 'families' field
            + TableImportDescriptorDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + TableImportDescriptorDesc.BuilderclearOverrideTimestampSource() + +
            +          Clears the value of the 'overrideTimestampSource' field
            + TableImportDescriptorDesc.BuilderclearVersion() + +
            +          Clears the value of the 'version' field
            + StringgetEntityIdSource() + +
            +          Gets the value of the 'entityIdSource' field
            + List<FamilyDesc>getFamilies() + +
            +          Gets the value of the 'families' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetOverrideTimestampSource() + +
            +          Gets the value of the 'overrideTimestampSource' field
            + StringgetVersion() + +
            +          Gets the value of the 'version' field
            + booleanhasEntityIdSource() + +
            +          Checks whether the 'entityIdSource' field has been set
            + booleanhasFamilies() + +
            +          Checks whether the 'families' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasOverrideTimestampSource() + +
            +          Checks whether the 'overrideTimestampSource' field has been set
            + booleanhasVersion() + +
            +          Checks whether the 'version' field has been set
            + TableImportDescriptorDesc.BuildersetEntityIdSource(String value) + +
            +          Sets the value of the 'entityIdSource' field
            + TableImportDescriptorDesc.BuildersetFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            + TableImportDescriptorDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + TableImportDescriptorDesc.BuildersetOverrideTimestampSource(String value) + +
            +          Sets the value of the 'overrideTimestampSource' field
            + TableImportDescriptorDesc.BuildersetVersion(String value) + +
            +          Sets the value of the 'version' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public TableImportDescriptorDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public TableImportDescriptorDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getFamilies

            +
            +public List<FamilyDesc> getFamilies()
            +
            +
            Gets the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setFamilies

            +
            +public TableImportDescriptorDesc.Builder setFamilies(List<FamilyDesc> value)
            +
            +
            Sets the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasFamilies

            +
            +public boolean hasFamilies()
            +
            +
            Checks whether the 'families' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearFamilies

            +
            +public TableImportDescriptorDesc.Builder clearFamilies()
            +
            +
            Clears the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEntityIdSource

            +
            +public String getEntityIdSource()
            +
            +
            Gets the value of the 'entityIdSource' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEntityIdSource

            +
            +public TableImportDescriptorDesc.Builder setEntityIdSource(String value)
            +
            +
            Sets the value of the 'entityIdSource' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEntityIdSource

            +
            +public boolean hasEntityIdSource()
            +
            +
            Checks whether the 'entityIdSource' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEntityIdSource

            +
            +public TableImportDescriptorDesc.Builder clearEntityIdSource()
            +
            +
            Clears the value of the 'entityIdSource' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getOverrideTimestampSource

            +
            +public String getOverrideTimestampSource()
            +
            +
            Gets the value of the 'overrideTimestampSource' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setOverrideTimestampSource

            +
            +public TableImportDescriptorDesc.Builder setOverrideTimestampSource(String value)
            +
            +
            Sets the value of the 'overrideTimestampSource' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasOverrideTimestampSource

            +
            +public boolean hasOverrideTimestampSource()
            +
            +
            Checks whether the 'overrideTimestampSource' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearOverrideTimestampSource

            +
            +public TableImportDescriptorDesc.Builder clearOverrideTimestampSource()
            +
            +
            Clears the value of the 'overrideTimestampSource' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getVersion

            +
            +public String getVersion()
            +
            +
            Gets the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setVersion

            +
            +public TableImportDescriptorDesc.Builder setVersion(String value)
            +
            +
            Sets the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasVersion

            +
            +public boolean hasVersion()
            +
            +
            Checks whether the 'version' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearVersion

            +
            +public TableImportDescriptorDesc.Builder clearVersion()
            +
            +
            Clears the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public TableImportDescriptorDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<TableImportDescriptorDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/TableImportDescriptorDesc.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/TableImportDescriptorDesc.html new file mode 100644 index 00000000..a4651df0 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/TableImportDescriptorDesc.html @@ -0,0 +1,821 @@ + + + + + + + +TableImportDescriptorDesc (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.avro +
            +Class TableImportDescriptorDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class TableImportDescriptorDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTableImportDescriptorDesc.Builder + +
            +          RecordBuilder for TableImportDescriptorDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + StringentityIdSource + +
            +          Deprecated. 
            + List<FamilyDesc>families + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + StringoverrideTimestampSource + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + Stringversion + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            TableImportDescriptorDesc() + +
            +          Default constructor.
            TableImportDescriptorDesc(String name, + List<FamilyDesc> families, + String entityIdSource, + String overrideTimestampSource, + String version) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetEntityIdSource() + +
            +          Gets the value of the 'entityIdSource' field.
            + List<FamilyDesc>getFamilies() + +
            +          Gets the value of the 'families' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetOverrideTimestampSource() + +
            +          Gets the value of the 'overrideTimestampSource' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + StringgetVersion() + +
            +          Gets the value of the 'version' field.
            +static TableImportDescriptorDesc.BuildernewBuilder() + +
            +          Creates a new TableImportDescriptorDesc RecordBuilder
            +static TableImportDescriptorDesc.BuildernewBuilder(TableImportDescriptorDesc.Builder other) + +
            +          Creates a new TableImportDescriptorDesc RecordBuilder by copying an existing Builder
            +static TableImportDescriptorDesc.BuildernewBuilder(TableImportDescriptorDesc other) + +
            +          Creates a new TableImportDescriptorDesc RecordBuilder by copying an existing TableImportDescriptorDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetEntityIdSource(String value) + +
            +          Sets the value of the 'entityIdSource' field.
            + voidsetFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetOverrideTimestampSource(String value) + +
            +          Sets the value of the 'overrideTimestampSource' field.
            + voidsetVersion(String value) + +
            +          Sets the value of the 'version' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Name of the table ([a-zA-Z0-9_]+). +

            +

            +
            +
            +
            + +

            +families

            +
            +@Deprecated
+public List<FamilyDesc> families
            +
            +
            Deprecated. 
            Column family descriptors. +

            +

            +
            +
            +
            + +

            +entityIdSource

            +
            +@Deprecated
+public String entityIdSource
            +
            +
            Deprecated. 
            EntityId source column. +

            +

            +
            +
            +
            + +

            +overrideTimestampSource

            +
            +@Deprecated
+public String overrideTimestampSource
            +
            +
            Deprecated. 
            If this is set, override system timestamp with the source field as timestamp. +

            +

            +
            +
            +
            + +

            +version

            +
            +@Deprecated
+public String version
            +
            +
            Deprecated. 
            Descriptor format version (eg. "import-1.0"). +

            +

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

            +TableImportDescriptorDesc

            +
            +public TableImportDescriptorDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +TableImportDescriptorDesc

            +
            +public TableImportDescriptorDesc(String name,
+                                 List<FamilyDesc> families,
+                                 String entityIdSource,
+                                 String overrideTimestampSource,
+                                 String version)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Name of the table ([a-zA-Z0-9_]+). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Name of the table ([a-zA-Z0-9_]+). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getFamilies

            +
            +public List<FamilyDesc> getFamilies()
            +
            +
            Gets the value of the 'families' field. + Column family descriptors. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setFamilies

            +
            +public void setFamilies(List<FamilyDesc> value)
            +
            +
            Sets the value of the 'families' field. + Column family descriptors. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEntityIdSource

            +
            +public String getEntityIdSource()
            +
            +
            Gets the value of the 'entityIdSource' field. + EntityId source column. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEntityIdSource

            +
            +public void setEntityIdSource(String value)
            +
            +
            Sets the value of the 'entityIdSource' field. + EntityId source column. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getOverrideTimestampSource

            +
            +public String getOverrideTimestampSource()
            +
            +
            Gets the value of the 'overrideTimestampSource' field. + If this is set, override system timestamp with the source field as timestamp. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setOverrideTimestampSource

            +
            +public void setOverrideTimestampSource(String value)
            +
            +
            Sets the value of the 'overrideTimestampSource' field. + If this is set, override system timestamp with the source field as timestamp. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getVersion

            +
            +public String getVersion()
            +
            +
            Gets the value of the 'version' field. + Descriptor format version (eg. "import-1.0"). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setVersion

            +
            +public void setVersion(String value)
            +
            +
            Sets the value of the 'version' field. + Descriptor format version (eg. "import-1.0"). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableImportDescriptorDesc.Builder newBuilder()
            +
            +
            Creates a new TableImportDescriptorDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableImportDescriptorDesc.Builder newBuilder(TableImportDescriptorDesc.Builder other)
            +
            +
            Creates a new TableImportDescriptorDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableImportDescriptorDesc.Builder newBuilder(TableImportDescriptorDesc other)
            +
            +
            Creates a new TableImportDescriptorDesc RecordBuilder by copying an existing TableImportDescriptorDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/ColumnDesc.Builder.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/ColumnDesc.Builder.html new file mode 100644 index 00000000..6dd53213 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/ColumnDesc.Builder.html @@ -0,0 +1,245 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.avro.ColumnDesc.Builder (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.avro.ColumnDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use ColumnDesc.Builder
            org.kiji.mapreduce.lib.avro  
            +  +

            + + + + + +
            +Uses of ColumnDesc.Builder in org.kiji.mapreduce.lib.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro that return ColumnDesc.Builder
            + ColumnDesc.BuilderColumnDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearSource() + +
            +          Clears the value of the 'source' field
            +static ColumnDesc.BuilderColumnDesc.newBuilder() + +
            +          Creates a new ColumnDesc RecordBuilder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            + ColumnDesc.BuilderColumnDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + ColumnDesc.BuilderColumnDesc.Builder.setSource(String value) + +
            +          Sets the value of the 'source' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro with parameters of type ColumnDesc.Builder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/ColumnDesc.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/ColumnDesc.html new file mode 100644 index 00000000..ab5ed2f8 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/ColumnDesc.html @@ -0,0 +1,303 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.avro.ColumnDesc (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.avro.ColumnDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use ColumnDesc
            org.kiji.mapreduce.lib.avro  
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR. 
            +  +

            + + + + + +
            +Uses of ColumnDesc in org.kiji.mapreduce.lib.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.mapreduce.lib.avro with type parameters of type ColumnDesc
            + List<ColumnDesc>FamilyDesc.columns + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro that return ColumnDesc
            + ColumnDescColumnDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro that return types with arguments of type ColumnDesc
            + List<ColumnDesc>FamilyDesc.getColumns() + +
            +          Gets the value of the 'columns' field.
            + List<ColumnDesc>FamilyDesc.Builder.getColumns() + +
            +          Gets the value of the 'columns' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro with parameters of type ColumnDesc
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.mapreduce.lib.avro with type arguments of type ColumnDesc
            + voidFamilyDesc.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field.
            + FamilyDesc.BuilderFamilyDesc.Builder.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.mapreduce.lib.avro with type arguments of type ColumnDesc
            FamilyDesc(String name, + List<ColumnDesc> columns) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of ColumnDesc in org.kiji.mapreduce.lib.bulkimport
            +  +

            + + + + + + + + +
            Constructors in org.kiji.mapreduce.lib.bulkimport with parameters of type ColumnDesc
            KijiTableImportDescriptor.FamilyLayout.ColumnLayout(ColumnDesc desc) + +
            +          Builds a new column layout instance from a descriptor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/FamilyDesc.Builder.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/FamilyDesc.Builder.html new file mode 100644 index 00000000..482479da --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/FamilyDesc.Builder.html @@ -0,0 +1,245 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.avro.FamilyDesc.Builder (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.avro.FamilyDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use FamilyDesc.Builder
            org.kiji.mapreduce.lib.avro  
            +  +

            + + + + + +
            +Uses of FamilyDesc.Builder in org.kiji.mapreduce.lib.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro that return FamilyDesc.Builder
            + FamilyDesc.BuilderFamilyDesc.Builder.clearColumns() + +
            +          Clears the value of the 'columns' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            +static FamilyDesc.BuilderFamilyDesc.newBuilder() + +
            +          Creates a new FamilyDesc RecordBuilder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            + FamilyDesc.BuilderFamilyDesc.Builder.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro with parameters of type FamilyDesc.Builder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/FamilyDesc.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/FamilyDesc.html new file mode 100644 index 00000000..751146bc --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/FamilyDesc.html @@ -0,0 +1,306 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.avro.FamilyDesc (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.avro.FamilyDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use FamilyDesc
            org.kiji.mapreduce.lib.avro  
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR. 
            +  +

            + + + + + +
            +Uses of FamilyDesc in org.kiji.mapreduce.lib.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.mapreduce.lib.avro with type parameters of type FamilyDesc
            + List<FamilyDesc>TableImportDescriptorDesc.families + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro that return FamilyDesc
            + FamilyDescFamilyDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro that return types with arguments of type FamilyDesc
            + List<FamilyDesc>TableImportDescriptorDesc.getFamilies() + +
            +          Gets the value of the 'families' field.
            + List<FamilyDesc>TableImportDescriptorDesc.Builder.getFamilies() + +
            +          Gets the value of the 'families' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro with parameters of type FamilyDesc
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.mapreduce.lib.avro with type arguments of type FamilyDesc
            + voidTableImportDescriptorDesc.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field.
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.mapreduce.lib.avro with type arguments of type FamilyDesc
            TableImportDescriptorDesc(String name, + List<FamilyDesc> families, + String entityIdSource, + String overrideTimestampSource, + String version) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of FamilyDesc in org.kiji.mapreduce.lib.bulkimport
            +  +

            + + + + + + + + +
            Constructors in org.kiji.mapreduce.lib.bulkimport with parameters of type FamilyDesc
            KijiTableImportDescriptor.FamilyLayout(FamilyDesc familyDesc) + +
            +          Builds a new family layout instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/KijiTableImportDescriptorRecords.Callback.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/KijiTableImportDescriptorRecords.Callback.html new file mode 100644 index 00000000..c5ffcb92 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/KijiTableImportDescriptorRecords.Callback.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.lib.avro.KijiTableImportDescriptorRecords.Callback (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.lib.avro.KijiTableImportDescriptorRecords.Callback

            +
            +No usage of org.kiji.mapreduce.lib.avro.KijiTableImportDescriptorRecords.Callback +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/KijiTableImportDescriptorRecords.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/KijiTableImportDescriptorRecords.html new file mode 100644 index 00000000..bdd9f7eb --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/KijiTableImportDescriptorRecords.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.lib.avro.KijiTableImportDescriptorRecords (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.lib.avro.KijiTableImportDescriptorRecords

            +
            + + + + + + + + + +
            +Packages that use KijiTableImportDescriptorRecords
            org.kiji.mapreduce.lib.avro  
            +  +

            + + + + + +
            +Uses of KijiTableImportDescriptorRecords in org.kiji.mapreduce.lib.avro
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiTableImportDescriptorRecords in org.kiji.mapreduce.lib.avro
            +static interfaceKijiTableImportDescriptorRecords.Callback + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/TableImportDescriptorDesc.Builder.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/TableImportDescriptorDesc.Builder.html new file mode 100644 index 00000000..3bf25524 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/TableImportDescriptorDesc.Builder.html @@ -0,0 +1,293 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use TableImportDescriptorDesc.Builder
            org.kiji.mapreduce.lib.avro  
            +  +

            + + + + + +
            +Uses of TableImportDescriptorDesc.Builder in org.kiji.mapreduce.lib.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro that return TableImportDescriptorDesc.Builder
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.clearEntityIdSource() + +
            +          Clears the value of the 'entityIdSource' field
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.clearFamilies() + +
            +          Clears the value of the 'families' field
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.clearOverrideTimestampSource() + +
            +          Clears the value of the 'overrideTimestampSource' field
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.clearVersion() + +
            +          Clears the value of the 'version' field
            +static TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.newBuilder() + +
            +          Creates a new TableImportDescriptorDesc RecordBuilder
            +static TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.newBuilder(TableImportDescriptorDesc.Builder other) + +
            +          Creates a new TableImportDescriptorDesc RecordBuilder by copying an existing Builder
            +static TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.newBuilder(TableImportDescriptorDesc other) + +
            +          Creates a new TableImportDescriptorDesc RecordBuilder by copying an existing TableImportDescriptorDesc instance
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.setEntityIdSource(String value) + +
            +          Sets the value of the 'entityIdSource' field
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.setOverrideTimestampSource(String value) + +
            +          Sets the value of the 'overrideTimestampSource' field
            + TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.Builder.setVersion(String value) + +
            +          Sets the value of the 'version' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro with parameters of type TableImportDescriptorDesc.Builder
            +static TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.newBuilder(TableImportDescriptorDesc.Builder other) + +
            +          Creates a new TableImportDescriptorDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/TableImportDescriptorDesc.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/TableImportDescriptorDesc.html new file mode 100644 index 00000000..d10f7d78 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/class-use/TableImportDescriptorDesc.html @@ -0,0 +1,248 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use TableImportDescriptorDesc
            org.kiji.mapreduce.lib.avro  
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR. 
            +  +

            + + + + + +
            +Uses of TableImportDescriptorDesc in org.kiji.mapreduce.lib.avro
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro that return TableImportDescriptorDesc
            + TableImportDescriptorDescTableImportDescriptorDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.avro with parameters of type TableImportDescriptorDesc
            +static TableImportDescriptorDesc.BuilderTableImportDescriptorDesc.newBuilder(TableImportDescriptorDesc other) + +
            +          Creates a new TableImportDescriptorDesc RecordBuilder by copying an existing TableImportDescriptorDesc instance
            +  +

            + + + + + +
            +Uses of TableImportDescriptorDesc in org.kiji.mapreduce.lib.bulkimport
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.bulkimport that return TableImportDescriptorDesc
            +static TableImportDescriptorDescKijiTableImportDescriptor.readTableImportDescriptorDescFromJSON(String json) + +
            +          Reads a table import mapping descriptor from its JSON serialized form.
            +static TableImportDescriptorDescKijiTableImportDescriptor.readTableImportMappingDescFromJSON(InputStream istream) + +
            +          Reads a table import mapping descriptor from its JSON serialized form.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.mapreduce.lib.bulkimport with parameters of type TableImportDescriptorDesc
            KijiTableImportDescriptor(TableImportDescriptorDesc desc) + +
            +          Constructs a KijiTableImportDescriptor from an Avro descriptor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-frame.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-frame.html new file mode 100644 index 00000000..6d101f77 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +org.kiji.mapreduce.lib.avro (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.lib.avro + + + + +
            +Interfaces  + +
            +KijiTableImportDescriptorRecords +
            +KijiTableImportDescriptorRecords.Callback
            + + + + + + +
            +Classes  + +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +TableImportDescriptorDesc +
            +TableImportDescriptorDesc.Builder
            + + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-summary.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-summary.html new file mode 100644 index 00000000..edaf3ec7 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-summary.html @@ -0,0 +1,196 @@ + + + + + + + +org.kiji.mapreduce.lib.avro (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.lib.avro +

            + + + + + + + + + + + + + +
            +Interface Summary
            KijiTableImportDescriptorRecords 
            KijiTableImportDescriptorRecords.Callback 
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            ColumnDesc 
            ColumnDesc.BuilderRecordBuilder for ColumnDesc instances.
            FamilyDesc 
            FamilyDesc.BuilderRecordBuilder for FamilyDesc instances.
            TableImportDescriptorDesc 
            TableImportDescriptorDesc.BuilderRecordBuilder for TableImportDescriptorDesc instances.
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-tree.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-tree.html new file mode 100644 index 00000000..b65246ab --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-tree.html @@ -0,0 +1,175 @@ + + + + + + + +org.kiji.mapreduce.lib.avro Class Hierarchy (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.lib.avro +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.avro.data.RecordBuilderBase<T> (implements org.apache.avro.data.RecordBuilder<T>) +
                  +
                • org.apache.avro.specific.SpecificRecordBuilderBase<T> +
                +
              • org.apache.avro.specific.SpecificRecordBase (implements java.lang.Comparable<T>, org.apache.avro.specific.SpecificRecord) +
                  +
                • org.kiji.mapreduce.lib.avro.ColumnDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.mapreduce.lib.avro.FamilyDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.mapreduce.lib.avro.TableImportDescriptorDesc (implements org.apache.avro.specific.SpecificRecord) +
                +
              +
            +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-use.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-use.html new file mode 100644 index 00000000..d2139f08 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/avro/package-use.html @@ -0,0 +1,238 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.lib.avro (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.lib.avro

            +
            + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.lib.avro
            org.kiji.mapreduce.lib.avro  
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.lib.avro used by org.kiji.mapreduce.lib.avro
            ColumnDesc + +
            +           
            ColumnDesc.Builder + +
            +          RecordBuilder for ColumnDesc instances.
            FamilyDesc + +
            +           
            FamilyDesc.Builder + +
            +          RecordBuilder for FamilyDesc instances.
            KijiTableImportDescriptorRecords + +
            +           
            TableImportDescriptorDesc + +
            +           
            TableImportDescriptorDesc.Builder + +
            +          RecordBuilder for TableImportDescriptorDesc instances.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.lib.avro used by org.kiji.mapreduce.lib.bulkimport
            ColumnDesc + +
            +           
            FamilyDesc + +
            +           
            TableImportDescriptorDesc + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/CSVBulkImporter.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/CSVBulkImporter.html new file mode 100644 index 00000000..45e1c42e --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/CSVBulkImporter.html @@ -0,0 +1,481 @@ + + + + + + + +CSVBulkImporter (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.bulkimport +
            +Class CSVBulkImporter

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Text>
+      extended by org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
+          extended by org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            +
            @ApiAudience.Public
+public final class CSVBulkImporter
            extends DescribedInputTextBulkImporter
            + + +

            +Bulk importer that handles comma separated files. TSVs are also supported by setting the + kiji.import.text.field.separator configuration item specified by + CONF_FIELD_DELIMITER. This bulk importer uses + CSVParser for parsing lines into fields. + + A default header row can be specified by setting the + kiji.import.text.column.header_row configuration item specified by + CONF_INPUT_HEADER_ROW. If this is not specified, this bulk importer will infer + headers from the first line of text encountered. Not that within a MapReduce job this is not + necessarily the first line of the file and thus this parameter should be set. + +

            Creating a bulk import job for CSV:

            +

            + The CSV bulk importer can be passed into a + KijiBulkImportJobBuilder. A + KijiTableImportDescriptor, which defines the mapping from the import fields to the + destination Kiji columns, must be passed in as part of the job configuration. For writing + to an HFile which can later be loaded with the kiji bulk-load tool the job + creation looks like: +

            + 
            
+   // Set the import descriptor file to be used for this bulk importer.
+   conf.set(DescribedInputTextBulkImporter.CONF_FILE, "foo-test-import-descriptor.json");
+
+   // Set the header line.
+   conf.set(CSVBulkImporter.CONF_INPUT_HEADER_ROW, "first,last,email,phone");
+
+   // Configure and create the MapReduce job.
+   final MapReduceJob job = KijiBulkImportJobBuilder.create()
+       .withConf(conf)
+       .withBulkImporter(CSVBulkImporter.class)
+       .withInput(new TextMapReduceJobInput(new Path(inputFile.toString())))
+       .withOutput(new HFileMapReduceJobOutput(mOutputTable, hfileDirPath))
+       .build();
+
            +

            + Alternately the bulk importer can be configured to write directly to a Kiji Table. This is + not recommended because it generates individual puts for each cell that is being + written. For small jobs or tests, a direct Kiji table output job can be created by modifying + out the .withOutput parameter to: + .withOutput(new DirectKijiTableMapReduceJobOutput(mOutputTable)) +

            +

            + +

            +

            +
            See Also:
            KijiTableImportDescriptor
            +
            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_FIELD_DELIMITER + +
            +          Configuration variable that specifies the cell value separator in the text input files.
            +static StringCONF_INPUT_HEADER_ROW + +
            +          Configuration variable for a header row containing delimited string of names of fields.
            +  + + + + + + + +
            Fields inherited from class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
            CONF_FILE, CONF_LOG_RATE
            +  + + + + + + + + + + +
            +Constructor Summary
            CSVBulkImporter() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  org.kiji.schema.EntityIdgetEntityId(List<String> fields, + org.kiji.mapreduce.KijiTableContext context) + +
            +          Generates the entity id for this imported line using the source from the import descriptor.
            +protected  LonggetTimestamp(List<String> fields) + +
            +          Generates the timestamp for this imported line using the source from the import descriptor.
            + voidproduce(org.apache.hadoop.io.Text value, + org.kiji.mapreduce.KijiTableContext context) + +
            +          Converts a line of text to a set of writes to context, and + an EntityId for the row.
            + voidsetupImporter(org.kiji.mapreduce.KijiTableContext context) + +
            +          Extensible version of KijiBulkImporter.setup(org.kiji.mapreduce.KijiTableContext) for subclasses of + DescribedInputTextBulkImporter.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
            cleanup, cleanupImporter, convert, getDestinationColumns, getEntityIdSource, getSource, getTimestampSource, incomplete, isOverrideTimestamp, produce, reject, setConf, setInputDescriptorPath, setLogRate, setup
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.bulkimport.KijiBulkImporter
            forName, getConf, getRequiredStores
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +CONF_INPUT_HEADER_ROW

            +
            +public static final String CONF_INPUT_HEADER_ROW
            +
            +
            Configuration variable for a header row containing delimited string of names of fields. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_FIELD_DELIMITER

            +
            +public static final String CONF_FIELD_DELIMITER
            +
            +
            Configuration variable that specifies the cell value separator in the text input files. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +CSVBulkImporter

            +
            +public CSVBulkImporter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setupImporter

            +
            +public void setupImporter(org.kiji.mapreduce.KijiTableContext context)
+                   throws IOException
            +
            +
            Extensible version of KijiBulkImporter.setup(org.kiji.mapreduce.KijiTableContext) for subclasses of + DescribedInputTextBulkImporter. + Does nothing by default. +

            +

            +
            Overrides:
            setupImporter in class DescribedInputTextBulkImporter
            +
            +
            +
            Parameters:
            context - A context you can use to generate EntityIds and commit writes. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getEntityId

            +
            +protected org.kiji.schema.EntityId getEntityId(List<String> fields,
+                                               org.kiji.mapreduce.KijiTableContext context)
            +
            +
            Generates the entity id for this imported line using the source from the import descriptor. + Called within the produce() method. +

            +

            +
            Parameters:
            fields - One line of input text split on the column delimiter.
            context - The context used by the produce() method. +
            Returns:
            The EntityId for the data that gets imported by this line.
            +
            +
            +
            + +

            +getTimestamp

            +
            +protected Long getTimestamp(List<String> fields)
            +
            +
            Generates the timestamp for this imported line using the source from the import descriptor. + Called within the produce() method. +

            +

            +
            Parameters:
            fields - One line of input text split on the column delimiter. +
            Returns:
            The timestamp to be used for this row of data.
            +
            +
            +
            + +

            +produce

            +
            +public void produce(org.apache.hadoop.io.Text value,
+                    org.kiji.mapreduce.KijiTableContext context)
+             throws IOException
            +
            +
            Converts a line of text to a set of writes to context, and + an EntityId for the row. +

            +

            +
            Specified by:
            produce in class DescribedInputTextBulkImporter
            +
            +
            +
            Parameters:
            value - The line to parse.
            context - The context to write to. +
            Throws: +
            IOException - if there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/CommonLogBulkImporter.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/CommonLogBulkImporter.html new file mode 100644 index 00000000..016798d8 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/CommonLogBulkImporter.html @@ -0,0 +1,346 @@ + + + + + + + +CommonLogBulkImporter (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.bulkimport +
            +Class CommonLogBulkImporter

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Text>
+      extended by org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
+          extended by org.kiji.mapreduce.lib.bulkimport.CommonLogBulkImporter
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            +
            @ApiAudience.Public
+public final class CommonLogBulkImporter
            extends DescribedInputTextBulkImporter
            + + +

            +Bulk importer that takes lines from an NCSA/Apache common logs and can produce a row for each + entry in the log file. This is the basic log file format used by the Apache HTTP server. + This bulk importer uses CommonLogParser for parsing lines + into fields. + +

            Creating a bulk import job for NCSA/Apache Common logs:

            +

            + The common log bulk importer can be passed into a + KijiBulkImportJobBuilder. A + KijiTableImportDescriptor, which defines the mapping from the import fields to the + destination Kiji columns, must be passed in as part of the job configuration. For writing + to an HFile which can later be loaded with the kiji bulk-load tool the job + creation looks like: +

            + 
            
+   // Set the import descriptor file to be used for this bulk importer.
+   conf.set(DescribedInputTextBulkImporter.CONF_FILE, "commonlog-import-descriptor.json");
+   // Configure and create the MapReduce job.
+   final MapReduceJob job = KijiBulkImportJobBuilder.create()
+       .withConf(conf)
+       .withBulkImporter(CommonLogBulkImporter.class)
+       .withInput(new TextMapReduceJobInput(new Path(inputFile.toString())))
+       .withOutput(new HFileMapReduceJobOutput(mOutputTable, hfileDirPath))
+       .build();
+
            +

            + Alternately the bulk importer can be configured to write directly to a Kiji Table. This is + not recommended because it generates individual puts for each cell that is being + written. For small jobs or tests, a direct Kiji table output job can be created by modifying + out the .withOutput parameter to: + .withOutput(new DirectKijiTableMapReduceJobOutput(mOutputTable)) +

            +

            + +

            +

            +
            See Also:
            KijiTableImportDescriptor, + + Common logfile format
            +
            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
            CONF_FILE, CONF_LOG_RATE
            +  + + + + + + + + + + +
            +Constructor Summary
            CommonLogBulkImporter() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + voidproduce(org.apache.hadoop.io.Text value, + org.kiji.mapreduce.KijiTableContext context) + +
            +          Converts a line of text to a set of writes to context, and + an EntityId for the row.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
            cleanup, cleanupImporter, convert, getDestinationColumns, getEntityIdSource, getSource, getTimestampSource, incomplete, isOverrideTimestamp, produce, reject, setConf, setInputDescriptorPath, setLogRate, setup, setupImporter
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.bulkimport.KijiBulkImporter
            forName, getConf, getRequiredStores
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +CommonLogBulkImporter

            +
            +public CommonLogBulkImporter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +produce

            +
            +public void produce(org.apache.hadoop.io.Text value,
+                    org.kiji.mapreduce.KijiTableContext context)
+             throws IOException
            +
            +
            Converts a line of text to a set of writes to context, and + an EntityId for the row. +

            +

            +
            Specified by:
            produce in class DescribedInputTextBulkImporter
            +
            +
            +
            Parameters:
            value - The line to parse.
            context - The context to write to. +
            Throws: +
            IOException - if there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/DescribedInputTextBulkImporter.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/DescribedInputTextBulkImporter.html new file mode 100644 index 00000000..19b8e557 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/DescribedInputTextBulkImporter.html @@ -0,0 +1,759 @@ + + + + + + + +DescribedInputTextBulkImporter (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.bulkimport +
            +Class DescribedInputTextBulkImporter

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Text>
+      extended by org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            Direct Known Subclasses:
            CommonLogBulkImporter, CSVBulkImporter, JSONBulkImporter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class DescribedInputTextBulkImporter
            extends org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Text>
            + + +

            +DescribedInputTextBulkImporter is an abstract class that provides methods to bulk importers for + mapping from source fields in the import lines to destination Kiji columns. These can be used + inside of KijiBulkImportJobBuilder via the withBulkImporter method. + + Importing from a text file requires specifying a KijiColumnName, and the source field + for each element to be inserted into Kiji, in addition to the raw import data. This information + is provided by KijiTableImportDescriptor which is set via + the kiji.import.text.input.descriptor.path parameter in CONF_FILE. + +

            Use this Mapper over text files to import data into a Kiji + table. Each line in the file will be treated as data for one row. + This line should generate a single EntityId to write to, and any number + of writes to add to that entity. You should override the produce(String, Context) + method to generate the entities from the input lines.

            + + Extensions of this class should implement the following methods: + + + Extensions of this class can use the following methods to implement their producers: + +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_FILE + +
            +          Location of writer layout file.
            +static StringCONF_LOG_RATE + +
            +           
            +  + + + + + + + + + + +
            +Constructor Summary
            DescribedInputTextBulkImporter() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidcleanup(org.kiji.mapreduce.KijiTableContext context) + +
            +          Subclasses should implement the cleanupImporter(KijiTableContext) method instead.
            + voidcleanupImporter(org.kiji.mapreduce.KijiTableContext context) + +
            +          Extensible version of KijiBulkImporter.cleanup(org.kiji.mapreduce.KijiTableContext) for subclasses of + DescribedInputTextBulkImporter.
            + Objectconvert(org.kiji.schema.KijiColumnName kijiColumnName, + String value) + +
            +          Converts the value into an object of the type associated with the specified column.
            +protected  Collection<org.kiji.schema.KijiColumnName>getDestinationColumns() + +
            +           
            +protected  StringgetEntityIdSource() + +
            +           
            +protected  StringgetSource(org.kiji.schema.KijiColumnName kijiColumnName) + +
            +          Returns the source for the specified column, or null if the specified column is not a + destination column for this importer.
            +protected  StringgetTimestampSource() + +
            +           
            + voidincomplete(org.apache.hadoop.io.Text line, + org.kiji.mapreduce.KijiTableContext context, + String reason) + +
            +          Post-processes incomplete lines(Logging, keeping count, etc).
            +protected  booleanisOverrideTimestamp() + +
            +           
            + voidproduce(org.apache.hadoop.io.LongWritable fileOffset, + org.apache.hadoop.io.Text line, + org.kiji.mapreduce.KijiTableContext context) + +
            +          Subclasses should implement the produce(Text line, KijiTableContext context) method instead.
            +abstract  voidproduce(org.apache.hadoop.io.Text line, + org.kiji.mapreduce.KijiTableContext context) + +
            +          Converts a line of text to a set of writes to context, and + an EntityId for the row.
            + voidreject(org.apache.hadoop.io.Text line, + org.kiji.mapreduce.KijiTableContext context, + String reason) + +
            +          Post-processes rejected lines(Logging, keeping count, etc).
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            +protected  voidsetInputDescriptorPath(String inputDescriptorFile) + +
            +          Sets the input descriptor.
            +protected  voidsetLogRate(String logRateString) + +
            +          Sets the log rate - the number of lines between log statements for incomplete/rejected lines.
            + voidsetup(org.kiji.mapreduce.KijiTableContext context) + +
            +          Performs validation that this table import descriptor can be applied to the output table.
            + voidsetupImporter(org.kiji.mapreduce.KijiTableContext context) + +
            +          Extensible version of KijiBulkImporter.setup(org.kiji.mapreduce.KijiTableContext) for subclasses of + DescribedInputTextBulkImporter.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.bulkimport.KijiBulkImporter
            forName, getConf, getRequiredStores
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +CONF_FILE

            +
            +public static final String CONF_FILE
            +
            +
            Location of writer layout file. File names columns and schemas, and implies + ordering of columns in delimited read-in file. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_LOG_RATE

            +
            +public static final String CONF_LOG_RATE
            +
            +
            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +DescribedInputTextBulkImporter

            +
            +public DescribedInputTextBulkImporter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            Overrides:
            setConf in class org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Text>
            +
            +
            +
            +
            +
            +
            + +

            +setup

            +
            +public final void setup(org.kiji.mapreduce.KijiTableContext context)
+                 throws IOException
            +
            +
            Performs validation that this table import descriptor can be applied to the output table. This + method is final to prevent it from being overridden without being called. Subclasses should + override the setupImporter() method instead of overriding this method. + +

            +

            +
            Overrides:
            setup in class org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Text>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +setupImporter

            +
            +public void setupImporter(org.kiji.mapreduce.KijiTableContext context)
+                   throws IOException
            +
            +
            Extensible version of KijiBulkImporter.setup(org.kiji.mapreduce.KijiTableContext) for subclasses of + DescribedInputTextBulkImporter. + Does nothing by default. +

            +

            +
            Parameters:
            context - A context you can use to generate EntityIds and commit writes. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +produce

            +
            +public abstract void produce(org.apache.hadoop.io.Text line,
+                             org.kiji.mapreduce.KijiTableContext context)
+                      throws IOException
            +
            +
            Converts a line of text to a set of writes to context, and + an EntityId for the row. +

            +

            +
            Parameters:
            line - The line to parse.
            context - The context to write to. +
            Throws: +
            IOException - if there is an error.
            +
            +
            +
            + +

            +incomplete

            +
            +public void incomplete(org.apache.hadoop.io.Text line,
+                       org.kiji.mapreduce.KijiTableContext context,
+                       String reason)
            +
            +
            Post-processes incomplete lines(Logging, keeping count, etc). +

            +

            +
            Parameters:
            line - the line that was marked incomplete incomplete by the producer.
            context - the context in which the incompletion occured.
            reason - the reason why this line was incomplete.
            +
            +
            +
            + +

            +reject

            +
            +public void reject(org.apache.hadoop.io.Text line,
+                   org.kiji.mapreduce.KijiTableContext context,
+                   String reason)
            +
            +
            Post-processes rejected lines(Logging, keeping count, etc). +

            +

            +
            Parameters:
            line - the line that was rejected by the producer.
            context - the context in which the rejection occured.
            reason - the reason why this line was rejected.
            +
            +
            +
            + +

            +convert

            +
            +public Object convert(org.kiji.schema.KijiColumnName kijiColumnName,
+                      String value)
            +
            +
            Converts the value into an object of the type associated with the specified column. +

            +

            +
            Parameters:
            kijiColumnName - the destination column to infer the type from.
            value - string representation of the value. +
            Returns:
            object containing the parsed representation of the value.
            +
            +
            +
            + +

            +produce

            +
            +public final void produce(org.apache.hadoop.io.LongWritable fileOffset,
+                          org.apache.hadoop.io.Text line,
+                          org.kiji.mapreduce.KijiTableContext context)
+                   throws IOException
            +
            +
            Subclasses should implement the produce(Text line, KijiTableContext context) method instead. + +

            +

            +
            Specified by:
            produce in class org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Text>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getDestinationColumns

            +
            +protected final Collection<org.kiji.schema.KijiColumnName> getDestinationColumns()
            +
            +
            + +
            Returns:
            an unmodifiable collection of the columns for this bulk importer.
            +
            +
            +
            + +

            +getSource

            +
            +protected final String getSource(org.kiji.schema.KijiColumnName kijiColumnName)
            +
            +
            Returns the source for the specified column, or null if the specified column is not a + destination column for this importer. +

            +

            +
            Parameters:
            kijiColumnName - the requested Kiji column +
            Returns:
            the source for the requested column
            +
            +
            +
            + +

            +getEntityIdSource

            +
            +protected final String getEntityIdSource()
            +
            +
            + +
            Returns:
            the source for the EntityId.
            +
            +
            +
            + +

            +isOverrideTimestamp

            +
            +protected final boolean isOverrideTimestamp()
            +
            +
            + +
            Returns:
            whether to override the timestamp from system time.
            +
            +
            +
            + +

            +getTimestampSource

            +
            +protected final String getTimestampSource()
            +
            +
            + +
            Returns:
            the source for timestamp.
            +
            +
            +
            + +

            +cleanup

            +
            +public final void cleanup(org.kiji.mapreduce.KijiTableContext context)
+                   throws IOException
            +
            +
            Subclasses should implement the cleanupImporter(KijiTableContext) method instead. + +

            +

            +
            Overrides:
            cleanup in class org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Text>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +cleanupImporter

            +
            +public void cleanupImporter(org.kiji.mapreduce.KijiTableContext context)
+                     throws IOException
            +
            +
            Extensible version of KijiBulkImporter.cleanup(org.kiji.mapreduce.KijiTableContext) for subclasses of + DescribedInputTextBulkImporter. + Does nothing by default. +

            +

            +
            Parameters:
            context - A context you can use to generate EntityIds and commit writes. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +setLogRate

            +
            +protected void setLogRate(String logRateString)
            +
            +
            Sets the log rate - the number of lines between log statements for incomplete/rejected lines. +

            +

            +
            Parameters:
            logRateString - The logging rate as a string.
            +
            +
            +
            + +

            +setInputDescriptorPath

            +
            +protected void setInputDescriptorPath(String inputDescriptorFile)
            +
            +
            Sets the input descriptor. +

            +

            +
            Parameters:
            inputDescriptorFile - The input descriptor path.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/InvalidTableImportDescriptorException.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/InvalidTableImportDescriptorException.html new file mode 100644 index 00000000..f87330f6 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/InvalidTableImportDescriptorException.html @@ -0,0 +1,253 @@ + + + + + + + +InvalidTableImportDescriptorException (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.bulkimport +
            +Class InvalidTableImportDescriptorException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.mapreduce.lib.bulkimport.InvalidTableImportDescriptorException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public class InvalidTableImportDescriptorException
            extends IOException
            + + +

            +Thrown when an invalid Kiji table import descriptor is encountered. + A table import descriptor is invalid when either the columns specified in either the source + or the destination don't exist. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            InvalidTableImportDescriptorException(String reason) + +
            +          Creates a new InvalidTableImportDescriptorException with the specified reason.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +InvalidTableImportDescriptorException

            +
            +public InvalidTableImportDescriptorException(String reason)
            +
            +
            Creates a new InvalidTableImportDescriptorException with the specified reason. +

            +

            +
            Parameters:
            reason - A message describing the reason the mapping is invalid.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/JSONBulkImporter.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/JSONBulkImporter.html new file mode 100644 index 00000000..2913d639 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/JSONBulkImporter.html @@ -0,0 +1,348 @@ + + + + + + + +JSONBulkImporter (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.bulkimport +
            +Class JSONBulkImporter

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.Text>
+      extended by org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
+          extended by org.kiji.mapreduce.lib.bulkimport.JSONBulkImporter
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            +
            @ApiAudience.Public
+public final class JSONBulkImporter
            extends DescribedInputTextBulkImporter
            + + +

            +Bulk importer that handles JSON files. The expected JSON file should be a set of records + separated by new lines + (see TextInputFormat). + Each line represents a separate JSON object to be imported into a row. Target + columns whose sources are not present in the JSON object are skipped. This bulk importer uses + google-gson to parse lines into fields. + + Complex paths in JSON are specified by strings delimited with periods(.). + +

            Creating a bulk import job for JSON files:

            +

            + The bulk importer can be passed into a + KijiBulkImportJobBuilder. A + KijiTableImportDescriptor, which defines the mapping from the import fields to the + destination Kiji columns, must be passed in as part of the job configuration. For writing + to an HFile which can later be loaded with the kiji bulk-load tool the job + creation looks like: +

            + 
            
+   // Set the import descriptor file to be used for this bulk importer.
+   conf.set(DescribedInputTextBulkImporter.CONF_FILE, "foo-test-import-descriptor.json");
+   // Configure and create the MapReduce job.
+   final MapReduceJob job = KijiBulkImportJobBuilder.create()
+       .withConf(conf)
+       .withBulkImporter(JSONBulkImporter.class)
+       .withInput(new TextMapReduceJobInput(new Path(inputFile.toString())))
+       .withOutput(new HFileMapReduceJobOutput(mOutputTable, hfileDirPath))
+       .build();
+
            +

            + Alternately the bulk importer can be configured to write directly to a Kiji Table. This is + not recommended because it generates individual puts for each cell that is being + written. For small jobs or tests, a direct Kiji table output job can be created by modifying + out the .withOutput parameter to: + .withOutput(new DirectKijiTableMapReduceJobOutput(mOutputTable)) +

            +

            + +

            +

            +
            See Also:
            KijiTableImportDescriptor
            +
            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
            CONF_FILE, CONF_LOG_RATE
            +  + + + + + + + + + + +
            +Constructor Summary
            JSONBulkImporter() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + voidproduce(org.apache.hadoop.io.Text value, + org.kiji.mapreduce.KijiTableContext context) + +
            +          Converts a line of text to a set of writes to context, and + an EntityId for the row.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter
            cleanup, cleanupImporter, convert, getDestinationColumns, getEntityIdSource, getSource, getTimestampSource, incomplete, isOverrideTimestamp, produce, reject, setConf, setInputDescriptorPath, setLogRate, setup, setupImporter
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.bulkimport.KijiBulkImporter
            forName, getConf, getRequiredStores
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +JSONBulkImporter

            +
            +public JSONBulkImporter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +produce

            +
            +public void produce(org.apache.hadoop.io.Text value,
+                    org.kiji.mapreduce.KijiTableContext context)
+             throws IOException
            +
            +
            Converts a line of text to a set of writes to context, and + an EntityId for the row. +

            +

            +
            Specified by:
            produce in class DescribedInputTextBulkImporter
            +
            +
            +
            Parameters:
            value - The line to parse.
            context - The context to write to. +
            Throws: +
            IOException - if there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/KijiTableImportDescriptor.FamilyLayout.ColumnLayout.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/KijiTableImportDescriptor.FamilyLayout.ColumnLayout.html new file mode 100644 index 00000000..acbef3b9 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/KijiTableImportDescriptor.FamilyLayout.ColumnLayout.html @@ -0,0 +1,309 @@ + + + + + + + +KijiTableImportDescriptor.FamilyLayout.ColumnLayout (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.bulkimport +
            +Class KijiTableImportDescriptor.FamilyLayout.ColumnLayout

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout.ColumnLayout
+
            +
            +
            Enclosing class:
            KijiTableImportDescriptor.FamilyLayout
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableImportDescriptor.FamilyLayout.ColumnLayout
            extends Object
            + + +

            +Concrete layout of a column. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTableImportDescriptor.FamilyLayout.ColumnLayout(ColumnDesc desc) + +
            +          Builds a new column layout instance from a descriptor.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiTableImportDescriptor.FamilyLayoutgetFamily() + +
            +           
            + StringgetName() + +
            +           
            + StringgetSource() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableImportDescriptor.FamilyLayout.ColumnLayout

            +
            +public KijiTableImportDescriptor.FamilyLayout.ColumnLayout(ColumnDesc desc)
+                                                    throws InvalidTableImportDescriptorException
            +
            +
            Builds a new column layout instance from a descriptor. +

            +

            +
            Parameters:
            desc - Column descriptor. +
            Throws: +
            InvalidTableImportDescriptorException - if the layout is invalid or inconsistent.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the name for the Kiji column.
            +
            +
            +
            + +

            +getSource

            +
            +public String getSource()
            +
            +
            + +
            Returns:
            the import source for the column.
            +
            +
            +
            + +

            +getFamily

            +
            +public KijiTableImportDescriptor.FamilyLayout getFamily()
            +
            +
            + +
            Returns:
            the family this column belongs to.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/KijiTableImportDescriptor.FamilyLayout.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/KijiTableImportDescriptor.FamilyLayout.html new file mode 100644 index 00000000..9770b497 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/KijiTableImportDescriptor.FamilyLayout.html @@ -0,0 +1,326 @@ + + + + + + + +KijiTableImportDescriptor.FamilyLayout (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.bulkimport +
            +Class KijiTableImportDescriptor.FamilyLayout

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout
+
            +
            +
            Enclosing class:
            KijiTableImportDescriptor
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiTableImportDescriptor.FamilyLayout
            extends Object
            + + +

            +Concrete layout of a family. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            + classKijiTableImportDescriptor.FamilyLayout.ColumnLayout + +
            +          Concrete layout of a column.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableImportDescriptor.FamilyLayout(FamilyDesc familyDesc) + +
            +          Builds a new family layout instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Map<String,KijiTableImportDescriptor.FamilyLayout.ColumnLayout>getColumnMap() + +
            +           
            + Collection<KijiTableImportDescriptor.FamilyLayout.ColumnLayout>getColumns() + +
            +           
            + StringgetName() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableImportDescriptor.FamilyLayout

            +
            +public KijiTableImportDescriptor.FamilyLayout(FamilyDesc familyDesc)
+                                       throws InvalidTableImportDescriptorException
            +
            +
            Builds a new family layout instance. +

            +

            +
            Parameters:
            familyDesc - Descriptor of the family. +
            Throws: +
            InvalidTableImportDescriptorException - if the layout is invalid or inconsistent.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the primary name for the family.
            +
            +
            +
            + +

            +getColumns

            +
            +public Collection<KijiTableImportDescriptor.FamilyLayout.ColumnLayout> getColumns()
            +
            +
            + +
            Returns:
            the columns in this family.
            +
            +
            +
            + +

            +getColumnMap

            +
            +public Map<String,KijiTableImportDescriptor.FamilyLayout.ColumnLayout> getColumnMap()
            +
            +
            + +
            Returns:
            the mapping from column names (no aliases) to column layouts.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/KijiTableImportDescriptor.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/KijiTableImportDescriptor.html new file mode 100644 index 00000000..df3fe5b2 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/KijiTableImportDescriptor.html @@ -0,0 +1,587 @@ + + + + + + + +KijiTableImportDescriptor (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.bulkimport +
            +Class KijiTableImportDescriptor

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableImportDescriptor
            extends Object
            + + +

            +Mapping of input schema to Kiji table layouts for bulk importers. + +

            + KijiTableImportDescriptor wraps a table import descriptor represented as a + TableImportDescriptorDesc Avro + record. KijiTableImportDescriptor provides validation and accessors to navigate + through the mapping. +

            + + Sample table import descriptor:
            
+ {
+   name : "foo", // destination table of the import
+   families : [ {
+     name : "info" // column family for the import
+     columns : [ {
+       name : "first_name", // name of the column within the column family
+       source : "first" // field in the source to import from
+     }, {
+      name : "last_name",
+      source : "last"
+     } ],
+   } ],
+   entityIdSource : "first", // field in the source to generate the entity id from.
+   overrideTimestampSource : "time", // optional field to use to set the timestamps on rows.
+   version : "import-1.0" // format version number of the import descriptor
+ }
+
            + +

            Overall structure

            +

            At the top-level, a table import descriptor contains: +

              +
            • the table that is the destination of the import.
              • +
            • the table column families.
              • +
            • the source for the entity id.
              • +
            • (optional) timestamp to use instead of system timestamp.
              • +
            • format version of the import descriptor.
              • +
            +

            + +

            Each column family has: +

              +
            • the name of the destination column.
              • +
            • the name of the source field to import from.
              • +
            +

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTableImportDescriptor.FamilyLayout + +
            +          Concrete layout of a family.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableImportDescriptor(TableImportDescriptorDesc desc) + +
            +          Constructs a KijiTableImportDescriptor from an Avro descriptor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiTableImportDescriptorcreateFromEffectiveJson(InputStream istream) + +
            +          Loads a table import mapping from the specified JSON text.
            +static KijiTableImportDescriptorcreateFromEffectiveJsonResource(String resource) + +
            +          Loads a table import mapping from the specified resource as JSON.
            + booleanequals(Object other) + +
            +          
            + Map<org.kiji.schema.KijiColumnName,String>getColumnNameSourceMap() + +
            +           
            + StringgetEntityIdSource() + +
            +           
            + StringgetName() + +
            +           
            + StringgetOverrideTimestampSource() + +
            +           
            + inthashCode() + +
            +          
            +static TableImportDescriptorDescreadTableImportDescriptorDescFromJSON(String json) + +
            +          Reads a table import mapping descriptor from its JSON serialized form.
            +static TableImportDescriptorDescreadTableImportMappingDescFromJSON(InputStream istream) + +
            +          Reads a table import mapping descriptor from its JSON serialized form.
            + StringtoString() + +
            +          
            + voidvalidateDestination(org.kiji.schema.layout.KijiTableLayout tableLayout) + +
            +          Validates that this table import descriptor can import data into the specified layout.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiTableImportDescriptor

            +
            +public KijiTableImportDescriptor(TableImportDescriptorDesc desc)
+                          throws InvalidTableImportDescriptorException
            +
            +
            Constructs a KijiTableImportDescriptor from an Avro descriptor. +

            +

            +
            Parameters:
            desc - Avro layout descriptor (relative to the reference layout). +
            Throws: +
            InvalidTableImportDescriptorException - if the descriptor is invalid or inconsistent + wrt reference.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the table name.
            +
            +
            +
            + +

            +getColumnNameSourceMap

            +
            +public Map<org.kiji.schema.KijiColumnName,String> getColumnNameSourceMap()
            +
            +
            + +
            Returns:
            mapping of column names to the source in the derived files.
            +
            +
            +
            + +

            +getOverrideTimestampSource

            +
            +public String getOverrideTimestampSource()
            +
            +
            + +
            Returns:
            the source for the timestamp.
            +
            +
            +
            + +

            +getEntityIdSource

            +
            +public String getEntityIdSource()
            +
            +
            + +
            Returns:
            the source for the entityId.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +createFromEffectiveJsonResource

            +
            +public static KijiTableImportDescriptor createFromEffectiveJsonResource(String resource)
+                                                                 throws IOException
            +
            +
            Loads a table import mapping from the specified resource as JSON. +

            +

            +
            Parameters:
            resource - Path of the resource containing the JSON layout description. +
            Returns:
            the parsed table layout. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +createFromEffectiveJson

            +
            +public static KijiTableImportDescriptor createFromEffectiveJson(InputStream istream)
+                                                         throws IOException
            +
            +
            Loads a table import mapping from the specified JSON text. The InputStream passed into this + method is closed upon completion. +

            +

            +
            Parameters:
            istream - Input stream containing the JSON text. +
            Returns:
            the parsed table layout. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +readTableImportMappingDescFromJSON

            +
            +public static TableImportDescriptorDesc readTableImportMappingDescFromJSON(InputStream istream)
+                                                                    throws IOException
            +
            +
            Reads a table import mapping descriptor from its JSON serialized form. +

            +

            +
            Parameters:
            istream - JSON input stream. +
            Returns:
            the decoded table layout descriptor. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +readTableImportDescriptorDescFromJSON

            +
            +public static TableImportDescriptorDesc readTableImportDescriptorDescFromJSON(String json)
+                                                                       throws IOException
            +
            +
            Reads a table import mapping descriptor from its JSON serialized form. +

            +

            +
            Parameters:
            json - JSON string. +
            Returns:
            the decoded table layout descriptor. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +validateDestination

            +
            +public void validateDestination(org.kiji.schema.layout.KijiTableLayout tableLayout)
+                         throws InvalidTableImportDescriptorException
            +
            +
            Validates that this table import descriptor can import data into the specified layout. This + is done by ensuring that every destination column exists in the specified table's layout. +

            +

            +
            Parameters:
            tableLayout - the table layout to validateDestination against +
            Throws: +
            InvalidTableImportDescriptorException - if the import mapping can not be applied to the + table layout
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/CSVBulkImporter.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/CSVBulkImporter.html new file mode 100644 index 00000000..2394068e --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/CSVBulkImporter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter

            +
            +No usage of org.kiji.mapreduce.lib.bulkimport.CSVBulkImporter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/CommonLogBulkImporter.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/CommonLogBulkImporter.html new file mode 100644 index 00000000..33c4599d --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/CommonLogBulkImporter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.bulkimport.CommonLogBulkImporter (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.bulkimport.CommonLogBulkImporter

            +
            +No usage of org.kiji.mapreduce.lib.bulkimport.CommonLogBulkImporter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/DescribedInputTextBulkImporter.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/DescribedInputTextBulkImporter.html new file mode 100644 index 00000000..fe177eee --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/DescribedInputTextBulkImporter.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.bulkimport.DescribedInputTextBulkImporter

            +
            + + + + + + + + + +
            +Packages that use DescribedInputTextBulkImporter
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR. 
            +  +

            + + + + + +
            +Uses of DescribedInputTextBulkImporter in org.kiji.mapreduce.lib.bulkimport
            +  +

            + + + + + + + + + + + + + + + + + +
            Subclasses of DescribedInputTextBulkImporter in org.kiji.mapreduce.lib.bulkimport
            + classCommonLogBulkImporter + +
            +          Bulk importer that takes lines from an NCSA/Apache common logs and can produce a row for each + entry in the log file.
            + classCSVBulkImporter + +
            +          Bulk importer that handles comma separated files.
            + classJSONBulkImporter + +
            +          Bulk importer that handles JSON files.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/InvalidTableImportDescriptorException.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/InvalidTableImportDescriptorException.html new file mode 100644 index 00000000..9d4a85ef --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/InvalidTableImportDescriptorException.html @@ -0,0 +1,207 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.bulkimport.InvalidTableImportDescriptorException (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.bulkimport.InvalidTableImportDescriptorException

            +
            + + + + + + + + + +
            +Packages that use InvalidTableImportDescriptorException
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR. 
            +  +

            + + + + + +
            +Uses of InvalidTableImportDescriptorException in org.kiji.mapreduce.lib.bulkimport
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.bulkimport that throw InvalidTableImportDescriptorException
            + voidKijiTableImportDescriptor.validateDestination(org.kiji.schema.layout.KijiTableLayout tableLayout) + +
            +          Validates that this table import descriptor can import data into the specified layout.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.mapreduce.lib.bulkimport that throw InvalidTableImportDescriptorException
            KijiTableImportDescriptor.FamilyLayout.ColumnLayout(ColumnDesc desc) + +
            +          Builds a new column layout instance from a descriptor.
            KijiTableImportDescriptor.FamilyLayout(FamilyDesc familyDesc) + +
            +          Builds a new family layout instance.
            KijiTableImportDescriptor(TableImportDescriptorDesc desc) + +
            +          Constructs a KijiTableImportDescriptor from an Avro descriptor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/JSONBulkImporter.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/JSONBulkImporter.html new file mode 100644 index 00000000..dde13d40 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/JSONBulkImporter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.bulkimport.JSONBulkImporter (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.bulkimport.JSONBulkImporter

            +
            +No usage of org.kiji.mapreduce.lib.bulkimport.JSONBulkImporter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/KijiTableImportDescriptor.FamilyLayout.ColumnLayout.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/KijiTableImportDescriptor.FamilyLayout.ColumnLayout.html new file mode 100644 index 00000000..efc5b8a8 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/KijiTableImportDescriptor.FamilyLayout.ColumnLayout.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout.ColumnLayout (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout.ColumnLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableImportDescriptor.FamilyLayout.ColumnLayout
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR. 
            +  +

            + + + + + +
            +Uses of KijiTableImportDescriptor.FamilyLayout.ColumnLayout in org.kiji.mapreduce.lib.bulkimport
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.bulkimport that return types with arguments of type KijiTableImportDescriptor.FamilyLayout.ColumnLayout
            + Map<String,KijiTableImportDescriptor.FamilyLayout.ColumnLayout>KijiTableImportDescriptor.FamilyLayout.getColumnMap() + +
            +           
            + Collection<KijiTableImportDescriptor.FamilyLayout.ColumnLayout>KijiTableImportDescriptor.FamilyLayout.getColumns() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/KijiTableImportDescriptor.FamilyLayout.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/KijiTableImportDescriptor.FamilyLayout.html new file mode 100644 index 00000000..05ef5ec9 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/KijiTableImportDescriptor.FamilyLayout.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor.FamilyLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableImportDescriptor.FamilyLayout
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR. 
            +  +

            + + + + + +
            +Uses of KijiTableImportDescriptor.FamilyLayout in org.kiji.mapreduce.lib.bulkimport
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.bulkimport that return KijiTableImportDescriptor.FamilyLayout
            + KijiTableImportDescriptor.FamilyLayoutKijiTableImportDescriptor.FamilyLayout.ColumnLayout.getFamily() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/KijiTableImportDescriptor.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/KijiTableImportDescriptor.html new file mode 100644 index 00000000..2289ae4b --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/class-use/KijiTableImportDescriptor.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.bulkimport.KijiTableImportDescriptor

            +
            + + + + + + + + + +
            +Packages that use KijiTableImportDescriptor
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR. 
            +  +

            + + + + + +
            +Uses of KijiTableImportDescriptor in org.kiji.mapreduce.lib.bulkimport
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.bulkimport that return KijiTableImportDescriptor
            +static KijiTableImportDescriptorKijiTableImportDescriptor.createFromEffectiveJson(InputStream istream) + +
            +          Loads a table import mapping from the specified JSON text.
            +static KijiTableImportDescriptorKijiTableImportDescriptor.createFromEffectiveJsonResource(String resource) + +
            +          Loads a table import mapping from the specified resource as JSON.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-frame.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-frame.html new file mode 100644 index 00000000..4f1fdc0a --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-frame.html @@ -0,0 +1,54 @@ + + + + + + + +org.kiji.mapreduce.lib.bulkimport (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.lib.bulkimport + + + + +
            +Classes  + +
            +CommonLogBulkImporter +
            +CSVBulkImporter +
            +DescribedInputTextBulkImporter +
            +JSONBulkImporter +
            +KijiTableImportDescriptor +
            +KijiTableImportDescriptor.FamilyLayout
            + + + + + + +
            +Exceptions  + +
            +InvalidTableImportDescriptorException
            + + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-summary.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-summary.html new file mode 100644 index 00000000..d2082a7e --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-summary.html @@ -0,0 +1,234 @@ + + + + + + + +org.kiji.mapreduce.lib.bulkimport (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.lib.bulkimport +

            +Bulk importers for KijiMR. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            CommonLogBulkImporterBulk importer that takes lines from an NCSA/Apache common logs and can produce a row for each + entry in the log file.
            CSVBulkImporterBulk importer that handles comma separated files.
            DescribedInputTextBulkImporterDescribedInputTextBulkImporter is an abstract class that provides methods to bulk importers for + mapping from source fields in the import lines to destination Kiji columns.
            JSONBulkImporterBulk importer that handles JSON files.
            KijiTableImportDescriptorMapping of input schema to Kiji table layouts for bulk importers.
            KijiTableImportDescriptor.FamilyLayoutConcrete layout of a family.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            InvalidTableImportDescriptorExceptionThrown when an invalid Kiji table import descriptor is encountered.
            +  + +

            +

            +Package org.kiji.mapreduce.lib.bulkimport Description +

            + +

            +Bulk importers for KijiMR. + +

            + Bulk importers are used for parsing data from input sources into fields which correspond to + Kiji columns. Bulk import jobs in KijiMR can be created using the + KijiBulkImportJobBuilder. There are two options for importing data + into Kiji tables: using a bulk importer to create HFiles or "putting" individual rows. A bulk + importer is suitable for reading in data from files, whereas putting is suitable for importing + individual rows. Bulk importers can be invoked using the kiji bulk-import tool. + Generated HFiles from bulk importers can subsequently be loaded using the + kiji bulk-load tool. +

            + +

            Usable bulk importers:

            +
          • CommonLogBulkImporter - Common Log bulk + importer
            • +
          • CSVBulkImporter - CSV (Comma Separated Value) + bulk importer that also processes TSV(Tab Separated Values).
            • +
          • JSONBulkImporter - JSON bulk importer + +

            Related Documentation:

            +
          • DescribedInputTextBulkImporter - Base class for + bulk importing of any form of structured text class. Other bulk importers will inherit + from this including:
            • +
          • KijiTableImportDescriptor - The bulk import + mapping import configuration.
            • +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-tree.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-tree.html new file mode 100644 index 00000000..6ebb7825 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-tree.html @@ -0,0 +1,166 @@ + + + + + + + +org.kiji.mapreduce.lib.bulkimport Class Hierarchy (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.lib.bulkimport +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-use.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-use.html new file mode 100644 index 00000000..475e26b8 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/bulkimport/package-use.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.lib.bulkimport (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.lib.bulkimport

            +
            + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.lib.bulkimport
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR. 
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.lib.bulkimport used by org.kiji.mapreduce.lib.bulkimport
            DescribedInputTextBulkImporter + +
            +          DescribedInputTextBulkImporter is an abstract class that provides methods to bulk importers for + mapping from source fields in the import lines to destination Kiji columns.
            InvalidTableImportDescriptorException + +
            +          Thrown when an invalid Kiji table import descriptor is encountered.
            KijiTableImportDescriptor + +
            +          Mapping of input schema to Kiji table layouts for bulk importers.
            KijiTableImportDescriptor.FamilyLayout + +
            +          Concrete layout of a family.
            KijiTableImportDescriptor.FamilyLayout.ColumnLayout + +
            +          Concrete layout of a column.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainCountGatherJob.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainCountGatherJob.html new file mode 100644 index 00000000..59bc9869 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainCountGatherJob.html @@ -0,0 +1,340 @@ + + + + + + + +EmailDomainCountGatherJob (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.examples +
            +Class EmailDomainCountGatherJob

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.mapreduce.lib.examples.EmailDomainCountGatherJob
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool
            +
            +
            +
            +
            public class EmailDomainCountGatherJob
            extends org.apache.hadoop.conf.Configured
            implements org.apache.hadoop.util.Tool
            + + +

            +A program that runs the EmailDomainCountGatherer + over a Kiji table. + +

            To run this job from the command line:

            + + 
            + $ java -cp `$KIJI_HOME/bin/kiji classpath` \
+ >   org.kiji.mapreduce.lib.examples.EmailDomainCountGatherJob \
+ >   instance-name table-name output-path num-splits
+
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EmailDomainCountGatherJob() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidmain(String[] args) + +
            +          The program's entry point.
            + intrun(String[] args) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +EmailDomainCountGatherJob

            +
            +public EmailDomainCountGatherJob()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +run

            +
            +public int run(String[] args)
+        throws Exception
            +
            +
            +

            +

            +
            Specified by:
            run in interface org.apache.hadoop.util.Tool
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            The program's entry point. + + 
            + USAGE:
+
+     EmailDomainCountGatherJob <kiji-instance> <kiji-table> <output-path>
+       <num-splits>
+
+ ARGUMENTS:
+
+     kiji-instance: Name of the kiji instance the table is in.
+
+     kiji-table: Name of the kiji table gather over.
+
+     output-path: The path to the output files to generate.
+
+     num-splits: The number of output file shards to generate (determines number of reducers).
+
            +

            +

            +
            +
            +
            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainCountGatherer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainCountGatherer.html new file mode 100644 index 00000000..e3406695 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainCountGatherer.html @@ -0,0 +1,383 @@ + + + + + + + +EmailDomainCountGatherer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.examples +
            +Class EmailDomainCountGatherer

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.gather.KijiGatherer<org.apache.hadoop.io.Text,org.apache.hadoop.io.IntWritable>
+      extended by org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.KijiDataRequester, org.kiji.mapreduce.KVOutputJob, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            +
            public class EmailDomainCountGatherer
            extends org.kiji.mapreduce.gather.KijiGatherer<org.apache.hadoop.io.Text,org.apache.hadoop.io.IntWritable>
            + + +

            +Computes the domain from the email, and outputs it as the key with an int count of 1. + +

            When used with an IntSumReducer, the resulting dataset is a map from + email domains to the number of users with that email domain.

            + +

            To run this from the command line:

            + + 

            + $ $KIJI_HOME/bin/kiji gather \
+ >   --input=kiji:tablename \
+ >   --gatherer=org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer \
+ >   --reducer=org.kiji.mapreduce.lib.reduce.IntSumReducer \
+ >   --output=text:email-domain-counts@1
+
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EmailDomainCountGatherer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidgather(org.kiji.schema.KijiRowData input, + org.kiji.mapreduce.gather.GathererContext context) + +
            +          
            + org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          
            + Class<?>getOutputKeyClass() + +
            +          
            + Class<?>getOutputValueClass() + +
            +          
            + voidsetup(org.kiji.mapreduce.gather.GathererContext context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.gather.KijiGatherer
            cleanup, forName, getConf, getRequiredStores, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EmailDomainCountGatherer

            +
            +public EmailDomainCountGatherer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +setup

            +
            +public void setup(org.kiji.mapreduce.gather.GathererContext context)
+           throws IOException
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.kiji.mapreduce.gather.KijiGatherer<org.apache.hadoop.io.Text,org.apache.hadoop.io.IntWritable>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +gather

            +
            +public void gather(org.kiji.schema.KijiRowData input,
+                   org.kiji.mapreduce.gather.GathererContext context)
+            throws IOException
            +
            +
            +

            +

            +
            Specified by:
            gather in class org.kiji.mapreduce.gather.KijiGatherer<org.apache.hadoop.io.Text,org.apache.hadoop.io.IntWritable>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainPopularityJob.DescendingIntWritableComparator.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainPopularityJob.DescendingIntWritableComparator.html new file mode 100644 index 00000000..66146c65 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainPopularityJob.DescendingIntWritableComparator.html @@ -0,0 +1,296 @@ + + + + + + + +EmailDomainPopularityJob.DescendingIntWritableComparator (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.examples +
            +Class EmailDomainPopularityJob.DescendingIntWritableComparator

            +
            +java.lang.Object
+  extended by org.apache.hadoop.io.WritableComparator
+      extended by org.apache.hadoop.io.IntWritable.Comparator
+          extended by org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob.DescendingIntWritableComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator, org.apache.hadoop.io.RawComparator
            +
            +
            +
            Enclosing class:
            EmailDomainPopularityJob
            +
            +
            +
            +
            public static class EmailDomainPopularityJob.DescendingIntWritableComparator
            extends org.apache.hadoop.io.IntWritable.Comparator
            + + +

            +A comparator that sorts IntWritables in descending order. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EmailDomainPopularityJob.DescendingIntWritableComparator() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + intcompare(byte[] b1, + int s1, + int l1, + byte[] b2, + int s2, + int l2) + +
            +           
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.io.WritableComparator
            compare, compare, compareBytes, define, get, getKeyClass, hashBytes, hashBytes, newKey, readDouble, readFloat, readInt, readLong, readUnsignedShort, readVInt, readVLong
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

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

            +EmailDomainPopularityJob.DescendingIntWritableComparator

            +
            +public EmailDomainPopularityJob.DescendingIntWritableComparator()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(byte[] b1,
+                   int s1,
+                   int l1,
+                   byte[] b2,
+                   int s2,
+                   int l2)
            +
            +
            +
            Specified by:
            compare in interface org.apache.hadoop.io.RawComparator
            Overrides:
            compare in class org.apache.hadoop.io.IntWritable.Comparator
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainPopularityJob.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainPopularityJob.html new file mode 100644 index 00000000..dde6138a --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainPopularityJob.html @@ -0,0 +1,365 @@ + + + + + + + +EmailDomainPopularityJob (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.examples +
            +Class EmailDomainPopularityJob

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool
            +
            +
            +
            +
            public class EmailDomainPopularityJob
            extends org.apache.hadoop.conf.Configured
            implements org.apache.hadoop.util.Tool
            + + +

            +A program that generates an Avro file of email domains sorted by decreasing popularity. + +

            This program runs two MapReduce jobs:

            + +
              +
            1. The EmailDomainCountGatherer and IntSumReducer are used to generate a map from + email domains to their popularity.
              2. +
            2. The InvertCountMapper and TextListReducer are used to invert the output into a + sorted map from popularity to list of email domains.
              3. +
            + +

            To run this job from the command line:

            + + 
            + $ java -cp `$KIJI_HOME/bin/kiji classpath` \
+ >   org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob \
+ >   instance-name table-name output-path num-splits
+
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classEmailDomainPopularityJob.DescendingIntWritableComparator + +
            +          A comparator that sorts IntWritables in descending order.
            +  + + + + + + + + + + +
            +Constructor Summary
            EmailDomainPopularityJob() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidmain(String[] args) + +
            +          The program's entry point.
            + intrun(String[] args) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +EmailDomainPopularityJob

            +
            +public EmailDomainPopularityJob()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +run

            +
            +public int run(String[] args)
+        throws Exception
            +
            +
            +

            +

            +
            Specified by:
            run in interface org.apache.hadoop.util.Tool
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            The program's entry point. + + 
            + USAGE:
+
+     EmailDomainPopularityJob <kiji-instance> <kiji-table> <output-path>
+      <num-splits>
+
+ ARGUMENTS:
+
+     kiji-instance: Name of the kiji instance the table is in.
+
+     kiji-table: Name of the kiji table gather over.
+
+     output-path: The path to the output files to generate.
+
+     num-splits: The number of output file shards to generate (determines number of reducers).
+
            +

            +

            +
            +
            +
            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainProduceJob.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainProduceJob.html new file mode 100644 index 00000000..6d90e6b7 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainProduceJob.html @@ -0,0 +1,335 @@ + + + + + + + +EmailDomainProduceJob (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.examples +
            +Class EmailDomainProduceJob

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.mapreduce.lib.examples.EmailDomainProduceJob
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool
            +
            +
            +
            +
            public class EmailDomainProduceJob
            extends org.apache.hadoop.conf.Configured
            implements org.apache.hadoop.util.Tool
            + + +

            +A program that runs the EmailDomainProducer + over a Kiji table. + +

            To run this job from the command line:

            + + 
            + $ java -cp `$KIJI_HOME/bin/kiji classpath` \
+ >   org.kiji.mapreduce.lib.examples.EmailDomainProduceJob \
+ >   instance-name table-name
+
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EmailDomainProduceJob() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidmain(String[] args) + +
            +          The program's entry point.
            + intrun(String[] args) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +EmailDomainProduceJob

            +
            +public EmailDomainProduceJob()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +run

            +
            +public int run(String[] args)
+        throws Exception
            +
            +
            +

            +

            +
            Specified by:
            run in interface org.apache.hadoop.util.Tool
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            The program's entry point. + + 
            + USAGE:
+
+     EmailDomainProduceJob <kiji-instance> <kiji-table>
+
+ ARGUMENTS:
+
+     kiji-instance: Name of the kiji instance the table is in.
+
+     kiji-table: Name of the kiji table to produce over.
+
            +

            +

            +
            +
            +
            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainProducer.html new file mode 100644 index 00000000..e33df101 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/EmailDomainProducer.html @@ -0,0 +1,339 @@ + + + + + + + +EmailDomainProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.examples +
            +Class EmailDomainProducer

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.produce.KijiProducer
+      extended by org.kiji.mapreduce.lib.examples.EmailDomainProducer
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.KijiDataRequester, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            +
            public class EmailDomainProducer
            extends org.kiji.mapreduce.produce.KijiProducer
            + + +

            +Extracts the domain of a user by reading their email address from the info:email column. + +

            The extracted email domain is written to the derived:domain column.

            + +

            To run this from the command line:

            + + 
            + $ $KIJI_HOME/bin/kiji produce \
+ >   --input=kiji:tablename \
+ >   --producer=org.kiji.mapreduce.lib.examples.EmailDomainProducer
+ >   --output=kiji \
+
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EmailDomainProducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          
            + StringgetOutputColumn() + +
            +          
            + voidproduce(org.kiji.schema.KijiRowData input, + org.kiji.mapreduce.produce.ProducerContext context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.produce.KijiProducer
            cleanup, getConf, getRequiredStores, setConf, setup
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EmailDomainProducer

            +
            +public EmailDomainProducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            +

            +

            +
            Specified by:
            getDataRequest in interface org.kiji.mapreduce.KijiDataRequester
            Specified by:
            getDataRequest in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            +
            +
            +
            +
            + +

            +getOutputColumn

            +
            +public String getOutputColumn()
            +
            +
            +

            +

            +
            Specified by:
            getOutputColumn in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            +
            +
            +
            +
            + +

            +produce

            +
            +public void produce(org.kiji.schema.KijiRowData input,
+                    org.kiji.mapreduce.produce.ProducerContext context)
+             throws IOException
            +
            +
            +

            +

            +
            Specified by:
            produce in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/InvertCountMapper.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/InvertCountMapper.html new file mode 100644 index 00000000..4844401e --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/InvertCountMapper.html @@ -0,0 +1,360 @@ + + + + + + + +InvertCountMapper (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.examples +
            +Class InvertCountMapper

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Mapper<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiMapper<org.apache.hadoop.io.Text,org.apache.hadoop.io.IntWritable,org.apache.hadoop.io.IntWritable,org.apache.hadoop.io.Text>
+          extended by org.kiji.mapreduce.lib.examples.InvertCountMapper
+
            +
            +
            All Implemented Interfaces:
            org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            public class InvertCountMapper
            extends org.kiji.mapreduce.KijiMapper<org.apache.hadoop.io.Text,org.apache.hadoop.io.IntWritable,org.apache.hadoop.io.IntWritable,org.apache.hadoop.io.Text>
            + + +

            +A map that inverts its (Text, IntWritable) records into (IntWritable, Text) records. + +

            This useful if you need to sort the value from the results of a previous job. For + example, you could use this map to invert the output of the + EmailDomainCountGatherJob to generate a dataset of email domains sorted by their + popularity.

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Mapper
            org.apache.hadoop.mapreduce.Mapper.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            InvertCountMapper() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Class<?>getOutputKeyClass() + +
            +          
            + Class<?>getOutputValueClass() + +
            +          
            + voidmap(org.apache.hadoop.io.Text key, + org.apache.hadoop.io.IntWritable value, + org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiMapper
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Mapper
            cleanup, run, setup
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +InvertCountMapper

            +
            +public InvertCountMapper()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +map

            +
            +public void map(org.apache.hadoop.io.Text key,
+                org.apache.hadoop.io.IntWritable value,
+                org.apache.hadoop.mapreduce.Mapper.Context context)
+         throws IOException,
+                InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            map in class org.apache.hadoop.mapreduce.Mapper<org.apache.hadoop.io.Text,org.apache.hadoop.io.IntWritable,org.apache.hadoop.io.IntWritable,org.apache.hadoop.io.Text>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/News20BulkImporter.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/News20BulkImporter.html new file mode 100644 index 00000000..9fde8ac7 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/News20BulkImporter.html @@ -0,0 +1,397 @@ + + + + + + + +News20BulkImporter (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.examples +
            +Class News20BulkImporter

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
+      extended by org.kiji.mapreduce.lib.examples.News20BulkImporter
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            +
            public class News20BulkImporter
            extends org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            + + +

            +

            A bulk importer that takes qualified_path/raw_article key/value pairs, + and loads these into kiji. The article name is specified by the + parent folder and name of this article (This is to guarantee unique names). + The classification is specified by the parent + folder to this article. The raw article to store is passed in as the value.

            + +

            For example, the calling the produce() method with key:value of

            + "some/path/sci.med/12345":"This is the article text" +

            will generate a single row in kiji with fields:

            +

              +
            • name: "sci.med.12345"
              • +
            • category: "sci.med"
              • +
            • raw_article: "This is the article text"
              • +
            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringARTICLE_NAME_QUALIFIER + +
            +          Qualifier storing the article name.
            +static StringCATEGORY_QUALIFIER + +
            +          Qualifier storing the article category.
            +static StringFAMILY + +
            +          The family to write input data to.
            +static StringRAW_ARTICLE_QUALIFIER + +
            +          Qualifier storing the raw text of an article.
            +  + + + + + + + + + + +
            +Constructor Summary
            News20BulkImporter() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + voidproduce(org.apache.hadoop.io.Text key, + org.apache.hadoop.io.Text value, + org.kiji.mapreduce.KijiTableContext context) + +
            +          Reads a single news article, and writes its contents to a new kiji row, + indexed by the article's name (A string consisting of the parent folder, and + this article's hash), and the a priori categorization of this article.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.bulkimport.KijiBulkImporter
            cleanup, forName, getConf, getRequiredStores, setConf, setup
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +FAMILY

            +
            +public static final String FAMILY
            +
            +
            The family to write input data to. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +ARTICLE_NAME_QUALIFIER

            +
            +public static final String ARTICLE_NAME_QUALIFIER
            +
            +
            Qualifier storing the article name. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CATEGORY_QUALIFIER

            +
            +public static final String CATEGORY_QUALIFIER
            +
            +
            Qualifier storing the article category. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +RAW_ARTICLE_QUALIFIER

            +
            +public static final String RAW_ARTICLE_QUALIFIER
            +
            +
            Qualifier storing the raw text of an article. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +News20BulkImporter

            +
            +public News20BulkImporter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +produce

            +
            +public void produce(org.apache.hadoop.io.Text key,
+                    org.apache.hadoop.io.Text value,
+                    org.kiji.mapreduce.KijiTableContext context)
+             throws IOException
            +
            +
            Reads a single news article, and writes its contents to a new kiji row, + indexed by the article's name (A string consisting of the parent folder, and + this article's hash), and the a priori categorization of this article. +

            +

            +
            Specified by:
            produce in class org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            +
            Parameters:
            key - The fully qualified path to the current file we're reading.
            value - The raw data to insert into this column.
            context - The context to write to. +
            Throws: +
            IOException - if there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/TextListReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/TextListReducer.html new file mode 100644 index 00000000..aef2ff81 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/TextListReducer.html @@ -0,0 +1,469 @@ + + + + + + + +TextListReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.examples +
            +Class TextListReducer<K>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Reducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiReducer<K,org.apache.hadoop.io.Text,K,org.apache.avro.mapred.AvroValue<List<CharSequence>>>
+          extended by org.kiji.mapreduce.lib.examples.TextListReducer<K>
+
            +
            +
            Type Parameters:
            K - The input key type, which will also be used as the output key type.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.avro.AvroValueWriter, org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            public class TextListReducer<K>
            extends org.kiji.mapreduce.KijiReducer<K,org.apache.hadoop.io.Text,K,org.apache.avro.mapred.AvroValue<List<CharSequence>>>
            implements org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.avro.AvroValueWriter
            + + +

            +A reducer that aggregates its text input values into a list. + +

            The MapReduce framework will group all output records from the map phase with the + same key. A call to the reduce() method will be made for each input + group. This reducer will aggregate all the values within a group into a single list to + be output as the value. Avro is used to output the complex list value.

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Reducer
            org.apache.hadoop.mapreduce.Reducer.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            TextListReducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.apache.avro.SchemagetAvroValueWriterSchema() + +
            +          
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +          
            + Class<?>getOutputKeyClass() + +
            +          
            + Class<?>getOutputValueClass() + +
            +          
            + voidreduce(K key, + Iterable<org.apache.hadoop.io.Text> values, + org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            + voidsetup(org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiReducer
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Reducer
            cleanup, run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +TextListReducer

            +
            +public TextListReducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +setup

            +
            +public void setup(org.apache.hadoop.mapreduce.Reducer.Context context)
+           throws IOException,
+                  InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.apache.hadoop.mapreduce.Reducer<K,org.apache.hadoop.io.Text,K,org.apache.avro.mapred.AvroValue<List<CharSequence>>>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +reduce

            +
            +public void reduce(K key,
+                   Iterable<org.apache.hadoop.io.Text> values,
+                   org.apache.hadoop.mapreduce.Reducer.Context context)
+            throws IOException,
+                   InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            reduce in class org.apache.hadoop.mapreduce.Reducer<K,org.apache.hadoop.io.Text,K,org.apache.avro.mapred.AvroValue<List<CharSequence>>>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputKeyClass in interface org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputValueClass in interface org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            +
            +
            + +

            +getAvroValueWriterSchema

            +
            +public org.apache.avro.Schema getAvroValueWriterSchema()
            +
            +
            +

            +

            +
            Specified by:
            getAvroValueWriterSchema in interface org.kiji.mapreduce.avro.AvroValueWriter
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainCountGatherJob.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainCountGatherJob.html new file mode 100644 index 00000000..1628a258 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainCountGatherJob.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherJob (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.examples.EmailDomainCountGatherJob

            +
            +No usage of org.kiji.mapreduce.lib.examples.EmailDomainCountGatherJob +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainCountGatherer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainCountGatherer.html new file mode 100644 index 00000000..d84c9802 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainCountGatherer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer

            +
            +No usage of org.kiji.mapreduce.lib.examples.EmailDomainCountGatherer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainPopularityJob.DescendingIntWritableComparator.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainPopularityJob.DescendingIntWritableComparator.html new file mode 100644 index 00000000..e7f4db27 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainPopularityJob.DescendingIntWritableComparator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob.DescendingIntWritableComparator (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob.DescendingIntWritableComparator

            +
            +No usage of org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob.DescendingIntWritableComparator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainPopularityJob.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainPopularityJob.html new file mode 100644 index 00000000..b6925f39 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainPopularityJob.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob

            +
            +No usage of org.kiji.mapreduce.lib.examples.EmailDomainPopularityJob +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainProduceJob.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainProduceJob.html new file mode 100644 index 00000000..e6f07c94 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainProduceJob.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.examples.EmailDomainProduceJob (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.examples.EmailDomainProduceJob

            +
            +No usage of org.kiji.mapreduce.lib.examples.EmailDomainProduceJob +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainProducer.html new file mode 100644 index 00000000..cc8bec15 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/EmailDomainProducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.examples.EmailDomainProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.examples.EmailDomainProducer

            +
            +No usage of org.kiji.mapreduce.lib.examples.EmailDomainProducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/InvertCountMapper.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/InvertCountMapper.html new file mode 100644 index 00000000..7996799d --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/InvertCountMapper.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.examples.InvertCountMapper (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.examples.InvertCountMapper

            +
            +No usage of org.kiji.mapreduce.lib.examples.InvertCountMapper +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/News20BulkImporter.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/News20BulkImporter.html new file mode 100644 index 00000000..53b4c15c --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/News20BulkImporter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.examples.News20BulkImporter (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.examples.News20BulkImporter

            +
            +No usage of org.kiji.mapreduce.lib.examples.News20BulkImporter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/TextListReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/TextListReducer.html new file mode 100644 index 00000000..4a06a775 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/class-use/TextListReducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.examples.TextListReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.examples.TextListReducer

            +
            +No usage of org.kiji.mapreduce.lib.examples.TextListReducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-frame.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-frame.html new file mode 100644 index 00000000..9d8a7197 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-frame.html @@ -0,0 +1,49 @@ + + + + + + + +org.kiji.mapreduce.lib.examples (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.lib.examples + + + + +
            +Classes  + +
            +EmailDomainCountGatherer +
            +EmailDomainCountGatherJob +
            +EmailDomainPopularityJob +
            +EmailDomainPopularityJob.DescendingIntWritableComparator +
            +EmailDomainProduceJob +
            +EmailDomainProducer +
            +InvertCountMapper +
            +News20BulkImporter +
            +TextListReducer
            + + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-summary.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-summary.html new file mode 100644 index 00000000..80c3404d --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-summary.html @@ -0,0 +1,210 @@ + + + + + + + +org.kiji.mapreduce.lib.examples (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.lib.examples +

            +Simple examples of using the KijiMR library API to write gatherers, producers, + and importers. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            EmailDomainCountGathererComputes the domain from the email, and outputs it as the key with an int count of 1.
            EmailDomainCountGatherJobA program that runs the EmailDomainCountGatherer + over a Kiji table.
            EmailDomainPopularityJobA program that generates an Avro file of email domains sorted by decreasing popularity.
            EmailDomainPopularityJob.DescendingIntWritableComparatorA comparator that sorts IntWritables in descending order.
            EmailDomainProduceJobA program that runs the EmailDomainProducer + over a Kiji table.
            EmailDomainProducerExtracts the domain of a user by reading their email address from the info:email column.
            InvertCountMapperA map that inverts its (Text, IntWritable) records into (IntWritable, Text) records.
            News20BulkImporterA bulk importer that takes qualified_path/raw_article key/value pairs, + and loads these into kiji.
            TextListReducer<K>A reducer that aggregates its text input values into a list.
            +  + +

            +

            +Package org.kiji.mapreduce.lib.examples Description +

            + +

            +Simple examples of using the KijiMR library API to write gatherers, producers, + and importers. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-tree.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-tree.html new file mode 100644 index 00000000..dd8f82e1 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-tree.html @@ -0,0 +1,185 @@ + + + + + + + +org.kiji.mapreduce.lib.examples Class Hierarchy (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.lib.examples +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.hadoop.conf.Configured (implements org.apache.hadoop.conf.Configurable) + +
              • org.kiji.mapreduce.bulkimport.KijiBulkImporter<K,V> (implements org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.kvstore.KeyValueStoreClient) + +
              • org.kiji.mapreduce.gather.KijiGatherer<K,V> (implements org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.kvstore.KeyValueStoreClient, org.kiji.mapreduce.KijiDataRequester, org.kiji.mapreduce.KVOutputJob) + +
              • org.kiji.mapreduce.produce.KijiProducer (implements org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.kvstore.KeyValueStoreClient, org.kiji.mapreduce.KijiDataRequester) + +
              • org.apache.hadoop.mapreduce.Mapper<KEYIN,VALUEIN,KEYOUT,VALUEOUT>
                  +
                • org.kiji.mapreduce.KijiMapper<INKEY,INVALUE,OUTKEY,OUTVALUE> (implements org.kiji.mapreduce.KVOutputJob) + +
                +
              • org.apache.hadoop.mapreduce.Reducer<KEYIN,VALUEIN,KEYOUT,VALUEOUT>
                  +
                • org.kiji.mapreduce.KijiReducer<INKEY,INVALUE,OUTKEY,OUTVALUE> (implements org.kiji.mapreduce.KVOutputJob) +
                    +
                  • org.kiji.mapreduce.lib.examples.TextListReducer<K> (implements org.kiji.mapreduce.avro.AvroValueWriter, org.apache.hadoop.conf.Configurable) +
                  +
                +
              • org.apache.hadoop.io.WritableComparator (implements org.apache.hadoop.io.RawComparator<T>) + +
              +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-use.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-use.html new file mode 100644 index 00000000..751fee7a --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/examples/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.lib.examples (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.lib.examples

            +
            +No usage of org.kiji.mapreduce.lib.examples +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/MapTypeDelimitedFileGatherer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/MapTypeDelimitedFileGatherer.html new file mode 100644 index 00000000..3e26e097 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/MapTypeDelimitedFileGatherer.html @@ -0,0 +1,446 @@ + + + + + + + +MapTypeDelimitedFileGatherer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.gather +
            +Class MapTypeDelimitedFileGatherer

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.gather.KijiGatherer<org.apache.hadoop.io.Text,org.apache.hadoop.io.NullWritable>
+      extended by org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.KijiDataRequester, org.kiji.mapreduce.KVOutputJob, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            +
            public class MapTypeDelimitedFileGatherer
            extends org.kiji.mapreduce.gather.KijiGatherer<org.apache.hadoop.io.Text,org.apache.hadoop.io.NullWritable>
            + + +

            +Gatherer to flatten a map-type family into a delimited file in HDFS. +

            This implementation writes one file per map-type family. + Each line contains one key-value pair from a map-type family. + By default, data is output in the format:

            +
            +

            [entityid]|[timestamp]|[key]|[value_as_json]

            + +

            As an exception to this pattern, strings are printed explicitly, instead of within + quotes, as json would normally print them.

            + +

            Values are output as json representations of the underlying data. + By default, the delimiter between timestamp and data (and subsequent data) is a pipe ("|"). + You can set this value by setting the kiji.export.field.delimiter configuration variable. + You must guarantee that the delimiter you choose does not appear in the json + representation of your data.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            MapTypeDelimitedFileGatherer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidgather(org.kiji.schema.KijiRowData input, + org.kiji.mapreduce.gather.GathererContext context) + +
            +          Outputs flattened data without schema definitions.
            + org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +           
            + Class<?>getOutputKeyClass() + +
            +           
            + Class<?>getOutputValueClass() + +
            +           
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          Initializes internal state from the Configuration.
            +protected  voidsetFamily(String family) + +
            +          Sets the family.
            +protected  voidsetFieldDelimiter(String delimiter) + +
            +          Sets the delimiter.
            + voidsetup(org.kiji.mapreduce.gather.GathererContext context) + +
            +           
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.gather.KijiGatherer
            cleanup, forName, getConf, getRequiredStores
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MapTypeDelimitedFileGatherer

            +
            +public MapTypeDelimitedFileGatherer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Initializes internal state from the Configuration. + Sets the delimiter to write between columns, the family to write to, and + the max versions to read from each column. +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            Overrides:
            setConf in class org.kiji.mapreduce.gather.KijiGatherer<org.apache.hadoop.io.Text,org.apache.hadoop.io.NullWritable>
            +
            +
            +
            Parameters:
            conf - The Configuration to initialize from.
            +
            +
            +
            + +

            +getDataRequest

            +
            +public org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            +
            +
            +
            +
            + +

            +setup

            +
            +public void setup(org.kiji.mapreduce.gather.GathererContext context)
+           throws IOException
            +
            +
            +
            Overrides:
            setup in class org.kiji.mapreduce.gather.KijiGatherer<org.apache.hadoop.io.Text,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +setFieldDelimiter

            +
            +protected void setFieldDelimiter(String delimiter)
            +
            +
            Sets the delimiter. +

            +

            +
            Parameters:
            delimiter - The delimiter.
            +
            +
            +
            + +

            +setFamily

            +
            +protected void setFamily(String family)
            +
            +
            Sets the family. +

            +

            +
            Parameters:
            family - The family.
            +
            +
            +
            + +

            +gather

            +
            +public void gather(org.kiji.schema.KijiRowData input,
+                   org.kiji.mapreduce.gather.GathererContext context)
+            throws IOException
            +
            +
            Outputs flattened data without schema definitions. + A single line of data contains one key-value record from a kiji family, formatted as: + [entityid]|[timestamp]|[key]|[value] +

            +

            +
            Specified by:
            gather in class org.kiji.mapreduce.gather.KijiGatherer<org.apache.hadoop.io.Text,org.apache.hadoop.io.NullWritable>
            +
            +
            +
            Parameters:
            input - The row data to export.
            context - The context to write export to. +
            Throws: +
            IOException - if there's an error.
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/class-use/MapTypeDelimitedFileGatherer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/class-use/MapTypeDelimitedFileGatherer.html new file mode 100644 index 00000000..5c837ffb --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/class-use/MapTypeDelimitedFileGatherer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer

            +
            +No usage of org.kiji.mapreduce.lib.gather.MapTypeDelimitedFileGatherer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-frame.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-frame.html new file mode 100644 index 00000000..fb172b50 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.kiji.mapreduce.lib.gather (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.lib.gather + + + + +
            +Classes  + +
            +MapTypeDelimitedFileGatherer
            + + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-summary.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-summary.html new file mode 100644 index 00000000..9fe57ea7 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-summary.html @@ -0,0 +1,184 @@ + + + + + + + +org.kiji.mapreduce.lib.gather (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.lib.gather +

            +Gatherers for KijiMR. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Class Summary
            MapTypeDelimitedFileGathererGatherer to flatten a map-type family into a delimited file in HDFS.
            +  + +

            +

            +Package org.kiji.mapreduce.lib.gather Description +

            + +

            +Gatherers for KijiMR. + +

            + A Kiji Gatherer scans over the rows of a Kiji table using the MapReduce framework to + aggregate information which can be passed to a Reducer. Gather jobs in KijiMR can be + created using the KijiGatherJobBuilder. Gather jobs are invoked + using the kiji gather tool. +

            + +

            Usable gatherers:

            +
          • MapTypeDelimitedFileGatherer - Gatherer that flattens + map-type Kiji data into delimited files in HDFS.
            • +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-tree.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-tree.html new file mode 100644 index 00000000..efc33948 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-tree.html @@ -0,0 +1,157 @@ + + + + + + + +org.kiji.mapreduce.lib.gather Class Hierarchy (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.lib.gather +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.kiji.mapreduce.gather.KijiGatherer<K,V> (implements org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.kvstore.KeyValueStoreClient, org.kiji.mapreduce.KijiDataRequester, org.kiji.mapreduce.KVOutputJob) + +
              +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-use.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-use.html new file mode 100644 index 00000000..c7540e41 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/gather/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.lib.gather (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.lib.gather

            +
            +No usage of org.kiji.mapreduce.lib.gather +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/TextFlatteningMapper.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/TextFlatteningMapper.html new file mode 100644 index 00000000..54abc8e9 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/TextFlatteningMapper.html @@ -0,0 +1,383 @@ + + + + + + + +TextFlatteningMapper (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.map +
            +Class TextFlatteningMapper

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Mapper<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiMapper<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text,org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
+          extended by org.kiji.mapreduce.lib.map.TextFlatteningMapper
+
            +
            +
            All Implemented Interfaces:
            org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            public class TextFlatteningMapper
            extends org.kiji.mapreduce.KijiMapper<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text,org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            + + +

            +A Mapper that takes name/text records, and outputs name/flattened-text pairs. + Here, "flattened-text" refers to the original text with all newlines + replaced by single spaces. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Mapper
            org.apache.hadoop.mapreduce.Mapper.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            TextFlatteningMapper() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Class<?>getOutputKeyClass() + +
            +          
            + Class<?>getOutputValueClass() + +
            +          
            +protected  voidmap(org.apache.hadoop.io.Text fileName, + org.apache.hadoop.io.Text fileContents, + org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          Converts The Bytes stored in fileContents to a single String with all new-line + characters removed.
            +protected  voidsetup(org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          Prepares internal state for executing map tasks.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiMapper
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Mapper
            cleanup, run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +TextFlatteningMapper

            +
            +public TextFlatteningMapper()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setup

            +
            +protected void setup(org.apache.hadoop.mapreduce.Mapper.Context context)
            +
            +
            Prepares internal state for executing map tasks. +

            +

            +
            Overrides:
            setup in class org.apache.hadoop.mapreduce.Mapper<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text,org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            +
            Parameters:
            context - The Context to read. Unused.
            +
            +
            +
            + +

            +map

            +
            +protected void map(org.apache.hadoop.io.Text fileName,
+                   org.apache.hadoop.io.Text fileContents,
+                   org.apache.hadoop.mapreduce.Mapper.Context context)
+            throws IOException,
+                   InterruptedException
            +
            +
            Converts The Bytes stored in fileContents to a single String with all new-line + characters removed. +

            +

            +
            Overrides:
            map in class org.apache.hadoop.mapreduce.Mapper<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text,org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            +
            Parameters:
            fileName - The qualified path to this file.
            fileContents - The file to convert, encoded in UTF8.
            context - The Context to write to. +
            Throws: +
            IOException - if there is an error. +
            InterruptedException - if there is an error.
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/class-use/TextFlatteningMapper.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/class-use/TextFlatteningMapper.html new file mode 100644 index 00000000..9cfe3d87 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/class-use/TextFlatteningMapper.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.map.TextFlatteningMapper (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.map.TextFlatteningMapper

            +
            +No usage of org.kiji.mapreduce.lib.map.TextFlatteningMapper +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-frame.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-frame.html new file mode 100644 index 00000000..aa6613bf --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.kiji.mapreduce.lib.map (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.lib.map + + + + +
            +Classes  + +
            +TextFlatteningMapper
            + + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-summary.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-summary.html new file mode 100644 index 00000000..b43e02a5 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-summary.html @@ -0,0 +1,177 @@ + + + + + + + +org.kiji.mapreduce.lib.map (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.lib.map +

            +Mappers for KijiMR. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Class Summary
            TextFlatteningMapperA Mapper that takes name/text records, and outputs name/flattened-text pairs.
            +  + +

            +

            +Package org.kiji.mapreduce.lib.map Description +

            + +

            +Mappers for KijiMR. + +

            Usable mappers:

            +
          • TextFlatteningMapper - Takes name/text records and + outputs name/flattened-text pairs. Flattened text has new lines replaced with spaces.
            • +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-tree.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-tree.html new file mode 100644 index 00000000..1827a17e --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-tree.html @@ -0,0 +1,159 @@ + + + + + + + +org.kiji.mapreduce.lib.map Class Hierarchy (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.lib.map +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.hadoop.mapreduce.Mapper<KEYIN,VALUEIN,KEYOUT,VALUEOUT>
                  +
                • org.kiji.mapreduce.KijiMapper<INKEY,INVALUE,OUTKEY,OUTVALUE> (implements org.kiji.mapreduce.KVOutputJob) + +
                +
              +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-use.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-use.html new file mode 100644 index 00000000..9713a113 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/map/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.lib.map (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.lib.map

            +
            +No usage of org.kiji.mapreduce.lib.map +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/AllVersionsSingleInputProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/AllVersionsSingleInputProducer.html new file mode 100644 index 00000000..b2bea517 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/AllVersionsSingleInputProducer.html @@ -0,0 +1,286 @@ + + + + + + + +AllVersionsSingleInputProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.produce +
            +Class AllVersionsSingleInputProducer

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.produce.KijiProducer
+      extended by org.kiji.mapreduce.lib.produce.SingleInputProducer
+          extended by org.kiji.mapreduce.lib.produce.AllVersionsSingleInputProducer
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.KijiDataRequester, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            +
            public abstract class AllVersionsSingleInputProducer
            extends SingleInputProducer
            + + +

            +Base class for producers that read all versions from a single input column. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            AllVersionsSingleInputProducer() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.lib.produce.SingleInputProducer
            getInputColumn, getInputColumnName, setup
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.produce.KijiProducer
            cleanup, getConf, getOutputColumn, getRequiredStores, produce, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AllVersionsSingleInputProducer

            +
            +public AllVersionsSingleInputProducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            Description copied from class: SingleInputProducer
            +
            +

            +

            +
            Specified by:
            getDataRequest in interface org.kiji.mapreduce.KijiDataRequester
            Overrides:
            getDataRequest in class SingleInputProducer
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/ConfiguredRegexProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/ConfiguredRegexProducer.html new file mode 100644 index 00000000..80cbc208 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/ConfiguredRegexProducer.html @@ -0,0 +1,447 @@ + + + + + + + +ConfiguredRegexProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.produce +
            +Class ConfiguredRegexProducer

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.produce.KijiProducer
+      extended by org.kiji.mapreduce.lib.produce.SingleInputProducer
+          extended by org.kiji.mapreduce.lib.produce.RegexProducer
+              extended by org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.KijiDataRequester, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            +
            public class ConfiguredRegexProducer
            extends RegexProducer
            + + +

            +A regex producer that is ready to use "out of the box." All you + need to do is specify a couple of configuration values. + + Here is an example of the EmailDomainProfiler implemented with + ConfiguredRegexProducer that reads from "info:email" and writes to + "derived:domain": + 

            + bin/kiji produce \
+   -Dkiji.regexproducer.input.column=info:email \
+   -Dkiji.regexproducer.output.column=derived:domain \
+   -Dkiji.regexproducer.regex='[^@]+@(.*)' \
+   --input="format=kiji table=kiji://.env/default/foo" \
+   --output="format=kiji table=kiji://.env/default/foo nsplits=2" \
+   --producer=org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer
+
            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_INPUT_COLUMN + +
            +           
            +static StringCONF_OUTPUT_COLUMN + +
            +           
            +static StringCONF_REGEX + +
            +           
            +  + + + + + + + + + + +
            +Constructor Summary
            ConfiguredRegexProducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  StringgetInputColumn() + +
            +           
            + StringgetOutputColumn() + +
            +           
            +protected  StringgetRegex() + +
            +           
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +           
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.lib.produce.RegexProducer
            produce, setup
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.lib.produce.SingleInputProducer
            getDataRequest, getInputColumnName
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.produce.KijiProducer
            cleanup, getConf, getRequiredStores
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +CONF_INPUT_COLUMN

            +
            +public static final String CONF_INPUT_COLUMN
            +
            +
            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_OUTPUT_COLUMN

            +
            +public static final String CONF_OUTPUT_COLUMN
            +
            +
            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_REGEX

            +
            +public static final String CONF_REGEX
            +
            +
            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +ConfiguredRegexProducer

            +
            +public ConfiguredRegexProducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            Overrides:
            setConf in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            +
            +
            +
            +
            + +

            +getInputColumn

            +
            +protected String getInputColumn()
            +
            +
            +
            Specified by:
            getInputColumn in class SingleInputProducer
            +
            +
            + +
            Returns:
            the name of the kiji input column to feed to this producer.
            +
            +
            +
            + +

            +getRegex

            +
            +protected String getRegex()
            +
            +
            +
            Specified by:
            getRegex in class RegexProducer
            +
            +
            + +
            Returns:
            the regular expression string (will match regex against full string).
            +
            +
            +
            + +

            +getOutputColumn

            +
            +public String getOutputColumn()
            +
            +
            +
            Specified by:
            getOutputColumn in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/IdentityProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/IdentityProducer.html new file mode 100644 index 00000000..65a1d1b3 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/IdentityProducer.html @@ -0,0 +1,457 @@ + + + + + + + +IdentityProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.produce +
            +Class IdentityProducer

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.produce.KijiProducer
+      extended by org.kiji.mapreduce.lib.produce.IdentityProducer
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.KijiDataRequester, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            +
            public class IdentityProducer
            extends org.kiji.mapreduce.produce.KijiProducer
            + + +

            +This producer copies data from one family or column to another without modification. + +

            To use this producer, you must specify an input and an output. The + input may be a single column of the form "family:qualifier", or an entire family + of the form "family". The input will be copied to the target output column or + family.

            + +

            To specify the input column name, set the configuration variable + identity.producer.input. The output column name is set with the configuration + variable identity.producer.output.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_INPUT + +
            +           
            +static StringCONF_OUTPUT + +
            +           
            +  + + + + + + + + + + +
            +Constructor Summary
            IdentityProducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          
            + StringgetOutputColumn() + +
            +          
            + voidproduce(org.kiji.schema.KijiRowData input, + org.kiji.mapreduce.produce.ProducerContext context) + +
            +          
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            +protected  voidsetInputColumn(String column) + +
            +          Sets the input column name.
            +protected  voidsetOutputColumn(String column) + +
            +          Sets the output column name.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.produce.KijiProducer
            cleanup, getConf, getRequiredStores, setup
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +CONF_INPUT

            +
            +public static final String CONF_INPUT
            +
            +
            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_OUTPUT

            +
            +public static final String CONF_OUTPUT
            +
            +
            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +IdentityProducer

            +
            +public IdentityProducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            Overrides:
            setConf in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            +
            +
            +
            +
            + +

            +setInputColumn

            +
            +protected void setInputColumn(String column)
            +
            +
            Sets the input column name. +

            +

            +
            Parameters:
            column - The input column.
            +
            +
            +
            + +

            +setOutputColumn

            +
            +protected void setOutputColumn(String column)
            +
            +
            Sets the output column name. +

            +

            +
            Parameters:
            column - The output column.
            +
            +
            +
            + +

            +getDataRequest

            +
            +public org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            +

            +

            +
            Specified by:
            getDataRequest in interface org.kiji.mapreduce.KijiDataRequester
            Specified by:
            getDataRequest in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            +
            +
            +
            +
            + +

            +getOutputColumn

            +
            +public String getOutputColumn()
            +
            +
            +

            +

            +
            Specified by:
            getOutputColumn in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            +
            +
            +
            +
            + +

            +produce

            +
            +public void produce(org.kiji.schema.KijiRowData input,
+                    org.kiji.mapreduce.produce.ProducerContext context)
+             throws IOException
            +
            +
            +

            +

            +
            Specified by:
            produce in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/RegexProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/RegexProducer.html new file mode 100644 index 00000000..22c83f3e --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/RegexProducer.html @@ -0,0 +1,343 @@ + + + + + + + +RegexProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.produce +
            +Class RegexProducer

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.produce.KijiProducer
+      extended by org.kiji.mapreduce.lib.produce.SingleInputProducer
+          extended by org.kiji.mapreduce.lib.produce.RegexProducer
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.KijiDataRequester, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            Direct Known Subclasses:
            ConfiguredRegexProducer
            +
            +
            +
            +
            public abstract class RegexProducer
            extends SingleInputProducer
            + + +

            +A producer which uses a full regular expression match on a string + input column to generate a new column. The regular expression + should have a single group (things inside parentheses), which will + be extracted and used as the new data. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            RegexProducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected abstract  StringgetRegex() + +
            +           
            + voidproduce(org.kiji.schema.KijiRowData input, + org.kiji.mapreduce.produce.ProducerContext context) + +
            +          
            + voidsetup(org.kiji.mapreduce.KijiContext context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.lib.produce.SingleInputProducer
            getDataRequest, getInputColumn, getInputColumnName
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.produce.KijiProducer
            cleanup, getConf, getOutputColumn, getRequiredStores, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +RegexProducer

            +
            +public RegexProducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getRegex

            +
            +protected abstract String getRegex()
            +
            +
            + +
            Returns:
            the regular expression string (will match regex against full string).
            +
            +
            +
            + +

            +setup

            +
            +public void setup(org.kiji.mapreduce.KijiContext context)
+           throws IOException
            +
            +
            +

            +

            +
            Overrides:
            setup in class SingleInputProducer
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +produce

            +
            +public void produce(org.kiji.schema.KijiRowData input,
+                    org.kiji.mapreduce.produce.ProducerContext context)
+             throws IOException
            +
            +
            +

            +

            +
            Specified by:
            produce in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/SingleInputProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/SingleInputProducer.html new file mode 100644 index 00000000..b758d921 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/SingleInputProducer.html @@ -0,0 +1,345 @@ + + + + + + + +SingleInputProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.produce +
            +Class SingleInputProducer

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.produce.KijiProducer
+      extended by org.kiji.mapreduce.lib.produce.SingleInputProducer
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.KijiDataRequester, org.kiji.mapreduce.kvstore.KeyValueStoreClient
            +
            +
            +
            Direct Known Subclasses:
            AllVersionsSingleInputProducer, RegexProducer
            +
            +
            +
            +
            public abstract class SingleInputProducer
            extends org.kiji.mapreduce.produce.KijiProducer
            + + +

            +Base class for producers that read from the most recent value of a single input column. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            SingleInputProducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          
            +protected abstract  StringgetInputColumn() + +
            +           
            +protected  org.kiji.schema.KijiColumnNamegetInputColumnName() + +
            +           
            + voidsetup(org.kiji.mapreduce.KijiContext context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.produce.KijiProducer
            cleanup, getConf, getOutputColumn, getRequiredStores, produce, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +SingleInputProducer

            +
            +public SingleInputProducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getInputColumn

            +
            +protected abstract String getInputColumn()
            +
            +
            + +
            Returns:
            the name of the kiji input column to feed to this producer.
            +
            +
            +
            + +

            +getDataRequest

            +
            +public org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            +

            +

            +
            Specified by:
            getDataRequest in interface org.kiji.mapreduce.KijiDataRequester
            Specified by:
            getDataRequest in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            +
            +
            +
            +
            + +

            +setup

            +
            +public void setup(org.kiji.mapreduce.KijiContext context)
+           throws IOException
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.kiji.mapreduce.produce.KijiProducer
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getInputColumnName

            +
            +protected org.kiji.schema.KijiColumnName getInputColumnName()
            +
            +
            + +
            Returns:
            the input column family.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/AllVersionsSingleInputProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/AllVersionsSingleInputProducer.html new file mode 100644 index 00000000..8edc0504 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/AllVersionsSingleInputProducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.produce.AllVersionsSingleInputProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.produce.AllVersionsSingleInputProducer

            +
            +No usage of org.kiji.mapreduce.lib.produce.AllVersionsSingleInputProducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/ConfiguredRegexProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/ConfiguredRegexProducer.html new file mode 100644 index 00000000..2f369471 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/ConfiguredRegexProducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer

            +
            +No usage of org.kiji.mapreduce.lib.produce.ConfiguredRegexProducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/IdentityProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/IdentityProducer.html new file mode 100644 index 00000000..50a4daee --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/IdentityProducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.produce.IdentityProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.produce.IdentityProducer

            +
            +No usage of org.kiji.mapreduce.lib.produce.IdentityProducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/RegexProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/RegexProducer.html new file mode 100644 index 00000000..df6002c2 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/RegexProducer.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.produce.RegexProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.produce.RegexProducer

            +
            + + + + + + + + + +
            +Packages that use RegexProducer
            org.kiji.mapreduce.lib.produceProducers for KijiMR. 
            +  +

            + + + + + +
            +Uses of RegexProducer in org.kiji.mapreduce.lib.produce
            +  +

            + + + + + + + + + +
            Subclasses of RegexProducer in org.kiji.mapreduce.lib.produce
            + classConfiguredRegexProducer + +
            +          A regex producer that is ready to use "out of the box." All you + need to do is specify a couple of configuration values.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/SingleInputProducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/SingleInputProducer.html new file mode 100644 index 00000000..dc32074a --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/class-use/SingleInputProducer.html @@ -0,0 +1,199 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.produce.SingleInputProducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.produce.SingleInputProducer

            +
            + + + + + + + + + +
            +Packages that use SingleInputProducer
            org.kiji.mapreduce.lib.produceProducers for KijiMR. 
            +  +

            + + + + + +
            +Uses of SingleInputProducer in org.kiji.mapreduce.lib.produce
            +  +

            + + + + + + + + + + + + + + + + + +
            Subclasses of SingleInputProducer in org.kiji.mapreduce.lib.produce
            + classAllVersionsSingleInputProducer + +
            +          Base class for producers that read all versions from a single input column.
            + classConfiguredRegexProducer + +
            +          A regex producer that is ready to use "out of the box." All you + need to do is specify a couple of configuration values.
            + classRegexProducer + +
            +          A producer which uses a full regular expression match on a string + input column to generate a new column.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-frame.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-frame.html new file mode 100644 index 00000000..e8bbc1ee --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-frame.html @@ -0,0 +1,41 @@ + + + + + + + +org.kiji.mapreduce.lib.produce (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.lib.produce + + + + +
            +Classes  + +
            +AllVersionsSingleInputProducer +
            +ConfiguredRegexProducer +
            +IdentityProducer +
            +RegexProducer +
            +SingleInputProducer
            + + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-summary.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-summary.html new file mode 100644 index 00000000..d2b055ca --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-summary.html @@ -0,0 +1,205 @@ + + + + + + + +org.kiji.mapreduce.lib.produce (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.lib.produce +

            +Producers for KijiMR. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AllVersionsSingleInputProducerBase class for producers that read all versions from a single input column.
            ConfiguredRegexProducerA regex producer that is ready to use "out of the box." All you + need to do is specify a couple of configuration values.
            IdentityProducerThis producer copies data from one family or column to another without modification.
            RegexProducerA producer which uses a full regular expression match on a string + input column to generate a new column.
            SingleInputProducerBase class for producers that read from the most recent value of a single input column.
            +  + +

            +

            +Package org.kiji.mapreduce.lib.produce Description +

            + +

            +Producers for KijiMR. + +

            + A KijiProducer executes a function over a subset of the columns in a table row and produces + output to be injected back into a column of that row. Produce jobs which execute the + producer over all rows in the table can be created using the + KijiProduceJobBuilder. Producers can be invoked using the + kiji produce tool. +

            + +

            Usable producers:

            +
          • ConfiguredRegexProducer - extracts data via + regex.
            • +
          • IdentityProducer - copies data from one family or + column to another.
            • +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-tree.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-tree.html new file mode 100644 index 00000000..08485ef1 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-tree.html @@ -0,0 +1,161 @@ + + + + + + + +org.kiji.mapreduce.lib.produce Class Hierarchy (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.lib.produce +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-use.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-use.html new file mode 100644 index 00000000..57567ce5 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/produce/package-use.html @@ -0,0 +1,178 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.lib.produce (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.lib.produce

            +
            + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.lib.produce
            org.kiji.mapreduce.lib.produceProducers for KijiMR. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.lib.produce used by org.kiji.mapreduce.lib.produce
            RegexProducer + +
            +          A producer which uses a full regular expression match on a string + input column to generate a new column.
            SingleInputProducer + +
            +          Base class for producers that read from the most recent value of a single input column.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/AvroReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/AvroReducer.html new file mode 100644 index 00000000..1df4ab40 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/AvroReducer.html @@ -0,0 +1,403 @@ + + + + + + + +AvroReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.reduce +
            +Class AvroReducer<K,V,T>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Reducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiReducer<K,V,org.apache.avro.mapred.AvroKey<T>,org.apache.hadoop.io.NullWritable>
+          extended by org.kiji.mapreduce.lib.reduce.AvroReducer<K,V,T>
+
            +
            +
            Type Parameters:
            K - The type of the MapReduce reducer input key.
            V - The type of the MapReduce reducer input value.
            T - The Avro type of the messages to output to the Avro container files.
            +
            +
            All Implemented Interfaces:
            org.kiji.mapreduce.avro.AvroKeyWriter, org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            public abstract class AvroReducer<K,V,T>
            extends org.kiji.mapreduce.KijiReducer<K,V,org.apache.avro.mapred.AvroKey<T>,org.apache.hadoop.io.NullWritable>
            implements org.kiji.mapreduce.avro.AvroKeyWriter
            + + +

            +Base class for reducers used with AvroOutputFormat to write Avro container files. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Reducer
            org.apache.hadoop.mapreduce.Reducer.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            AvroReducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Class<?>getOutputKeyClass() + +
            +          
            + Class<?>getOutputValueClass() + +
            +          
            +protected  voidsetup(org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          
            +protected  voidwrite(T value, + org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          Subclasses can use this instead of context.write() to output Avro + messages directly instead of having to wrap them in AvroKey + container objects.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiReducer
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Reducer
            cleanup, reduce, run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.avro.AvroKeyWriter
            getAvroKeyWriterSchema
            +  +

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

            +AvroReducer

            +
            +public AvroReducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setup

            +
            +protected void setup(org.apache.hadoop.mapreduce.Reducer.Context context)
+              throws IOException,
+                     InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.apache.hadoop.mapreduce.Reducer<K,V,org.apache.avro.mapred.AvroKey<T>,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputKeyClass in interface org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputValueClass in interface org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            +
            +
            + +

            +write

            +
            +protected void write(T value,
+                     org.apache.hadoop.mapreduce.Reducer.Context context)
+              throws IOException,
+                     InterruptedException
            +
            +
            Subclasses can use this instead of context.write() to output Avro + messages directly instead of having to wrap them in AvroKey + container objects. +

            +

            +
            +
            +
            +
            Parameters:
            value - The avro value to write.
            context - The reducer context. +
            Throws: +
            IOException - If there is an error. +
            InterruptedException - If the thread is interrupted.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/DoubleSumReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/DoubleSumReducer.html new file mode 100644 index 00000000..35f73535 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/DoubleSumReducer.html @@ -0,0 +1,378 @@ + + + + + + + +DoubleSumReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.reduce +
            +Class DoubleSumReducer<K>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Reducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiReducer<K,INVALUE,K,OUTVALUE>
+          extended by org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer<K,org.apache.hadoop.io.DoubleWritable,org.apache.hadoop.io.DoubleWritable>
+              extended by org.kiji.mapreduce.lib.reduce.DoubleSumReducer<K>
+
            +
            +
            Type Parameters:
            K - The type of the reduce input key.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.avro.AvroKeyWriter, org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            public class DoubleSumReducer<K>
            extends KeyPassThroughReducer<K,org.apache.hadoop.io.DoubleWritable,org.apache.hadoop.io.DoubleWritable>
            + + +

            +

            A KijiReducer that works of key/value pairs where the value is + an DoubleWritable. For all double values with the same key, the + DoubleSumReducer will output a single pair with a value equal to the + sum, leaving the key unchanged.

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Reducer
            org.apache.hadoop.mapreduce.Reducer.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            DoubleSumReducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Class<?>getOutputValueClass() + +
            +          
            +protected  voidreduce(K key, + Iterable<org.apache.hadoop.io.DoubleWritable> values, + org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          
            +protected  voidsetup(org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer
            getAvroKeyWriterSchema, getConf, getOutputKeyClass, setConf
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiReducer
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Reducer
            cleanup, run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DoubleSumReducer

            +
            +public DoubleSumReducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setup

            +
            +protected void setup(org.apache.hadoop.mapreduce.Reducer.Context context)
+              throws IOException,
+                     InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.apache.hadoop.mapreduce.Reducer<K,org.apache.hadoop.io.DoubleWritable,K,org.apache.hadoop.io.DoubleWritable>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +reduce

            +
            +protected void reduce(K key,
+                      Iterable<org.apache.hadoop.io.DoubleWritable> values,
+                      org.apache.hadoop.mapreduce.Reducer.Context context)
+               throws IOException,
+                      InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            reduce in class org.apache.hadoop.mapreduce.Reducer<K,org.apache.hadoop.io.DoubleWritable,K,org.apache.hadoop.io.DoubleWritable>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/IntSumReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/IntSumReducer.html new file mode 100644 index 00000000..14c131a5 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/IntSumReducer.html @@ -0,0 +1,378 @@ + + + + + + + +IntSumReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.reduce +
            +Class IntSumReducer<K>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Reducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiReducer<K,INVALUE,K,OUTVALUE>
+          extended by org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer<K,org.apache.hadoop.io.IntWritable,org.apache.hadoop.io.IntWritable>
+              extended by org.kiji.mapreduce.lib.reduce.IntSumReducer<K>
+
            +
            +
            Type Parameters:
            K - The type of the reduce input key.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.avro.AvroKeyWriter, org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            public class IntSumReducer<K>
            extends KeyPassThroughReducer<K,org.apache.hadoop.io.IntWritable,org.apache.hadoop.io.IntWritable>
            + + +

            +

            A KijiReducer that works on key/value pairs where the value is + an IntWritable. For all integer values with the same key, the + IntSumReducer will output a single pair with a value equal to the + sum, leaving the key unchanged.

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Reducer
            org.apache.hadoop.mapreduce.Reducer.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            IntSumReducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Class<?>getOutputValueClass() + +
            +          
            +protected  voidreduce(K key, + Iterable<org.apache.hadoop.io.IntWritable> values, + org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          
            +protected  voidsetup(org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer
            getAvroKeyWriterSchema, getConf, getOutputKeyClass, setConf
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiReducer
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Reducer
            cleanup, run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +IntSumReducer

            +
            +public IntSumReducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setup

            +
            +protected void setup(org.apache.hadoop.mapreduce.Reducer.Context context)
+              throws IOException,
+                     InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.apache.hadoop.mapreduce.Reducer<K,org.apache.hadoop.io.IntWritable,K,org.apache.hadoop.io.IntWritable>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +reduce

            +
            +protected void reduce(K key,
+                      Iterable<org.apache.hadoop.io.IntWritable> values,
+                      org.apache.hadoop.mapreduce.Reducer.Context context)
+               throws IOException,
+                      InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            reduce in class org.apache.hadoop.mapreduce.Reducer<K,org.apache.hadoop.io.IntWritable,K,org.apache.hadoop.io.IntWritable>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/KeyPassThroughReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/KeyPassThroughReducer.html new file mode 100644 index 00000000..90fb764d --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/KeyPassThroughReducer.html @@ -0,0 +1,396 @@ + + + + + + + +KeyPassThroughReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.reduce +
            +Class KeyPassThroughReducer<K,INVALUE,OUTVALUE>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Reducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiReducer<K,INVALUE,K,OUTVALUE>
+          extended by org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer<K,INVALUE,OUTVALUE>
+
            +
            +
            Type Parameters:
            K - The input and output key type.
            INVALUE - The input value type.
            OUTVALUE - The output value type.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.avro.AvroKeyWriter, org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            Direct Known Subclasses:
            DoubleSumReducer, IntSumReducer, LongSumReducer
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KeyPassThroughReducer<K,INVALUE,OUTVALUE>
            extends org.kiji.mapreduce.KijiReducer<K,INVALUE,K,OUTVALUE>
            implements org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.avro.AvroKeyWriter
            + + +

            +An abstract KijiReducer to encapsulate common functionality among + reducers that pass the key from the map phase through unchanged. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Reducer
            org.apache.hadoop.mapreduce.Reducer.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            KeyPassThroughReducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.apache.avro.SchemagetAvroKeyWriterSchema() + +
            +          
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +          
            + Class<?>getOutputKeyClass() + +
            +          
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiReducer
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Reducer
            cleanup, reduce, run, setup
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KVOutputJob
            getOutputValueClass
            +  +

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

            +KeyPassThroughReducer

            +
            +public KeyPassThroughReducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputKeyClass in interface org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            +
            +
            + +

            +getAvroKeyWriterSchema

            +
            +public org.apache.avro.Schema getAvroKeyWriterSchema()
+                                              throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getAvroKeyWriterSchema in interface org.kiji.mapreduce.avro.AvroKeyWriter
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/LongSumReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/LongSumReducer.html new file mode 100644 index 00000000..3ffb081b --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/LongSumReducer.html @@ -0,0 +1,373 @@ + + + + + + + +LongSumReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.reduce +
            +Class LongSumReducer<K>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Reducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiReducer<K,INVALUE,K,OUTVALUE>
+          extended by org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer<K,org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.LongWritable>
+              extended by org.kiji.mapreduce.lib.reduce.LongSumReducer<K>
+
            +
            +
            Type Parameters:
            K - The type of the reduce input key.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.mapreduce.avro.AvroKeyWriter, org.kiji.mapreduce.KVOutputJob
            +
            +
            +
            +
            public class LongSumReducer<K>
            extends KeyPassThroughReducer<K,org.apache.hadoop.io.LongWritable,org.apache.hadoop.io.LongWritable>
            + + +

            +

            A KijiReducer that works of key/value pairs where the value is + an LongWritable. For all long values with the same key, the + LongSumReducer will output a single pair with a value equal to the + sum, leaving the key unchanged.

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Reducer
            org.apache.hadoop.mapreduce.Reducer.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            LongSumReducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Class<?>getOutputValueClass() + +
            +          
            +protected  voidreduce(K key, + Iterable<org.apache.hadoop.io.LongWritable> values, + org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          
            +protected  voidsetup(org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer
            getAvroKeyWriterSchema, getConf, getOutputKeyClass, setConf
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiReducer
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Reducer
            cleanup, run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +LongSumReducer

            +
            +public LongSumReducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setup

            +
            +protected void setup(org.apache.hadoop.mapreduce.Reducer.Context context)
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.apache.hadoop.mapreduce.Reducer<K,org.apache.hadoop.io.LongWritable,K,org.apache.hadoop.io.LongWritable>
            +
            +
            +
            +
            +
            +
            + +

            +reduce

            +
            +protected void reduce(K key,
+                      Iterable<org.apache.hadoop.io.LongWritable> values,
+                      org.apache.hadoop.mapreduce.Reducer.Context context)
+               throws IOException,
+                      InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            reduce in class org.apache.hadoop.mapreduce.Reducer<K,org.apache.hadoop.io.LongWritable,K,org.apache.hadoop.io.LongWritable>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/AvroReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/AvroReducer.html new file mode 100644 index 00000000..74bb91b7 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/AvroReducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.reduce.AvroReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.reduce.AvroReducer

            +
            +No usage of org.kiji.mapreduce.lib.reduce.AvroReducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/DoubleSumReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/DoubleSumReducer.html new file mode 100644 index 00000000..8b5b6b50 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/DoubleSumReducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.reduce.DoubleSumReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.reduce.DoubleSumReducer

            +
            +No usage of org.kiji.mapreduce.lib.reduce.DoubleSumReducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/IntSumReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/IntSumReducer.html new file mode 100644 index 00000000..873e3a26 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/IntSumReducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.reduce.IntSumReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.reduce.IntSumReducer

            +
            +No usage of org.kiji.mapreduce.lib.reduce.IntSumReducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/KeyPassThroughReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/KeyPassThroughReducer.html new file mode 100644 index 00000000..fd3b8c0e --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/KeyPassThroughReducer.html @@ -0,0 +1,200 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer

            +
            + + + + + + + + + +
            +Packages that use KeyPassThroughReducer
            org.kiji.mapreduce.lib.reduceReducers for KijiMR. 
            +  +

            + + + + + +
            +Uses of KeyPassThroughReducer in org.kiji.mapreduce.lib.reduce
            +  +

            + + + + + + + + + + + + + + + + + +
            Subclasses of KeyPassThroughReducer in org.kiji.mapreduce.lib.reduce
            + classDoubleSumReducer<K> + +
            +          A KijiReducer that works of key/value pairs where the value is + an DoubleWritable.
            + classIntSumReducer<K> + +
            +          A KijiReducer that works on key/value pairs where the value is + an IntWritable.
            + classLongSumReducer<K> + +
            +          A KijiReducer that works of key/value pairs where the value is + an LongWritable.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/LongSumReducer.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/LongSumReducer.html new file mode 100644 index 00000000..4acf9f65 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/class-use/LongSumReducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.reduce.LongSumReducer (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.reduce.LongSumReducer

            +
            +No usage of org.kiji.mapreduce.lib.reduce.LongSumReducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-frame.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-frame.html new file mode 100644 index 00000000..9bf7a5e8 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-frame.html @@ -0,0 +1,41 @@ + + + + + + + +org.kiji.mapreduce.lib.reduce (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.lib.reduce + + + + +
            +Classes  + +
            +AvroReducer +
            +DoubleSumReducer +
            +IntSumReducer +
            +KeyPassThroughReducer +
            +LongSumReducer
            + + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-summary.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-summary.html new file mode 100644 index 00000000..cca57f2d --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-summary.html @@ -0,0 +1,201 @@ + + + + + + + +org.kiji.mapreduce.lib.reduce (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.lib.reduce +

            +Reducers for KijiMR. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AvroReducer<K,V,T>Base class for reducers used with AvroOutputFormat to write Avro container files.
            DoubleSumReducer<K>A KijiReducer that works of key/value pairs where the value is + an DoubleWritable.
            IntSumReducer<K>A KijiReducer that works on key/value pairs where the value is + an IntWritable.
            KeyPassThroughReducer<K,INVALUE,OUTVALUE>An abstract KijiReducer to encapsulate common functionality among + reducers that pass the key from the map phase through unchanged.
            LongSumReducer<K>A KijiReducer that works of key/value pairs where the value is + an LongWritable.
            +  + +

            +

            +Package org.kiji.mapreduce.lib.reduce Description +

            + +

            +Reducers for KijiMR. + +

            Usable reducers:

            +
          • DoubleSumReducer - for all double values with the same + key, returns a single pair with a double value equal to the sum.
            • +
          • IntSumReducer - for all int values with the same + key, returns a single pair with a int value equal to the sum.
            • +
          • LongSumReducer - for all long values with the same + key, returns a single pair with a long value equal to the sum.
            • +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-tree.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-tree.html new file mode 100644 index 00000000..973f9db4 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-tree.html @@ -0,0 +1,163 @@ + + + + + + + +org.kiji.mapreduce.lib.reduce Class Hierarchy (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.lib.reduce +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.hadoop.mapreduce.Reducer<KEYIN,VALUEIN,KEYOUT,VALUEOUT>
                  +
                • org.kiji.mapreduce.KijiReducer<INKEY,INVALUE,OUTKEY,OUTVALUE> (implements org.kiji.mapreduce.KVOutputJob) +
                    +
                  • org.kiji.mapreduce.lib.reduce.AvroReducer<K,V,T> (implements org.kiji.mapreduce.avro.AvroKeyWriter) +
                  • org.kiji.mapreduce.lib.reduce.KeyPassThroughReducer<K,INVALUE,OUTVALUE> (implements org.kiji.mapreduce.avro.AvroKeyWriter, org.apache.hadoop.conf.Configurable) + +
                  +
                +
              +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-use.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-use.html new file mode 100644 index 00000000..9700fd9d --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/reduce/package-use.html @@ -0,0 +1,172 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.lib.reduce (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.lib.reduce

            +
            + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.lib.reduce
            org.kiji.mapreduce.lib.reduceReducers for KijiMR. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.lib.reduce used by org.kiji.mapreduce.lib.reduce
            KeyPassThroughReducer + +
            +          An abstract KijiReducer to encapsulate common functionality among + reducers that pass the key from the map phase through unchanged.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/CSVParser.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/CSVParser.html new file mode 100644 index 00000000..3eb9b754 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/CSVParser.html @@ -0,0 +1,267 @@ + + + + + + + +CSVParser (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.util +
            +Class CSVParser

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.lib.util.CSVParser
+
            +
            +
            +
            @ApiAudience.Public
+public final class CSVParser
            extends Object
            + + +

            +Parser that extracts fields from RFC 4180 (http://tools.ietf.org/html/rfc4180) compliant + CSV and TSV lines of text. + +

            Typical invocations to parse CSV and TSV lines respectively:

            + 
            
+   List<String> parsedoCSVFields = CSVParser.parseCSV("first,last");
+
+   List<String> parsedTSVFields TSVParser.parseTSV("first\tlast");
+
            + +

            The difference between these methods and String.split(',') is that this handles the escaping + of double quotes in the manner specified by RFC 4180 Section 2.7.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static List<String>parseCSV(String line) + +
            +          Parses the input text using comma as the delimiter.
            +static List<String>parseTSV(String line) + +
            +          Parses the input text using tab as the delimiter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +parseCSV

            +
            +public static List<String> parseCSV(String line)
+                             throws ParseException
            +
            +
            Parses the input text using comma as the delimiter. +

            +

            +
            Parameters:
            line - of text to parse the individual fields from. +
            Returns:
            list of strings for each of the parsed fields (using comma as a delimiter). +
            Throws: +
            ParseException - if there is an issue with escaping.
            +
            +
            +
            + +

            +parseTSV

            +
            +public static List<String> parseTSV(String line)
+                             throws ParseException
            +
            +
            Parses the input text using tab as the delimiter. +

            +

            +
            Parameters:
            line - of text to parse the individual fields from. +
            Returns:
            list of strings for each of the parsed fields (using tab as a delimiter). +
            Throws: +
            ParseException - if there is an issue with escaping.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/CommonLogParser.Field.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/CommonLogParser.Field.html new file mode 100644 index 00000000..302d9d38 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/CommonLogParser.Field.html @@ -0,0 +1,410 @@ + + + + + + + +CommonLogParser.Field (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.util +
            +Enum CommonLogParser.Field

            +
            +java.lang.Object
+  extended by java.lang.Enum<CommonLogParser.Field>
+      extended by org.kiji.mapreduce.lib.util.CommonLogParser.Field
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<CommonLogParser.Field>
            +
            +
            +
            Enclosing class:
            CommonLogParser
            +
            +
            +
            +
            public static enum CommonLogParser.Field
            extends Enum<CommonLogParser.Field>
            + + +

            +Fields that can be extracted via the Common Log Format. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            AUTHUSER + +
            +           
            BYTES + +
            +           
            DATE + +
            +           
            IDENT + +
            +           
            REMOTEHOST + +
            +           
            REQUEST + +
            +           
            STATUS + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static CommonLogParser.FieldvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static CommonLogParser.Field[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +REMOTEHOST

            +
            +public static final CommonLogParser.Field REMOTEHOST
            +
            +
            +
            +
            +
            + +

            +IDENT

            +
            +public static final CommonLogParser.Field IDENT
            +
            +
            +
            +
            +
            + +

            +AUTHUSER

            +
            +public static final CommonLogParser.Field AUTHUSER
            +
            +
            +
            +
            +
            + +

            +DATE

            +
            +public static final CommonLogParser.Field DATE
            +
            +
            +
            +
            +
            + +

            +REQUEST

            +
            +public static final CommonLogParser.Field REQUEST
            +
            +
            +
            +
            +
            + +

            +STATUS

            +
            +public static final CommonLogParser.Field STATUS
            +
            +
            +
            +
            +
            + +

            +BYTES

            +
            +public static final CommonLogParser.Field BYTES
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static CommonLogParser.Field[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (CommonLogParser.Field c : CommonLogParser.Field.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static CommonLogParser.Field valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/CommonLogParser.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/CommonLogParser.html new file mode 100644 index 00000000..faba3097 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/CommonLogParser.html @@ -0,0 +1,279 @@ + + + + + + + +CommonLogParser (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.lib.util +
            +Class CommonLogParser

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.lib.util.CommonLogParser
+
            +
            +
            +
            @ApiAudience.Public
+public final class CommonLogParser
            extends Object
            + + +

            +Parser that extracts fields from the NCSA Common Log Format. The fields available for + extraction are represented by the enumeration CommonLogParser.Field. No conversion is done for any + fields which might have a type associated (such as sizes, codes, or dates). + +

            Typical invocation:

            + 
            
+   Map<Field, String> derivedFields = CommonLogParser.get().parseCommonLog(logStr);
+
            +

            + +

            +

            +
            See Also:
            + Common logfile format
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classCommonLogParser.Field + +
            +          Fields that can be extracted via the Common Log Format.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static CommonLogParserget() + +
            +           
            + Map<CommonLogParser.Field,String>parseCommonLog(String line) + +
            +          Parses the input text with the specified delimiter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static CommonLogParser get()
            +
            +
            + +
            Returns:
            an instance of CommonLogParser.
            +
            +
            +
            + +

            +parseCommonLog

            +
            +public Map<CommonLogParser.Field,String> parseCommonLog(String line)
+                                                 throws ParseException
            +
            +
            Parses the input text with the specified delimiter. +

            +

            +
            Parameters:
            line - of text to parse the individual fields from. +
            Returns:
            list of strings for the parsed fields. +
            Throws: +
            ParseException - if there is an issue with escaping, or if there are insufficient fields +
            IllegalArgumentException - if the line is null.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/class-use/CSVParser.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/class-use/CSVParser.html new file mode 100644 index 00000000..830d4231 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/class-use/CSVParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.util.CSVParser (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.util.CSVParser

            +
            +No usage of org.kiji.mapreduce.lib.util.CSVParser +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/class-use/CommonLogParser.Field.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/class-use/CommonLogParser.Field.html new file mode 100644 index 00000000..5eea04ed --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/class-use/CommonLogParser.Field.html @@ -0,0 +1,207 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.util.CommonLogParser.Field (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.util.CommonLogParser.Field

            +
            + + + + + + + + + +
            +Packages that use CommonLogParser.Field
            org.kiji.mapreduce.lib.utilUtility classes (for example, parsers) which may be useful to clients when running MapReduce + jobs that use the Kiji system. 
            +  +

            + + + + + +
            +Uses of CommonLogParser.Field in org.kiji.mapreduce.lib.util
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.util that return CommonLogParser.Field
            +static CommonLogParser.FieldCommonLogParser.Field.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static CommonLogParser.Field[]CommonLogParser.Field.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.util that return types with arguments of type CommonLogParser.Field
            + Map<CommonLogParser.Field,String>CommonLogParser.parseCommonLog(String line) + +
            +          Parses the input text with the specified delimiter.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/class-use/CommonLogParser.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/class-use/CommonLogParser.html new file mode 100644 index 00000000..03be81b8 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/class-use/CommonLogParser.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.lib.util.CommonLogParser (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.lib.util.CommonLogParser

            +
            + + + + + + + + + +
            +Packages that use CommonLogParser
            org.kiji.mapreduce.lib.utilUtility classes (for example, parsers) which may be useful to clients when running MapReduce + jobs that use the Kiji system. 
            +  +

            + + + + + +
            +Uses of CommonLogParser in org.kiji.mapreduce.lib.util
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.lib.util that return CommonLogParser
            +static CommonLogParserCommonLogParser.get() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-frame.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-frame.html new file mode 100644 index 00000000..c14e8def --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +org.kiji.mapreduce.lib.util (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.lib.util + + + + +
            +Classes  + +
            +CommonLogParser +
            +CSVParser
            + + + + + + +
            +Enums  + +
            +CommonLogParser.Field
            + + + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-summary.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-summary.html new file mode 100644 index 00000000..3a6538cf --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-summary.html @@ -0,0 +1,194 @@ + + + + + + + +org.kiji.mapreduce.lib.util (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.lib.util +

            +Utility classes (for example, parsers) which may be useful to clients when running MapReduce + jobs that use the Kiji system. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + +
            +Class Summary
            CommonLogParserParser that extracts fields from the NCSA Common Log Format.
            CSVParserParser that extracts fields from RFC 4180 (http://tools.ietf.org/html/rfc4180) compliant + CSV and TSV lines of text.
            +  + +

            + + + + + + + + + +
            +Enum Summary
            CommonLogParser.FieldFields that can be extracted via the Common Log Format.
            +  + +

            +

            +Package org.kiji.mapreduce.lib.util Description +

            + +

            +Utility classes (for example, parsers) which may be useful to clients when running MapReduce + jobs that use the Kiji system. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-tree.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-tree.html new file mode 100644 index 00000000..c73752f0 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +org.kiji.mapreduce.lib.util Class Hierarchy (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.lib.util +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-use.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-use.html new file mode 100644 index 00000000..0cb83a11 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce/lib/util/package-use.html @@ -0,0 +1,178 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.lib.util (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.lib.util

            +
            + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.lib.util
            org.kiji.mapreduce.lib.utilUtility classes (for example, parsers) which may be useful to clients when running MapReduce + jobs that use the Kiji system. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.lib.util used by org.kiji.mapreduce.lib.util
            CommonLogParser + +
            +          Parser that extracts fields from the NCSA Common Log Format.
            CommonLogParser.Field + +
            +          Fields that can be extracted via the Common Log Format.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/overview-frame.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/overview-frame.html new file mode 100644 index 00000000..cd4be0ac --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/overview-frame.html @@ -0,0 +1,57 @@ + + + + + + + +Overview List (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + + + + +
            +
            + + + + + +
            All Classes +

            + +Packages +
            +org.kiji.mapreduce.lib.avro +
            +org.kiji.mapreduce.lib.bulkimport +
            +org.kiji.mapreduce.lib.examples +
            +org.kiji.mapreduce.lib.gather +
            +org.kiji.mapreduce.lib.map +
            +org.kiji.mapreduce.lib.produce +
            +org.kiji.mapreduce.lib.reduce +
            +org.kiji.mapreduce.lib.util +
            +

            + +

            +  + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/overview-summary.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/overview-summary.html new file mode 100644 index 00000000..f8748675 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/overview-summary.html @@ -0,0 +1,187 @@ + + + + + + + +Overview (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +The KijiMR Library 1.0.0-rc4 API +

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages
            org.kiji.mapreduce.lib.avro 
            org.kiji.mapreduce.lib.bulkimportBulk importers for KijiMR.
            org.kiji.mapreduce.lib.examplesSimple examples of using the KijiMR library API to write gatherers, producers, + and importers.
            org.kiji.mapreduce.lib.gatherGatherers for KijiMR.
            org.kiji.mapreduce.lib.mapMappers for KijiMR.
            org.kiji.mapreduce.lib.produceProducers for KijiMR.
            org.kiji.mapreduce.lib.reduceReducers for KijiMR.
            org.kiji.mapreduce.lib.utilUtility classes (for example, parsers) which may be useful to clients when running MapReduce + jobs that use the Kiji system.
            + +

            + 

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/overview-tree.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/overview-tree.html new file mode 100644 index 00000000..dc9d1e96 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/overview-tree.html @@ -0,0 +1,232 @@ + + + + + + + +Class Hierarchy (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.kiji.mapreduce.lib.avro, org.kiji.mapreduce.lib.bulkimport, org.kiji.mapreduce.lib.examples, org.kiji.mapreduce.lib.gather, org.kiji.mapreduce.lib.map, org.kiji.mapreduce.lib.produce, org.kiji.mapreduce.lib.reduce, org.kiji.mapreduce.lib.util
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/package-list b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/package-list new file mode 100644 index 00000000..13a42e3d --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/package-list @@ -0,0 +1,8 @@ +org.kiji.mapreduce.lib.avro +org.kiji.mapreduce.lib.bulkimport +org.kiji.mapreduce.lib.examples +org.kiji.mapreduce.lib.gather +org.kiji.mapreduce.lib.map +org.kiji.mapreduce.lib.produce +org.kiji.mapreduce.lib.reduce +org.kiji.mapreduce.lib.util diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/resources/inherit.gif b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/resources/inherit.gif differ diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/serialized-form.html b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/serialized-form.html new file mode 100644 index 00000000..05276315 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/serialized-form.html @@ -0,0 +1,164 @@ + + + + + + + +Serialized Form (The KijiMR Library 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Serialized Form

            +
            +
            + + + + + +
            +Package org.kiji.mapreduce.lib.bulkimport
            + +

            + + + + + +
            +Class org.kiji.mapreduce.lib.bulkimport.InvalidTableImportDescriptorException extends IOException implements Serializable
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce-lib/1.0.0-rc4/stylesheet.css b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/kiji-mapreduce-lib/1.0.0-rc4/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/allclasses-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/allclasses-frame.html new file mode 100644 index 00000000..8c131823 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/allclasses-frame.html @@ -0,0 +1,302 @@ + + + + + + + +All Classes (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            AvroBulkImporter +
            +AvroKeyMapReduceJobInput +
            +AvroKeyMapReduceJobOutput +
            +AvroKeyReader +
            +AvroKeyValueMapReduceJobInput +
            +AvroKeyValueMapReduceJobOutput +
            +AvroKeyWriter +
            +AvroKVRecordKeyValueStore +
            +AvroKVRecordKeyValueStore.Builder +
            +AvroMapReader +
            +AvroMapReduce +
            +AvroRecordKeyValueStore +
            +AvroRecordKeyValueStore.Builder +
            +AvroValueReader +
            +AvroValueWriter +
            +BinaryHTableBulkImporter +
            +BinaryHTableBulkImporter.ColumnDescriptor +
            +BulkImportMapper +
            +CombineFileInputFormat +
            +CombineFileRecordReader +
            +CombineFileSplit +
            +DirectKijiTableMapReduceJobOutput +
            +DirectKijiTableWriterContext +
            +DistributedCacheJars +
            +EmptyKeyValueStore +
            +EmptyKeyValueStore.Builder +
            +FileMapReduceJobInput +
            +FileMapReduceJobOutput +
            +FileStoreHelper +
            +FileStoreHelper.Builder +
            +GathererContext +
            +GatherMapper +
            +HFileKeyValue +
            +HFileKeyValue.FastComparator +
            +HFileLoader +
            +HFileMapReduceJobOutput +
            +HFileReducerMapReduceJobOutput +
            +HFileWriterContext +
            +HTableInputFormat +
            +HTableMapReduceJobInput +
            +HTableReader +
            +IdentityReducer +
            +InternalGathererContext +
            +InternalKijiContext +
            +InternalProducerContext +
            +InternalProducerContextInterface +
            +Jars +
            +JobConfigurationException +
            +JobHistoryCounters +
            +JobHistoryKijiTable +
            +JobInputSpec +
            +JobInputSpec.Format +
            +JobIOConfKeys +
            +JobIOSpecParseException +
            +JobOutputSpec +
            +JobOutputSpec.Format +
            +JobTool +
            +KeyValueStore +
            +KeyValueStoreClient +
            +KeyValueStoreConfigSerializer +
            +KeyValueStoreConfiguration +
            +KeyValueStoreConfigValidator +
            +KeyValueStoreReader +
            +KeyValueStoreReaderFactory +
            +KijiBulkImport +
            +KijiBulkImporter +
            +KijiBulkImporters +
            +KijiBulkImportJobBuilder +
            +KijiBulkLoad +
            +KijiConfKeys +
            +KijiContext +
            +KijiDataRequester +
            +KijiGather +
            +KijiGatherer +
            +KijiGatherJobBuilder +
            +KijiHFileOutputFormat +
            +KijiJobHistory +
            +KijiJobTool +
            +KijiLaunchMapReduce +
            +KijiMapper +
            +KijiMapReduceJob +
            +KijiMapReduceJobBuilder +
            +KijiMultithreadedMapper +
            +KijiProduce +
            +KijiProduceJobBuilder +
            +KijiProducer +
            +KijiProducerOutputException +
            +KijiProducers +
            +KijiReducer +
            +KijiTableContext +
            +KijiTableContextFactory +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader +
            +KijiTableInputJobBuilder +
            +KijiTableKeyValueStore +
            +KijiTableKeyValueStore.Builder +
            +KijiTableMapper +
            +KijiTableMapReduceJobInput +
            +KijiTableMapReduceJobInput.RowOptions +
            +KijiTableMapReduceJobOutput +
            +KijiTableReducer +
            +KijiTableSplit +
            +KVOutputJob +
            +Lists +
            +Lists.Aggregator +
            +Lists.Func +
            +Lists.IsNullFn +
            +Lists.ToStringFn +
            +LruCache +
            +MapFileMapReduceJobOutput +
            +MapFileOutputFormat +
            +MapReduceJob +
            +MapReduceJob.Status +
            +MapReduceJobBuilder +
            +MapReduceJobInput +
            +MapReduceJobInputFactory +
            +MapReduceJobOutput +
            +MapReduceJobOutputFactory +
            +ProduceMapper +
            +ProducerContext +
            +RequiredStores +
            +RequiredStores.StoreMap +
            +SeqFileKeyValueStore +
            +SeqFileKeyValueStore.Builder +
            +SequenceFileMapReduceJobInput +
            +SequenceFileMapReduceJobOutput +
            +TextFileKeyValueStore +
            +TextFileKeyValueStore.Builder +
            +TextMapReduceJobInput +
            +TextMapReduceJobOutput +
            +UnconfiguredKeyValueStore +
            +UnconfiguredKeyValueStore.Builder +
            +WholeFileInputFormat +
            +WholeFileRecordReader +
            +WholeTextFileMapReduceJobInput +
            +XmlKeyValueStoreParser +
            +
            + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/allclasses-noframe.html b/apidocs/kiji-mapreduce/1.0.0-rc4/allclasses-noframe.html new file mode 100644 index 00000000..4ca1f230 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/allclasses-noframe.html @@ -0,0 +1,302 @@ + + + + + + + +All Classes (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            AvroBulkImporter +
            +AvroKeyMapReduceJobInput +
            +AvroKeyMapReduceJobOutput +
            +AvroKeyReader +
            +AvroKeyValueMapReduceJobInput +
            +AvroKeyValueMapReduceJobOutput +
            +AvroKeyWriter +
            +AvroKVRecordKeyValueStore +
            +AvroKVRecordKeyValueStore.Builder +
            +AvroMapReader +
            +AvroMapReduce +
            +AvroRecordKeyValueStore +
            +AvroRecordKeyValueStore.Builder +
            +AvroValueReader +
            +AvroValueWriter +
            +BinaryHTableBulkImporter +
            +BinaryHTableBulkImporter.ColumnDescriptor +
            +BulkImportMapper +
            +CombineFileInputFormat +
            +CombineFileRecordReader +
            +CombineFileSplit +
            +DirectKijiTableMapReduceJobOutput +
            +DirectKijiTableWriterContext +
            +DistributedCacheJars +
            +EmptyKeyValueStore +
            +EmptyKeyValueStore.Builder +
            +FileMapReduceJobInput +
            +FileMapReduceJobOutput +
            +FileStoreHelper +
            +FileStoreHelper.Builder +
            +GathererContext +
            +GatherMapper +
            +HFileKeyValue +
            +HFileKeyValue.FastComparator +
            +HFileLoader +
            +HFileMapReduceJobOutput +
            +HFileReducerMapReduceJobOutput +
            +HFileWriterContext +
            +HTableInputFormat +
            +HTableMapReduceJobInput +
            +HTableReader +
            +IdentityReducer +
            +InternalGathererContext +
            +InternalKijiContext +
            +InternalProducerContext +
            +InternalProducerContextInterface +
            +Jars +
            +JobConfigurationException +
            +JobHistoryCounters +
            +JobHistoryKijiTable +
            +JobInputSpec +
            +JobInputSpec.Format +
            +JobIOConfKeys +
            +JobIOSpecParseException +
            +JobOutputSpec +
            +JobOutputSpec.Format +
            +JobTool +
            +KeyValueStore +
            +KeyValueStoreClient +
            +KeyValueStoreConfigSerializer +
            +KeyValueStoreConfiguration +
            +KeyValueStoreConfigValidator +
            +KeyValueStoreReader +
            +KeyValueStoreReaderFactory +
            +KijiBulkImport +
            +KijiBulkImporter +
            +KijiBulkImporters +
            +KijiBulkImportJobBuilder +
            +KijiBulkLoad +
            +KijiConfKeys +
            +KijiContext +
            +KijiDataRequester +
            +KijiGather +
            +KijiGatherer +
            +KijiGatherJobBuilder +
            +KijiHFileOutputFormat +
            +KijiJobHistory +
            +KijiJobTool +
            +KijiLaunchMapReduce +
            +KijiMapper +
            +KijiMapReduceJob +
            +KijiMapReduceJobBuilder +
            +KijiMultithreadedMapper +
            +KijiProduce +
            +KijiProduceJobBuilder +
            +KijiProducer +
            +KijiProducerOutputException +
            +KijiProducers +
            +KijiReducer +
            +KijiTableContext +
            +KijiTableContextFactory +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader +
            +KijiTableInputJobBuilder +
            +KijiTableKeyValueStore +
            +KijiTableKeyValueStore.Builder +
            +KijiTableMapper +
            +KijiTableMapReduceJobInput +
            +KijiTableMapReduceJobInput.RowOptions +
            +KijiTableMapReduceJobOutput +
            +KijiTableReducer +
            +KijiTableSplit +
            +KVOutputJob +
            +Lists +
            +Lists.Aggregator +
            +Lists.Func +
            +Lists.IsNullFn +
            +Lists.ToStringFn +
            +LruCache +
            +MapFileMapReduceJobOutput +
            +MapFileOutputFormat +
            +MapReduceJob +
            +MapReduceJob.Status +
            +MapReduceJobBuilder +
            +MapReduceJobInput +
            +MapReduceJobInputFactory +
            +MapReduceJobOutput +
            +MapReduceJobOutputFactory +
            +ProduceMapper +
            +ProducerContext +
            +RequiredStores +
            +RequiredStores.StoreMap +
            +SeqFileKeyValueStore +
            +SeqFileKeyValueStore.Builder +
            +SequenceFileMapReduceJobInput +
            +SequenceFileMapReduceJobOutput +
            +TextFileKeyValueStore +
            +TextFileKeyValueStore.Builder +
            +TextMapReduceJobInput +
            +TextMapReduceJobOutput +
            +UnconfiguredKeyValueStore +
            +UnconfiguredKeyValueStore.Builder +
            +WholeFileInputFormat +
            +WholeFileRecordReader +
            +WholeTextFileMapReduceJobInput +
            +XmlKeyValueStoreParser +
            +
            + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/constant-values.html b/apidocs/kiji-mapreduce/1.0.0-rc4/constant-values.html new file mode 100644 index 00000000..1afa9274 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/constant-values.html @@ -0,0 +1,467 @@ + + + + + + + +Constant Field Values (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents + + + + + + +
            +org.apache.*
            + +

            + + + + + + + + + + + + + + + + + +
            org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat<K,V>
            +public static final StringSPLIT_MINSIZE_PERNODE"mapreduce.input.fileinputformat.split.minsize.per.node"
            +public static final StringSPLIT_MINSIZE_PERRACK"mapreduce.input.fileinputformat.split.minsize.per.rack"
            + +

            + +

            + + + + + +
            +org.kiji.*
            + +

            + + + + + + + + + + + + +
            org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter
            +public static final StringCONF_COLUMN_DESCRIPTORS"binary.htable.importer.columns"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.mapreduce.framework.KijiConfKeys
            +public static final StringKIJI_BULK_IMPORTER_CLASS"kiji.bulk.importer.class"
            +public static final StringKIJI_GATHERER_CLASS"kiji.gatherer.class"
            +public static final StringKIJI_INPUT_DATA_REQUEST"kiji.input.data.request"
            +public static final StringKIJI_INPUT_TABLE_URI"kiji.input.table.uri"
            +public static final StringKIJI_INSTANCE_NAME"kiji.instance.name"
            +public static final StringKIJI_OUTPUT_TABLE_URI"kiji.output.table.uri"
            +public static final StringKIJI_PRODUCER_CLASS"kiji.producer.class"
            +public static final StringKIJI_TABLE_CONTEXT_CLASS"kiji.table.context.class"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration
            +public static final StringKEY_VALUE_STORE_NAMESPACE"kiji.job.kvstores."
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigSerializer
            +public static final StringCONF_CLASS"kiji$kvstore$class"
            +public static final StringCONF_KEY_VALUE_STORE_COUNT"kiji.job.kvstores.count"
            +public static final StringCONF_NAME"kiji$kvstore$name"
            +public static final intDEFAULT_KEY_VALUE_STORE_COUNT0
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.mapreduce.kvstore.lib.FileStoreHelper
            +public static final StringCONF_DCACHE_PREFIX_KEY"dcache.prefix"
            +public static final StringCONF_PATHS_KEY"paths"
            +public static final StringCONF_USE_DCACHE_KEY"dcache"
            +public static final booleanUSE_DCACHE_DEFAULTtrue
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore
            +public static final StringDEFAULT_DELIMITER"\t"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.mapreduce.output.framework.KijiHFileOutputFormat
            +public static final StringCONF_HFILE_BLOCKSIZE"hbase.mapreduce.hfileoutputformat.blocksize"
            +public static final StringCONF_HREGION_MAX_FILESIZE"hbase.hregion.max.filesize"
            +public static final StringCONF_LATEST_TIMESTAMP"kiji.hfile.latest.timestamp"
            +public static final intDEFAULT_HFILE_BLOCKSIZE65536
            +public static final longDEFAULT_HREGION_MAX_FILESIZE268435456L
            +public static final StringOUTPUT_EXTENSION".hfile"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.mapreduce.tools.framework.JobIOConfKeys
            +public static final StringFILE_PATH_KEY"file"
            +public static final StringFORMAT_KEY"format"
            +public static final StringHTABLE_NAME_KEY"htable"
            +public static final StringNSPLITS_KEY"nsplits"
            +public static final StringTABLE_KEY"table"
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/deprecated-list.html b/apidocs/kiji-mapreduce/1.0.0-rc4/deprecated-list.html new file mode 100644 index 00000000..072fc93c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/deprecated-list.html @@ -0,0 +1,147 @@ + + + + + + + +Deprecated List (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents
              +
            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/help-doc.html b/apidocs/kiji-mapreduce/1.0.0-rc4/help-doc.html new file mode 100644 index 00000000..e84b3f9c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/help-doc.html @@ -0,0 +1,224 @@ + + + + + + + +API Help (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Overview

            +
            + +

            +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

            +

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/index-all.html b/apidocs/kiji-mapreduce/1.0.0-rc4/index-all.html new file mode 100644 index 00000000..62ae09b8 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/index-all.html @@ -0,0 +1,2682 @@ + + + + + + + +Index (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +A B C D E F G H I J K L M N O P R S T U V W X
            +

            +A

            +
            +
            addJarDirectory(File) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Adds a local directory of jars to the distributed cache of the job. +
            addJarDirectory(String) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Adds a local directory of jars to the distributed cache of the job. +
            addJarsToDistributedCache(Job, String) - +Static method in class org.kiji.mapreduce.DistributedCacheJars +
            Adds the jars from a directory into the distributed cache of a job. +
            addJarsToDistributedCache(Job, File) - +Static method in class org.kiji.mapreduce.DistributedCacheJars +
            Adds the jars from a directory into the distributed cache of a job. +
            addStoreMapToConfiguration(Map<String, KeyValueStore<?, ?>>, Configuration) - +Method in class org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigSerializer +
            Given a set of KeyValueStores, add their configuration data to the provided Configuration. +
            addToScan(Scan) - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter.ColumnDescriptor +
            Adds a request for the HBase column to the scan descriptor. +
            AvroBulkImporter<T> - Class in org.kiji.mapreduce.bulkimport
            Base class for Kiji bulk importers that process Avro container + files.
            AvroBulkImporter() - +Constructor for class org.kiji.mapreduce.bulkimport.AvroBulkImporter +
              +
            AvroKeyMapReduceJobInput - Class in org.kiji.mapreduce.input
            The class AvroKeyMapReduceJobInput is used to indicate the usage of Avro container + files containing keys as input to a MapReduce job.
            AvroKeyMapReduceJobInput(Path...) - +Constructor for class org.kiji.mapreduce.input.AvroKeyMapReduceJobInput +
            Constructs job input from a varags of paths to Avro container files. +
            AvroKeyMapReduceJobOutput - Class in org.kiji.mapreduce.output
            The class AvroKeyMapReduceJobOutput is used to indicate the usage of Avro container files + as output for a MapReduce job.
            AvroKeyMapReduceJobOutput() - +Constructor for class org.kiji.mapreduce.output.AvroKeyMapReduceJobOutput +
            Default constructor. +
            AvroKeyMapReduceJobOutput(Path, int) - +Constructor for class org.kiji.mapreduce.output.AvroKeyMapReduceJobOutput +
            Creates a new AvroKeyMapReduceJobOutput instance. +
            AvroKeyReader - Interface in org.kiji.mapreduce.avro
            Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that read + AvroKey objects are required to implement this interface + as a means of specifying the Avro reader schema for their input key data.
            AvroKeyValueMapReduceJobInput - Class in org.kiji.mapreduce.input
            The class AvroKeyValueMapReduceJobInput is used to indicate the usage of Avro container + files containing key-value pairs as input to a MapReduce job.
            AvroKeyValueMapReduceJobInput(Path...) - +Constructor for class org.kiji.mapreduce.input.AvroKeyValueMapReduceJobInput +
            Constructs job input from a varargs of paths to Avro container files. +
            AvroKeyValueMapReduceJobOutput - Class in org.kiji.mapreduce.output
            The class AvroKeyValueMapReduceJobOutput is used to indicate the usage of Avro container files + as output for a MapReduce job.
            AvroKeyValueMapReduceJobOutput() - +Constructor for class org.kiji.mapreduce.output.AvroKeyValueMapReduceJobOutput +
            Default constructor. +
            AvroKeyValueMapReduceJobOutput(Path, int) - +Constructor for class org.kiji.mapreduce.output.AvroKeyValueMapReduceJobOutput +
            Creates a new AvroKeyValueMapReduceJobOutput instance. +
            AvroKeyWriter - Interface in org.kiji.mapreduce.avro
            Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that output + AvroKey objects are required to implement this interface + as a means of specifying the Avro writer schema for their output key data.
            AvroKVRecordKeyValueStore<K,V> - Class in org.kiji.mapreduce.kvstore.lib
            An interface for providing read access to Avro container files of (key, value) + records.
            AvroKVRecordKeyValueStore() - +Constructor for class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore +
            Reflection-only constructor. +
            AvroKVRecordKeyValueStore.Builder - Class in org.kiji.mapreduce.kvstore.lib
            A Builder-pattern class that configures and creates new AvroKVRecordKeyValueStore + instances.
            AvroMapReader<V> - Class in org.kiji.mapreduce.avro
            A reader for Avro "map" data.
            AvroMapReduce - Class in org.kiji.mapreduce.util
            A utility class for working with MapReduce jobs that use Avro for input or output data.
            AvroRecordKeyValueStore<K,V extends org.apache.avro.generic.IndexedRecord> - Class in org.kiji.mapreduce.kvstore.lib
            An interface for providing read access to Avro container files of records.
            AvroRecordKeyValueStore() - +Constructor for class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore +
            Reflection-only constructor. +
            AvroRecordKeyValueStore.Builder - Class in org.kiji.mapreduce.kvstore.lib
            A Builder-pattern class that configures and creates new AvroRecordKeyValueStore + instances.
            AvroValueReader - Interface in org.kiji.mapreduce.avro
            Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that read + AvroValue objects are required to implement this interface + as a means of specifying the Avro reader schema for their input value data.
            AvroValueWriter - Interface in org.kiji.mapreduce.avro
            Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that output + AvroValue objects are required to implement this interface + as a means of specifying the Avro writer schema for their output value data.
            +
            +

            +B

            +
            +
            BinaryHTableBulkImporter - Class in org.kiji.mapreduce.bulkimport
            A bulk importer that reads columns from an HTable that were encoded using the Bytes utility class.
            BinaryHTableBulkImporter() - +Constructor for class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter +
            Constructor. +
            BinaryHTableBulkImporter.ColumnDescriptor - Class in org.kiji.mapreduce.bulkimport
            Describes an input HTable column, its type, and a the target column in a Kiji table + it should be imported into.
            BinaryHTableBulkImporter.ColumnDescriptor(String, String, String, KijiColumnName) - +Constructor for class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter.ColumnDescriptor +
            Creates a new ColumnDescriptor instance. +
            bindAndValidateRequiredStores(Map<String, KeyValueStore<?, ?>>, Map<String, KeyValueStore<?, ?>>) - +Method in class org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigValidator +
            Fills any unbound stores in storeBindings with the default + implementations found in requiredStores. +
            build(Job) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Wraps a Hadoop MR job in a MapReduceJob. +
            build() - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Builds a runnable MapReduce job. +
            build(Job) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Wraps a Hadoop MR job in a MapReduceJob. +
            build(Job) - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Wraps a Hadoop MR job in a MapReduceJob. +
            build(Job) - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Wraps a Hadoop MR job in a MapReduceJob. +
            build() - +Method in class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore.Builder +
            Build a new AvroKVRecordKeyValueStore instance. +
            build() - +Method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore.Builder +
            Build a new AvroRecordKeyValueStore instance. +
            build() - +Method in class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore.Builder +
            Build a new EmptyKeyValueStore instance. +
            build() - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper.Builder +
            Builds and returns a new FileStoreHelper instance. +
            build() - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder +
            Build a new KijiTableKeyValueStore instance. +
            build() - +Method in class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore.Builder +
            Build a new SeqFileKeyValueStore instance. +
            build() - +Method in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore.Builder +
            Build a new TextFileKeyValueStore instance. +
            build() - +Method in class org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore.Builder +
            Build a new UnconfiguredKeyValueStore instance. +
            build(Job) - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Wraps a Hadoop MR job in a MapReduceJob. +
            builder() - +Static method in class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore +
            Creates a new AvroKVRecordKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore. +
            builder() - +Static method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore +
            Creates a new AvroRecordKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore. +
            builder() - +Static method in class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore +
            Creates a new EmptyKeyValueStore.Builder instance that can be used + to create a new KeyValueStore. +
            builder() - +Static method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
              +
            builder() - +Static method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore +
            Creates a new KijiTableKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore. +
            builder() - +Static method in class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore +
            Creates a new SeqFileKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore. +
            builder() - +Static method in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore +
            Creates a new TextFileKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore. +
            builder() - +Static method in class org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore +
            Creates a new UnconfiguredKeyValueStore.Builder instance that can be used + to create a new KeyValueStore. +
            BulkImportMapper<K,V> - Class in org.kiji.mapreduce.bulkimport.impl
            Hadoop mapper that runs a KijiBulkImporter.
            BulkImportMapper() - +Constructor for class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
              +
            +
            +

            +C

            +
            +
            cleanup(Mapper<K, V, HFileKeyValue, NullWritable>.Context) - +Method in class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
            +
            cleanup(KijiTableContext) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImporter +
            Called once to clean up this producer after all + KijiBulkImporter.produce(Object, Object, org.kiji.mapreduce.KijiTableContext) calls are made. +
            cleanup(Mapper<EntityId, KijiRowData, K, V>.Context) - +Method in class org.kiji.mapreduce.gather.impl.GatherMapper +
            +
            cleanup(GathererContext<K, V>) - +Method in class org.kiji.mapreduce.gather.KijiGatherer +
            Called once to dispose of any resources used by the gatherer after all calls to gather(). +
            cleanup(Mapper<EntityId, KijiRowData, K, V>.Context) - +Method in class org.kiji.mapreduce.impl.KijiTableMapper +
            +
            cleanup(Reducer<K, V, HFileKeyValue, NullWritable>.Context) - +Method in class org.kiji.mapreduce.KijiTableReducer +
            +
            cleanup(Mapper<EntityId, KijiRowData, HFileKeyValue, NullWritable>.Context) - +Method in class org.kiji.mapreduce.produce.impl.ProduceMapper +
            +
            cleanup(KijiContext) - +Method in class org.kiji.mapreduce.produce.KijiProducer +
            Called once to clean up this producer after all + KijiProducer.produce(KijiRowData, ProducerContext) calls are made. +
            cleanup() - +Method in class org.kiji.mapreduce.tools.KijiBulkImport +
            +
            clear() - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            close() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            close() - +Method in class org.kiji.mapreduce.framework.JobHistoryKijiTable +
              +
            close() - +Method in class org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader +
            +
            close() - +Method in class org.kiji.mapreduce.impl.DirectKijiTableWriterContext +
            +
            close() - +Method in class org.kiji.mapreduce.impl.HFileWriterContext +
              +
            close() - +Method in class org.kiji.mapreduce.impl.InternalKijiContext +
            +
            close() - +Method in class org.kiji.mapreduce.input.impl.WholeFileRecordReader +
            +
            close() - +Method in class org.kiji.mapreduce.kvstore.KeyValueStoreReaderFactory +
            Closes all KeyValueStoreReaders opened by this factory. +
            close() - +Method in class org.kiji.mapreduce.produce.impl.InternalProducerContext +
            +
            CombineFileInputFormat<K,V> - Class in org.apache.hadoop.mapreduce.lib.input
            An abstract InputFormat that returns CombineFileSplit's in + InputFormat.getSplits(JobContext) method.
            CombineFileInputFormat() - +Constructor for class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat +
            default constructor +
            CombineFileRecordReader<K,V> - Class in org.apache.hadoop.mapreduce.lib.input
            A generic RecordReader that can hand out different recordReaders + for each chunk in a CombineFileSplit.
            CombineFileRecordReader(CombineFileSplit, TaskAttemptContext, Class<? extends RecordReader<K, V>>) - +Constructor for class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
            A generic RecordReader that can hand out different recordReaders + for each chunk in the CombineFileSplit. +
            CombineFileSplit - Class in org.apache.hadoop.mapreduce.lib.input
            A sub-collection of input files.
            CombineFileSplit() - +Constructor for class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            default constructor +
            CombineFileSplit(Path[], long[], long[], String[]) - +Constructor for class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            Specify the set of files to include in this split +
            CombineFileSplit(Path[], long[]) - +Constructor for class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
              +
            CombineFileSplit(CombineFileSplit) - +Constructor for class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            Copy constructor +
            compare(byte[], int, int, byte[], int, int) - +Method in class org.kiji.mapreduce.framework.HFileKeyValue.FastComparator +
            +
            compareTo(HFileKeyValue) - +Method in class org.kiji.mapreduce.framework.HFileKeyValue +
            +
            CONF_CLASS - +Static variable in class org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigSerializer +
            KeyValueStoreConfiguration variable storing the class name to deserialize the store. +
            CONF_COLUMN_DESCRIPTORS - +Static variable in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter +
            The configuration variable listing the input/output columns and their types. +
            CONF_DCACHE_PREFIX_KEY - +Static variable in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
            Configuration key for the KeyValueStore definition that sets whether input files are + stored in the DistributedCache. +
            CONF_HFILE_BLOCKSIZE - +Static variable in class org.kiji.mapreduce.output.framework.KijiHFileOutputFormat +
              +
            CONF_HREGION_MAX_FILESIZE - +Static variable in class org.kiji.mapreduce.output.framework.KijiHFileOutputFormat +
              +
            CONF_KEY_VALUE_STORE_COUNT - +Static variable in class org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigSerializer +
            How many KeyValueStore definitions were serialized in the configuration? +
            CONF_LATEST_TIMESTAMP - +Static variable in class org.kiji.mapreduce.output.framework.KijiHFileOutputFormat +
              +
            CONF_NAME - +Static variable in class org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigSerializer +
            KeyValueStoreConfiguration variable storing the name of this KeyValueStore. +
            CONF_PATHS_KEY - +Static variable in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
            Suffix for the KeyValueStore definition that is set to the list of + input paths. +
            CONF_USE_DCACHE_KEY - +Static variable in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
            Boolean flag used in XML Configuration files only to state that the files + specified are + HDFS files, but should be loaded into the DistributedCache as part + of the job. +
            configure(Job) - +Method in class org.kiji.mapreduce.input.FileMapReduceJobInput +
              +
            configure(Job) - +Method in class org.kiji.mapreduce.input.HTableMapReduceJobInput +
            Configure a job to use this type of input for the MapReduce. +
            configure(Job) - +Method in class org.kiji.mapreduce.input.KijiTableMapReduceJobInput +
            Configure a job to use this type of input for the MapReduce. +
            configure(Job) - +Method in class org.kiji.mapreduce.MapReduceJobInput +
            Configure a job to use this type of input for the MapReduce. +
            configure(Job) - +Method in class org.kiji.mapreduce.MapReduceJobOutput +
            Configures the output for a MapReduce job. +
            configure(Job) - +Method in class org.kiji.mapreduce.output.DirectKijiTableMapReduceJobOutput +
            Configures the output for a MapReduce job. +
            configure(Job) - +Method in class org.kiji.mapreduce.output.FileMapReduceJobOutput +
            Configures the output for a MapReduce job. +
            configure(Job) - +Method in class org.kiji.mapreduce.output.framework.HFileReducerMapReduceJobOutput +
            Configures the output for a MapReduce job. +
            configure(Job) - +Method in class org.kiji.mapreduce.output.HFileMapReduceJobOutput +
            Configures the output for a MapReduce job. +
            configure(Job) - +Method in class org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput +
            Configures the output for a MapReduce job. +
            configure(B) - +Method in class org.kiji.mapreduce.tools.framework.JobTool +
            Configures the job builder by applying the flags from the user. +
            configure(B) - +Method in class org.kiji.mapreduce.tools.framework.KijiJobTool +
            Configures the job builder by applying the flags from the user. +
            configure(KijiBulkImportJobBuilder) - +Method in class org.kiji.mapreduce.tools.KijiBulkImport +
            Configures the job builder by applying the flags from the user. +
            configure(KijiGatherJobBuilder) - +Method in class org.kiji.mapreduce.tools.KijiGather +
              +
            configure(KijiMapReduceJobBuilder) - +Method in class org.kiji.mapreduce.tools.KijiLaunchMapReduce +
              +
            configure(KijiProduceJobBuilder) - +Method in class org.kiji.mapreduce.tools.KijiProduce +
            Configures the job builder by applying the flags from the user. +
            configureAvro(Job, KijiMapper<?, ?, ?, ?>) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures the job with any Avro reader or writer schemas specified by the mapper class. +
            configureCombiner(Job) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures the MapReduce combiner for the job. +
            configureHTableInput(Job, KijiMapper<?, ?, ?, ?>) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures HTable input for the job if the mapper is an HTableReader. +
            configureInput(Job) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures the input for the job. +
            configureJars(Job) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures the jars to be added to the distributed cache during the job. +
            configureJob(Job) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Configures a Hadoop MR job. +
            configureJob(Job, KijiURI, KijiDataRequest, String, String) - +Static method in class org.kiji.mapreduce.framework.KijiTableInputFormat +
            Configures a Hadoop M/R job to read from a given table. +
            configureJob(Job) - +Method in class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
            Configures a Hadoop MR job. +
            configureJob(Job) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures a Hadoop MR job. +
            configureJob(Job) - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Configures a Hadoop MR job. +
            configureJob(Job) - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Configures a Hadoop MR job. +
            configureJob(Job) - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Configures a Hadoop MR job. +
            configureJobForHFileOutput(Job) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Configures the job settings specific to writing HFiles. +
            configureMapper(Job) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures the MapReduce mapper for the job. +
            configureMapper(Job) - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Configures the MapReduce mapper for the job. +
            configureOutput(Job) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures the output for the job. +
            configureOutput(Job) - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Configures the output for the job. +
            configureReducer(Job) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures the MapReduce reducer for the job. +
            configureStores(Job) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures the key-value stores to be attached to the job. +
            containsKey(Object) - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            containsKey(K) - +Method in interface org.kiji.mapreduce.kvstore.KeyValueStoreReader +
            Determines if the specified key exists in the KeyValueStore. +
            containsValue(Object) - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            context - +Variable in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            create(Map<CharSequence, V>) - +Static method in class org.kiji.mapreduce.avro.AvroMapReader +
            Creates a new Avro map reader wrapping a map generated by the Avro framework. +
            create(Configuration) - +Static method in class org.kiji.mapreduce.bulkimport.impl.KijiBulkImporters +
            Create an instance of the bulk importer specified by the + Configuration. +
            create() - +Static method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Creates a new builder for Kiji bulk import jobs. +
            create(Job) - +Static method in class org.kiji.mapreduce.framework.KijiMapReduceJob +
            Creates a new KijiMapReduceJob. +
            create(TaskInputOutputContext<EntityId, KijiRowData, K, V>) - +Static method in class org.kiji.mapreduce.gather.impl.InternalGathererContext +
            Creates a new context for gatherers. +
            create() - +Static method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Creates a new builder for Kiji gather jobs. +
            create(Configuration) - +Static method in class org.kiji.mapreduce.HFileLoader +
            Creates a new HFile loader. +
            create(TaskInputOutputContext<?, ?, ?, ?>) - +Static method in class org.kiji.mapreduce.impl.DirectKijiTableWriterContext +
            Creates a new context that can write cells directly to a Kiji table. +
            create(TaskInputOutputContext<?, ?, ?, ?>) - +Static method in class org.kiji.mapreduce.impl.HFileWriterContext +
            Creates a new context that can write cells to an HFile that can be loaded into an HBase table. +
            create(TaskInputOutputContext) - +Static method in class org.kiji.mapreduce.impl.KijiTableContextFactory +
            Instantiates the configured KijiTableContext. +
            create() - +Static method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Creates a new builder for Kiji transform jobs. +
            create(Map<String, KeyValueStore<?, ?>>) - +Static method in class org.kiji.mapreduce.kvstore.KeyValueStoreReaderFactory +
            Creates a KeyValueStoreReaderFactory backed by a map of specific store bindings. +
            create(Configuration) - +Static method in class org.kiji.mapreduce.kvstore.KeyValueStoreReaderFactory +
            Creates a KeyValueStoreReaderFactory backed by store bindings specified in a Configuration. +
            create(TaskInputOutputContext<EntityId, KijiRowData, ?, ?>, KijiColumnName) - +Static method in class org.kiji.mapreduce.produce.impl.InternalProducerContext +
            Creates a new implementation of InternalProducerContextInterface for use by Kiji + producers. +
            create(Configuration) - +Static method in class org.kiji.mapreduce.produce.impl.KijiProducers +
            Creates an instance of the producer specified by the + Configuration. +
            create() - +Static method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Creates a new builder for Kiji produce jobs. +
            create(JobInputSpec.Format, String...) - +Static method in class org.kiji.mapreduce.tools.framework.JobInputSpec +
            Creates a new job input specification. +
            create(JobOutputSpec.Format, String, int) - +Static method in class org.kiji.mapreduce.tools.framework.JobOutputSpec +
            Creates a new job output specification. +
            create() - +Static method in class org.kiji.mapreduce.tools.framework.MapReduceJobInputFactory +
            Creates a new factory for instances of MapReduceJobInput. +
            create() - +Static method in class org.kiji.mapreduce.tools.framework.MapReduceJobOutputFactory +
            Creates a new factory for instances of MapReduceJobOutput. +
            create(int) - +Static method in class org.kiji.mapreduce.util.LruCache +
            Creates a new cache that holds a limited number of elements. +
            createEmpty() - +Static method in class org.kiji.mapreduce.kvstore.KeyValueStoreReaderFactory +
            Creates an empty KeyValueStoreReaderFactory. +
            createFromRowKey(byte[]) - +Static method in class org.kiji.mapreduce.framework.HFileKeyValue +
            Creates a new HFileKeyValue with a row key (all other fields left empty). +
            createGatherer(Configuration) - +Method in class org.kiji.mapreduce.gather.impl.GatherMapper +
            Initialize the gatherer instance to execute. +
            createJobBuilder() - +Method in class org.kiji.mapreduce.tools.framework.JobTool +
            Creates a new job builder. +
            createJobBuilder() - +Method in class org.kiji.mapreduce.tools.KijiBulkImport +
            Creates a new job builder. +
            createJobBuilder() - +Method in class org.kiji.mapreduce.tools.KijiGather +
              +
            createJobBuilder() - +Method in class org.kiji.mapreduce.tools.KijiLaunchMapReduce +
              +
            createJobBuilder() - +Method in class org.kiji.mapreduce.tools.KijiProduce +
            Creates a new job builder. +
            createPool(List<PathFilter>) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat +
            Create a new pool and add the filters to it. +
            createPool(PathFilter...) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat +
            Create a new pool and add the filters to it. +
            createRecordReader(InputSplit, TaskAttemptContext) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat +
            This is not implemented yet. +
            createRecordReader(InputSplit, TaskAttemptContext) - +Method in class org.kiji.mapreduce.framework.KijiTableInputFormat +
            +
            createRecordReader(InputSplit, TaskAttemptContext) - +Method in class org.kiji.mapreduce.input.impl.WholeFileInputFormat +
            Creates a CombineFileRecordReader to read each file assigned to this InputSplit. +
            curReader - +Variable in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            +
            +

            +D

            +
            +
            decodeHBaseCell(BinaryHTableBulkImporter.ColumnDescriptor, byte[]) - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter +
            Converts the contents of an HBase cell into a typed Kiji cell. +
            deDuplicateJarNames(List<String>) - +Static method in class org.kiji.mapreduce.DistributedCacheJars +
            Takes a list of paths and returns a list of paths with unique filenames. +
            DEFAULT_DELIMITER - +Static variable in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore +
            Records are tab-delimited by default, to be compatible with TextOutputFormat, + and function like KeyValueTextInputFormat. +
            DEFAULT_HFILE_BLOCKSIZE - +Static variable in class org.kiji.mapreduce.output.framework.KijiHFileOutputFormat +
              +
            DEFAULT_HREGION_MAX_FILESIZE - +Static variable in class org.kiji.mapreduce.output.framework.KijiHFileOutputFormat +
              +
            DEFAULT_KEY_VALUE_STORE_COUNT - +Static variable in class org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigSerializer +
            Default value for CONF_KEY_VALUE_STORE_COUNT. +
            DirectKijiTableMapReduceJobOutput - Class in org.kiji.mapreduce.output
            The class DirectKijiTableMapReduceJobOutput is used to indicate the usage of a Kiji table + as an output for a MapReduce job.
            DirectKijiTableMapReduceJobOutput() - +Constructor for class org.kiji.mapreduce.output.DirectKijiTableMapReduceJobOutput +
            Default constructor. +
            DirectKijiTableMapReduceJobOutput(KijiURI) - +Constructor for class org.kiji.mapreduce.output.DirectKijiTableMapReduceJobOutput +
            Creates a new KijiTableMapReduceJobOutput instance. +
            DirectKijiTableMapReduceJobOutput(KijiURI, int) - +Constructor for class org.kiji.mapreduce.output.DirectKijiTableMapReduceJobOutput +
            Creates a new KijiTableMapReduceJobOutput instance. +
            DirectKijiTableWriterContext - Class in org.kiji.mapreduce.impl
            Kiji context that writes cells to a configured output table.
            DirectKijiTableWriterContext(TaskInputOutputContext<?, ?, ?, ?>) - +Constructor for class org.kiji.mapreduce.impl.DirectKijiTableWriterContext +
            Constructs a new context that can write cells directly to a Kiji table. +
            distinct(List<X>) - +Static method in class org.kiji.mapreduce.util.Lists +
            Returns a list containing only the distinct elements of the input list. +
            DistributedCacheJars - Class in org.kiji.mapreduce
            Utility class for dealing with Java JAR files and the hadoop distributed cache.
            +
            +

            +E

            +
            +
            EmptyKeyValueStore<K,V> - Class in org.kiji.mapreduce.kvstore.lib
            A KeyValueStore that contains no data.
            EmptyKeyValueStore() - +Constructor for class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore +
            Reflection-only constructor. +
            EmptyKeyValueStore.Builder<K,V> - Class in org.kiji.mapreduce.kvstore.lib
            A Builder-pattern class that configures and creates new EmptyKeyValueStore + instances.
            entrySet() - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            equals(Object) - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            equals(Object) - +Method in class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore +
            +
            equals(Object) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore +
            +
            equals(Object) - +Method in class org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore +
            +
            eval(X, Y) - +Method in class org.kiji.mapreduce.util.Lists.Aggregator +
            Perform an operation on the current list element and intermediate datum. +
            eval(X) - +Method in class org.kiji.mapreduce.util.Lists.Func +
            Perform an operation on the current list element and return an output value. +
            eval(X) - +Method in class org.kiji.mapreduce.util.Lists.IsNullFn +
            Returns listItem == null. +
            eval(X) - +Method in class org.kiji.mapreduce.util.Lists.ToStringFn +
            Returns listItem.toString(). +
            exists(List<X>, Lists.Func<? super X, Boolean>) - +Static method in class org.kiji.mapreduce.util.Lists +
            Consider elements of a list, returning true if one of the elements of the list + satisfies the predicate function so that it returns True. +
            +
            +

            +F

            +
            +
            FILE_PATH_KEY - +Static variable in class org.kiji.mapreduce.tools.framework.JobIOConfKeys +
            Input or output file path, usually an hdfs:// URI. +
            FileMapReduceJobInput - Class in org.kiji.mapreduce.input
            Base class for MapReduce job input that is read from files.
            FileMapReduceJobOutput - Class in org.kiji.mapreduce.output
            Base class for MapReduce job output types that write to files.
            FileStoreHelper - Class in org.kiji.mapreduce.kvstore.lib
            Helper class that manages filenames and distributed cache functionality + for KeyValueStore implementations that work with files or collections + of files.
            FileStoreHelper.Builder - Class in org.kiji.mapreduce.kvstore.lib
            A class that builds configured FileStoreHelper instances.
            flush() - +Method in class org.kiji.mapreduce.impl.DirectKijiTableWriterContext +
            +
            flush() - +Method in class org.kiji.mapreduce.impl.InternalKijiContext +
            +
            flush() - +Method in class org.kiji.mapreduce.produce.impl.InternalProducerContext +
            +
            foldLeft(Y, List<X>, Lists.Aggregator<? super X, Y>) - +Static method in class org.kiji.mapreduce.util.Lists +
            Operate element-wise on elements of a list in a left-to-right fashion, + computing an aggregated value. +
            foldRight(Y, List<X>, Lists.Aggregator<? super X, Y>) - +Static method in class org.kiji.mapreduce.util.Lists +
            Operate element-wise on elements of a list in a right-to-left fashion, + computing an aggregated value. +
            FORMAT_KEY - +Static variable in class org.kiji.mapreduce.tools.framework.JobIOConfKeys +
            Format of the input or the ouptut. +
            forName(String) - +Static method in class org.kiji.mapreduce.bulkimport.KijiBulkImporter +
            Loads a KijiBulkImporter class by name. +
            forName(String) - +Static method in class org.kiji.mapreduce.gather.KijiGatherer +
            Loads a KijiGatherer class by name. +
            forName(String) - +Static method in class org.kiji.mapreduce.KijiMapper +
            Loads a KijiMapper class by name. +
            forName(String) - +Static method in class org.kiji.mapreduce.KijiReducer +
            Loads a KijiReducer class by name. +
            fromConf(Configuration) - +Static method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Factory method to wrap a Configuration in a KeyValueStoreConfiguration. +
            fromSpaceSeparatedMap(String) - +Method in class org.kiji.mapreduce.tools.framework.MapReduceJobInputFactory +
            Creates a job input from a command-line flag space-separated parameters map. +
            fromSpaceSeparatedMap(String) - +Method in class org.kiji.mapreduce.tools.framework.MapReduceJobOutputFactory +
            Creates a job output from a command-line flag space-separated parameters map. +
            fs - +Variable in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            +
            +

            +G

            +
            +
            gather(KijiRowData, GathererContext<K, V>) - +Method in class org.kiji.mapreduce.gather.KijiGatherer +
            Called once per row in the kiji table. +
            GathererContext<K,V> - Interface in org.kiji.mapreduce.gather
            Context for gatherers.
            GatherMapper<K,V> - Class in org.kiji.mapreduce.gather.impl
            Mapper that executes a gatherer over the rows of a Kiji table.
            GatherMapper() - +Constructor for class org.kiji.mapreduce.gather.impl.GatherMapper +
              +
            get(Object) - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            get(String) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Get the value of the name property, or null + if no such property exists. +
            get(String, String) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Get the value of the name property. +
            get() - +Static method in class org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigSerializer +
            This method returns a KeyValueStoreConfigSerializer instance. +
            get() - +Static method in class org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigValidator +
            This method returns a KeyValueStoreConfigValidator instance. +
            get() - +Static method in class org.kiji.mapreduce.kvstore.impl.XmlKeyValueStoreParser +
            This method returns XmlKeyValueStoreParser instance. +
            get(K) - +Method in interface org.kiji.mapreduce.kvstore.KeyValueStoreReader +
            Looks up the specified key in the KeyValueStore and returns the associated + value if available. +
            get() - +Static method in class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore +
            Returns a singleton EmptyKeyValueStore instance. +
            get() - +Static method in class org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore +
            Returns a singleton UnconfiguredKeyValueStore instance. +
            getAvroKeyReaderSchema() - +Method in interface org.kiji.mapreduce.avro.AvroKeyReader +
            If the input key class is AvroKey, this method + returns the Avro reader schema of the wrapped datum; otherwise null. +
            getAvroKeyReaderSchema() - +Method in class org.kiji.mapreduce.bulkimport.AvroBulkImporter +
            Specifies the expected reader schema for the input data. +
            getAvroKeyReaderSchema() - +Method in class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
            If the input key class is AvroKey, this method + returns the Avro reader schema of the wrapped datum; otherwise null. +
            getAvroKeyReaderSchema(Object) - +Static method in class org.kiji.mapreduce.util.AvroMapReduce +
            If the given object implements AvroKeyReader, return the reader schema for its + AvroKey; otherwise return null. +
            getAvroKeyWriterSchema() - +Method in interface org.kiji.mapreduce.avro.AvroKeyWriter +
            If the output key class is AvroKey, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. +
            getAvroKeyWriterSchema() - +Method in class org.kiji.mapreduce.gather.impl.GatherMapper +
            If the output key class is AvroKey, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. +
            getAvroKeyWriterSchema() - +Method in class org.kiji.mapreduce.reducer.IdentityReducer +
            If the output key class is AvroKey, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. +
            getAvroKeyWriterSchema(Object) - +Static method in class org.kiji.mapreduce.util.AvroMapReduce +
            If the given object implements AvroKeyWriter, return the writer schema for its + AvroKey; otherwise return null. +
            getAvroValueReaderSchema() - +Method in interface org.kiji.mapreduce.avro.AvroValueReader +
            If the input value class is AvroValue, this method + returns the Avro reader schema of the wrapped datum; otherwise null. +
            getAvroValueReaderSchema() - +Method in class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
            If the input value class is AvroValue, this method + returns the Avro reader schema of the wrapped datum; otherwise null. +
            getAvroValueReaderSchema(Object) - +Static method in class org.kiji.mapreduce.util.AvroMapReduce +
            If the given object implements AvroValueReader, return the reader schema for its + AvroValue; otherwise return null. +
            getAvroValueWriterSchema() - +Method in interface org.kiji.mapreduce.avro.AvroValueWriter +
            If the output key class is AvroValue, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. +
            getAvroValueWriterSchema() - +Method in class org.kiji.mapreduce.gather.impl.GatherMapper +
            If the output key class is AvroValue, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. +
            getAvroValueWriterSchema() - +Method in class org.kiji.mapreduce.reducer.IdentityReducer +
            If the output key class is AvroValue, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. +
            getAvroValueWriterSchema(Object) - +Static method in class org.kiji.mapreduce.util.AvroMapReduce +
            If the given object implements AvroValueWriter, return the writer schema for its + AvroValue; otherwise return null. +
            getBoolean(String, boolean) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Get the value of the name property as a boolean. +
            getCategory() - +Method in class org.kiji.mapreduce.tools.KijiBulkImport +
            +
            getCategory() - +Method in class org.kiji.mapreduce.tools.KijiBulkLoad +
            +
            getCategory() - +Method in class org.kiji.mapreduce.tools.KijiGather +
            +
            getCategory() - +Method in class org.kiji.mapreduce.tools.KijiJobHistory +
            +
            getCategory() - +Method in class org.kiji.mapreduce.tools.KijiLaunchMapReduce +
            +
            getCategory() - +Method in class org.kiji.mapreduce.tools.KijiProduce +
            +
            getClass(String, Class<?>) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Gets the value of the name property as a Class. +
            getClass(String, Class<? extends U>, Class<U>) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Get the value of the name property as a Class implementing the + interface specified by xface. +
            getClassByName(String) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Gets the value of the name property as a Class. +
            getCombiner() - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Gets an instance of the MapReduce combiner to be used for this job. +
            getCombiner() - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Gets an instance of the MapReduce combiner to be used for this job. +
            getCombiner() - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Gets an instance of the MapReduce combiner to be used for this job. +
            getCombiner() - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Gets an instance of the MapReduce combiner to be used for this job. +
            getCombiner() - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Gets an instance of the MapReduce combiner to be used for this job. +
            getConf() - +Method in class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
            +
            getConf() - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImporter +
            +
            getConf() - +Method in class org.kiji.mapreduce.framework.KijiTableInputFormat +
            +
            getConf() - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
              +
            getConf() - +Method in class org.kiji.mapreduce.gather.KijiGatherer +
            +
            getConf() - +Method in class org.kiji.mapreduce.impl.KijiTableMapper +
            +
            getConf() - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
            +
            getConf() - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore +
              +
            getConf() - +Method in class org.kiji.mapreduce.produce.KijiProducer +
            +
            getConf() - +Method in class org.kiji.mapreduce.reducer.IdentityReducer +
            +
            getCurrentKey() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            getCurrentKey() - +Method in class org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader +
            +
            getCurrentKey() - +Method in class org.kiji.mapreduce.input.impl.WholeFileRecordReader +
            Returns the absolute path to the current file. +
            getCurrentValue() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            getCurrentValue() - +Method in class org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader +
            +
            getCurrentValue() - +Method in class org.kiji.mapreduce.input.impl.WholeFileRecordReader +
            Returns the current value. +
            getDataRequest() - +Method in class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
            Subclasses must override this to provide a Kiji data request for the input table. +
            getDataRequest() - +Method in class org.kiji.mapreduce.gather.impl.GatherMapper +
            Return a KijiDataRequest that describes which input columns need to be available. +
            getDataRequest() - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Subclasses must override this to provide a Kiji data request for the input table. +
            getDataRequest() - +Method in interface org.kiji.mapreduce.KijiDataRequester +
            Return a KijiDataRequest that describes which input columns need to be available. +
            getDataRequest() - +Method in class org.kiji.mapreduce.produce.impl.ProduceMapper +
            Return a KijiDataRequest that describes which input columns need to be available. +
            getDataRequest() - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Subclasses must override this to provide a Kiji data request for the input table. +
            getDataRequest() - +Method in class org.kiji.mapreduce.produce.KijiProducer +
            Returns a KijiDataRequest that describes which input columns need to be available to + the producer. +
            getDelegate() - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Returns the parent Configuration that backs this KeyValueStoreConfiguration. +
            getDescription() - +Method in class org.kiji.mapreduce.tools.KijiBulkImport +
            +
            getDescription() - +Method in class org.kiji.mapreduce.tools.KijiBulkLoad +
            +
            getDescription() - +Method in class org.kiji.mapreduce.tools.KijiGather +
            +
            getDescription() - +Method in class org.kiji.mapreduce.tools.KijiJobHistory +
            +
            getDescription() - +Method in class org.kiji.mapreduce.tools.KijiLaunchMapReduce +
            +
            getDescription() - +Method in class org.kiji.mapreduce.tools.KijiProduce +
            +
            getEntityId(String) - +Method in class org.kiji.mapreduce.impl.DirectKijiTableWriterContext +
            Creates an entity ID for the specified Kiji row key. +
            getEntityId(String) - +Method in class org.kiji.mapreduce.impl.HFileWriterContext +
            Creates an entity ID for the specified Kiji row key. +
            getEntityId(String) - +Method in interface org.kiji.mapreduce.KijiTableContext +
            Creates an entity ID for the specified Kiji row key. +
            getEntityId() - +Method in class org.kiji.mapreduce.produce.impl.InternalProducerContext +
            +
            getEntityId() - +Method in interface org.kiji.mapreduce.produce.ProducerContext +
              +
            getEntry(MapFile.Reader[], Partitioner<K, V>, K, V) - +Static method in class org.apache.hadoop.mapreduce.lib.output.MapFileOutputFormat +
            Get an entry from output generated by this class. +
            getExpandedInputPaths() - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
            Returns the set of input path(s) that should be actually opened for read. +
            getFamily() - +Method in class org.kiji.mapreduce.framework.HFileKeyValue +
            Gets the KeyValue's column family. +
            getFloat(String, float) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Gets the value of the name property as a float. +
            getFormat() - +Method in class org.kiji.mapreduce.tools.framework.JobInputSpec +
              +
            getFormat() - +Method in class org.kiji.mapreduce.tools.framework.JobOutputSpec +
              +
            getHadoopJob() - +Method in class org.kiji.mapreduce.MapReduceJob +
            Gives access the underlying Hadoop Job object. +
            getHBaseFamilyBytes() - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter.ColumnDescriptor +
            Gets the input HBase column family. +
            getHBaseQualifierBytes() - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter.ColumnDescriptor +
            Gets the input HBase column qualifier. +
            getInputFormatClass() - +Method in class org.kiji.mapreduce.input.AvroKeyMapReduceJobInput +
            Returns the class to use for this MapReduce input format type. +
            getInputFormatClass() - +Method in class org.kiji.mapreduce.input.AvroKeyValueMapReduceJobInput +
            Returns the class to use for this MapReduce input format type. +
            getInputFormatClass() - +Method in class org.kiji.mapreduce.input.HTableMapReduceJobInput +
            Returns the class to use for this MapReduce input format type. +
            getInputFormatClass() - +Method in class org.kiji.mapreduce.input.KijiTableMapReduceJobInput +
            Returns the class to use for this MapReduce input format type. +
            getInputFormatClass() - +Method in class org.kiji.mapreduce.input.SequenceFileMapReduceJobInput +
            Returns the class to use for this MapReduce input format type. +
            getInputFormatClass() - +Method in class org.kiji.mapreduce.input.TextMapReduceJobInput +
            Returns the class to use for this MapReduce input format type. +
            getInputFormatClass() - +Method in class org.kiji.mapreduce.input.WholeTextFileMapReduceJobInput +
            Returns the class to use for this MapReduce input format type. +
            getInputFormatClass() - +Method in class org.kiji.mapreduce.MapReduceJobInput +
            Returns the class to use for this MapReduce input format type. +
            getInputHTableScan(Configuration) - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter +
            Returns an HBase scan descriptor that specifies what subset of rows and cells should + be read from the input HTable. +
            getInputHTableScan(Configuration) - +Method in class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
            Returns an HBase scan descriptor that specifies what subset of rows and cells should + be read from the input HTable. +
            getInputHTableScan(Configuration) - +Method in interface org.kiji.mapreduce.impl.HTableReader +
            Returns an HBase scan descriptor that specifies what subset of rows and cells should + be read from the input HTable. +
            getInputPaths() - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
            Returns the set of raw input path(s) that were specified for read. +
            getInputPaths() - +Method in class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore +
              +
            getInputTableURI() - +Method in class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
              +
            getInputTableURI() - +Method in class org.kiji.mapreduce.input.KijiTableMapReduceJobInput +
              +
            getInstallName() - +Static method in class org.kiji.mapreduce.framework.JobHistoryKijiTable +
            Returns the default name of the job history table. +
            getInt(String, int) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Gets the value of the name property as an int. +
            getJarClass() - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks. +
            getJarClass() - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks. +
            getJarClass() - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks. +
            getJarClass() - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks. +
            getJarClass() - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks. +
            getJarPathForClass(Class<? extends Object>) - +Static method in class org.kiji.mapreduce.util.Jars +
            Finds the file path to the jar that contains a particular class. +
            getJarsFromConfiguration(Configuration) - +Static method in class org.kiji.mapreduce.DistributedCacheJars +
            Lists all jars in the variable tmpjars of this Configuration. +
            getJarsFromDirectory(Configuration, File) - +Static method in class org.kiji.mapreduce.DistributedCacheJars +
            Lists all jars in the specified directory. +
            getJobDetails(String) - +Method in class org.kiji.mapreduce.framework.JobHistoryKijiTable +
            Get the saved information for a particular JobID. +
            getJobInput() - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Gets the input to configure the job with. +
            getJobInput() - +Method in class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
            Gets the input to configure the job with. +
            getJobInput() - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Gets the input to configure the job with. +
            getJobInput() - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Gets the input to configure the job with. +
            getJobInput() - +Method in class org.kiji.mapreduce.tools.framework.JobTool +
              +
            getJobInputTable() - +Method in class org.kiji.mapreduce.tools.framework.KijiJobTool +
              +
            getJobOutput() - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Provides access to the job output that the builder is configured with. +
            getJobOutput() - +Method in class org.kiji.mapreduce.tools.framework.JobTool +
              +
            getKeyValue() - +Method in class org.kiji.mapreduce.framework.HFileKeyValue +
            Provides access to the wrapped KeyValue object. +
            getKijiColumnName() - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter.ColumnDescriptor +
            Gets the name of the target Kiji column. +
            getLength() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
              +
            getLength(int) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            Returns the length of the ith Path +
            getLength() - +Method in class org.kiji.mapreduce.framework.HFileKeyValue +
            Gets the length of the serialized HFileKeyValue in bytes. +
            getLength() - +Method in class org.kiji.mapreduce.impl.KijiTableSplit +
            Returns the length of the split. +
            getLengths() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            Returns an array containing the lengths of the files in the split +
            getLimitRow() - +Method in class org.kiji.mapreduce.input.KijiTableMapReduceJobInput.RowOptions +
            Gets the entity id of the row to stop reading at (exclusive). +
            getLocation() - +Method in class org.kiji.mapreduce.tools.framework.JobInputSpec +
            Convenience method to return the location iff exactly one is specified. +
            getLocation() - +Method in class org.kiji.mapreduce.tools.framework.JobOutputSpec +
              +
            getLocations() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            Returns all the Nodes where this input-split resides +
            getLocations() - +Method in class org.kiji.mapreduce.tools.framework.JobInputSpec +
              +
            getLong(String, long) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Gets the value of the name property as a long. +
            getMapper() - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Gets an instance of the MapReduce mapper to be used for this job. +
            getMapper() - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Gets an instance of the MapReduce mapper to be used for this job. +
            getMapper() - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Gets an instance of the MapReduce mapper to be used for this job. +
            getMapper() - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Gets an instance of the MapReduce mapper to be used for this job. +
            getMapper() - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Gets an instance of the MapReduce mapper to be used for this job. +
            getMapperClass(JobContext) - +Static method in class org.apache.hadoop.mapreduce.lib.map.KijiMultithreadedMapper +
            Get the application's mapper class. +
            getMapReduceContext() - +Method in class org.kiji.mapreduce.impl.InternalKijiContext +
              +
            getMaxSize() - +Method in class org.kiji.mapreduce.util.LruCache +
              +
            getName() - +Method in enum org.kiji.mapreduce.tools.framework.JobInputSpec.Format +
            The short name of the format (used as the prefix in the string + representation of the JobInputSpec). +
            getName() - +Method in enum org.kiji.mapreduce.tools.framework.JobOutputSpec.Format +
            Name of the format. +
            getName() - +Method in class org.kiji.mapreduce.tools.KijiBulkImport +
            +
            getName() - +Method in class org.kiji.mapreduce.tools.KijiBulkLoad +
            +
            getName() - +Method in class org.kiji.mapreduce.tools.KijiGather +
            +
            getName() - +Method in class org.kiji.mapreduce.tools.KijiJobHistory +
            +
            getName() - +Method in class org.kiji.mapreduce.tools.KijiLaunchMapReduce +
            +
            getName() - +Method in class org.kiji.mapreduce.tools.KijiProduce +
            +
            getNamespace() - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Returns the namespace that this KeyValueStoreConfiguration works in. +
            getNumberOfThreads(JobContext) - +Static method in class org.apache.hadoop.mapreduce.lib.map.KijiMultithreadedMapper +
            The number of threads in the thread pool that will run the map function. +
            getNumPaths() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            Returns the number of Paths in the split +
            getNumReduceTasks() - +Method in class org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput +
              +
            getOffset(int) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            Returns the start offset of the ith Path +
            getOutputColumn() - +Method in class org.kiji.mapreduce.produce.KijiProducer +
            Return the name of the output column. +
            getOutputFormatClass() - +Method in class org.kiji.mapreduce.MapReduceJobOutput +
            Gets the Hadoop MapReduce output format class. +
            getOutputFormatClass() - +Method in class org.kiji.mapreduce.output.AvroKeyMapReduceJobOutput +
            Gets the Hadoop MapReduce output format class. +
            getOutputFormatClass() - +Method in class org.kiji.mapreduce.output.AvroKeyValueMapReduceJobOutput +
            Gets the Hadoop MapReduce output format class. +
            getOutputFormatClass() - +Method in class org.kiji.mapreduce.output.DirectKijiTableMapReduceJobOutput +
            Gets the Hadoop MapReduce output format class. +
            getOutputFormatClass() - +Method in class org.kiji.mapreduce.output.framework.HFileReducerMapReduceJobOutput +
            Gets the Hadoop MapReduce output format class. +
            getOutputFormatClass() - +Method in class org.kiji.mapreduce.output.HFileMapReduceJobOutput +
            Gets the Hadoop MapReduce output format class. +
            getOutputFormatClass() - +Method in class org.kiji.mapreduce.output.MapFileMapReduceJobOutput +
            Gets the Hadoop MapReduce output format class. +
            getOutputFormatClass() - +Method in class org.kiji.mapreduce.output.SequenceFileMapReduceJobOutput +
            Gets the Hadoop MapReduce output format class. +
            getOutputFormatClass() - +Method in class org.kiji.mapreduce.output.TextMapReduceJobOutput +
            Gets the Hadoop MapReduce output format class. +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
            +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.gather.impl.GatherMapper +
            +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.KijiTableReducer +
            +
            getOutputKeyClass() - +Method in interface org.kiji.mapreduce.KVOutputJob +
              +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.produce.impl.ProduceMapper +
            +
            getOutputKeyClass() - +Method in class org.kiji.mapreduce.reducer.IdentityReducer +
            +
            getOutputTableURI() - +Method in class org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput +
              +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.gather.impl.GatherMapper +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.KijiTableReducer +
            +
            getOutputValueClass() - +Method in interface org.kiji.mapreduce.KVOutputJob +
              +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.produce.impl.ProduceMapper +
            +
            getOutputValueClass() - +Method in class org.kiji.mapreduce.reducer.IdentityReducer +
            +
            getPath(int) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            Returns the ith Path +
            getPath() - +Method in class org.kiji.mapreduce.output.HFileMapReduceJobOutput +
              +
            getPaths() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            Returns all the Paths in the split +
            getProgress() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
            return progress based on the amount of data processed so far. +
            getProgress() - +Method in class org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader +
            +
            getProgress() - +Method in class org.kiji.mapreduce.input.impl.WholeFileRecordReader +
            Returns whether the file has been processed or not. +
            getRaw(String) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Get the value of the name property, without doing variable expansion. +
            getReaders(Path, Configuration) - +Static method in class org.apache.hadoop.mapreduce.lib.output.MapFileOutputFormat +
            Open the output generated by this format. +
            getRecordWriter(TaskAttemptContext) - +Method in class org.apache.hadoop.mapreduce.lib.output.MapFileOutputFormat +
              +
            getRecordWriter(TaskAttemptContext) - +Method in class org.kiji.mapreduce.output.framework.KijiHFileOutputFormat +
            +
            getReducer() - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Gets an instance of the MapReduce reducer to be used for this job. +
            getReducer() - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Gets an instance of the MapReduce reducer to be used for this job. +
            getReducer() - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Gets an instance of the MapReduce reducer to be used for this job. +
            getReducer() - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Gets an instance of the MapReduce reducer to be used for this job. +
            getReducer() - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Gets an instance of the MapReduce reducer to be used for this job. +
            getRegionStartKey() - +Method in class org.kiji.mapreduce.impl.KijiTableSplit +
            Returns the start key of the region associated with this split. +
            getRequiredStores() - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImporter +
            Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations. +
            getRequiredStores() - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Method for job components to declare required KeyValueStore entries (and their default + implementations). +
            getRequiredStores() - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Method for job components to declare required KeyValueStore entries (and their default + implementations). +
            getRequiredStores() - +Method in class org.kiji.mapreduce.gather.KijiGatherer +
            Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations. +
            getRequiredStores() - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Method for job components to declare required KeyValueStore entries (and their default + implementations). +
            getRequiredStores() - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Method for job components to declare required KeyValueStore entries (and their default + implementations). +
            getRequiredStores() - +Method in interface org.kiji.mapreduce.kvstore.KeyValueStoreClient +
            Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations. +
            getRequiredStores() - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Method for job components to declare required KeyValueStore entries (and their default + implementations). +
            getRequiredStores() - +Method in class org.kiji.mapreduce.produce.KijiProducer +
            Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations. +
            getRowFilter() - +Method in class org.kiji.mapreduce.input.KijiTableMapReduceJobInput.RowOptions +
              +
            getRowKey() - +Method in class org.kiji.mapreduce.framework.HFileKeyValue +
            Gets the KeyValue's row key. +
            getRowOptions() - +Method in class org.kiji.mapreduce.input.KijiTableMapReduceJobInput +
              +
            getSplits(JobContext) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat +
              +
            getSplits(JobContext) - +Method in class org.kiji.mapreduce.framework.KijiTableInputFormat +
            +
            getSplits(JobContext) - +Method in class org.kiji.mapreduce.impl.HTableInputFormat +
            +
            getSplits() - +Method in class org.kiji.mapreduce.tools.framework.JobOutputSpec +
              +
            getStartOffsets() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
            Returns an array containing the start offsets of the files in the split +
            getStartRow() - +Method in class org.kiji.mapreduce.input.KijiTableMapReduceJobInput.RowOptions +
            Gets the entity id of the row to start reading from (inclusive). +
            getStatus() - +Method in class org.kiji.mapreduce.impl.InternalKijiContext +
            Returns a previously set status message. +
            getStatus() - +Method in interface org.kiji.mapreduce.KijiContext +
            Returns a previously set status message. +
            getStore(String) - +Method in class org.kiji.mapreduce.impl.InternalKijiContext +
            Opens a KeyValueStore associated with storeName for read-access. +
            getStore(String) - +Method in interface org.kiji.mapreduce.KijiContext +
            Opens a KeyValueStore associated with storeName for read-access. +
            getStrings(String) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Get the comma delimited values of the name property + as an array of Strings. +
            getStrings(String, String...) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Get the comma delimited values of the name property + as an array of Strings. +
            getType() - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter.ColumnDescriptor +
            Gets the type of the HBase column, used to determine how to decode the cell's bytes. +
            +
            +

            +H

            +
            +
            hashCode() - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            hashCode() - +Method in class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore +
            +
            hashCode() - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore +
            +
            hashCode() - +Method in class org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore +
            +
            HFileKeyValue - Class in org.kiji.mapreduce.framework
            A KeyValue-like object that implements WritableComparable.
            HFileKeyValue() - +Constructor for class org.kiji.mapreduce.framework.HFileKeyValue +
            Default constructor for Writable instantiation -- you probably don't want to use this. +
            HFileKeyValue(byte[], byte[], byte[], long, byte[]) - +Constructor for class org.kiji.mapreduce.framework.HFileKeyValue +
            Constructor that builds a filled HFileKeyValue. +
            HFileKeyValue.FastComparator - Class in org.kiji.mapreduce.framework
            A comparator that works over byte arrays, to avoid serialization.
            HFileKeyValue.FastComparator() - +Constructor for class org.kiji.mapreduce.framework.HFileKeyValue.FastComparator +
            Constructor. +
            HFileLoader - Class in org.kiji.mapreduce
            Loads HFiles generated by a MapReduce job into a Kiji table.
            HFileMapReduceJobOutput - Class in org.kiji.mapreduce.output
            The class HFileMapReduceJobOutput is used to indicate the usage of HFiles based on the layout + of a Kiji table as output for a MapReduce job.
            HFileMapReduceJobOutput() - +Constructor for class org.kiji.mapreduce.output.HFileMapReduceJobOutput +
            Default constructor. +
            HFileMapReduceJobOutput(KijiURI, Path) - +Constructor for class org.kiji.mapreduce.output.HFileMapReduceJobOutput +
            Create job output of HFiles that can be efficiently loaded into a Kiji table. +
            HFileMapReduceJobOutput(KijiURI, Path, int) - +Constructor for class org.kiji.mapreduce.output.HFileMapReduceJobOutput +
            Create job output of HFiles that can be efficiently loaded into a Kiji table. +
            HFileReducerMapReduceJobOutput - Class in org.kiji.mapreduce.output.framework
            M/R job output configuration for a job intending to reduce into HFiles.
            HFileReducerMapReduceJobOutput(HFileMapReduceJobOutput) - +Constructor for class org.kiji.mapreduce.output.framework.HFileReducerMapReduceJobOutput +
            Initializes an instance. +
            HFileWriterContext - Class in org.kiji.mapreduce.impl
            Kiji context that emits puts for the configured output table to HFiles.
            HFileWriterContext(TaskInputOutputContext<?, ?, ?, ?>) - +Constructor for class org.kiji.mapreduce.impl.HFileWriterContext +
            Constructs a new context that can write cells to an HFile that can be loaded into an HBase + table. +
            HTABLE_NAME_KEY - +Static variable in class org.kiji.mapreduce.tools.framework.JobIOConfKeys +
            Name of the input HTable, for HTableMapReduceJobInput. +
            HTableInputFormat - Class in org.kiji.mapreduce.impl
            An InputFormat for MapReduce jobs over HBase HTables.
            HTableInputFormat() - +Constructor for class org.kiji.mapreduce.impl.HTableInputFormat +
              +
            HTableMapReduceJobInput - Class in org.kiji.mapreduce.input
            The class HTableMapReduceJobInput is used to indicate the usage of a HBase table + as input to a MapReduce job.
            HTableMapReduceJobInput() - +Constructor for class org.kiji.mapreduce.input.HTableMapReduceJobInput +
            Default constructor. +
            HTableMapReduceJobInput(String) - +Constructor for class org.kiji.mapreduce.input.HTableMapReduceJobInput +
            Creates a new HTableMapReduceJobInput instance. +
            HTableReader - Interface in org.kiji.mapreduce.impl
            An interface for Kiji mappers or bulk importers that read from HBase HTables.
            +
            +

            +I

            +
            +
            IdentityReducer<K,V> - Class in org.kiji.mapreduce.reducer
            This MapReduce reducer will pass through all of the input key-value + pairs unchanged.
            IdentityReducer() - +Constructor for class org.kiji.mapreduce.reducer.IdentityReducer +
              +
            idx - +Variable in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            incrementCounter(Enum<?>) - +Method in class org.kiji.mapreduce.impl.InternalKijiContext +
            Increments a counter by 1. +
            incrementCounter(Enum<?>, long) - +Method in class org.kiji.mapreduce.impl.InternalKijiContext +
            Increment a counter by an amount. +
            incrementCounter(Enum<?>) - +Method in interface org.kiji.mapreduce.KijiContext +
            Increments a counter by 1. +
            incrementCounter(Enum<?>, long) - +Method in interface org.kiji.mapreduce.KijiContext +
            Increment a counter by an amount. +
            initFromConf(KeyValueStoreConfiguration) - +Method in interface org.kiji.mapreduce.kvstore.KeyValueStore +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +
            initFromConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +
            initFromConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +
            initFromConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +
            initFromConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
            Deserializes file- and DistributedCache-specific properties associated + with the KeyValueStore that owns this FileStoreHelper from the specified configuration. +
            initFromConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +
            initFromConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +
            initFromConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +
            initFromConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +
            initialize(InputSplit, TaskAttemptContext) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            initialize(InputSplit, TaskAttemptContext) - +Method in class org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader +
            +
            initialize(Map<String, String>) - +Method in class org.kiji.mapreduce.input.FileMapReduceJobInput +
            Initializes the job input with the given parameters. +
            initialize(Map<String, String>) - +Method in class org.kiji.mapreduce.input.HTableMapReduceJobInput +
            Initializes the job input with the given parameters. +
            initialize(InputSplit, TaskAttemptContext) - +Method in class org.kiji.mapreduce.input.impl.WholeFileRecordReader +
            All of the internal state is already set on instantiation. +
            initialize(Map<String, String>) - +Method in class org.kiji.mapreduce.input.KijiTableMapReduceJobInput +
            Initializes the job input with the given parameters. +
            initialize(Map<String, String>) - +Method in class org.kiji.mapreduce.MapReduceJobInput +
            Initializes the job input with the given parameters. +
            initialize(Map<String, String>) - +Method in class org.kiji.mapreduce.MapReduceJobOutput +
            Initializes the job output from command-line parameters. +
            initialize(Map<String, String>) - +Method in class org.kiji.mapreduce.output.FileMapReduceJobOutput +
            Initializes the job output from command-line parameters. +
            initialize(Map<String, String>) - +Method in class org.kiji.mapreduce.output.framework.HFileReducerMapReduceJobOutput +
            Initializes the job output from command-line parameters. +
            initialize(Map<String, String>) - +Method in class org.kiji.mapreduce.output.HFileMapReduceJobOutput +
            Initializes the job output from command-line parameters. +
            initialize(Map<String, String>) - +Method in class org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput +
            Initializes the job output from command-line parameters. +
            initNextRecordReader() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
            Get the record reader for the next chunk in this CombineFileSplit. +
            install(Kiji) - +Static method in class org.kiji.mapreduce.framework.JobHistoryKijiTable +
            Install the job history table into a Kiji instance. +
            InternalGathererContext<K,V> - Class in org.kiji.mapreduce.gather.impl
            Concrete context for gatherers that emit key/value pairs.
            InternalKijiContext - Class in org.kiji.mapreduce.impl
            Implements KijiContext.
            InternalKijiContext(TaskInputOutputContext) - +Constructor for class org.kiji.mapreduce.impl.InternalKijiContext +
            Constructs a new implementation of KijiContext. +
            InternalProducerContext - Class in org.kiji.mapreduce.produce.impl
            Implementation of a producer context.
            InternalProducerContextInterface - Interface in org.kiji.mapreduce.produce.impl
            Internal interface for producer contexts.
            isComplete() - +Method in class org.kiji.mapreduce.MapReduceJob.Status +
            Determines whether the job has completed. +
            isEmpty() - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            isOpen() - +Method in interface org.kiji.mapreduce.kvstore.KeyValueStoreReader +
              +
            isSplitable(JobContext, Path) - +Method in class org.kiji.mapreduce.input.impl.WholeFileInputFormat +
            Guarantees that no file is split. +
            isSuccessful() - +Method in class org.kiji.mapreduce.MapReduceJob.Status +
            Determines whether the job was successful. +
            +
            +

            +J

            +
            +
            Jars - Class in org.kiji.mapreduce.util
            Utility class for dealing with Java Jar files and their contained classes.
            JobConfigurationException - Exception in org.kiji.mapreduce
            Thrown when a MapReduceJob is being built, but it has missing or incomplete configuration.
            JobConfigurationException(String) - +Constructor for exception org.kiji.mapreduce.JobConfigurationException +
            Creates a new JobConfigurationException instance. +
            JobHistoryCounters - Enum in org.kiji.mapreduce.framework
            An enumeration for the various hadoop job counters we collect.
            JobHistoryKijiTable - Class in org.kiji.mapreduce.framework
            A class providing an API to install and access the job history kiji table.
            JobInputSpec - Class in org.kiji.mapreduce.tools.framework
            Describes the format and location of the input for a MapReduce job.
            JobInputSpec.Format - Enum in org.kiji.mapreduce.tools.framework
            The Job input formats supported by Kiji.
            JobIOConfKeys - Class in org.kiji.mapreduce.tools.framework
            Configuration keys for Job input and output specifications.
            JobIOSpecParseException - Exception in org.kiji.mapreduce.tools.framework
            Thrown when a JobInputSpec or JobOutputSpec cannot be parsed.
            JobIOSpecParseException(String, String) - +Constructor for exception org.kiji.mapreduce.tools.framework.JobIOSpecParseException +
              +
            JobOutputSpec - Class in org.kiji.mapreduce.tools.framework
            Describes the format and location for the output of a MapReduce job.
            JobOutputSpec.Format - Enum in org.kiji.mapreduce.tools.framework
            The job output formats supported by Kiji.
            JobTool<B extends MapReduceJobBuilder> - Class in org.kiji.mapreduce.tools.framework
            Base class for tools that run MapReduce jobs.
            JobTool() - +Constructor for class org.kiji.mapreduce.tools.framework.JobTool +
              +
            just(String, KeyValueStore<K, V>) - +Static method in class org.kiji.mapreduce.kvstore.RequiredStores +
            Create an immutable required store map of a single entry. +
            +
            +

            +K

            +
            +
            KEY_VALUE_STORE_NAMESPACE - +Static variable in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            KeyValueStore definitions are serialized to the Configuration as a set of + keys under the "kiji.kvstores.[i]" namespace. +
            keySet() - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            KeyValueStore<K,V> - Interface in org.kiji.mapreduce.kvstore
            A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store.
            KeyValueStoreClient - Interface in org.kiji.mapreduce.kvstore
            A KeyValueStoreClient defines a mapping between store names and their + KeyValueStore implementations via the getRequiredStores() method.
            KeyValueStoreConfigSerializer - Class in org.kiji.mapreduce.kvstore.impl
            Serialize multiple KeyValueStoreConfigurations into a Hadoop Configuration + or deserialize the reverse.
            KeyValueStoreConfiguration - Class in org.kiji.mapreduce.kvstore.framework
            Used to serialize KeyValueStore information into a unique namespace + inside a Configuration object.
            KeyValueStoreConfiguration(Configuration, int) - +Constructor for class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Creates a KeyValueStoreConfiguration that writes to the storeIndexth + KeyValueStore namespace. +
            KeyValueStoreConfiguration(Configuration, String) - +Constructor for class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Constructs a new KeyValueStoreConfiguration that will read and write + values to the parent Configuration, under an arbitrary namespace. +
            KeyValueStoreConfigValidator - Class in org.kiji.mapreduce.kvstore.impl
            Merges default required store configs with per-job store configuration overrides, + and validates that the required stores are present.
            KeyValueStoreReader<K,V> - Interface in org.kiji.mapreduce.kvstore
            Allows users to read from a KeyValueStore.
            KeyValueStoreReaderFactory - Class in org.kiji.mapreduce.kvstore
            Class that manages the creation of KeyValueStoreReaders associated + with a set of bound KeyValueStore name--instance pairs.
            KIJI_BULK_IMPORTER_CLASS - +Static variable in class org.kiji.mapreduce.framework.KijiConfKeys +
            Fully qualified name of the KijiBulkImporter class to run. +
            KIJI_GATHERER_CLASS - +Static variable in class org.kiji.mapreduce.framework.KijiConfKeys +
            Fully qualified name of the KijiGatherer class to run. +
            KIJI_INPUT_DATA_REQUEST - +Static variable in class org.kiji.mapreduce.framework.KijiConfKeys +
            Serialized input data request. +
            KIJI_INPUT_TABLE_URI - +Static variable in class org.kiji.mapreduce.framework.KijiConfKeys +
            URI of the input table to read from. +
            KIJI_INSTANCE_NAME - +Static variable in class org.kiji.mapreduce.framework.KijiConfKeys +
            Kiji Instance Name. +
            KIJI_OUTPUT_TABLE_URI - +Static variable in class org.kiji.mapreduce.framework.KijiConfKeys +
            URI of the output Kiji table to write to. +
            KIJI_PRODUCER_CLASS - +Static variable in class org.kiji.mapreduce.framework.KijiConfKeys +
            Fully qualified name of the KijiProducer class to run. +
            KIJI_TABLE_CONTEXT_CLASS - +Static variable in class org.kiji.mapreduce.framework.KijiConfKeys +
            Name of the KijiTableContext class to use. +
            KijiBulkImport - Class in org.kiji.mapreduce.tools
            Bulk imports a file into a Kiji table.
            KijiBulkImport() - +Constructor for class org.kiji.mapreduce.tools.KijiBulkImport +
              +
            KijiBulkImporter<K,V> - Class in org.kiji.mapreduce.bulkimport
            Base class for all Kiji bulk importers.
            KijiBulkImporter() - +Constructor for class org.kiji.mapreduce.bulkimport.KijiBulkImporter +
            Your subclass of KijiBulkImporter must have a default constructor if it is to be used + in a bulk import job. +
            KijiBulkImporters - Class in org.kiji.mapreduce.bulkimport.impl
            Utility methods for working with KijiBulkImporter.
            KijiBulkImportJobBuilder - Class in org.kiji.mapreduce.bulkimport
            Builds a job that runs a KijiBulkImporter to import data into a Kiji table.
            KijiBulkLoad - Class in org.kiji.mapreduce.tools
            Bulk loads HFiles into a Kiji table.
            KijiBulkLoad() - +Constructor for class org.kiji.mapreduce.tools.KijiBulkLoad +
              +
            KijiConfKeys - Class in org.kiji.mapreduce.framework
            Configuration keys used by KijiMR in Hadoop Configuration objects.
            KijiContext - Interface in org.kiji.mapreduce
            Interface for contexts passed to KijiMR methods.
            KijiDataRequester - Interface in org.kiji.mapreduce
            Interface for classes that specify a set of columns to read from a kiji table.
            KijiGather - Class in org.kiji.mapreduce.tools
            Command-line tool for running a KijiGatherer.
            KijiGather() - +Constructor for class org.kiji.mapreduce.tools.KijiGather +
              +
            KijiGatherer<K,V> - Class in org.kiji.mapreduce.gather
            + Base class for all Kiji Gatherers.
            KijiGatherer() - +Constructor for class org.kiji.mapreduce.gather.KijiGatherer +
              +
            KijiGatherJobBuilder - Class in org.kiji.mapreduce.gather
            Builds jobs that run a gatherer over a Kiji table.
            KijiHFileOutputFormat - Class in org.kiji.mapreduce.output.framework
            Hadoop output format that writes HFiles that can be loaded directly into HBase region servers.
            KijiHFileOutputFormat() - +Constructor for class org.kiji.mapreduce.output.framework.KijiHFileOutputFormat +
              +
            KijiJobHistory - Class in org.kiji.mapreduce.tools
            A tool that installs a job history table and lets you query individual jobs from it.
            KijiJobHistory() - +Constructor for class org.kiji.mapreduce.tools.KijiJobHistory +
              +
            KijiJobTool<B extends KijiTableInputJobBuilder> - Class in org.kiji.mapreduce.tools.framework
            Base class for tools that run MapReduce jobs over kiji tables.
            KijiJobTool() - +Constructor for class org.kiji.mapreduce.tools.framework.KijiJobTool +
            Creates a new KijiTool instance. +
            KijiLaunchMapReduce - Class in org.kiji.mapreduce.tools
            Launch an arbitrary KijiMapReduceJob.
            KijiLaunchMapReduce() - +Constructor for class org.kiji.mapreduce.tools.KijiLaunchMapReduce +
              +
            KijiMapper<INKEY,INVALUE,OUTKEY,OUTVALUE> - Class in org.kiji.mapreduce
            Base class for Kiji mappers.
            KijiMapper() - +Constructor for class org.kiji.mapreduce.KijiMapper +
              +
            KijiMapReduceJob - Class in org.kiji.mapreduce.framework
            An implementation of a runnable MapReduce job that interacts with Kiji tables.
            KijiMapReduceJobBuilder - Class in org.kiji.mapreduce
            Builds general MapReduce jobs around Kiji mappers and reducers.
            KijiMultithreadedMapper<K,V> - Class in org.apache.hadoop.mapreduce.lib.map
            Multithreaded implementation for @link org.apache.hadoop.mapreduce.Mapper.
            KijiMultithreadedMapper() - +Constructor for class org.apache.hadoop.mapreduce.lib.map.KijiMultithreadedMapper +
              +
            KijiProduce - Class in org.kiji.mapreduce.tools
            Program for running a Kiji producer in a MapReduce job.
            KijiProduce() - +Constructor for class org.kiji.mapreduce.tools.KijiProduce +
              +
            KijiProduceJobBuilder - Class in org.kiji.mapreduce.produce
            Builds jobs that run a producer over a Kiji table.
            KijiProducer - Class in org.kiji.mapreduce.produce
            + Base class for all Kiji Producers used to generate per-row derived + entity data.
            KijiProducer() - +Constructor for class org.kiji.mapreduce.produce.KijiProducer +
            Your subclass of KijiProducer must have a default constructor if it is to be used in a + KijiProduceJob. +
            KijiProducerOutputException - Exception in org.kiji.mapreduce.produce
            Thrown when a KijiProducer fails to produce output.
            KijiProducerOutputException(String) - +Constructor for exception org.kiji.mapreduce.produce.KijiProducerOutputException +
            Creates a new KijiProducerOutputException instance. +
            KijiProducers - Class in org.kiji.mapreduce.produce.impl
            Utility methods for working with KijiProducers.
            KijiReducer<INKEY,INVALUE,OUTKEY,OUTVALUE> - Class in org.kiji.mapreduce
            Base class for Kiji reducer.
            KijiReducer() - +Constructor for class org.kiji.mapreduce.KijiReducer +
              +
            KijiTableContext - Interface in org.kiji.mapreduce
            Context for Kiji bulk-importers or reducers to output to a Kiji table.
            KijiTableContextFactory - Class in org.kiji.mapreduce.impl
            Instantiates a KijiTableContext according to a configuration.
            KijiTableInputFormat - Class in org.kiji.mapreduce.framework
            InputFormat for Hadoop MapReduce jobs reading from a Kiji table.
            KijiTableInputFormat() - +Constructor for class org.kiji.mapreduce.framework.KijiTableInputFormat +
              +
            KijiTableInputFormat.KijiTableRecordReader - Class in org.kiji.mapreduce.framework
            Hadoop record reader for Kiji table rows.
            KijiTableInputFormat.KijiTableRecordReader(Configuration) - +Constructor for class org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader +
            Creates a new RecordReader for this input format. +
            KijiTableInputJobBuilder<T extends KijiTableInputJobBuilder<T>> - Class in org.kiji.mapreduce.framework
            Base class for MapReduce jobs that use a Kiji table as input.
            KijiTableInputJobBuilder() - +Constructor for class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
            Constructs a builder for jobs that use a Kiji table as input. +
            KijiTableKeyValueStore<V> - Class in org.kiji.mapreduce.kvstore.lib
            KeyValueStore lookup implementation based on a Kiji table.
            KijiTableKeyValueStore() - +Constructor for class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore +
            Reflection-only constructor. +
            KijiTableKeyValueStore.Builder - Class in org.kiji.mapreduce.kvstore.lib
            A Builder-pattern class that configures and creates new KijiTableKeyValueStore + instances.
            KijiTableMapper<K,V> - Class in org.kiji.mapreduce.impl
            Base class for mappers reading from a Kiji table.
            KijiTableMapper() - +Constructor for class org.kiji.mapreduce.impl.KijiTableMapper +
            Constructs a new mapper that reads from a Kiji table. +
            KijiTableMapReduceJobInput - Class in org.kiji.mapreduce.input
            The class KijiTableMapReduceJobInput is used to indicate the usage of a KijiTable + as input to a MapReduce job.
            KijiTableMapReduceJobInput() - +Constructor for class org.kiji.mapreduce.input.KijiTableMapReduceJobInput +
            Default constructor. +
            KijiTableMapReduceJobInput(KijiURI, KijiDataRequest, KijiTableMapReduceJobInput.RowOptions) - +Constructor for class org.kiji.mapreduce.input.KijiTableMapReduceJobInput +
            Constructs job input from column data in a Kiji table over a row range. +
            KijiTableMapReduceJobInput.RowOptions - Class in org.kiji.mapreduce.input
            Options that specify which rows from the input table should be included.
            KijiTableMapReduceJobInput.RowOptions() - +Constructor for class org.kiji.mapreduce.input.KijiTableMapReduceJobInput.RowOptions +
            Constructs options with default settings to include all the rows of the table. +
            KijiTableMapReduceJobInput.RowOptions(EntityId, EntityId, KijiRowFilter) - +Constructor for class org.kiji.mapreduce.input.KijiTableMapReduceJobInput.RowOptions +
            Creates a new RowOptions instance. +
            KijiTableMapReduceJobOutput - Class in org.kiji.mapreduce.output.impl
            MapReduce job output configuration that outputs to a Kiji table.
            KijiTableMapReduceJobOutput() - +Constructor for class org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput +
            Default constructor. +
            KijiTableMapReduceJobOutput(KijiURI, int) - +Constructor for class org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput +
            Creates a new KijiTableMapReduceJobOutput instance. +
            KijiTableReducer<K,V> - Class in org.kiji.mapreduce
            Base class for reducers that emit to a Kiji table.
            KijiTableReducer() - +Constructor for class org.kiji.mapreduce.KijiTableReducer +
              +
            KijiTableSplit - Class in org.kiji.mapreduce.impl
            An KijiTableSplit stores exactly the same data as TableSplit, but + does a better job handling default split sizes.
            KijiTableSplit() - +Constructor for class org.kiji.mapreduce.impl.KijiTableSplit +
            The default constructor. +
            KijiTableSplit(TableSplit, byte[]) - +Constructor for class org.kiji.mapreduce.impl.KijiTableSplit +
            Create a new KijiTableSplit instance from an HBase TableSplit. +
            KVOutputJob - Interface in org.kiji.mapreduce
            Base interface for tasks that emit (key, value) pairs.
            +
            +

            +L

            +
            +
            Lists - Class in org.kiji.mapreduce.util
            A library of static List manipulation functions.
            Lists.Aggregator<X,Y> - Class in org.kiji.mapreduce.util
            Aggregation function to apply over a list of elements of type X with foldLeft() + or foldRight().
            Lists.Aggregator() - +Constructor for class org.kiji.mapreduce.util.Lists.Aggregator +
              +
            Lists.Func<X,Y> - Class in org.kiji.mapreduce.util
            Generic function to apply to elements of a list.
            Lists.Func() - +Constructor for class org.kiji.mapreduce.util.Lists.Func +
              +
            Lists.IsNullFn<X> - Class in org.kiji.mapreduce.util
            Evaluation function that returns True if it encounters a null input item.
            Lists.IsNullFn() - +Constructor for class org.kiji.mapreduce.util.Lists.IsNullFn +
              +
            Lists.ToStringFn<X> - Class in org.kiji.mapreduce.util
            Evaluation function that returns the String representation of each input item.
            Lists.ToStringFn() - +Constructor for class org.kiji.mapreduce.util.Lists.ToStringFn +
              +
            load(Path, KijiTable) - +Method in class org.kiji.mapreduce.HFileLoader +
            Loads HFiles directly into the regions of a Kiji table. +
            loadStoresFromXml(InputStream) - +Method in class org.kiji.mapreduce.kvstore.impl.XmlKeyValueStoreParser +
            Given an InputStream pointing to an opened resource that specifies a set of KeyValueStores + via XML, return the map of names to configured KeyValueStore instances. +
            LruCache<K,V> - Class in org.kiji.mapreduce.util
            LRU cache based on LinkedHashMap.
            +
            +

            +M

            +
            +
            main(String[]) - +Static method in class org.kiji.mapreduce.tools.KijiBulkImport +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.mapreduce.tools.KijiBulkLoad +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.mapreduce.tools.KijiGather +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.mapreduce.tools.KijiJobHistory +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.mapreduce.tools.KijiLaunchMapReduce +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.mapreduce.tools.KijiProduce +
            Program entry point. +
            map(K, V, Mapper<K, V, HFileKeyValue, NullWritable>.Context) - +Method in class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
              +
            map(KijiRowData, Mapper<EntityId, KijiRowData, K, V>.Context) - +Method in class org.kiji.mapreduce.gather.impl.GatherMapper +
            Kiji mapper function that processes an input row. +
            map(KijiRowData, Mapper<EntityId, KijiRowData, K, V>.Context) - +Method in class org.kiji.mapreduce.impl.KijiTableMapper +
            Kiji mapper function that processes an input row. +
            map(EntityId, KijiRowData, Mapper<EntityId, KijiRowData, K, V>.Context) - +Method in class org.kiji.mapreduce.impl.KijiTableMapper +
            +
            map(KijiRowData, Mapper<EntityId, KijiRowData, HFileKeyValue, NullWritable>.Context) - +Method in class org.kiji.mapreduce.produce.impl.ProduceMapper +
            Kiji mapper function that processes an input row. +
            map(List<X>, Lists.Func<? super X, ? extends Y>) - +Static method in class org.kiji.mapreduce.util.Lists +
            Applies the mapper function element-by-element, creating an output list of the same + length as the input list, with the transformation function applied to each. +
            MapFileMapReduceJobOutput - Class in org.kiji.mapreduce.output
            The class MapFileMapReduceJobOutput is used to indicate the usage of Hadoop map files as + output for a MapReduce job.
            MapFileMapReduceJobOutput() - +Constructor for class org.kiji.mapreduce.output.MapFileMapReduceJobOutput +
            Default constructor. +
            MapFileMapReduceJobOutput(Path, int) - +Constructor for class org.kiji.mapreduce.output.MapFileMapReduceJobOutput +
            Creates a new MapFileMapReduceJobOutput instance. +
            MapFileOutputFormat - Class in org.apache.hadoop.mapreduce.lib.output
            An OutputFormat that writes + MapFiles.
            MapFileOutputFormat() - +Constructor for class org.apache.hadoop.mapreduce.lib.output.MapFileOutputFormat +
              +
            MapReduceJob - Class in org.kiji.mapreduce
            A Hadoop MapReduce job that runs Kiji mappers and reducers.
            MapReduceJob(Job) - +Constructor for class org.kiji.mapreduce.MapReduceJob +
            Wraps a Hadoop job to be run. +
            MapReduceJob.Status - Class in org.kiji.mapreduce
            The status of a job that was started asynchronously using MapReduceJob.submit().
            MapReduceJob.Status(Job) - +Constructor for class org.kiji.mapreduce.MapReduceJob.Status +
            Constructs a Status around a Hadoop job. +
            MapReduceJobBuilder<T extends MapReduceJobBuilder<T>> - Class in org.kiji.mapreduce.framework
            Base class for builders that configure MapReduceJobs.
            MapReduceJobBuilder() - +Constructor for class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Creates a new MapReduceJobBuilder instance. +
            MapReduceJobInput - Class in org.kiji.mapreduce
            Base class for types of input to a MapReduce job.
            MapReduceJobInput() - +Constructor for class org.kiji.mapreduce.MapReduceJobInput +
              +
            MapReduceJobInputFactory - Class in org.kiji.mapreduce.tools.framework
            Constructs instances of MapReduceJobInput from a string specification.
            MapReduceJobOutput - Class in org.kiji.mapreduce
            Describe class MapReduceJobOutput here.
            MapReduceJobOutput() - +Constructor for class org.kiji.mapreduce.MapReduceJobOutput +
              +
            MapReduceJobOutputFactory - Class in org.kiji.mapreduce.tools.framework
            A factory for creating MapReduceJobOutput objects from outputspecs.
            mDataRequest - +Variable in class org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader +
            Data request. +
            mergeStores(Map<String, KeyValueStore<?, ?>>, Map<String, KeyValueStore<?, ?>>) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Adds all KeyValueStore mappings from src to the 'dest' map. +
            mInputFlag - +Variable in class org.kiji.mapreduce.tools.framework.JobTool +
              +
            mKvStoreFile - +Variable in class org.kiji.mapreduce.tools.framework.JobTool +
              +
            mLibDir - +Variable in class org.kiji.mapreduce.tools.framework.JobTool +
              +
            mLimitRowFlag - +Variable in class org.kiji.mapreduce.tools.framework.KijiJobTool +
              +
            mOutputFlag - +Variable in class org.kiji.mapreduce.tools.framework.JobTool +
              +
            mStartRowFlag - +Variable in class org.kiji.mapreduce.tools.framework.KijiJobTool +
              +
            +
            +

            +N

            +
            +
            nextKeyValue() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            nextKeyValue() - +Method in class org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader +
            +
            nextKeyValue() - +Method in class org.kiji.mapreduce.input.impl.WholeFileRecordReader +
            If the file has not already been read, this reads it into memory, so that a call + to getCurrentValue() will return the entire contents of this file as Text, + and getCurrentKey() will return the qualified path to this file as Text. +
            none() - +Static method in class org.kiji.mapreduce.kvstore.RequiredStores +
            Returns an immutable, empty mapping from names to store implementations. +
            NSPLITS_KEY - +Static variable in class org.kiji.mapreduce.tools.framework.JobIOConfKeys +
            Number of splits for the output files. +
            +
            +

            +O

            +
            +
            open(Kiji) - +Static method in class org.kiji.mapreduce.framework.JobHistoryKijiTable +
            Opens a JobHistoryKijiTable for a given kiji. +
            open() - +Method in interface org.kiji.mapreduce.kvstore.KeyValueStore +
            Opens a KeyValueStoreReader instance for access by clients to this store. +
            open() - +Method in class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore +
            Opens a KeyValueStoreReader instance for access by clients to this store. +
            open() - +Method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore +
            Opens a KeyValueStoreReader instance for access by clients to this store. +
            open() - +Method in class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore +
            Opens a KeyValueStoreReader instance for access by clients to this store. +
            open() - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore +
            Opens a KeyValueStoreReader instance for access by clients to this store. +
            open() - +Method in class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore +
            Opens a KeyValueStoreReader instance for access by clients to this store. +
            open() - +Method in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore +
            Opens a KeyValueStoreReader instance for access by clients to this store. +
            open() - +Method in class org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore +
            Throws IllegalStateException; you cannot open an unconfigured store. +
            openStore(String) - +Method in class org.kiji.mapreduce.kvstore.KeyValueStoreReaderFactory +
            Opens a KeyValueStore associated with storeName for read-access. +
            org.apache.hadoop.mapreduce.lib.input - package org.apache.hadoop.mapreduce.lib.input
             
            org.apache.hadoop.mapreduce.lib.map - package org.apache.hadoop.mapreduce.lib.map
             
            org.apache.hadoop.mapreduce.lib.output - package org.apache.hadoop.mapreduce.lib.output
             
            org.kiji.mapreduce - package org.kiji.mapreduce
            KijiMR utilities.
            org.kiji.mapreduce.avro - package org.kiji.mapreduce.avro
            Avro interfaces for KijiMR.
            org.kiji.mapreduce.bulkimport - package org.kiji.mapreduce.bulkimport
            Bulk importer classes for KijiMR clients.
            org.kiji.mapreduce.bulkimport.impl - package org.kiji.mapreduce.bulkimport.impl
            Internal classes for KijiMR bulk importers.
            org.kiji.mapreduce.framework - package org.kiji.mapreduce.framework
            Framework-level classes supporting basic KijiMR classes.
            org.kiji.mapreduce.gather - package org.kiji.mapreduce.gather
            Gatherer classes for KijiMR clients.
            org.kiji.mapreduce.gather.impl - package org.kiji.mapreduce.gather.impl
            Kiji gatherer implementation details.
            org.kiji.mapreduce.impl - package org.kiji.mapreduce.impl
            Internal implementation details for KijiMR's top level classes.
            org.kiji.mapreduce.input - package org.kiji.mapreduce.input
            MapReduce job input types.
            org.kiji.mapreduce.input.impl - package org.kiji.mapreduce.input.impl
            Internal implementation details for KijiMR's job input classes.
            org.kiji.mapreduce.kvstore - package org.kiji.mapreduce.kvstore
            Key-value store APIs.
            org.kiji.mapreduce.kvstore.framework - package org.kiji.mapreduce.kvstore.framework
            Framework-level classes supporting KijiMR key value stores.
            org.kiji.mapreduce.kvstore.impl - package org.kiji.mapreduce.kvstore.impl
            Key value store implementation details.
            org.kiji.mapreduce.kvstore.lib - package org.kiji.mapreduce.kvstore.lib
            Key-value store implementations.
            org.kiji.mapreduce.output - package org.kiji.mapreduce.output
            MapReduce job output types.
            org.kiji.mapreduce.output.framework - package org.kiji.mapreduce.output.framework
            Framework-level classes supporting KijiMR job output classes.
            org.kiji.mapreduce.output.impl - package org.kiji.mapreduce.output.impl
            Implementation details for KijiMR's Hadoop output classes.
            org.kiji.mapreduce.produce - package org.kiji.mapreduce.produce
            Producer classes for KijiMR clients.
            org.kiji.mapreduce.produce.impl - package org.kiji.mapreduce.produce.impl
            Kiji producer implementation details.
            org.kiji.mapreduce.reducer - package org.kiji.mapreduce.reducer
            Basic identity reducer which is required for KijiMR jobs.
            org.kiji.mapreduce.tools - package org.kiji.mapreduce.tools
            KijiMR commandline tools.
            org.kiji.mapreduce.tools.framework - package org.kiji.mapreduce.tools.framework
            Framework-level classes supporting KijiMR command line tools.
            org.kiji.mapreduce.util - package org.kiji.mapreduce.util
            KijiMR utilities.
            OUTPUT_EXTENSION - +Static variable in class org.kiji.mapreduce.output.framework.KijiHFileOutputFormat +
              +
            +
            +

            +P

            +
            +
            parse(String) - +Static method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter.ColumnDescriptor +
            Parses an input string into a ColumnDescriptor. +
            parse(String) - +Static method in enum org.kiji.mapreduce.tools.framework.JobInputSpec.Format +
            Return the format referred to by the name. +
            parse(String) - +Static method in class org.kiji.mapreduce.tools.framework.JobInputSpec +
            Parses the string representation of a JobInputSpec. +
            parse(String) - +Static method in enum org.kiji.mapreduce.tools.framework.JobOutputSpec.Format +
            Gets a Format object from its name. +
            parse(String) - +Static method in class org.kiji.mapreduce.tools.framework.JobOutputSpec +
            Parses the string representation of a JobOutputSpec. +
            produce(AvroKey<T>, NullWritable, KijiTableContext) - +Method in class org.kiji.mapreduce.bulkimport.AvroBulkImporter +
              +
            produce(T, KijiTableContext) - +Method in class org.kiji.mapreduce.bulkimport.AvroBulkImporter +
            Process an Avro datum from the input container file to produce + Kiji output. +
            produce(ImmutableBytesWritable, Result, KijiTableContext) - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter +
            Produces data to be imported into Kiji. +
            produce(K, V, KijiTableContext) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImporter +
            Produces data to be imported into Kiji. +
            produce(KijiRowData, ProducerContext) - +Method in class org.kiji.mapreduce.produce.KijiProducer +
            Called to compute derived data for a single entity. +
            ProduceMapper - Class in org.kiji.mapreduce.produce.impl
            Hadoop mapper that runs a Kiji producer.
            ProduceMapper() - +Constructor for class org.kiji.mapreduce.produce.impl.ProduceMapper +
              +
            ProducerContext - Interface in org.kiji.mapreduce.produce
            Context for producers to output new cells in the currently processed row.
            progress - +Variable in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            progress() - +Method in class org.kiji.mapreduce.impl.InternalKijiContext +
            Report progress to the kiji framework. +
            progress() - +Method in interface org.kiji.mapreduce.KijiContext +
            Report progress to the kiji framework. +
            put(CharSequence, V) - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            put(EntityId, String, String, T) - +Method in class org.kiji.mapreduce.impl.DirectKijiTableWriterContext +
            +
            put(EntityId, String, String, long, T) - +Method in class org.kiji.mapreduce.impl.DirectKijiTableWriterContext +
            +
            put(EntityId, String, String, T) - +Method in class org.kiji.mapreduce.impl.HFileWriterContext +
            +
            put(EntityId, String, String, long, T) - +Method in class org.kiji.mapreduce.impl.HFileWriterContext +
            +
            put(T) - +Method in class org.kiji.mapreduce.produce.impl.InternalProducerContext +
            Outputs a new cell to the configured output column with the current timestamp. +
            put(String, T) - +Method in class org.kiji.mapreduce.produce.impl.InternalProducerContext +
            Outputs a new cell to the configured output column with the current timestamp. +
            put(long, T) - +Method in class org.kiji.mapreduce.produce.impl.InternalProducerContext +
            Outputs a new cell to the configured output column. +
            put(String, long, T) - +Method in class org.kiji.mapreduce.produce.impl.InternalProducerContext +
            Outputs a new cell to the configured output column. +
            put(T) - +Method in interface org.kiji.mapreduce.produce.ProducerContext +
            Outputs a new cell to the configured output column with the current timestamp. +
            put(long, T) - +Method in interface org.kiji.mapreduce.produce.ProducerContext +
            Outputs a new cell to the configured output column. +
            put(String, T) - +Method in interface org.kiji.mapreduce.produce.ProducerContext +
            Outputs a new cell to the configured output column with the current timestamp. +
            put(String, long, T) - +Method in interface org.kiji.mapreduce.produce.ProducerContext +
            Outputs a new cell to the configured output column. +
            putAll(Map<? extends CharSequence, ? extends V>) - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            +
            +

            +R

            +
            +
            read() - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            Reads the wrapped Avro map into a Map with a comparator for CharSequences. +
            readFields(DataInput) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
              +
            readFields(DataInput) - +Method in class org.kiji.mapreduce.framework.HFileKeyValue +
            +
            readFields(DataInput) - +Method in class org.kiji.mapreduce.impl.KijiTableSplit +
            +
            recordJob(Job, long, long) - +Method in class org.kiji.mapreduce.framework.JobHistoryKijiTable +
            Writes a job into the JobHistoryKijiTable. +
            reduce(K, Iterable<V>, Reducer<K, V, HFileKeyValue, NullWritable>.Context) - +Method in class org.kiji.mapreduce.KijiTableReducer +
            +
            reduce(K, Iterable<V>, KijiTableContext) - +Method in class org.kiji.mapreduce.KijiTableReducer +
            Kiji reducer function that processes the values for a key and emits to the output table. +
            reduce(K, Iterable<V>, Reducer<K, V, K, V>.Context) - +Method in class org.kiji.mapreduce.reducer.IdentityReducer +
            +
            remove(Object) - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            removeEldestEntry(Map.Entry<K, V>) - +Method in class org.kiji.mapreduce.util.LruCache +
            +
            RequiredStores - Class in org.kiji.mapreduce.kvstore
            Convenient methods for assembling maps from names to KeyValueStore + implementations in getRequiredStores() calls.
            RequiredStores.StoreMap - Class in org.kiji.mapreduce.kvstore
            A Map from names to KeyValueStore entries, created by RequiredStores.with().
            rrClass - +Variable in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            rrConstructor - +Variable in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            run(Mapper<EntityId, KijiRowData, K, V>.Context) - +Method in class org.apache.hadoop.mapreduce.lib.map.KijiMultithreadedMapper +
            Run the application's maps using a thread pool. +
            run() - +Method in class org.kiji.mapreduce.framework.KijiMapReduceJob +
              +
            run() - +Method in class org.kiji.mapreduce.MapReduceJob +
            Runs the job (blocks until it is complete). +
            run(List<String>) - +Method in class org.kiji.mapreduce.tools.framework.JobTool +
            +
            run(List<String>) - +Method in class org.kiji.mapreduce.tools.KijiBulkImport +
            +
            run(List<String>) - +Method in class org.kiji.mapreduce.tools.KijiBulkLoad +
            +
            run(List<String>) - +Method in class org.kiji.mapreduce.tools.KijiJobHistory +
            +
            run(List<String>) - +Method in class org.kiji.mapreduce.tools.KijiProduce +
            +
            +
            +

            +S

            +
            +
            SeqFileKeyValueStore<K,V> - Class in org.kiji.mapreduce.kvstore.lib
            KeyValueStore implementation that reads records from SequenceFiles.
            SeqFileKeyValueStore() - +Constructor for class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore +
            Reflection-only constructor. +
            SeqFileKeyValueStore.Builder - Class in org.kiji.mapreduce.kvstore.lib
            A Builder-pattern class that configures and creates new SeqFileKeyValueStore + instances.
            SequenceFileMapReduceJobInput - Class in org.kiji.mapreduce.input
            The class SequenceFileMapReduceJobInput is used to indicate the usage of a Hadoop + sequence file as input to a MapReduce job.
            SequenceFileMapReduceJobInput(Path...) - +Constructor for class org.kiji.mapreduce.input.SequenceFileMapReduceJobInput +
            Constructs job input from a varargs of paths to sequence files. +
            SequenceFileMapReduceJobOutput - Class in org.kiji.mapreduce.output
            The class SequenceFileMapReduceJobOutput is used to indicate the usage of Hadoop + sequence files as output for a MapReduce job.
            SequenceFileMapReduceJobOutput() - +Constructor for class org.kiji.mapreduce.output.SequenceFileMapReduceJobOutput +
            Default constructor. +
            SequenceFileMapReduceJobOutput(Path, int) - +Constructor for class org.kiji.mapreduce.output.SequenceFileMapReduceJobOutput +
            Creates a new SequenceFileMapReduceJobOutput instance. +
            set(String, String) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Sets the value of the name property. +
            setBoolean(String, boolean) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Sets the value of the name property to a boolean. +
            setClass(String, Class<?>, Class<?>) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Sets the value of the name property to be a Class. +
            setColumnDescriptors(String[]) - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter +
            Sets the column descriptors. +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter +
            Initializes this object's state using the settings from the configuration. +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
            +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImporter +
            +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.framework.KijiTableInputFormat +
            +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.gather.impl.GatherMapper +
              +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.gather.KijiGatherer +
            Sets the Configuration for this instance. +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.impl.KijiTableMapper +
            +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
            +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore +
            Set the configuration object to refer to. +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.produce.KijiProducer +
            Sets the Configuration for this KijiProducer to use. +
            setConf(Configuration) - +Method in class org.kiji.mapreduce.reducer.IdentityReducer +
            +
            setEntityId(EntityId) - +Method in class org.kiji.mapreduce.produce.impl.InternalProducerContext +
            Sets the entity ID of the current row being processed and written to. +
            setEntityId(EntityId) - +Method in interface org.kiji.mapreduce.produce.impl.InternalProducerContextInterface +
            Sets the entity ID of the current row being processed and written to. +
            setFloat(String, float) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Sets the value of the name property to be a float. +
            setInt(String, int) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Sets the value of the name property to be an int. +
            setLong(String, long) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Sets the value of the name property to be a long. +
            setMapperClass(Job, Class<? extends Mapper<EntityId, KijiRowData, K, V>>) - +Static method in class org.apache.hadoop.mapreduce.lib.map.KijiMultithreadedMapper +
            Set the application's mapper class. +
            setMaxSplitSize(long) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat +
            Specify the maximum size (in bytes) of each split. +
            setMinSplitSizeNode(long) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat +
            Specify the minimum size (in bytes) of each split per node. +
            setMinSplitSizeRack(long) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat +
            Specify the minimum size (in bytes) of each split per rack. +
            setNumberOfThreads(Job, int) - +Static method in class org.apache.hadoop.mapreduce.lib.map.KijiMultithreadedMapper +
            Set the number of threads in the pool for running maps. +
            setStatus(String) - +Method in class org.kiji.mapreduce.impl.InternalKijiContext +
            Sets a status string for the kiji task. +
            setStatus(String) - +Method in interface org.kiji.mapreduce.KijiContext +
            Sets a status string for the kiji task. +
            setStrings(String, String...) - +Method in class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration +
            Set the array of string values for the name property as comma + delimited values. +
            setup(KijiTableContext) - +Method in class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter +
            Called once to initialize this producer before any calls to + KijiBulkImporter.produce(Object, Object, org.kiji.mapreduce.KijiTableContext). +
            setup(Mapper<K, V, HFileKeyValue, NullWritable>.Context) - +Method in class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +
            +
            setup(KijiTableContext) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImporter +
            Called once to initialize this producer before any calls to + KijiBulkImporter.produce(Object, Object, org.kiji.mapreduce.KijiTableContext). +
            setup(Mapper<EntityId, KijiRowData, K, V>.Context) - +Method in class org.kiji.mapreduce.gather.impl.GatherMapper +
            +
            setup(GathererContext<K, V>) - +Method in class org.kiji.mapreduce.gather.KijiGatherer +
            Called once to initialize the gatherer before any calls to gather(). +
            setup(Mapper<EntityId, KijiRowData, K, V>.Context) - +Method in class org.kiji.mapreduce.impl.KijiTableMapper +
            +
            setup(Reducer<K, V, HFileKeyValue, NullWritable>.Context) - +Method in class org.kiji.mapreduce.KijiTableReducer +
            +
            setup(Mapper<EntityId, KijiRowData, HFileKeyValue, NullWritable>.Context) - +Method in class org.kiji.mapreduce.produce.impl.ProduceMapper +
            +
            setup(KijiContext) - +Method in class org.kiji.mapreduce.produce.KijiProducer +
            Called once to initialize this producer before any calls to + KijiProducer.produce(KijiRowData, ProducerContext). +
            setup() - +Method in class org.kiji.mapreduce.tools.KijiBulkImport +
            +
            size() - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            split - +Variable in class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +
              +
            SPLIT_MINSIZE_PERNODE - +Static variable in class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat +
              +
            SPLIT_MINSIZE_PERRACK - +Static variable in class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat +
              +
            storeToConf(KeyValueStoreConfiguration) - +Method in interface org.kiji.mapreduce.kvstore.KeyValueStore +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +
            storeToConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +
            storeToConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +
            storeToConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +
            storeToConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
            Serializes file- and DistributedCache-specific properties associated + with the KeyValueStore that owns this FileStoreHelper to the specified configuration. +
            storeToConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +
            storeToConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +
            storeToConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +
            storeToConf(KeyValueStoreConfiguration) - +Method in class org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +
            submit() - +Method in class org.kiji.mapreduce.framework.KijiMapReduceJob +
              +
            submit() - +Method in class org.kiji.mapreduce.MapReduceJob +
            Starts the job and return immediately. +
            +
            +

            +T

            +
            +
            TABLE_KEY - +Static variable in class org.kiji.mapreduce.tools.framework.JobIOConfKeys +
            Input or output Kiji table, as a kiji:// URI. +
            TextFileKeyValueStore - Class in org.kiji.mapreduce.kvstore.lib
            KeyValueStore implementation that reads delimited records from text files.
            TextFileKeyValueStore() - +Constructor for class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore +
            Reflection-only constructor. +
            TextFileKeyValueStore.Builder - Class in org.kiji.mapreduce.kvstore.lib
            A Builder-pattern class that configures and creates new TextFileKeyValueStore + instances.
            TextMapReduceJobInput - Class in org.kiji.mapreduce.input
            The class TextMapReduceJobInput is used to indicate the usage of lines in text files + in HDFS as input to a MapReduce job.
            TextMapReduceJobInput(Path...) - +Constructor for class org.kiji.mapreduce.input.TextMapReduceJobInput +
            Constructs job input from a varargs of paths to text files. +
            TextMapReduceJobOutput - Class in org.kiji.mapreduce.output
            The class TextMapReduceJobOutput is used to indicate the usage of text files as output + for a MapReduce job.
            TextMapReduceJobOutput() - +Constructor for class org.kiji.mapreduce.output.TextMapReduceJobOutput +
            Default constructor. +
            TextMapReduceJobOutput(Path, int) - +Constructor for class org.kiji.mapreduce.output.TextMapReduceJobOutput +
            Creates a new TextMapReduceJobOutput instance. +
            toArray(List<X>, Class<X>) - +Static method in class org.kiji.mapreduce.util.Lists +
            Returns an array of the same length as the input list. +
            toString() - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
              +
            toString() - +Method in class org.kiji.mapreduce.framework.HFileKeyValue +
            +
            toString() - +Method in class org.kiji.mapreduce.tools.framework.JobInputSpec +
            +
            toString() - +Method in class org.kiji.mapreduce.tools.framework.JobOutputSpec +
            +
            +
            +

            +U

            +
            +
            UnconfiguredKeyValueStore<K,V> - Class in org.kiji.mapreduce.kvstore.lib
            A KeyValueStore that is not configured.
            UnconfiguredKeyValueStore.Builder<K,V> - Class in org.kiji.mapreduce.kvstore.lib
            A Builder-pattern class that creates new UnconfiguredKeyValueStore + instances.
            updateLatestStamp(byte[]) - +Method in class org.kiji.mapreduce.framework.HFileKeyValue +
            Sets the timestamp that should be used if the KeyValue is using + HConstants.LATEST_TIMESTAMP. +
            USE_DCACHE_DEFAULT - +Static variable in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper +
            By default, it is assumed that the user wants to load this KeyValueStore + through the DistributedCache. +
            +
            +

            +V

            +
            +
            validateFlags() - +Method in class org.kiji.mapreduce.tools.framework.JobTool +
            +
            validateFlags() - +Method in class org.kiji.mapreduce.tools.framework.KijiJobTool +
            +
            validateFlags() - +Method in class org.kiji.mapreduce.tools.KijiBulkImport +
            +
            validateFlags() - +Method in class org.kiji.mapreduce.tools.KijiBulkLoad +
            +
            validateFlags() - +Method in class org.kiji.mapreduce.tools.KijiGather +
              +
            validateFlags() - +Method in class org.kiji.mapreduce.tools.KijiJobHistory +
            +
            validateFlags() - +Method in class org.kiji.mapreduce.tools.KijiLaunchMapReduce +
              +
            validateFlags() - +Method in class org.kiji.mapreduce.tools.KijiProduce +
              +
            validateInputTable(KijiTable) - +Method in class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
            Validates the input table. +
            validateInputTable(KijiTable) - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Validates the input table. +
            validateOutputColumn(KijiProducer, KijiTableLayout) - +Static method in class org.kiji.mapreduce.produce.impl.KijiProducers +
            Makes sure the producer's requested output column exists in the + kiji table layout. +
            valueOf(String) - +Static method in enum org.kiji.mapreduce.framework.JobHistoryCounters +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.mapreduce.tools.framework.JobInputSpec.Format +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.mapreduce.tools.framework.JobOutputSpec.Format +
            Returns the enum constant of this type with the specified name. +
            values() - +Method in class org.kiji.mapreduce.avro.AvroMapReader +
            +
            values() - +Static method in enum org.kiji.mapreduce.framework.JobHistoryCounters +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.mapreduce.tools.framework.JobInputSpec.Format +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.mapreduce.tools.framework.JobOutputSpec.Format +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            +
            +

            +W

            +
            +
            WholeFileInputFormat - Class in org.kiji.mapreduce.input.impl
            An input format for reading multiple files in a single map task.
            WholeFileInputFormat() - +Constructor for class org.kiji.mapreduce.input.impl.WholeFileInputFormat +
              +
            WholeFileRecordReader - Class in org.kiji.mapreduce.input.impl
            A RecordReader that reads an entire file as a single key-value.
            WholeFileRecordReader(CombineFileSplit, TaskAttemptContext, Integer) - +Constructor for class org.kiji.mapreduce.input.impl.WholeFileRecordReader +
            Implementation detail: This constructor is built to be called via + reflection from within CombineFileRecordReader. +
            WholeTextFileMapReduceJobInput - Class in org.kiji.mapreduce.input
            The class WholeTextFileMapReduceJobInput is used to indicate the usage of entire text + files as rows for input to a MapReduce job.
            WholeTextFileMapReduceJobInput(Path...) - +Constructor for class org.kiji.mapreduce.input.WholeTextFileMapReduceJobInput +
            Constructs job input from a varargs of paths to text files. +
            with(String, KeyValueStore<?, ?>) - +Method in class org.kiji.mapreduce.kvstore.RequiredStores.StoreMap +
            Add the associated name-to-store mapping. +
            with(String, KeyValueStore<?, ?>) - +Static method in class org.kiji.mapreduce.kvstore.RequiredStores +
            Creates a map from names to stores with an initial entry. +
            withBulkImporter(Class<? extends KijiBulkImporter>) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Configures the job with a bulk importer to run in the map phase. +
            withCacheLimit(int) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder +
            Sets the maximum number of lookups to cache in memory. +
            withColumn(KijiColumnName) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder +
            Sets the column to retrieve values from. +
            withColumn(String, String) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder +
            Sets the column to retrieve values from. +
            withCombiner(Class<? extends KijiReducer>) - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Configures the job with a combiner to run (optional). +
            withCombiner(Class<? extends KijiReducer>) - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Configures the job with a combiner to run (optional). +
            withConf(Configuration) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Sets the base Hadoop configuration used to build the MapReduce job. +
            withConfiguration(Configuration) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore.Builder +
            Sets the Hadoop configuration instance to use. +
            withConfiguration(Configuration) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore.Builder +
            Sets the Hadoop configuration instance to use. +
            withConfiguration(Configuration) - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper.Builder +
            Sets the Hadoop configuration instance to use. +
            withConfiguration(Configuration) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder +
            Sets the Configuration to use to connect to Kiji. +
            withConfiguration(Configuration) - +Method in class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore.Builder +
            Sets the Hadoop configuration instance to use. +
            withConfiguration(Configuration) - +Method in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore.Builder +
            Sets the Hadoop configuration instance to use. +
            withDelimiter(String) - +Method in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore.Builder +
            Specifies the delimiter between the key and the value on a line in the file. +
            withDistributedCache(boolean) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore.Builder +
            Sets a flag indicating the use of the DistributedCache to distribute + input files. +
            withDistributedCache(boolean) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore.Builder +
            Sets a flag indicating the use of the DistributedCache to distribute + input files. +
            withDistributedCache(boolean) - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper.Builder +
            Sets a flag indicating the use of the DistributedCache to distribute + input files. +
            withDistributedCache(boolean) - +Method in class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore.Builder +
            Sets a flag indicating the use of the DistributedCache to distribute + input files. +
            withDistributedCache(boolean) - +Method in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore.Builder +
            Sets a flag indicating the use of the DistributedCache to distribute + input files. +
            withFilter(KijiRowFilter) - +Method in class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
            Configures the job to exclude rows not accepted by a row filter. +
            withGatherer(Class<? extends KijiGatherer>) - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Configures the job with the Kiji gatherer to run in the map phase. +
            withInput(MapReduceJobInput) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Configures the job with input. +
            withInput(MapReduceJobInput) - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Configures the job with input. +
            withInputPath(Path) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore.Builder +
            Adds a path to the list of files to load. +
            withInputPath(Path) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore.Builder +
            Adds a path to the list of files to load. +
            withInputPath(Path) - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper.Builder +
            Adds a path to the list of files to load. +
            withInputPath(Path) - +Method in class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore.Builder +
            Adds a path to the list of files to load. +
            withInputPath(Path) - +Method in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore.Builder +
            Adds a path to the list of files to load. +
            withInputPaths(List<Path>) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore.Builder +
            Replaces the current list of files to load with the set of files + specified as an argument. +
            withInputPaths(List<Path>) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore.Builder +
            Replaces the current list of files to load with the set of files + specified as an argument. +
            withInputPaths(List<Path>) - +Method in class org.kiji.mapreduce.kvstore.lib.FileStoreHelper.Builder +
            Replaces the current list of files to load with the set of files + specified as an argument. +
            withInputPaths(List<Path>) - +Method in class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore.Builder +
            Replaces the current list of files to load with the set of files + specified as an argument. +
            withInputPaths(List<Path>) - +Method in class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore.Builder +
            Replaces the current list of files to load with the set of files + specified as an argument. +
            withInputTable(KijiURI) - +Method in class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
            Configures the job with the Kiji table to use as input. +
            withJobInput(KijiTableMapReduceJobInput) - +Method in class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
            Configures the job input table. +
            withKeyFieldName(String) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore.Builder +
            Sets the name of the record field to use as the lookup key. +
            withLimitRow(EntityId) - +Method in class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
            Configures the job to process rows before an entity id. +
            withMapper(Class<? extends KijiMapper>) - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Configures the job with a mapper to run in the map phase. +
            withMaxTimestamp(long) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder +
            Sets the newest timestamp to retrieve values from in the column. +
            withMinTimestamp(long) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder +
            Sets the oldest timestamp to retrieve values from in the column. +
            withNumThreads(int) - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Sets the number of threads to use for running the producer in parallel. +
            withOutput(KijiTableMapReduceJobOutput) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Configures the bulk-importer output Kiji table. +
            withOutput(MapReduceJobOutput) - +Method in class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder +
            Configures the job output. +
            withOutput(MapReduceJobOutput) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Configures the job output. +
            withOutput(KijiTableMapReduceJobOutput) - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Configures the producer output. +
            withOutput(MapReduceJobOutput) - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Configures the job output. +
            withProducer(Class<? extends KijiProducer>) - +Method in class org.kiji.mapreduce.produce.KijiProduceJobBuilder +
            Configures the job with the Kiji producer to run. +
            withReaderSchema(Schema) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore.Builder +
            Sets the schema to read the records with. +
            withReaderSchema(Schema) - +Method in class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore.Builder +
            Sets the schema to read the records with. +
            withReaderSchema(Schema) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder +
            Sets the reader schema to use when deserializing values from the value column. +
            withReducer(Class<? extends KijiReducer>) - +Method in class org.kiji.mapreduce.gather.KijiGatherJobBuilder +
            Configures the job with a reducer to run (optional). +
            withReducer(Class<? extends KijiReducer>) - +Method in class org.kiji.mapreduce.KijiMapReduceJobBuilder +
            Configures the job with a reducer to run (optional). +
            withStartRow(EntityId) - +Method in class org.kiji.mapreduce.framework.KijiTableInputJobBuilder +
            Configures the job to process rows after and including an entity id. +
            withStore(String, KeyValueStore<?, ?>) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Binds a key-value store name to the specified KeyValueStore implementation. +
            withStoreBindings(InputStream) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Parses the inputSpec as a KeyValueStore xml configuration file. +
            withStoreBindingsFile(String) - +Method in class org.kiji.mapreduce.framework.MapReduceJobBuilder +
            Parses the KeyValueStore specification XML file and adds all store bindings in the + file to the job. +
            withTable(KijiURI) - +Method in class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder +
            Sets the table to use as the backing store. +
            write(DataOutput) - +Method in class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit +
              +
            write(DataOutput) - +Method in class org.kiji.mapreduce.framework.HFileKeyValue +
            +
            write(K, V) - +Method in interface org.kiji.mapreduce.gather.GathererContext +
            Emits a key/value pair. +
            write(K, V) - +Method in class org.kiji.mapreduce.gather.impl.InternalGathererContext +
            Emits a key/value pair. +
            write(DataOutput) - +Method in class org.kiji.mapreduce.impl.KijiTableSplit +
            +
            +
            +

            +X

            +
            +
            XmlKeyValueStoreParser - Class in org.kiji.mapreduce.kvstore.impl
            Utility that parses an XML file that specifies KeyValueStore implementations + to bind in an application.
            +
            +A B C D E F G H I J K L M N O P R S T U V W X + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/index.html b/apidocs/kiji-mapreduce/1.0.0-rc4/index.html new file mode 100644 index 00000000..9b190223 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/index.html @@ -0,0 +1,40 @@ + + + + + + + +KijiMR 1.0.0-rc4 API + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/CombineFileInputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/CombineFileInputFormat.html new file mode 100644 index 00000000..eeda026a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/CombineFileInputFormat.html @@ -0,0 +1,499 @@ + + + + + + + +CombineFileInputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.mapreduce.lib.input +
            +Class CombineFileInputFormat<K,V>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.InputFormat<K,V>
+      extended by org.apache.hadoop.mapreduce.lib.input.FileInputFormat<K,V>
+          extended by org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat<K,V>
+
            +
            +
            Direct Known Subclasses:
            WholeFileInputFormat
            +
            +
            +
            +
            public abstract class CombineFileInputFormat<K,V>
            extends org.apache.hadoop.mapreduce.lib.input.FileInputFormat<K,V>
            + + +

            +An abstract InputFormat that returns CombineFileSplit's in + InputFormat.getSplits(JobContext) method. + + Splits are constructed from the files under the input paths. + A split cannot have files from different pools. + Each split returned may contain blocks from different files. + If a maxSplitSize is specified, then blocks on the same node are + combined to form a single split. Blocks that are left over are + then combined with other blocks in the same rack. + If maxSplitSize is not specified, then blocks from the same rack + are combined in a single split; no attempt is made to create + node-local splits. + If the maxSplitSize is equal to the block size, then this class + is similar to the default splitting behavior in Hadoop: each + block is a locally processed split. + Subclasses implement + InputFormat.createRecordReader(InputSplit, TaskAttemptContext) + to construct RecordReader's for + CombineFileSplit's. +

            + +

            +

            +
            See Also:
            I've removed the annotations InterfaceAudience and InterfaceStability from this class.
            +
            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringSPLIT_MINSIZE_PERNODE + +
            +           
            +static StringSPLIT_MINSIZE_PERRACK + +
            +           
            +  + + + + + + + + + + +
            +Constructor Summary
            CombineFileInputFormat() + +
            +          default constructor
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcreatePool(List<org.apache.hadoop.fs.PathFilter> filters) + +
            +          Create a new pool and add the filters to it.
            +protected  voidcreatePool(org.apache.hadoop.fs.PathFilter... filters) + +
            +          Create a new pool and add the filters to it.
            +abstract  org.apache.hadoop.mapreduce.RecordReader<K,V>createRecordReader(org.apache.hadoop.mapreduce.InputSplit split, + org.apache.hadoop.mapreduce.TaskAttemptContext context) + +
            +          This is not implemented yet.
            + List<org.apache.hadoop.mapreduce.InputSplit>getSplits(org.apache.hadoop.mapreduce.JobContext job) + +
            +           
            +protected  voidsetMaxSplitSize(long maxSplitSize) + +
            +          Specify the maximum size (in bytes) of each split.
            +protected  voidsetMinSplitSizeNode(long minSplitSizeNode) + +
            +          Specify the minimum size (in bytes) of each split per node.
            +protected  voidsetMinSplitSizeRack(long minSplitSizeRack) + +
            +          Specify the minimum size (in bytes) of each split per rack.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.lib.input.FileInputFormat
            addInputPath, addInputPaths, computeSplitSize, getBlockIndex, getFormatMinSplitSize, getInputPathFilter, getInputPaths, getMaxSplitSize, getMinSplitSize, isSplitable, listStatus, setInputPathFilter, setInputPaths, setInputPaths, setMaxInputSplitSize, setMinInputSplitSize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SPLIT_MINSIZE_PERNODE

            +
            +public static final String SPLIT_MINSIZE_PERNODE
            +
            +
            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +SPLIT_MINSIZE_PERRACK

            +
            +public static final String SPLIT_MINSIZE_PERRACK
            +
            +
            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +CombineFileInputFormat

            +
            +public CombineFileInputFormat()
            +
            +
            default constructor +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +setMaxSplitSize

            +
            +protected void setMaxSplitSize(long maxSplitSize)
            +
            +
            Specify the maximum size (in bytes) of each split. Each split is + approximately equal to the specified size. +

            +

            +
            +
            +
            +
            + +

            +setMinSplitSizeNode

            +
            +protected void setMinSplitSizeNode(long minSplitSizeNode)
            +
            +
            Specify the minimum size (in bytes) of each split per node. + This applies to data that is left over after combining data on a single + node into splits that are of maximum size specified by maxSplitSize. + This leftover data will be combined into its own split if its size + exceeds minSplitSizeNode. +

            +

            +
            +
            +
            +
            + +

            +setMinSplitSizeRack

            +
            +protected void setMinSplitSizeRack(long minSplitSizeRack)
            +
            +
            Specify the minimum size (in bytes) of each split per rack. + This applies to data that is left over after combining data on a single + rack into splits that are of maximum size specified by maxSplitSize. + This leftover data will be combined into its own split if its size + exceeds minSplitSizeRack. +

            +

            +
            +
            +
            +
            + +

            +createPool

            +
            +protected void createPool(List<org.apache.hadoop.fs.PathFilter> filters)
            +
            +
            Create a new pool and add the filters to it. + A split cannot have files from different pools. +

            +

            +
            +
            +
            +
            + +

            +createPool

            +
            +protected void createPool(org.apache.hadoop.fs.PathFilter... filters)
            +
            +
            Create a new pool and add the filters to it. + A pathname can satisfy any one of the specified filters. + A split cannot have files from different pools. +

            +

            +
            +
            +
            +
            + +

            +getSplits

            +
            +public List<org.apache.hadoop.mapreduce.InputSplit> getSplits(org.apache.hadoop.mapreduce.JobContext job)
+                                                       throws IOException
            +
            +
            +
            Overrides:
            getSplits in class org.apache.hadoop.mapreduce.lib.input.FileInputFormat<K,V>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +createRecordReader

            +
            +public abstract org.apache.hadoop.mapreduce.RecordReader<K,V> createRecordReader(org.apache.hadoop.mapreduce.InputSplit split,
+                                                                                 org.apache.hadoop.mapreduce.TaskAttemptContext context)
+                                                                          throws IOException
            +
            +
            This is not implemented yet. +

            +

            +
            Specified by:
            createRecordReader in class org.apache.hadoop.mapreduce.InputFormat<K,V>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/CombineFileRecordReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/CombineFileRecordReader.html new file mode 100644 index 00000000..bce6d63f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/CombineFileRecordReader.html @@ -0,0 +1,627 @@ + + + + + + + +CombineFileRecordReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.mapreduce.lib.input +
            +Class CombineFileRecordReader<K,V>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.RecordReader<K,V>
+      extended by org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader<K,V>
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            public class CombineFileRecordReader<K,V>
            extends org.apache.hadoop.mapreduce.RecordReader<K,V>
            + + +

            +A generic RecordReader that can hand out different recordReaders + for each chunk in a CombineFileSplit. + A CombineFileSplit can combine data chunks from multiple files. + This class allows using different RecordReaders for processing + these data chunks from different files. +

            + +

            +

            +
            See Also:

            Note that this class has been edited slightly from the hadoop 0.21 release. + In this version, initNextRecordReader() does not set the JobConfig variables named

            +
              +
            • MRJobConfig.MAP_INPUT_FILE
              • +
            • MRJobConfig.MAP_INPUT_START
              • +
            • MRJobConfig.MAP_INPUT_PATH
              • +
            + + I've removed the annotations InterfaceAudience and InterfaceStability from this class.
            +
            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +protected  org.apache.hadoop.mapreduce.TaskAttemptContextcontext + +
            +           
            +protected  org.apache.hadoop.mapreduce.RecordReader<K,V>curReader + +
            +           
            +protected  org.apache.hadoop.fs.FileSystemfs + +
            +           
            +protected  intidx + +
            +           
            +protected  longprogress + +
            +           
            +protected  Class<? extends org.apache.hadoop.mapreduce.RecordReader<K,V>>rrClass + +
            +           
            +protected  Constructor<? extends org.apache.hadoop.mapreduce.RecordReader<K,V>>rrConstructor + +
            +           
            +protected  CombineFileSplitsplit + +
            +           
            +  + + + + + + + + + + +
            +Constructor Summary
            CombineFileRecordReader(CombineFileSplit split, + org.apache.hadoop.mapreduce.TaskAttemptContext context, + Class<? extends org.apache.hadoop.mapreduce.RecordReader<K,V>> rrClass) + +
            +          A generic RecordReader that can hand out different recordReaders + for each chunk in the CombineFileSplit.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +           
            + KgetCurrentKey() + +
            +           
            + VgetCurrentValue() + +
            +           
            + floatgetProgress() + +
            +          return progress based on the amount of data processed so far.
            + voidinitialize(org.apache.hadoop.mapreduce.InputSplit split, + org.apache.hadoop.mapreduce.TaskAttemptContext context) + +
            +           
            +protected  booleaninitNextRecordReader() + +
            +          Get the record reader for the next chunk in this CombineFileSplit.
            + booleannextKeyValue() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +split

            +
            +protected CombineFileSplit split
            +
            +
            +
            +
            +
            + +

            +rrClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.RecordReader<K,V>> rrClass
            +
            +
            +
            +
            +
            + +

            +rrConstructor

            +
            +protected Constructor<? extends org.apache.hadoop.mapreduce.RecordReader<K,V>> rrConstructor
            +
            +
            +
            +
            +
            + +

            +fs

            +
            +protected org.apache.hadoop.fs.FileSystem fs
            +
            +
            +
            +
            +
            + +

            +context

            +
            +protected org.apache.hadoop.mapreduce.TaskAttemptContext context
            +
            +
            +
            +
            +
            + +

            +idx

            +
            +protected int idx
            +
            +
            +
            +
            +
            + +

            +progress

            +
            +protected long progress
            +
            +
            +
            +
            +
            + +

            +curReader

            +
            +protected org.apache.hadoop.mapreduce.RecordReader<K,V> curReader
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +CombineFileRecordReader

            +
            +public CombineFileRecordReader(CombineFileSplit split,
+                               org.apache.hadoop.mapreduce.TaskAttemptContext context,
+                               Class<? extends org.apache.hadoop.mapreduce.RecordReader<K,V>> rrClass)
+                        throws IOException
            +
            +
            A generic RecordReader that can hand out different recordReaders + for each chunk in the CombineFileSplit. +

            +

            + +
            Throws: +
            IOException
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(org.apache.hadoop.mapreduce.InputSplit split,
+                       org.apache.hadoop.mapreduce.TaskAttemptContext context)
+                throws IOException,
+                       InterruptedException
            +
            +
            +
            Specified by:
            initialize in class org.apache.hadoop.mapreduce.RecordReader<K,V>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +nextKeyValue

            +
            +public boolean nextKeyValue()
+                     throws IOException,
+                            InterruptedException
            +
            +
            +
            Specified by:
            nextKeyValue in class org.apache.hadoop.mapreduce.RecordReader<K,V>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +getCurrentKey

            +
            +public K getCurrentKey()
+                throws IOException,
+                       InterruptedException
            +
            +
            +
            Specified by:
            getCurrentKey in class org.apache.hadoop.mapreduce.RecordReader<K,V>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +getCurrentValue

            +
            +public V getCurrentValue()
+                  throws IOException,
+                         InterruptedException
            +
            +
            +
            Specified by:
            getCurrentValue in class org.apache.hadoop.mapreduce.RecordReader<K,V>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in class org.apache.hadoop.mapreduce.RecordReader<K,V>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getProgress

            +
            +public float getProgress()
+                  throws IOException,
+                         InterruptedException
            +
            +
            return progress based on the amount of data processed so far. +

            +

            +
            Specified by:
            getProgress in class org.apache.hadoop.mapreduce.RecordReader<K,V>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +initNextRecordReader

            +
            +protected boolean initNextRecordReader()
+                                throws IOException
            +
            +
            Get the record reader for the next chunk in this CombineFileSplit. + + This function has been edited. Unlike the hadoop 0.21.0 release, this function + does NOT set the Configuration variables named +
              +
            • MRJobConfig.MAP_INPUT_FILE
              • +
            • MRJobConfig.MAP_INPUT_START
              • +
            • MRJobConfig.MAP_INPUT_PATH
              • +
            +

            +

            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/CombineFileSplit.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/CombineFileSplit.html new file mode 100644 index 00000000..5657fe52 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/CombineFileSplit.html @@ -0,0 +1,602 @@ + + + + + + + +CombineFileSplit (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.mapreduce.lib.input +
            +Class CombineFileSplit

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.InputSplit
+      extended by org.apache.hadoop.mapreduce.lib.input.CombineFileSplit
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.io.Writable
            +
            +
            +
            +
            public class CombineFileSplit
            extends org.apache.hadoop.mapreduce.InputSplit
            implements org.apache.hadoop.io.Writable
            + + +

            +A sub-collection of input files. + + Unlike FileSplit, CombineFileSplit class does not represent + a split of a file, but a split of input files into smaller sets. + A split may contain blocks from different file but all + the blocks in the same split are probably local to some rack
            + CombineFileSplit can be used to implement RecordReader's, + with reading one record per file. +

            + +

            +

            +
            See Also:
            FileSplit, +I've removed the annotations InterfaceAudience and InterfaceStability from this class.
            +
            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            CombineFileSplit() + +
            +          default constructor
            CombineFileSplit(CombineFileSplit old) + +
            +          Copy constructor
            CombineFileSplit(org.apache.hadoop.fs.Path[] files, + long[] lengths) + +
            +           
            CombineFileSplit(org.apache.hadoop.fs.Path[] files, + long[] start, + long[] lengths, + String[] locations) + +
            +          Specify the set of files to include in this split
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + longgetLength() + +
            +           
            + longgetLength(int i) + +
            +          Returns the length of the ith Path
            + long[]getLengths() + +
            +          Returns an array containing the lengths of the files in the split
            + String[]getLocations() + +
            +          Returns all the Nodes where this input-split resides
            + intgetNumPaths() + +
            +          Returns the number of Paths in the split
            + longgetOffset(int i) + +
            +          Returns the start offset of the ith Path
            + org.apache.hadoop.fs.PathgetPath(int i) + +
            +          Returns the ith Path
            + org.apache.hadoop.fs.Path[]getPaths() + +
            +          Returns all the Paths in the split
            + long[]getStartOffsets() + +
            +          Returns an array containing the start offsets of the files in the split
            + voidreadFields(DataInput in) + +
            +           
            + StringtoString() + +
            +           
            + voidwrite(DataOutput out) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +CombineFileSplit

            +
            +public CombineFileSplit()
            +
            +
            default constructor +

            +

            +
            + +

            +CombineFileSplit

            +
            +public CombineFileSplit(org.apache.hadoop.fs.Path[] files,
+                        long[] start,
+                        long[] lengths,
+                        String[] locations)
            +
            +
            Specify the set of files to include in this split +

            +

            +
            + +

            +CombineFileSplit

            +
            +public CombineFileSplit(org.apache.hadoop.fs.Path[] files,
+                        long[] lengths)
            +
            +
            +
            + +

            +CombineFileSplit

            +
            +public CombineFileSplit(CombineFileSplit old)
+                 throws IOException
            +
            +
            Copy constructor +

            +

            + +
            Throws: +
            IOException
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getLength

            +
            +public long getLength()
            +
            +
            +
            Specified by:
            getLength in class org.apache.hadoop.mapreduce.InputSplit
            +
            +
            +
            +
            +
            +
            + +

            +getStartOffsets

            +
            +public long[] getStartOffsets()
            +
            +
            Returns an array containing the start offsets of the files in the split +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLengths

            +
            +public long[] getLengths()
            +
            +
            Returns an array containing the lengths of the files in the split +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getOffset

            +
            +public long getOffset(int i)
            +
            +
            Returns the start offset of the ith Path +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLength

            +
            +public long getLength(int i)
            +
            +
            Returns the length of the ith Path +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getNumPaths

            +
            +public int getNumPaths()
            +
            +
            Returns the number of Paths in the split +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getPath

            +
            +public org.apache.hadoop.fs.Path getPath(int i)
            +
            +
            Returns the ith Path +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getPaths

            +
            +public org.apache.hadoop.fs.Path[] getPaths()
            +
            +
            Returns all the Paths in the split +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLocations

            +
            +public String[] getLocations()
+                      throws IOException
            +
            +
            Returns all the Nodes where this input-split resides +

            +

            +
            Specified by:
            getLocations in class org.apache.hadoop.mapreduce.InputSplit
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +readFields

            +
            +public void readFields(DataInput in)
+                throws IOException
            +
            +
            +
            Specified by:
            readFields in interface org.apache.hadoop.io.Writable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +write

            +
            +public void write(DataOutput out)
+           throws IOException
            +
            +
            +
            Specified by:
            write in interface org.apache.hadoop.io.Writable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/class-use/CombineFileInputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/class-use/CombineFileInputFormat.html new file mode 100644 index 00000000..d9c50b44 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/class-use/CombineFileInputFormat.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat

            +
            + + + + + + + + + +
            +Packages that use CombineFileInputFormat
            org.kiji.mapreduce.input.implInternal implementation details for KijiMR's job input classes. 
            +  +

            + + + + + +
            +Uses of CombineFileInputFormat in org.kiji.mapreduce.input.impl
            +  +

            + + + + + + + + + +
            Subclasses of CombineFileInputFormat in org.kiji.mapreduce.input.impl
            + classWholeFileInputFormat + +
            +          An input format for reading multiple files in a single map task.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/class-use/CombineFileRecordReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/class-use/CombineFileRecordReader.html new file mode 100644 index 00000000..0a7fe443 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/class-use/CombineFileRecordReader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader

            +
            +No usage of org.apache.hadoop.mapreduce.lib.input.CombineFileRecordReader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/class-use/CombineFileSplit.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/class-use/CombineFileSplit.html new file mode 100644 index 00000000..536aa797 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/class-use/CombineFileSplit.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Class org.apache.hadoop.mapreduce.lib.input.CombineFileSplit (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.mapreduce.lib.input.CombineFileSplit

            +
            + + + + + + + + + + + + + +
            +Packages that use CombineFileSplit
            org.apache.hadoop.mapreduce.lib.input  
            org.kiji.mapreduce.input.implInternal implementation details for KijiMR's job input classes. 
            +  +

            + + + + + +
            +Uses of CombineFileSplit in org.apache.hadoop.mapreduce.lib.input
            +  +

            + + + + + + + + + +
            Fields in org.apache.hadoop.mapreduce.lib.input declared as CombineFileSplit
            +protected  CombineFileSplitCombineFileRecordReader.split + +
            +           
            +  +

            + + + + + + + + + + + +
            Constructors in org.apache.hadoop.mapreduce.lib.input with parameters of type CombineFileSplit
            CombineFileRecordReader(CombineFileSplit split, + org.apache.hadoop.mapreduce.TaskAttemptContext context, + Class<? extends org.apache.hadoop.mapreduce.RecordReader<K,V>> rrClass) + +
            +          A generic RecordReader that can hand out different recordReaders + for each chunk in the CombineFileSplit.
            CombineFileSplit(CombineFileSplit old) + +
            +          Copy constructor
            +  +

            + + + + + +
            +Uses of CombineFileSplit in org.kiji.mapreduce.input.impl
            +  +

            + + + + + + + + +
            Constructors in org.kiji.mapreduce.input.impl with parameters of type CombineFileSplit
            WholeFileRecordReader(CombineFileSplit fileSplit, + org.apache.hadoop.mapreduce.TaskAttemptContext context, + Integer pathToProcess) + +
            +          Implementation detail: This constructor is built to be called via + reflection from within CombineFileRecordReader.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-frame.html new file mode 100644 index 00000000..d6521ea7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-frame.html @@ -0,0 +1,37 @@ + + + + + + + +org.apache.hadoop.mapreduce.lib.input (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.apache.hadoop.mapreduce.lib.input + + + + +
            +Classes  + +
            +CombineFileInputFormat +
            +CombineFileRecordReader +
            +CombineFileSplit
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-summary.html new file mode 100644 index 00000000..d36f3240 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-summary.html @@ -0,0 +1,168 @@ + + + + + + + +org.apache.hadoop.mapreduce.lib.input (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.apache.hadoop.mapreduce.lib.input +

            + + + + + + + + + + + + + + + + + +
            +Class Summary
            CombineFileInputFormat<K,V>An abstract InputFormat that returns CombineFileSplit's in + InputFormat.getSplits(JobContext) method.
            CombineFileRecordReader<K,V>A generic RecordReader that can hand out different recordReaders + for each chunk in a CombineFileSplit.
            CombineFileSplitA sub-collection of input files.
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-tree.html new file mode 100644 index 00000000..7a2c4917 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +org.apache.hadoop.mapreduce.lib.input Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.apache.hadoop.mapreduce.lib.input +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.hadoop.mapreduce.InputFormat<K,V>
                  +
                • org.apache.hadoop.mapreduce.lib.input.FileInputFormat<K,V> +
                +
              • org.apache.hadoop.mapreduce.InputSplit
                  +
                • org.apache.hadoop.mapreduce.lib.input.CombineFileSplit (implements org.apache.hadoop.io.Writable) +
                +
              • org.apache.hadoop.mapreduce.RecordReader<KEYIN,VALUEIN> (implements java.io.Closeable) + +
              +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-use.html new file mode 100644 index 00000000..98b9fd4b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/input/package-use.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Package org.apache.hadoop.mapreduce.lib.input (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.apache.hadoop.mapreduce.lib.input

            +
            + + + + + + + + + + + + + +
            +Packages that use org.apache.hadoop.mapreduce.lib.input
            org.apache.hadoop.mapreduce.lib.input  
            org.kiji.mapreduce.input.implInternal implementation details for KijiMR's job input classes. 
            +  +

            + + + + + + + + +
            +Classes in org.apache.hadoop.mapreduce.lib.input used by org.apache.hadoop.mapreduce.lib.input
            CombineFileSplit + +
            +          A sub-collection of input files.
            +  +

            + + + + + + + + + + + +
            +Classes in org.apache.hadoop.mapreduce.lib.input used by org.kiji.mapreduce.input.impl
            CombineFileInputFormat + +
            +          An abstract InputFormat that returns CombineFileSplit's in + InputFormat.getSplits(JobContext) method.
            CombineFileSplit + +
            +          A sub-collection of input files.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/KijiMultithreadedMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/KijiMultithreadedMapper.html new file mode 100644 index 00000000..a0b52937 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/KijiMultithreadedMapper.html @@ -0,0 +1,402 @@ + + + + + + + +KijiMultithreadedMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.mapreduce.lib.map +
            +Class KijiMultithreadedMapper<K,V>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Mapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>
+      extended by org.apache.hadoop.mapreduce.lib.map.KijiMultithreadedMapper<K,V>
+
            +
            +
            +
            public class KijiMultithreadedMapper<K,V>
            extends org.apache.hadoop.mapreduce.Mapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>
            + + +

            +Multithreaded implementation for @link org.apache.hadoop.mapreduce.Mapper. +

            + It can be used instead of the default implementation, +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Mapper
            org.apache.hadoop.mapreduce.Mapper.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            KijiMultithreadedMapper() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<K,V> Class<org.apache.hadoop.mapreduce.Mapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>>
            +            		getMapperClass(org.apache.hadoop.mapreduce.JobContext job) + +
            +          Get the application's mapper class.
            +static intgetNumberOfThreads(org.apache.hadoop.mapreduce.JobContext job) + +
            +          The number of threads in the thread pool that will run the map function.
            + voidrun(org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          Run the application's maps using a thread pool.
            +static + + + + +
            +<K,V> void
            +            		setMapperClass(org.apache.hadoop.mapreduce.Job job, + Class<? extends org.apache.hadoop.mapreduce.Mapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>> cls) + +
            +          Set the application's mapper class.
            +static voidsetNumberOfThreads(org.apache.hadoop.mapreduce.Job job, + int threads) + +
            +          Set the number of threads in the pool for running maps.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Mapper
            cleanup, map, setup
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiMultithreadedMapper

            +
            +public KijiMultithreadedMapper()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getNumberOfThreads

            +
            +public static int getNumberOfThreads(org.apache.hadoop.mapreduce.JobContext job)
            +
            +
            The number of threads in the thread pool that will run the map function. +

            +

            +
            Parameters:
            job - the job +
            Returns:
            the number of threads
            +
            +
            +
            + +

            +setNumberOfThreads

            +
            +public static void setNumberOfThreads(org.apache.hadoop.mapreduce.Job job,
+                                      int threads)
            +
            +
            Set the number of threads in the pool for running maps. +

            +

            +
            Parameters:
            job - the job to modify
            threads - the new number of threads
            +
            +
            +
            + +

            +getMapperClass

            +
            +public static <K,V> Class<org.apache.hadoop.mapreduce.Mapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>> getMapperClass(org.apache.hadoop.mapreduce.JobContext job)
            +
            +
            Get the application's mapper class. +

            +

            +
            Type Parameters:
            K - the map's output key type
            V - the map's output value type
            Parameters:
            job - the job +
            Returns:
            the mapper class to run
            +
            +
            +
            + +

            +setMapperClass

            +
            +public static <K,V> void setMapperClass(org.apache.hadoop.mapreduce.Job job,
+                                        Class<? extends org.apache.hadoop.mapreduce.Mapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>> cls)
            +
            +
            Set the application's mapper class. +

            +

            +
            Type Parameters:
            K - the map output key type
            V - the map output value type
            Parameters:
            job - the job to modify
            cls - the class to use as the mapper
            +
            +
            +
            + +

            +run

            +
            +public void run(org.apache.hadoop.mapreduce.Mapper.Context context)
+         throws IOException,
+                InterruptedException
            +
            +
            Run the application's maps using a thread pool. +

            +

            +
            Overrides:
            run in class org.apache.hadoop.mapreduce.Mapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/class-use/KijiMultithreadedMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/class-use/KijiMultithreadedMapper.html new file mode 100644 index 00000000..e48e9b12 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/class-use/KijiMultithreadedMapper.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.mapreduce.lib.map.KijiMultithreadedMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.mapreduce.lib.map.KijiMultithreadedMapper

            +
            +No usage of org.apache.hadoop.mapreduce.lib.map.KijiMultithreadedMapper +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-frame.html new file mode 100644 index 00000000..6c929ecb --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.apache.hadoop.mapreduce.lib.map (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.apache.hadoop.mapreduce.lib.map + + + + +
            +Classes  + +
            +KijiMultithreadedMapper
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-summary.html new file mode 100644 index 00000000..3fb1aa31 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +org.apache.hadoop.mapreduce.lib.map (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.apache.hadoop.mapreduce.lib.map +

            + + + + + + + + + +
            +Class Summary
            KijiMultithreadedMapper<K,V>Multithreaded implementation for @link org.apache.hadoop.mapreduce.Mapper.
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-tree.html new file mode 100644 index 00000000..2b816bb4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-tree.html @@ -0,0 +1,156 @@ + + + + + + + +org.apache.hadoop.mapreduce.lib.map Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.apache.hadoop.mapreduce.lib.map +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.hadoop.mapreduce.Mapper<KEYIN,VALUEIN,KEYOUT,VALUEOUT> +
              +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-use.html new file mode 100644 index 00000000..2940f0a6 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/map/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.apache.hadoop.mapreduce.lib.map (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.apache.hadoop.mapreduce.lib.map

            +
            +No usage of org.apache.hadoop.mapreduce.lib.map +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/MapFileOutputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/MapFileOutputFormat.html new file mode 100644 index 00000000..aaff4b1d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/MapFileOutputFormat.html @@ -0,0 +1,358 @@ + + + + + + + +MapFileOutputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.mapreduce.lib.output +
            +Class MapFileOutputFormat

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.OutputFormat<K,V>
+      extended by org.apache.hadoop.mapreduce.lib.output.FileOutputFormat<org.apache.hadoop.io.WritableComparable<?>,org.apache.hadoop.io.Writable>
+          extended by org.apache.hadoop.mapreduce.lib.output.MapFileOutputFormat
+
            +
            +
            +
            public class MapFileOutputFormat
            extends org.apache.hadoop.mapreduce.lib.output.FileOutputFormat<org.apache.hadoop.io.WritableComparable<?>,org.apache.hadoop.io.Writable>
            + + +

            +An OutputFormat that writes + MapFiles. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat
            BASE_OUTPUT_NAME, PART
            +  + + + + + + + + + + +
            +Constructor Summary
            MapFileOutputFormat() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<K extends org.apache.hadoop.io.WritableComparable<?>,V extends org.apache.hadoop.io.Writable> +
            +org.apache.hadoop.io.Writable
            +            		getEntry(org.apache.hadoop.io.MapFile.Reader[] readers, + org.apache.hadoop.mapreduce.Partitioner<K,V> partitioner, + K key, + V value) + +
            +          Get an entry from output generated by this class.
            +static org.apache.hadoop.io.MapFile.Reader[]getReaders(org.apache.hadoop.fs.Path dir, + org.apache.hadoop.conf.Configuration conf) + +
            +          Open the output generated by this format.
            + org.apache.hadoop.mapreduce.RecordWriter<org.apache.hadoop.io.WritableComparable<?>,org.apache.hadoop.io.Writable>getRecordWriter(org.apache.hadoop.mapreduce.TaskAttemptContext context) + +
            +           
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat
            checkOutputSpecs, getCompressOutput, getDefaultWorkFile, getOutputCommitter, getOutputCompressorClass, getOutputName, getOutputPath, getPathForWorkFile, getUniqueFile, getWorkOutputPath, setCompressOutput, setOutputCompressorClass, setOutputName, setOutputPath
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MapFileOutputFormat

            +
            +public MapFileOutputFormat()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getRecordWriter

            +
            +public org.apache.hadoop.mapreduce.RecordWriter<org.apache.hadoop.io.WritableComparable<?>,org.apache.hadoop.io.Writable> getRecordWriter(org.apache.hadoop.mapreduce.TaskAttemptContext context)
+                                                                                                                                   throws IOException
            +
            +
            +
            Specified by:
            getRecordWriter in class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat<org.apache.hadoop.io.WritableComparable<?>,org.apache.hadoop.io.Writable>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getReaders

            +
            +public static org.apache.hadoop.io.MapFile.Reader[] getReaders(org.apache.hadoop.fs.Path dir,
+                                                               org.apache.hadoop.conf.Configuration conf)
+                                                        throws IOException
            +
            +
            Open the output generated by this format. +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getEntry

            +
            +public static <K extends org.apache.hadoop.io.WritableComparable<?>,V extends org.apache.hadoop.io.Writable> org.apache.hadoop.io.Writable getEntry(org.apache.hadoop.io.MapFile.Reader[] readers,
+                                                                                                                                                    org.apache.hadoop.mapreduce.Partitioner<K,V> partitioner,
+                                                                                                                                                    K key,
+                                                                                                                                                    V value)
+                                              throws IOException
            +
            +
            Get an entry from output generated by this class. +

            +

            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/class-use/MapFileOutputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/class-use/MapFileOutputFormat.html new file mode 100644 index 00000000..2429ce72 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/class-use/MapFileOutputFormat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.mapreduce.lib.output.MapFileOutputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.mapreduce.lib.output.MapFileOutputFormat

            +
            +No usage of org.apache.hadoop.mapreduce.lib.output.MapFileOutputFormat +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-frame.html new file mode 100644 index 00000000..acf78f6c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.apache.hadoop.mapreduce.lib.output (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.apache.hadoop.mapreduce.lib.output + + + + +
            +Classes  + +
            +MapFileOutputFormat
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-summary.html new file mode 100644 index 00000000..38fdaa63 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-summary.html @@ -0,0 +1,159 @@ + + + + + + + +org.apache.hadoop.mapreduce.lib.output (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.apache.hadoop.mapreduce.lib.output +

            + + + + + + + + + +
            +Class Summary
            MapFileOutputFormatAn OutputFormat that writes + MapFiles.
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-tree.html new file mode 100644 index 00000000..0dd01e7e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-tree.html @@ -0,0 +1,158 @@ + + + + + + + +org.apache.hadoop.mapreduce.lib.output Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.apache.hadoop.mapreduce.lib.output +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.hadoop.mapreduce.OutputFormat<K,V>
                  +
                • org.apache.hadoop.mapreduce.lib.output.FileOutputFormat<K,V> +
                +
              +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-use.html new file mode 100644 index 00000000..d4a2f182 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/apache/hadoop/mapreduce/lib/output/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.apache.hadoop.mapreduce.lib.output (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.apache.hadoop.mapreduce.lib.output

            +
            +No usage of org.apache.hadoop.mapreduce.lib.output +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/DistributedCacheJars.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/DistributedCacheJars.html new file mode 100644 index 00000000..44ac97dc --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/DistributedCacheJars.html @@ -0,0 +1,329 @@ + + + + + + + +DistributedCacheJars (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class DistributedCacheJars

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.DistributedCacheJars
+
            +
            +
            +
            @ApiAudience.Public
+public final class DistributedCacheJars
            extends Object
            + + +

            +Utility class for dealing with Java JAR files and the hadoop distributed cache. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidaddJarsToDistributedCache(org.apache.hadoop.mapreduce.Job job, + File jarDirectory) + +
            +          Adds the jars from a directory into the distributed cache of a job.
            +static voidaddJarsToDistributedCache(org.apache.hadoop.mapreduce.Job job, + String jarDirectory) + +
            +          Adds the jars from a directory into the distributed cache of a job.
            +static List<String>deDuplicateJarNames(List<String> jarList) + +
            +          Takes a list of paths and returns a list of paths with unique filenames.
            +static List<String>getJarsFromConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Lists all jars in the variable tmpjars of this Configuration.
            +static List<String>getJarsFromDirectory(org.apache.hadoop.conf.Configuration conf, + File jarDirectory) + +
            +          Lists all jars in the specified directory.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +addJarsToDistributedCache

            +
            +public static void addJarsToDistributedCache(org.apache.hadoop.mapreduce.Job job,
+                                             String jarDirectory)
+                                      throws IOException
            +
            +
            Adds the jars from a directory into the distributed cache of a job. +

            +

            +
            Parameters:
            job - The job to configure.
            jarDirectory - A path to a directory of jar files. +
            Throws: +
            IOException - If there is a problem reading from the file system.
            +
            +
            +
            + +

            +addJarsToDistributedCache

            +
            +public static void addJarsToDistributedCache(org.apache.hadoop.mapreduce.Job job,
+                                             File jarDirectory)
+                                      throws IOException
            +
            +
            Adds the jars from a directory into the distributed cache of a job. +

            +

            +
            Parameters:
            job - The job to configure.
            jarDirectory - A path to a directory of jar files. +
            Throws: +
            IOException - If there is a problem reading from the file system.
            +
            +
            +
            + +

            +getJarsFromConfiguration

            +
            +public static List<String> getJarsFromConfiguration(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Lists all jars in the variable tmpjars of this Configuration. +

            +

            +
            Parameters:
            conf - The Configuration to get jar names from +
            Returns:
            A list of jars.
            +
            +
            +
            + +

            +getJarsFromDirectory

            +
            +public static List<String> getJarsFromDirectory(org.apache.hadoop.conf.Configuration conf,
+                                                File jarDirectory)
+                                         throws IOException
            +
            +
            Lists all jars in the specified directory. +

            +

            +
            Parameters:
            conf - Configuration to get FileSystem from
            jarDirectory - The directory of jars to get. +
            Returns:
            A list of qualified paths to the jars in jarDirectory. +
            Throws: +
            IOException - if there's a problem.
            +
            +
            +
            + +

            +deDuplicateJarNames

            +
            +public static List<String> deDuplicateJarNames(List<String> jarList)
            +
            +
            Takes a list of paths and returns a list of paths with unique filenames. +

            +

            +
            Parameters:
            jarList - A list of jars to de-dupe. +
            Returns:
            A de-duplicated list of jars.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/HFileLoader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/HFileLoader.html new file mode 100644 index 00000000..aadc2f69 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/HFileLoader.html @@ -0,0 +1,257 @@ + + + + + + + +HFileLoader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class HFileLoader

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.HFileLoader
+
            +
            +
            +
            @ApiAudience.Public
+public final class HFileLoader
            extends Object
            + + +

            +Loads HFiles generated by a MapReduce job into a Kiji table. +

            + +

            +

            +
            See Also:
            HFileMapReduceJobOutput, +KijiBulkLoad
            +
            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static HFileLoadercreate(org.apache.hadoop.conf.Configuration conf) + +
            +          Creates a new HFile loader.
            + voidload(org.apache.hadoop.fs.Path hfilePath, + org.kiji.schema.KijiTable table) + +
            +          Loads HFiles directly into the regions of a Kiji table.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static HFileLoader create(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Creates a new HFile loader. +

            +

            +
            Parameters:
            conf - The configuration to be used by the new loader. +
            Returns:
            A new loader that can be used to add HFiles to HBase tables.
            +
            +
            +
            + +

            +load

            +
            +public void load(org.apache.hadoop.fs.Path hfilePath,
+                 org.kiji.schema.KijiTable table)
+          throws IOException
            +
            +
            Loads HFiles directly into the regions of a Kiji table. +

            +

            +
            Parameters:
            hfilePath - The path to the HFiles generated by a bulk-import job.
            table - The target kiji table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/JobConfigurationException.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/JobConfigurationException.html new file mode 100644 index 00000000..c1c3bd8e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/JobConfigurationException.html @@ -0,0 +1,251 @@ + + + + + + + +JobConfigurationException (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class JobConfigurationException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.mapreduce.JobConfigurationException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class JobConfigurationException
            extends RuntimeException
            + + +

            +Thrown when a MapReduceJob is being built, but it has missing or incomplete configuration. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            JobConfigurationException(String message) + +
            +          Creates a new JobConfigurationException instance.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +JobConfigurationException

            +
            +public JobConfigurationException(String message)
            +
            +
            Creates a new JobConfigurationException instance. +

            +

            +
            Parameters:
            message - A detailed message describing the exception.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KVOutputJob.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KVOutputJob.html new file mode 100644 index 00000000..c43acfc7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KVOutputJob.html @@ -0,0 +1,239 @@ + + + + + + + +KVOutputJob (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Interface KVOutputJob

            +
            +
            All Known Implementing Classes:
            BulkImportMapper, GatherMapper, IdentityReducer, KijiGatherer, KijiMapper, KijiReducer, KijiTableMapper, KijiTableReducer, ProduceMapper
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface KVOutputJob
            + + +

            +Base interface for tasks that emit (key, value) pairs. + + Tasks can be mappers, reducers, gatherers, etc. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + Class<?>getOutputKeyClass() + +
            +           
            + Class<?>getOutputValueClass() + +
            +           
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getOutputKeyClass

            +
            +Class<?> getOutputKeyClass()
            +
            +
            + +
            Returns:
            the type of keys emitted by this task.
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +Class<?> getOutputValueClass()
            +
            +
            + +
            Returns:
            the type of values emitted by this task.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiContext.html new file mode 100644 index 00000000..7c936097 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiContext.html @@ -0,0 +1,401 @@ + + + + + + + +KijiContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Interface KijiContext

            +
            +
            All Superinterfaces:
            Closeable, Flushable
            +
            +
            +
            All Known Subinterfaces:
            GathererContext<K,V>, InternalProducerContextInterface, KijiTableContext, ProducerContext
            +
            +
            +
            All Known Implementing Classes:
            DirectKijiTableWriterContext, HFileWriterContext, InternalGathererContext, InternalKijiContext, InternalProducerContext
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiContext
            extends Closeable, Flushable
            + + +

            +Interface for contexts passed to KijiMR methods. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetStatus() + +
            +          Returns a previously set status message.
            + + + + + +
            +<K,V> KeyValueStoreReader<K,V>
            +            		getStore(String storeName) + +
            +          Opens a KeyValueStore associated with storeName for read-access.
            + voidincrementCounter(Enum<?> counter) + +
            +          Increments a counter by 1.
            + voidincrementCounter(Enum<?> counter, + long amount) + +
            +          Increment a counter by an amount.
            + voidprogress() + +
            +          Report progress to the kiji framework.
            + voidsetStatus(String msg) + +
            +          Sets a status string for the kiji task.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getStore

            +
            +<K,V> KeyValueStoreReader<K,V> getStore(String storeName)
+                                  throws IOException,
+                                         InterruptedException
            +
            +
            Opens a KeyValueStore associated with storeName for read-access. + +

            You should close() the store instance returned by this method + when you are done with it.

            + +

            Calling getStore() multiple times on the same name will reuse the same + reader unless it is closed.

            +

            +

            +
            +
            +
            +
            Type Parameters:
            K - The key type for the KeyValueStore.
            V - The value type for the KeyValueStore.
            Parameters:
            storeName - the name of the KeyValueStore to open. +
            Returns:
            A KeyValueStoreReader associated with this storeName, or null + if there is no such KeyValueStore available. +
            Throws: +
            IOException - if there is an error opening the underlying storage resource. +
            InterruptedException - if there is an interruption while connecting to + the underlying storage resource.
            +
            +
            +
            + +

            +incrementCounter

            +
            +void incrementCounter(Enum<?> counter)
            +
            +
            Increments a counter by 1. +

            +

            +
            +
            +
            +
            Parameters:
            counter - The counter to increment.
            +
            +
            +
            + +

            +incrementCounter

            +
            +void incrementCounter(Enum<?> counter,
+                      long amount)
            +
            +
            Increment a counter by an amount. +

            +

            +
            +
            +
            +
            Parameters:
            counter - The counter to increment.
            amount - The amount to increment the counter by.
            +
            +
            +
            + +

            +progress

            +
            +void progress()
            +
            +
            Report progress to the kiji framework. + +

            If called as part of a MapReduce job, this will indicate progress in the style of + org.apache.hadoop.util.Progressable, keeping the task from being marked as dead. It may also + be called safely from Fresheners, so a producer using this call can be used either as a + Freshener or part of a Hadoop job. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setStatus

            +
            +void setStatus(String msg)
+               throws IOException
            +
            +
            Sets a status string for the kiji task. + +

            If called as part of a MapReduce job, the msg will be used as the task status + string. It may also be called safely from Fresheners, so a producer using this call can be + used either as a Freshener or part of a Hadoop job.

            +

            +

            +
            +
            +
            +
            Parameters:
            msg - The status string. +
            Throws: +
            IOException - if there is an error when setting the status string of the task.
            +
            +
            +
            + +

            +getStatus

            +
            +String getStatus()
            +
            +
            Returns a previously set status message. +

            +

            +
            +
            +
            + +
            Returns:
            The previously set status message.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiDataRequester.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiDataRequester.html new file mode 100644 index 00000000..ed2016b6 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiDataRequester.html @@ -0,0 +1,219 @@ + + + + + + + +KijiDataRequester (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Interface KijiDataRequester

            +
            +
            All Known Implementing Classes:
            GatherMapper, KijiGatherer, KijiProducer, KijiTableMapper, ProduceMapper
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface KijiDataRequester
            + + +

            +Interface for classes that specify a set of columns to read from a kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          Return a KijiDataRequest that describes which input columns need to be available.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            Return a KijiDataRequest that describes which input columns need to be available. +

            +

            + +
            Returns:
            A kiji data request.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiMapReduceJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiMapReduceJobBuilder.html new file mode 100644 index 00000000..adadf18b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiMapReduceJobBuilder.html @@ -0,0 +1,534 @@ + + + + + + + +KijiMapReduceJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class KijiMapReduceJobBuilder

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.framework.MapReduceJobBuilder<KijiMapReduceJobBuilder>
+      extended by org.kiji.mapreduce.KijiMapReduceJobBuilder
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiMapReduceJobBuilder
            extends MapReduceJobBuilder<KijiMapReduceJobBuilder>
            + + +

            +Builds general MapReduce jobs around Kiji mappers and reducers. For specialized tasks see, + for example, KijiProduceJobBuilder. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  MapReduceJobbuild(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop MR job in a MapReduceJob.
            +protected  voidconfigureJob(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures a Hadoop MR job.
            +static KijiMapReduceJobBuildercreate() + +
            +          Creates a new builder for Kiji transform jobs.
            +protected  KijiReducer<?,?,?,?>getCombiner() + +
            +          Gets an instance of the MapReduce combiner to be used for this job.
            +protected  Class<?>getJarClass() + +
            +          Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks.
            +protected  MapReduceJobInputgetJobInput() + +
            +          Gets the input to configure the job with.
            +protected  KijiMapper<?,?,?,?>getMapper() + +
            +          Gets an instance of the MapReduce mapper to be used for this job.
            +protected  KijiReducer<?,?,?,?>getReducer() + +
            +          Gets an instance of the MapReduce reducer to be used for this job.
            +protected  Map<String,KeyValueStore<?,?>>getRequiredStores() + +
            +          Method for job components to declare required KeyValueStore entries (and their default + implementations).
            + KijiMapReduceJobBuilderwithCombiner(Class<? extends KijiReducer> combinerClass) + +
            +          Configures the job with a combiner to run (optional).
            + KijiMapReduceJobBuilderwithInput(MapReduceJobInput jobInput) + +
            +          Configures the job with input.
            + KijiMapReduceJobBuilderwithMapper(Class<? extends KijiMapper> mapperClass) + +
            +          Configures the job with a mapper to run in the map phase.
            + KijiMapReduceJobBuilderwithReducer(Class<? extends KijiReducer> reducerClass) + +
            +          Configures the job with a reducer to run (optional).
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.framework.MapReduceJobBuilder
            addJarDirectory, addJarDirectory, build, configureAvro, configureCombiner, configureHTableInput, configureInput, configureJars, configureMapper, configureOutput, configureReducer, configureStores, getConf, getJobOutput, mergeStores, withConf, withOutput, withStore, withStoreBindings, withStoreBindingsFile
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiMapReduceJobBuilder create()
            +
            +
            Creates a new builder for Kiji transform jobs. +

            +

            + +
            Returns:
            a new Kiji transform job builder.
            +
            +
            +
            + +

            +withInput

            +
            +public KijiMapReduceJobBuilder withInput(MapReduceJobInput jobInput)
            +
            +
            Configures the job with input. +

            +

            +
            Parameters:
            jobInput - The input for the job. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withMapper

            +
            +public KijiMapReduceJobBuilder withMapper(Class<? extends KijiMapper> mapperClass)
            +
            +
            Configures the job with a mapper to run in the map phase. +

            +

            +
            Parameters:
            mapperClass - The mapper class. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withCombiner

            +
            +public KijiMapReduceJobBuilder withCombiner(Class<? extends KijiReducer> combinerClass)
            +
            +
            Configures the job with a combiner to run (optional). +

            +

            +
            Parameters:
            combinerClass - The combiner class. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withReducer

            +
            +public KijiMapReduceJobBuilder withReducer(Class<? extends KijiReducer> reducerClass)
            +
            +
            Configures the job with a reducer to run (optional). +

            +

            +
            Parameters:
            reducerClass - The reducer class. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +configureJob

            +
            +protected void configureJob(org.apache.hadoop.mapreduce.Job job)
+                     throws IOException
            +
            +
            Configures a Hadoop MR job. +

            +

            +
            Overrides:
            configureJob in class MapReduceJobBuilder<KijiMapReduceJobBuilder>
            +
            +
            +
            Parameters:
            job - The Hadoop MR job. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getRequiredStores

            +
            +protected Map<String,KeyValueStore<?,?>> getRequiredStores()
            +
            +
            Method for job components to declare required KeyValueStore entries (and their default + implementations). +

            +

            +
            Overrides:
            getRequiredStores in class MapReduceJobBuilder<KijiMapReduceJobBuilder>
            +
            +
            + +
            Returns:
            a map of required names to default KeyValueStore implementations to add. These will + be used to augment the existing map if any names are not defined by withStore().
            +
            +
            +
            + +

            +build

            +
            +protected MapReduceJob build(org.apache.hadoop.mapreduce.Job job)
            +
            +
            Wraps a Hadoop MR job in a MapReduceJob. +

            +

            +
            Specified by:
            build in class MapReduceJobBuilder<KijiMapReduceJobBuilder>
            +
            +
            +
            Parameters:
            job - The Hadoop MR job. +
            Returns:
            The built MapReduceJob.
            +
            +
            +
            + +

            +getJobInput

            +
            +protected MapReduceJobInput getJobInput()
            +
            +
            Gets the input to configure the job with. +

            +

            +
            Specified by:
            getJobInput in class MapReduceJobBuilder<KijiMapReduceJobBuilder>
            +
            +
            + +
            Returns:
            The job input.
            +
            +
            +
            + +

            +getMapper

            +
            +protected KijiMapper<?,?,?,?> getMapper()
            +
            +
            Gets an instance of the MapReduce mapper to be used for this job. +

            +

            +
            Specified by:
            getMapper in class MapReduceJobBuilder<KijiMapReduceJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the mapper.
            +
            +
            +
            + +

            +getCombiner

            +
            +protected KijiReducer<?,?,?,?> getCombiner()
            +
            +
            Gets an instance of the MapReduce combiner to be used for this job. +

            +

            +
            Specified by:
            getCombiner in class MapReduceJobBuilder<KijiMapReduceJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the combiner, or null if this job should not use a combiner.
            +
            +
            +
            + +

            +getReducer

            +
            +protected KijiReducer<?,?,?,?> getReducer()
            +
            +
            Gets an instance of the MapReduce reducer to be used for this job. +

            +

            +
            Specified by:
            getReducer in class MapReduceJobBuilder<KijiMapReduceJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the reducer, or null if this job should be map-only.
            +
            +
            +
            + +

            +getJarClass

            +
            +protected Class<?> getJarClass()
            +
            +
            Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks. +

            +

            +
            Specified by:
            getJarClass in class MapReduceJobBuilder<KijiMapReduceJobBuilder>
            +
            +
            + +
            Returns:
            A class contained in the jar to be included on the MR classpath.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiMapper.html new file mode 100644 index 00000000..c2a9a0b6 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiMapper.html @@ -0,0 +1,315 @@ + + + + + + + +KijiMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class KijiMapper<INKEY,INVALUE,OUTKEY,OUTVALUE>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Mapper<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiMapper<INKEY,INVALUE,OUTKEY,OUTVALUE>
+
            +
            +
            Type Parameters:
            INKEY - The type of the input key to the mapper.
            INVALUE - The type of the input value to the mapper.
            OUTKEY - The type of the output key from the mapper.
            OUTVALUE - The type of the output value from the mapper.
            +
            +
            All Implemented Interfaces:
            KVOutputJob
            +
            +
            +
            Direct Known Subclasses:
            BulkImportMapper, KijiTableMapper
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KijiMapper<INKEY,INVALUE,OUTKEY,OUTVALUE>
            extends org.apache.hadoop.mapreduce.Mapper<INKEY,INVALUE,OUTKEY,OUTVALUE>
            implements KVOutputJob
            + + +

            +Base class for Kiji mappers. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Mapper
            org.apache.hadoop.mapreduce.Mapper.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            KijiMapper() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            +static Class<? extends KijiMapper>forName(String className) + +
            +          Loads a KijiMapper class by name.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Mapper
            cleanup, map, run, setup
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KVOutputJob
            getOutputKeyClass, getOutputValueClass
            +  +

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

            +KijiMapper

            +
            +public KijiMapper()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +forName

            +
            +public static Class<? extends KijiMapper> forName(String className)
+                                           throws ClassNotFoundException
            +
            +
            Loads a KijiMapper class by name. +

            +

            +
            +
            +
            +
            Parameters:
            className - Fully qualified name of the class to load. +
            Returns:
            the loaded class. +
            Throws: +
            ClassNotFoundException - if the class is not found. +
            ClassCastException - if the class is not a KijiMapper.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiReducer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiReducer.html new file mode 100644 index 00000000..5474a413 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiReducer.html @@ -0,0 +1,315 @@ + + + + + + + +KijiReducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class KijiReducer<INKEY,INVALUE,OUTKEY,OUTVALUE>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Reducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiReducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
+
            +
            +
            Type Parameters:
            INKEY - The type of the input key to the mapper.
            INVALUE - The type of the input value to the mapper.
            OUTKEY - The type of the output key from the mapper.
            OUTVALUE - The type of the output value from the mapper.
            +
            +
            All Implemented Interfaces:
            KVOutputJob
            +
            +
            +
            Direct Known Subclasses:
            IdentityReducer, KijiTableReducer
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KijiReducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
            extends org.apache.hadoop.mapreduce.Reducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
            implements KVOutputJob
            + + +

            +Base class for Kiji reducer. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Reducer
            org.apache.hadoop.mapreduce.Reducer.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            KijiReducer() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            +static Class<? extends KijiReducer>forName(String className) + +
            +          Loads a KijiReducer class by name.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Reducer
            cleanup, reduce, run, setup
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KVOutputJob
            getOutputKeyClass, getOutputValueClass
            +  +

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

            +KijiReducer

            +
            +public KijiReducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +forName

            +
            +public static Class<? extends KijiReducer> forName(String className)
+                                            throws ClassNotFoundException
            +
            +
            Loads a KijiReducer class by name. +

            +

            +
            +
            +
            +
            Parameters:
            className - Fully qualified name of the class to load. +
            Returns:
            the loaded class. +
            Throws: +
            ClassNotFoundException - if the class is not found. +
            ClassCastException - if the class is not a KijiReducer.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiTableContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiTableContext.html new file mode 100644 index 00000000..d04607de --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiTableContext.html @@ -0,0 +1,261 @@ + + + + + + + +KijiTableContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Interface KijiTableContext

            +
            +
            All Superinterfaces:
            Closeable, Flushable, KijiContext, org.kiji.schema.KijiPutter
            +
            +
            +
            All Known Implementing Classes:
            DirectKijiTableWriterContext, HFileWriterContext
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiTableContext
            extends KijiContext, org.kiji.schema.KijiPutter
            + + +

            +Context for Kiji bulk-importers or reducers to output to a Kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + org.kiji.schema.EntityIdgetEntityId(String kijiRowKey) + +
            +          Creates an entity ID for the specified Kiji row key.
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KijiContext
            getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiPutter
            put, put
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEntityId

            +
            +org.kiji.schema.EntityId getEntityId(String kijiRowKey)
            +
            +
            Creates an entity ID for the specified Kiji row key. +

            +

            +
            +
            +
            +
            Parameters:
            kijiRowKey - Kiji row key. +
            Returns:
            the entity ID for the specified Kiji row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiTableReducer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiTableReducer.html new file mode 100644 index 00000000..9c69e093 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/KijiTableReducer.html @@ -0,0 +1,449 @@ + + + + + + + +KijiTableReducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class KijiTableReducer<K,V>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Reducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiReducer<K,V,HFileKeyValue,org.apache.hadoop.io.NullWritable>
+          extended by org.kiji.mapreduce.KijiTableReducer<K,V>
+
            +
            +
            Type Parameters:
            K - Type of the reducer input key.
            V - Type of the reducer input values.
            +
            +
            All Implemented Interfaces:
            KVOutputJob
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KijiTableReducer<K,V>
            extends KijiReducer<K,V,HFileKeyValue,org.apache.hadoop.io.NullWritable>
            + + +

            +Base class for reducers that emit to a Kiji table. + + Intended to be inherited by users to implement custom reducers writing to Kiji tables. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Reducer
            org.apache.hadoop.mapreduce.Reducer.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            KijiTableReducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup(org.apache.hadoop.mapreduce.Reducer.Context hadoopContext) + +
            +          
            + Class<?>getOutputKeyClass() + +
            +          
            + Class<?>getOutputValueClass() + +
            +          
            +protected abstract  voidreduce(K key, + Iterable<V> values, + KijiTableContext context) + +
            +          Kiji reducer function that processes the values for a key and emits to the output table.
            +protected  voidreduce(K key, + Iterable<V> values, + org.apache.hadoop.mapreduce.Reducer.Context hadoopContext) + +
            +          
            +protected  voidsetup(org.apache.hadoop.mapreduce.Reducer.Context hadoopContext) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiReducer
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Reducer
            run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableReducer

            +
            +public KijiTableReducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setup

            +
            +protected void setup(org.apache.hadoop.mapreduce.Reducer.Context hadoopContext)
+              throws IOException,
+                     InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.apache.hadoop.mapreduce.Reducer<K,V,HFileKeyValue,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +reduce

            +
            +protected final void reduce(K key,
+                            Iterable<V> values,
+                            org.apache.hadoop.mapreduce.Reducer.Context hadoopContext)
+                     throws IOException,
+                            InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            reduce in class org.apache.hadoop.mapreduce.Reducer<K,V,HFileKeyValue,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup(org.apache.hadoop.mapreduce.Reducer.Context hadoopContext)
+                throws IOException,
+                       InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            cleanup in class org.apache.hadoop.mapreduce.Reducer<K,V,HFileKeyValue,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +reduce

            +
            +protected abstract void reduce(K key,
+                               Iterable<V> values,
+                               KijiTableContext context)
+                        throws IOException
            +
            +
            Kiji reducer function that processes the values for a key and emits to the output table. +

            +

            +
            Parameters:
            key - Input key.
            values - Input values.
            context - Context to write to the configured output table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            + +
            Returns:
            the type of keys emitted by this task.
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            + +
            Returns:
            the type of values emitted by this task.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJob.Status.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJob.Status.html new file mode 100644 index 00000000..62cdb34d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJob.Status.html @@ -0,0 +1,298 @@ + + + + + + + +MapReduceJob.Status (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class MapReduceJob.Status

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJob.Status
+
            +
            +
            Enclosing class:
            MapReduceJob
            +
            +
            +
            +
            public static class MapReduceJob.Status
            extends Object
            + + +

            +The status of a job that was started asynchronously using MapReduceJob.submit(). +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected MapReduceJob.Status(org.apache.hadoop.mapreduce.Job job) + +
            +          Constructs a Status around a Hadoop job.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanisComplete() + +
            +          Determines whether the job has completed.
            + booleanisSuccessful() + +
            +          Determines whether the job was successful.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MapReduceJob.Status

            +
            +protected MapReduceJob.Status(org.apache.hadoop.mapreduce.Job job)
            +
            +
            Constructs a Status around a Hadoop job. +

            +

            +
            Parameters:
            job - The Hadoop job being run.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +isComplete

            +
            +public boolean isComplete()
+                   throws IOException
            +
            +
            Determines whether the job has completed. +

            +

            + +
            Returns:
            Whether the job has completed. +
            Throws: +
            IOException - If there is an error querying the job.
            +
            +
            +
            + +

            +isSuccessful

            +
            +public boolean isSuccessful()
+                     throws IOException
            +
            +
            Determines whether the job was successful. The return value is undefined if the + job has not yet completed. +

            +

            + +
            Returns:
            Whether the job was successful. +
            Throws: +
            IOException - If there is an error querying the job.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJob.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJob.html new file mode 100644 index 00000000..9757788f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJob.html @@ -0,0 +1,346 @@ + + + + + + + +MapReduceJob (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class MapReduceJob

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJob
+
            +
            +
            Direct Known Subclasses:
            KijiMapReduceJob
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract class MapReduceJob
            extends Object
            + + +

            +A Hadoop MapReduce job that runs Kiji mappers and reducers. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classMapReduceJob.Status + +
            +          The status of a job that was started asynchronously using submit().
            +  + + + + + + + + + + + +
            +Constructor Summary
            +protected MapReduceJob(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop job to be run.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.apache.hadoop.mapreduce.JobgetHadoopJob() + +
            +          Gives access the underlying Hadoop Job object.
            + booleanrun() + +
            +          Runs the job (blocks until it is complete).
            + MapReduceJob.Statussubmit() + +
            +          Starts the job and return immediately.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MapReduceJob

            +
            +protected MapReduceJob(org.apache.hadoop.mapreduce.Job job)
            +
            +
            Wraps a Hadoop job to be run. +

            +

            +
            Parameters:
            job - The Hadoop job to be run.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHadoopJob

            +
            +public org.apache.hadoop.mapreduce.Job getHadoopJob()
            +
            +
            Gives access the underlying Hadoop Job object. +

            +

            + +
            Returns:
            The Hadoop Job object.
            +
            +
            +
            + +

            +submit

            +
            +public MapReduceJob.Status submit()
+                           throws ClassNotFoundException,
+                                  IOException,
+                                  InterruptedException
            +
            +
            Starts the job and return immediately. +

            +

            + +
            Returns:
            The job status. This can be queried for completion and success or failure. +
            Throws: +
            ClassNotFoundException - If a required class cannot be found on the classpath. +
            IOException - If there is an IO error. +
            InterruptedException - If the thread is interrupted.
            +
            +
            +
            + +

            +run

            +
            +public boolean run()
+            throws ClassNotFoundException,
+                   IOException,
+                   InterruptedException
            +
            +
            Runs the job (blocks until it is complete). +

            +

            + +
            Returns:
            Whether the job was successful. +
            Throws: +
            ClassNotFoundException - If a required class cannot be found on the classpath. +
            IOException - If there is an IO error. +
            InterruptedException - If the thread is interrupted.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJobInput.html new file mode 100644 index 00000000..0d38339f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJobInput.html @@ -0,0 +1,313 @@ + + + + + + + +MapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class MapReduceJobInput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobInput
+
            +
            +
            Direct Known Subclasses:
            FileMapReduceJobInput, HTableMapReduceJobInput, KijiTableMapReduceJobInput
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract class MapReduceJobInput
            extends Object
            + + +

            +Base class for types of input to a MapReduce job. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            MapReduceJobInput() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidconfigure(org.apache.hadoop.mapreduce.Job job) + +
            +          Configure a job to use this type of input for the MapReduce.
            +protected abstract  Class<? extends org.apache.hadoop.mapreduce.InputFormat>getInputFormatClass() + +
            +          Returns the class to use for this MapReduce input format type.
            +abstract  voidinitialize(Map<String,String> params) + +
            +          Initializes the job input with the given parameters.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MapReduceJobInput

            +
            +public MapReduceJobInput()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public abstract void initialize(Map<String,String> params)
+                         throws IOException
            +
            +
            Initializes the job input with the given parameters. +

            +

            +
            Parameters:
            params - Parameters, usually parsed from the command-line. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +configure

            +
            +public void configure(org.apache.hadoop.mapreduce.Job job)
+               throws IOException
            +
            +
            Configure a job to use this type of input for the MapReduce. +

            +

            +
            Parameters:
            job - The job to configure with input. +
            Throws: +
            IOException - If there is an error during configuration.
            +
            +
            +
            + +

            +getInputFormatClass

            +
            +protected abstract Class<? extends org.apache.hadoop.mapreduce.InputFormat> getInputFormatClass()
            +
            +
            Returns the class to use for this MapReduce input format type. +

            +

            + +
            Returns:
            The MR input format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJobOutput.html new file mode 100644 index 00000000..fa40d164 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/MapReduceJobOutput.html @@ -0,0 +1,313 @@ + + + + + + + +MapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce +
            +Class MapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+
            +
            +
            Direct Known Subclasses:
            FileMapReduceJobOutput, HFileReducerMapReduceJobOutput, KijiTableMapReduceJobOutput
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract class MapReduceJobOutput
            extends Object
            + + +

            +Describe class MapReduceJobOutput here. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            MapReduceJobOutput() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidconfigure(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the output for a MapReduce job.
            +protected abstract  Class<? extends org.apache.hadoop.mapreduce.OutputFormat>getOutputFormatClass() + +
            +          Gets the Hadoop MapReduce output format class.
            +abstract  voidinitialize(Map<String,String> params) + +
            +          Initializes the job output from command-line parameters.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MapReduceJobOutput

            +
            +public MapReduceJobOutput()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public abstract void initialize(Map<String,String> params)
+                         throws IOException
            +
            +
            Initializes the job output from command-line parameters. +

            +

            +
            Parameters:
            params - Initialization parameters. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +configure

            +
            +public void configure(org.apache.hadoop.mapreduce.Job job)
+               throws IOException
            +
            +
            Configures the output for a MapReduce job. +

            +

            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getOutputFormatClass

            +
            +protected abstract Class<? extends org.apache.hadoop.mapreduce.OutputFormat> getOutputFormatClass()
            +
            +
            Gets the Hadoop MapReduce output format class. +

            +

            + +
            Returns:
            The job output format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroKeyReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroKeyReader.html new file mode 100644 index 00000000..412a6f14 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroKeyReader.html @@ -0,0 +1,226 @@ + + + + + + + +AvroKeyReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.avro +
            +Interface AvroKeyReader

            +
            +
            All Known Implementing Classes:
            AvroBulkImporter, BulkImportMapper
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface AvroKeyReader
            + + +

            +Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that read + AvroKey objects are required to implement this interface + as a means of specifying the Avro reader schema for their input key data. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + org.apache.avro.SchemagetAvroKeyReaderSchema() + +
            +          If the input key class is AvroKey, this method + returns the Avro reader schema of the wrapped datum; otherwise null.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getAvroKeyReaderSchema

            +
            +org.apache.avro.Schema getAvroKeyReaderSchema()
+                                              throws IOException
            +
            +
            If the input key class is AvroKey, this method + returns the Avro reader schema of the wrapped datum; otherwise null. +

            +

            + +
            Returns:
            The Avro reader schema of the datum wrapped in the AvroKey input. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroKeyWriter.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroKeyWriter.html new file mode 100644 index 00000000..7998d572 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroKeyWriter.html @@ -0,0 +1,229 @@ + + + + + + + +AvroKeyWriter (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.avro +
            +Interface AvroKeyWriter

            +
            +
            All Known Implementing Classes:
            GatherMapper, IdentityReducer
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface AvroKeyWriter
            + + +

            +Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that output + AvroKey objects are required to implement this interface + as a means of specifying the Avro writer schema for their output key data. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + org.apache.avro.SchemagetAvroKeyWriterSchema() + +
            +          If the output key class is AvroKey, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getAvroKeyWriterSchema

            +
            +org.apache.avro.Schema getAvroKeyWriterSchema()
+                                              throws IOException
            +
            +
            If the output key class is AvroKey, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. + +

            If this class does not use an AvroKey as its output key class, the return value from + this method will not be used. It may be null.

            +

            +

            + +
            Returns:
            The Avro schema of the datum wrapped in the AvroKey output. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroMapReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroMapReader.html new file mode 100644 index 00000000..13a86550 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroMapReader.html @@ -0,0 +1,643 @@ + + + + + + + +AvroMapReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.avro +
            +Class AvroMapReader<V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.avro.AvroMapReader<V>
+
            +
            +
            Type Parameters:
            V - The map's value type.
            +
            +
            All Implemented Interfaces:
            Map<CharSequence,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class AvroMapReader<V>
            extends Object
            implements Map<CharSequence,V>
            + + +

            +A reader for Avro "map" data. + +

            Avro "map" types are implemented in Java as Map, where the keys + are CharSequence. Since CharSequence does not refine + the general contracts of equals() and hashCode() methods, + this unfortunately means that testing for the existence of a key in an Avro map is not + possible. In particular, if you test for the existence of a String key + "foo" in a map deserialized using Avro, its underyling + HashMap implementation will not match your "foo" hash code to + its underlying Utf8("foo")'s hash code.

            + +

            A possible workaround would be to always use Utf8 objects whenever + working with Avro maps. However, this is not possible when writing framework code like + Kiji. Clients must be free to use any CharSequence implementation of + their choosing.

            + +

            Until this issue is resolved in Avro, use this class to read from Avro "map" + types. This is a read-only map. Calling a method that would mutate the map will throw + an UnsupportedOperationException. If the underlying Avro "map" is + mutated, you should call read() to reread the map. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface java.util.Map
            Map.Entry<K,V>
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclear() + +
            +          
            + booleancontainsKey(Object key) + +
            +          
            + booleancontainsValue(Object value) + +
            +          
            +static + + + + +
            +<V> AvroMapReader<V>
            +            		create(Map<CharSequence,V> map) + +
            +          Creates a new Avro map reader wrapping a map generated by the Avro framework.
            + Set<Map.Entry<CharSequence,V>>entrySet() + +
            +          
            + booleanequals(Object o) + +
            +          
            + Vget(Object key) + +
            +          
            + inthashCode() + +
            +          
            + booleanisEmpty() + +
            +          
            + Set<CharSequence>keySet() + +
            +          
            + Vput(CharSequence key, + V value) + +
            +          
            + voidputAll(Map<? extends CharSequence,? extends V> m) + +
            +          
            + voidread() + +
            +          Reads the wrapped Avro map into a Map with a comparator for CharSequences.
            + Vremove(Object key) + +
            +          
            + intsize() + +
            +          
            + Collection<V>values() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static <V> AvroMapReader<V> create(Map<CharSequence,V> map)
            +
            +
            Creates a new Avro map reader wrapping a map generated by the Avro framework. +

            +

            +
            +
            +
            +
            Type Parameters:
            V - The type of the values contained in the map.
            Parameters:
            map - The map obtained from the Avro framework that should be wrapped. +
            Returns:
            A new Avro map reader wrapping the specified map.
            +
            +
            +
            + +

            +read

            +
            +public void read()
            +
            +
            Reads the wrapped Avro map into a Map with a comparator for CharSequences. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clear

            +
            +public void clear()
            +
            +
            +

            +

            +
            Specified by:
            clear in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +containsKey

            +
            +public boolean containsKey(Object key)
            +
            +
            +

            +

            +
            Specified by:
            containsKey in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +containsValue

            +
            +public boolean containsValue(Object value)
            +
            +
            +

            +

            +
            Specified by:
            containsValue in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +entrySet

            +
            +public Set<Map.Entry<CharSequence,V>> entrySet()
            +
            +
            +

            +

            +
            Specified by:
            entrySet in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object o)
            +
            +
            +

            +

            +
            Specified by:
            equals in interface Map<CharSequence,V>
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public V get(Object key)
            +
            +
            +

            +

            +
            Specified by:
            get in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Specified by:
            hashCode in interface Map<CharSequence,V>
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +isEmpty

            +
            +public boolean isEmpty()
            +
            +
            +

            +

            +
            Specified by:
            isEmpty in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +keySet

            +
            +public Set<CharSequence> keySet()
            +
            +
            +

            +

            +
            Specified by:
            keySet in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public V put(CharSequence key,
+             V value)
            +
            +
            +

            +

            +
            Specified by:
            put in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +putAll

            +
            +public void putAll(Map<? extends CharSequence,? extends V> m)
            +
            +
            +

            +

            +
            Specified by:
            putAll in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +remove

            +
            +public V remove(Object key)
            +
            +
            +

            +

            +
            Specified by:
            remove in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +size

            +
            +public int size()
            +
            +
            +

            +

            +
            Specified by:
            size in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            +
            + +

            +values

            +
            +public Collection<V> values()
            +
            +
            +

            +

            +
            Specified by:
            values in interface Map<CharSequence,V>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroValueReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroValueReader.html new file mode 100644 index 00000000..dbb93ba8 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroValueReader.html @@ -0,0 +1,226 @@ + + + + + + + +AvroValueReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.avro +
            +Interface AvroValueReader

            +
            +
            All Known Implementing Classes:
            BulkImportMapper
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface AvroValueReader
            + + +

            +Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that read + AvroValue objects are required to implement this interface + as a means of specifying the Avro reader schema for their input value data. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + org.apache.avro.SchemagetAvroValueReaderSchema() + +
            +          If the input value class is AvroValue, this method + returns the Avro reader schema of the wrapped datum; otherwise null.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getAvroValueReaderSchema

            +
            +org.apache.avro.Schema getAvroValueReaderSchema()
+                                                throws IOException
            +
            +
            If the input value class is AvroValue, this method + returns the Avro reader schema of the wrapped datum; otherwise null. +

            +

            + +
            Returns:
            The Avro reader schema of the datum wrapped in the AvroValue input. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroValueWriter.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroValueWriter.html new file mode 100644 index 00000000..1201c407 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/AvroValueWriter.html @@ -0,0 +1,229 @@ + + + + + + + +AvroValueWriter (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.avro +
            +Interface AvroValueWriter

            +
            +
            All Known Implementing Classes:
            GatherMapper, IdentityReducer
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface AvroValueWriter
            + + +

            +Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that output + AvroValue objects are required to implement this interface + as a means of specifying the Avro writer schema for their output value data. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + org.apache.avro.SchemagetAvroValueWriterSchema() + +
            +          If the output key class is AvroValue, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getAvroValueWriterSchema

            +
            +org.apache.avro.Schema getAvroValueWriterSchema()
+                                                throws IOException
            +
            +
            If the output key class is AvroValue, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. + +

            If this class does not use an AvroKey as its output key class, the return value from + this method will not be used. It may be null.

            +

            +

            + +
            Returns:
            The Avro schema of the datum wrapped in the AvroValue output. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroKeyReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroKeyReader.html new file mode 100644 index 00000000..ec770c88 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroKeyReader.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.avro.AvroKeyReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.avro.AvroKeyReader

            +
            + + + + + + + + + + + + + +
            +Packages that use AvroKeyReader
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers. 
            +  +

            + + + + + +
            +Uses of AvroKeyReader in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.bulkimport that implement AvroKeyReader
            + classAvroBulkImporter<T> + +
            +          Base class for Kiji bulk importers that process Avro container + files.
            +  +

            + + + + + +
            +Uses of AvroKeyReader in org.kiji.mapreduce.bulkimport.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.bulkimport.impl that implement AvroKeyReader
            + classBulkImportMapper<K,V> + +
            +          Hadoop mapper that runs a KijiBulkImporter.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroKeyWriter.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroKeyWriter.html new file mode 100644 index 00000000..9bebb52e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroKeyWriter.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.avro.AvroKeyWriter (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.avro.AvroKeyWriter

            +
            + + + + + + + + + + + + + +
            +Packages that use AvroKeyWriter
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.reducerBasic identity reducer which is required for KijiMR jobs. 
            +  +

            + + + + + +
            +Uses of AvroKeyWriter in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.gather.impl that implement AvroKeyWriter
            + classGatherMapper<K,V> + +
            +          Mapper that executes a gatherer over the rows of a Kiji table.
            +  +

            + + + + + +
            +Uses of AvroKeyWriter in org.kiji.mapreduce.reducer
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.reducer that implement AvroKeyWriter
            + classIdentityReducer<K,V> + +
            +          This MapReduce reducer will pass through all of the input key-value + pairs unchanged.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroMapReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroMapReader.html new file mode 100644 index 00000000..c5bcaba0 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroMapReader.html @@ -0,0 +1,188 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.avro.AvroMapReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.avro.AvroMapReader

            +
            + + + + + + + + + +
            +Packages that use AvroMapReader
            org.kiji.mapreduce.avroAvro interfaces for KijiMR. 
            +  +

            + + + + + +
            +Uses of AvroMapReader in org.kiji.mapreduce.avro
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.avro that return AvroMapReader
            +static + + + + +
            +<V> AvroMapReader<V>
            +            		AvroMapReader.create(Map<CharSequence,V> map) + +
            +          Creates a new Avro map reader wrapping a map generated by the Avro framework.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroValueReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroValueReader.html new file mode 100644 index 00000000..b4dfbfdd --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroValueReader.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.avro.AvroValueReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.avro.AvroValueReader

            +
            + + + + + + + + + +
            +Packages that use AvroValueReader
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers. 
            +  +

            + + + + + +
            +Uses of AvroValueReader in org.kiji.mapreduce.bulkimport.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.bulkimport.impl that implement AvroValueReader
            + classBulkImportMapper<K,V> + +
            +          Hadoop mapper that runs a KijiBulkImporter.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroValueWriter.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroValueWriter.html new file mode 100644 index 00000000..3caa30dd --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/class-use/AvroValueWriter.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.avro.AvroValueWriter (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.avro.AvroValueWriter

            +
            + + + + + + + + + + + + + +
            +Packages that use AvroValueWriter
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.reducerBasic identity reducer which is required for KijiMR jobs. 
            +  +

            + + + + + +
            +Uses of AvroValueWriter in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.gather.impl that implement AvroValueWriter
            + classGatherMapper<K,V> + +
            +          Mapper that executes a gatherer over the rows of a Kiji table.
            +  +

            + + + + + +
            +Uses of AvroValueWriter in org.kiji.mapreduce.reducer
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.reducer that implement AvroValueWriter
            + classIdentityReducer<K,V> + +
            +          This MapReduce reducer will pass through all of the input key-value + pairs unchanged.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-frame.html new file mode 100644 index 00000000..cebf830c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-frame.html @@ -0,0 +1,50 @@ + + + + + + + +org.kiji.mapreduce.avro (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.avro + + + + +
            +Interfaces  + +
            +AvroKeyReader +
            +AvroKeyWriter +
            +AvroValueReader +
            +AvroValueWriter
            + + + + + + +
            +Classes  + +
            +AvroMapReader
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-summary.html new file mode 100644 index 00000000..0b14f05e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-summary.html @@ -0,0 +1,210 @@ + + + + + + + +org.kiji.mapreduce.avro (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.avro +

            +Avro interfaces for KijiMR. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + +
            +Interface Summary
            AvroKeyReaderKiji analytic functions (mappers, reducers, producer, gatherers, etc.) that read + AvroKey objects are required to implement this interface + as a means of specifying the Avro reader schema for their input key data.
            AvroKeyWriterKiji analytic functions (mappers, reducers, producer, gatherers, etc.) that output + AvroKey objects are required to implement this interface + as a means of specifying the Avro writer schema for their output key data.
            AvroValueReaderKiji analytic functions (mappers, reducers, producer, gatherers, etc.) that read + AvroValue objects are required to implement this interface + as a means of specifying the Avro reader schema for their input value data.
            AvroValueWriterKiji analytic functions (mappers, reducers, producer, gatherers, etc.) that output + AvroValue objects are required to implement this interface + as a means of specifying the Avro writer schema for their output value data.
            +  + +

            + + + + + + + + + +
            +Class Summary
            AvroMapReader<V>A reader for Avro "map" data.
            +  + +

            +

            +Package org.kiji.mapreduce.avro Description +

            + +

            +Avro interfaces for KijiMR. + + This package is mainly comprised of interfaces that expose avro schemas associated with the + input or output of the implementing class. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-tree.html new file mode 100644 index 00000000..fb81bb38 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.mapreduce.avro Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.avro +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-use.html new file mode 100644 index 00000000..045f3f65 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/avro/package-use.html @@ -0,0 +1,279 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.avro (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.avro

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.avro
            org.kiji.mapreduce.avroAvro interfaces for KijiMR. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers. 
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.reducerBasic identity reducer which is required for KijiMR jobs. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.avro used by org.kiji.mapreduce.avro
            AvroMapReader + +
            +          A reader for Avro "map" data.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.avro used by org.kiji.mapreduce.bulkimport
            AvroKeyReader + +
            +          Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that read + AvroKey objects are required to implement this interface + as a means of specifying the Avro reader schema for their input key data.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.avro used by org.kiji.mapreduce.bulkimport.impl
            AvroKeyReader + +
            +          Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that read + AvroKey objects are required to implement this interface + as a means of specifying the Avro reader schema for their input key data.
            AvroValueReader + +
            +          Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that read + AvroValue objects are required to implement this interface + as a means of specifying the Avro reader schema for their input value data.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.avro used by org.kiji.mapreduce.gather.impl
            AvroKeyWriter + +
            +          Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that output + AvroKey objects are required to implement this interface + as a means of specifying the Avro writer schema for their output key data.
            AvroValueWriter + +
            +          Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that output + AvroValue objects are required to implement this interface + as a means of specifying the Avro writer schema for their output value data.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.avro used by org.kiji.mapreduce.reducer
            AvroKeyWriter + +
            +          Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that output + AvroKey objects are required to implement this interface + as a means of specifying the Avro writer schema for their output key data.
            AvroValueWriter + +
            +          Kiji analytic functions (mappers, reducers, producer, gatherers, etc.) that output + AvroValue objects are required to implement this interface + as a means of specifying the Avro writer schema for their output value data.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/AvroBulkImporter.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/AvroBulkImporter.html new file mode 100644 index 00000000..cb12a6e4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/AvroBulkImporter.html @@ -0,0 +1,356 @@ + + + + + + + +AvroBulkImporter (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.bulkimport +
            +Class AvroBulkImporter<T>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.avro.mapred.AvroKey<T>,org.apache.hadoop.io.NullWritable>
+      extended by org.kiji.mapreduce.bulkimport.AvroBulkImporter<T>
+
            +
            +
            Type Parameters:
            T - The type of the Avro data to be processed.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, AvroKeyReader, KeyValueStoreClient
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class AvroBulkImporter<T>
            extends KijiBulkImporter<org.apache.avro.mapred.AvroKey<T>,org.apache.hadoop.io.NullWritable>
            implements AvroKeyReader
            + + +

            +Base class for Kiji bulk importers that process Avro container + files. You may extend this class to be used as the --importer flag + when you have specified an --input flag of + avro:<filename> in your kiji + bulk-import command. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            AvroBulkImporter() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.apache.avro.SchemagetAvroKeyReaderSchema() + +
            +          Specifies the expected reader schema for the input data.
            + voidproduce(org.apache.avro.mapred.AvroKey<T> key, + org.apache.hadoop.io.NullWritable ignore, + KijiTableContext context) + +
            +          Produces data to be imported into Kiji.
            +protected abstract  voidproduce(T datum, + KijiTableContext context) + +
            +          Process an Avro datum from the input container file to produce + Kiji output.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.bulkimport.KijiBulkImporter
            cleanup, forName, getConf, getRequiredStores, setConf, setup
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroBulkImporter

            +
            +public AvroBulkImporter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +produce

            +
            +public void produce(org.apache.avro.mapred.AvroKey<T> key,
+                    org.apache.hadoop.io.NullWritable ignore,
+                    KijiTableContext context)
+             throws IOException
            +
            +
            Description copied from class: KijiBulkImporter
            +
            Produces data to be imported into Kiji. +

            +

            +
            Specified by:
            produce in class KijiBulkImporter<org.apache.avro.mapred.AvroKey<T>,org.apache.hadoop.io.NullWritable>
            +
            +
            +
            Parameters:
            key - The MapReduce input key (its type depends on the InputFormat you use).
            ignore - The MapReduce input value (its type depends on the InputFormat you use).
            context - A context you can use to generate EntityIds and commit writes. + See KijiTableContext.getEntityId(String). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +produce

            +
            +protected abstract void produce(T datum,
+                                KijiTableContext context)
+                         throws IOException
            +
            +
            Process an Avro datum from the input container file to produce + Kiji output. +

            +

            +
            +
            +
            +
            Parameters:
            datum - An Avro datum from the input file.
            context - A context which can be used to write Kiji data. + data should not be written for this input record. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getAvroKeyReaderSchema

            +
            +public org.apache.avro.Schema getAvroKeyReaderSchema()
+                                              throws IOException
            +
            +
            Specifies the expected reader schema for the input data. By default, this + returns null, meaning that it will accept as input any writer schema + encountered in the input. Clients expecting homogenous input elements + (e.g., those using Avro specific record classes) should specify their + schema here. +

            +

            +
            Specified by:
            getAvroKeyReaderSchema in interface AvroKeyReader
            +
            +
            + +
            Returns:
            The input avro schema. +
            Throws: +
            IOException - If there is an error determining the schema.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/BinaryHTableBulkImporter.ColumnDescriptor.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/BinaryHTableBulkImporter.ColumnDescriptor.html new file mode 100644 index 00000000..71aeb304 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/BinaryHTableBulkImporter.ColumnDescriptor.html @@ -0,0 +1,390 @@ + + + + + + + +BinaryHTableBulkImporter.ColumnDescriptor (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.bulkimport +
            +Class BinaryHTableBulkImporter.ColumnDescriptor

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter.ColumnDescriptor
+
            +
            +
            Enclosing class:
            BinaryHTableBulkImporter
            +
            +
            +
            +
            protected static class BinaryHTableBulkImporter.ColumnDescriptor
            extends Object
            + + +

            +Describes an input HTable column, its type, and a the target column in a Kiji table + it should be imported into. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            BinaryHTableBulkImporter.ColumnDescriptor(String hbaseFamily, + String hbaseQualifier, + String hbaseType, + org.kiji.schema.KijiColumnName kijiColumnName) + +
            +          Creates a new ColumnDescriptor instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidaddToScan(org.apache.hadoop.hbase.client.Scan scan) + +
            +          Adds a request for the HBase column to the scan descriptor.
            + byte[]getHBaseFamilyBytes() + +
            +          Gets the input HBase column family.
            + byte[]getHBaseQualifierBytes() + +
            +          Gets the input HBase column qualifier.
            + org.kiji.schema.KijiColumnNamegetKijiColumnName() + +
            +          Gets the name of the target Kiji column.
            + StringgetType() + +
            +          Gets the type of the HBase column, used to determine how to decode the cell's bytes.
            +static BinaryHTableBulkImporter.ColumnDescriptorparse(String input) + +
            +          Parses an input string into a ColumnDescriptor.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +BinaryHTableBulkImporter.ColumnDescriptor

            +
            +public BinaryHTableBulkImporter.ColumnDescriptor(String hbaseFamily,
+                                                 String hbaseQualifier,
+                                                 String hbaseType,
+                                                 org.kiji.schema.KijiColumnName kijiColumnName)
            +
            +
            Creates a new ColumnDescriptor instance. +

            +

            +
            Parameters:
            hbaseFamily - The input HBase column family.
            hbaseQualifier - The input HBase column qualifier.
            hbaseType - The type of the HBase column (used to determine how to decode the bytes).
            kijiColumnName - The name of the target Kiji column.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseFamilyBytes

            +
            +public byte[] getHBaseFamilyBytes()
            +
            +
            Gets the input HBase column family. +

            +

            + +
            Returns:
            The input HBase column family.
            +
            +
            +
            + +

            +getHBaseQualifierBytes

            +
            +public byte[] getHBaseQualifierBytes()
            +
            +
            Gets the input HBase column qualifier. +

            +

            + +
            Returns:
            The input HBase column qualifier.
            +
            +
            +
            + +

            +getType

            +
            +public String getType()
            +
            +
            Gets the type of the HBase column, used to determine how to decode the cell's bytes. +

            +

            + +
            Returns:
            The type of the HBase column.
            +
            +
            +
            + +

            +getKijiColumnName

            +
            +public org.kiji.schema.KijiColumnName getKijiColumnName()
            +
            +
            Gets the name of the target Kiji column. +

            +

            + +
            Returns:
            The name of the target Kiji column.
            +
            +
            +
            + +

            +addToScan

            +
            +public void addToScan(org.apache.hadoop.hbase.client.Scan scan)
            +
            +
            Adds a request for the HBase column to the scan descriptor. +

            +

            +
            Parameters:
            scan - The scan to add the request to.
            +
            +
            +
            + +

            +parse

            +
            +public static BinaryHTableBulkImporter.ColumnDescriptor parse(String input)
+                                                       throws IOException
            +
            +
            Parses an input string into a ColumnDescriptor. + +

            The input string must be formatted as:

            + + hbase-family:hbase-qualifier:hbase-type:kiji-family:kiji-qualifier +

            +

            +
            Parameters:
            input - The input string. +
            Returns:
            A parsed ColumnDescriptor. +
            Throws: +
            IOException - If the input string cannot be parsed.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/BinaryHTableBulkImporter.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/BinaryHTableBulkImporter.html new file mode 100644 index 00000000..63a80027 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/BinaryHTableBulkImporter.html @@ -0,0 +1,541 @@ + + + + + + + +BinaryHTableBulkImporter (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.bulkimport +
            +Class BinaryHTableBulkImporter

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.bulkimport.KijiBulkImporter<org.apache.hadoop.hbase.io.ImmutableBytesWritable,org.apache.hadoop.hbase.client.Result>
+      extended by org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, HTableReader, KeyValueStoreClient
            +
            +
            +
            +
            @ApiAudience.Public
+public final class BinaryHTableBulkImporter
            extends KijiBulkImporter<org.apache.hadoop.hbase.io.ImmutableBytesWritable,org.apache.hadoop.hbase.client.Result>
            implements HTableReader
            + + +

            +A bulk importer that reads columns from an HTable that were encoded using the Bytes utility class. + +

            You may extend this class to be used as the --importer flag when you have specified + an --input flag of htable:<tablename> in your kiji + bulk-import command.

            + +

            Concrete subclass must implement:

            +
              +
            • getOutputColumn() - Specify the target column in the Kiji table.
              • +
            • getInputHTableScan() - The Scan descriptor describing the rows/columns you wish + to read from the HTable.
              • +
            +

            Since HTable columns have no concept of schemas or types, this importer requires you + specify the type of encoding that was used for each input HTable column. Any primitive + types supported by the HBase Bytes utility class may be used here:

            + + + + + + + + + + + +
            HBase input-typeAvro schemaDecoding method
            boolean"boolean"Bytes.toBoolean(byte[])
            bytes"bytes"none
            double"double"Bytes.toDouble(byte[])
            float"float"Bytes.toFloat(byte[])
            int"int"Bytes.toInt(byte[])
            long"long"Bytes.toLong(byte[])
            short"int"Bytes.toShort(byte[])
            string"string"Bytes.toString(byte[])
            + +

            The most recent version of each input column (hbase-column) will be + decoded using the input type (input-type) and stored into a target Kiji + column (kiji-column) using the same timestamp as the HBase cell.

            + +

            The configuration variable binary.htable.importer.columns should + contain a comma-separated list of column-descriptors:

            + +

            + hbase-column:input-type:kiji-column +

            + +

            For example, to run a bulk import job that reads a string from the + i:name column and an integer from the i:id column of an HBase + table mytable into the info:name and info:id + columns of a Kiji table kijitable:

            + + 
            + $ kiji bulk-import \
+ >   -D binary.htable.importer.columns=i:name:string:info:name,i:id:int:info:id \
+ >   --importer=com.kijidata.core.client.lib.bulkimport.BinaryHTableBulkImporter \
+ >   --input=htable:mytable \
+ >   --table=kijitable
+
            + +

            Note: Like all bulk importers, only one column family may be targeted at a time. To + import into multiple column families, run the importer once per target family.

            + +

            To support alternative methods of decoding HTable cells into typed Kiji cells, this + class may be extended. Subclasses may override the decodeHBaseCell() + method to customize how HBase cells are converted to Kiji cells.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +protected static classBinaryHTableBulkImporter.ColumnDescriptor + +
            +          Describes an input HTable column, its type, and a the target column in a Kiji table + it should be imported into.
            +  + + + + + + + + + + +
            +Field Summary
            +static StringCONF_COLUMN_DESCRIPTORS + +
            +          The configuration variable listing the input/output columns and their types.
            +  + + + + + + + + + + +
            +Constructor Summary
            BinaryHTableBulkImporter() + +
            +          Constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  org.kiji.schema.DecodedCell<?>decodeHBaseCell(BinaryHTableBulkImporter.ColumnDescriptor columnDescriptor, + byte[] hbaseCell) + +
            +          Converts the contents of an HBase cell into a typed Kiji cell.
            + org.apache.hadoop.hbase.client.ScangetInputHTableScan(org.apache.hadoop.conf.Configuration conf) + +
            +          Returns an HBase scan descriptor that specifies what subset of rows and cells should + be read from the input HTable.
            + voidproduce(org.apache.hadoop.hbase.io.ImmutableBytesWritable hbaseRowKey, + org.apache.hadoop.hbase.client.Result hbaseRow, + KijiTableContext context) + +
            +          Produces data to be imported into Kiji.
            +protected  voidsetColumnDescriptors(String[] columnDescriptors) + +
            +          Sets the column descriptors.
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          Initializes this object's state using the settings from the configuration.
            + voidsetup(KijiTableContext context) + +
            +          Called once to initialize this producer before any calls to + KijiBulkImporter.produce(Object, Object, org.kiji.mapreduce.KijiTableContext).
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.bulkimport.KijiBulkImporter
            cleanup, forName, getConf, getRequiredStores
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +CONF_COLUMN_DESCRIPTORS

            +
            +public static final String CONF_COLUMN_DESCRIPTORS
            +
            +
            The configuration variable listing the input/output columns and their types. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +BinaryHTableBulkImporter

            +
            +public BinaryHTableBulkImporter()
            +
            +
            Constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getInputHTableScan

            +
            +public org.apache.hadoop.hbase.client.Scan getInputHTableScan(org.apache.hadoop.conf.Configuration conf)
+                                                       throws IOException
            +
            +
            Returns an HBase scan descriptor that specifies what subset of rows and cells should + be read from the input HTable. + +

            This method may return null, meaning that this instance is not really able to read + from an HTable.

            +

            +

            +
            Specified by:
            getInputHTableScan in interface HTableReader
            +
            +
            +
            Parameters:
            conf - The job configuration. +
            Returns:
            A new scan descriptor. +
            Throws: +
            IOException - If the scan descriptor cannot be constructed.
            +
            +
            +
            + +

            +setup

            +
            +public void setup(KijiTableContext context)
+           throws IOException
            +
            +
            Called once to initialize this producer before any calls to + KijiBulkImporter.produce(Object, Object, org.kiji.mapreduce.KijiTableContext). +

            +

            +
            Overrides:
            setup in class KijiBulkImporter<org.apache.hadoop.hbase.io.ImmutableBytesWritable,org.apache.hadoop.hbase.client.Result>
            +
            +
            +
            Parameters:
            context - A context you can use to generate EntityIds and commit writes. + See KijiTableContext.getEntityId(String). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +produce

            +
            +public void produce(org.apache.hadoop.hbase.io.ImmutableBytesWritable hbaseRowKey,
+                    org.apache.hadoop.hbase.client.Result hbaseRow,
+                    KijiTableContext context)
+             throws IOException
            +
            +
            Produces data to be imported into Kiji. +

            +

            +
            Specified by:
            produce in class KijiBulkImporter<org.apache.hadoop.hbase.io.ImmutableBytesWritable,org.apache.hadoop.hbase.client.Result>
            +
            +
            +
            Parameters:
            hbaseRowKey - The MapReduce input key (its type depends on the InputFormat you use).
            hbaseRow - The MapReduce input value (its type depends on the InputFormat you use).
            context - A context you can use to generate EntityIds and commit writes. + See KijiTableContext.getEntityId(String). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Initializes this object's state using the settings from the configuration. + Throws a RuntimeException if there is an error. +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            Overrides:
            setConf in class KijiBulkImporter<org.apache.hadoop.hbase.io.ImmutableBytesWritable,org.apache.hadoop.hbase.client.Result>
            +
            +
            +
            Parameters:
            conf - The configuration to read settings from.
            +
            +
            +
            + +

            +setColumnDescriptors

            +
            +protected void setColumnDescriptors(String[] columnDescriptors)
            +
            +
            Sets the column descriptors. +

            +

            +
            +
            +
            +
            Parameters:
            columnDescriptors - The list of descriptors.
            +
            +
            +
            + +

            +decodeHBaseCell

            +
            +protected org.kiji.schema.DecodedCell<?> decodeHBaseCell(BinaryHTableBulkImporter.ColumnDescriptor columnDescriptor,
+                                                         byte[] hbaseCell)
+                                                  throws IOException
            +
            +
            Converts the contents of an HBase cell into a typed Kiji cell. +

            +

            +
            +
            +
            +
            Parameters:
            columnDescriptor - Describes the HBase column the cell came from.
            hbaseCell - The bytes of the HBase cell to be converted. +
            Returns:
            A kiji cell to be imported. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/KijiBulkImportJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/KijiBulkImportJobBuilder.html new file mode 100644 index 00000000..b7d79343 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/KijiBulkImportJobBuilder.html @@ -0,0 +1,563 @@ + + + + + + + +KijiBulkImportJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.bulkimport +
            +Class KijiBulkImportJobBuilder

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.framework.MapReduceJobBuilder<KijiBulkImportJobBuilder>
+      extended by org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiBulkImportJobBuilder
            extends MapReduceJobBuilder<KijiBulkImportJobBuilder>
            + + +

            +Builds a job that runs a KijiBulkImporter to import data into a Kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  MapReduceJobbuild(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop MR job in a MapReduceJob.
            +protected  voidconfigureJob(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures a Hadoop MR job.
            +protected  voidconfigureJobForHFileOutput(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the job settings specific to writing HFiles.
            +static KijiBulkImportJobBuildercreate() + +
            +          Creates a new builder for Kiji bulk import jobs.
            +protected  KijiReducer<?,?,?,?>getCombiner() + +
            +          Gets an instance of the MapReduce combiner to be used for this job.
            +protected  Class<?>getJarClass() + +
            +          Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks.
            +protected  MapReduceJobInputgetJobInput() + +
            +          Gets the input to configure the job with.
            +protected  KijiMapper<?,?,?,?>getMapper() + +
            +          Gets an instance of the MapReduce mapper to be used for this job.
            +protected  KijiReducer<?,?,?,?>getReducer() + +
            +          Gets an instance of the MapReduce reducer to be used for this job.
            +protected  Map<String,KeyValueStore<?,?>>getRequiredStores() + +
            +          Method for job components to declare required KeyValueStore entries (and their default + implementations).
            + KijiBulkImportJobBuilderwithBulkImporter(Class<? extends KijiBulkImporter> bulkImporterClass) + +
            +          Configures the job with a bulk importer to run in the map phase.
            + KijiBulkImportJobBuilderwithInput(MapReduceJobInput jobInput) + +
            +          Configures the job with input.
            + KijiBulkImportJobBuilderwithOutput(KijiTableMapReduceJobOutput jobOutput) + +
            +          Configures the bulk-importer output Kiji table.
            + KijiBulkImportJobBuilderwithOutput(MapReduceJobOutput jobOutput) + +
            +          Configures the job output.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.framework.MapReduceJobBuilder
            addJarDirectory, addJarDirectory, build, configureAvro, configureCombiner, configureHTableInput, configureInput, configureJars, configureMapper, configureOutput, configureReducer, configureStores, getConf, getJobOutput, mergeStores, withConf, withStore, withStoreBindings, withStoreBindingsFile
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiBulkImportJobBuilder create()
            +
            +
            Creates a new builder for Kiji bulk import jobs. +

            +

            + +
            Returns:
            a new Kiji bulk import job builder.
            +
            +
            +
            + +

            +withInput

            +
            +public KijiBulkImportJobBuilder withInput(MapReduceJobInput jobInput)
            +
            +
            Configures the job with input. +

            +

            +
            Parameters:
            jobInput - The input for the job. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withOutput

            +
            +public KijiBulkImportJobBuilder withOutput(KijiTableMapReduceJobOutput jobOutput)
            +
            +
            Configures the bulk-importer output Kiji table. +

            +

            +
            Parameters:
            jobOutput - Bulk importer must output to a Kiji table. +
            Returns:
            this builder.
            +
            +
            +
            + +

            +withOutput

            +
            +public KijiBulkImportJobBuilder withOutput(MapReduceJobOutput jobOutput)
            +
            +
            Configures the job output. +

            +

            +
            Overrides:
            withOutput in class MapReduceJobBuilder<KijiBulkImportJobBuilder>
            +
            +
            +
            Parameters:
            jobOutput - The output for the job. + Bulk importer must output to a Kiji table. +
            Returns:
            This builder instance so you may chain configuration method calls. + + This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withBulkImporter

            +
            +public KijiBulkImportJobBuilder withBulkImporter(Class<? extends KijiBulkImporter> bulkImporterClass)
            +
            +
            Configures the job with a bulk importer to run in the map phase. +

            +

            +
            Parameters:
            bulkImporterClass - The bulk importer class to use in the job. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +configureJob

            +
            +protected void configureJob(org.apache.hadoop.mapreduce.Job job)
+                     throws IOException
            +
            +
            Configures a Hadoop MR job. +

            +

            +
            Overrides:
            configureJob in class MapReduceJobBuilder<KijiBulkImportJobBuilder>
            +
            +
            +
            Parameters:
            job - The Hadoop MR job. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +configureJobForHFileOutput

            +
            +protected void configureJobForHFileOutput(org.apache.hadoop.mapreduce.Job job)
            +
            +
            Configures the job settings specific to writing HFiles. +

            +

            +
            Parameters:
            job - The job to configure.
            +
            +
            +
            + +

            +build

            +
            +protected MapReduceJob build(org.apache.hadoop.mapreduce.Job job)
            +
            +
            Wraps a Hadoop MR job in a MapReduceJob. +

            +

            +
            Specified by:
            build in class MapReduceJobBuilder<KijiBulkImportJobBuilder>
            +
            +
            +
            Parameters:
            job - The Hadoop MR job. +
            Returns:
            The built MapReduceJob.
            +
            +
            +
            + +

            +getRequiredStores

            +
            +protected Map<String,KeyValueStore<?,?>> getRequiredStores()
+                                                    throws IOException
            +
            +
            Method for job components to declare required KeyValueStore entries (and their default + implementations). +

            +

            +
            Overrides:
            getRequiredStores in class MapReduceJobBuilder<KijiBulkImportJobBuilder>
            +
            +
            + +
            Returns:
            a map of required names to default KeyValueStore implementations to add. These will + be used to augment the existing map if any names are not defined by withStore(). +
            Throws: +
            IOException - if there is an error configuring stores.
            +
            +
            +
            + +

            +getJobInput

            +
            +protected MapReduceJobInput getJobInput()
            +
            +
            Gets the input to configure the job with. +

            +

            +
            Specified by:
            getJobInput in class MapReduceJobBuilder<KijiBulkImportJobBuilder>
            +
            +
            + +
            Returns:
            The job input.
            +
            +
            +
            + +

            +getMapper

            +
            +protected KijiMapper<?,?,?,?> getMapper()
            +
            +
            Gets an instance of the MapReduce mapper to be used for this job. +

            +

            +
            Specified by:
            getMapper in class MapReduceJobBuilder<KijiBulkImportJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the mapper.
            +
            +
            +
            + +

            +getCombiner

            +
            +protected KijiReducer<?,?,?,?> getCombiner()
            +
            +
            Gets an instance of the MapReduce combiner to be used for this job. +

            +

            +
            Specified by:
            getCombiner in class MapReduceJobBuilder<KijiBulkImportJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the combiner, or null if this job should not use a combiner.
            +
            +
            +
            + +

            +getReducer

            +
            +protected KijiReducer<?,?,?,?> getReducer()
            +
            +
            Gets an instance of the MapReduce reducer to be used for this job. +

            +

            +
            Specified by:
            getReducer in class MapReduceJobBuilder<KijiBulkImportJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the reducer, or null if this job should be map-only.
            +
            +
            +
            + +

            +getJarClass

            +
            +protected Class<?> getJarClass()
            +
            +
            Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks. +

            +

            +
            Specified by:
            getJarClass in class MapReduceJobBuilder<KijiBulkImportJobBuilder>
            +
            +
            + +
            Returns:
            A class contained in the jar to be included on the MR classpath.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/KijiBulkImporter.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/KijiBulkImporter.html new file mode 100644 index 00000000..128b3999 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/KijiBulkImporter.html @@ -0,0 +1,491 @@ + + + + + + + +KijiBulkImporter (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.bulkimport +
            +Class KijiBulkImporter<K,V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.bulkimport.KijiBulkImporter<K,V>
+
            +
            +
            Type Parameters:
            K - The type of the MapReduce input key, which will depend on the input format used.
            V - The type of the MapReduce input value, which will depend on the input format used.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, KeyValueStoreClient
            +
            +
            +
            Direct Known Subclasses:
            AvroBulkImporter, BinaryHTableBulkImporter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KijiBulkImporter<K,V>
            extends Object
            implements org.apache.hadoop.conf.Configurable, KeyValueStoreClient
            + + +

            +

            Base class for all Kiji bulk importers. Subclasses of KijiBulkImporter can be + passed to the --importer flag of a kiji bulk-import command.

            + +

            To implement your own bulk importer, extend KijiBulkImporter and implement the + produce(Object, Object, org.kiji.mapreduce.KijiTableContext) method to process + your input. To write data to Kiji, call the appropriate put() method of the + KijiTableContext.

            + +

            Lifecycle:

            + +

            Internal state is set by a call to setConf(). Thus, KijiBulkImporters will be + automagically initialized by hadoop's ReflectionUtils.

            + +

            + As a KeyValueStoreClient, KijiBulkImporter will have access to all + stores defined by KeyValueStoreClient.getRequiredStores(). Readers for + these stores are surfaced in the setup(), produce(), and cleanup() methods + via the Context provided to each by calling + KijiContext.getStore(String). +

            + +

            Once the internal state is set, functions may be called in any order, except for + restrictions on setup(), produce(), and cleanup().

            + +

            setup() will get called once at the beginning of the map phase, followed by + a call to produce() for each input key-value pair. Once all of these produce() + calls have completed, cleanup() will be called exactly once. It is possible + that this setup-produce-cleanup cycle may repeat any number of times.

            + +

            A final guarantee is that setup(), produce(), and cleanup() will be called after + getOutputColumn() has been called at least once.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiBulkImporter() + +
            +          Your subclass of KijiBulkImporter must have a default constructor if it is to be used + in a bulk import job.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidcleanup(KijiTableContext context) + +
            +          Called once to clean up this producer after all + produce(Object, Object, org.kiji.mapreduce.KijiTableContext) calls are made.
            +static Class<? extends KijiBulkImporter>forName(String className) + +
            +          Loads a KijiBulkImporter class by name.
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +          
            + Map<String,KeyValueStore<?,?>>getRequiredStores() + +
            +          Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations.
            +abstract  voidproduce(K key, + V value, + KijiTableContext context) + +
            +          Produces data to be imported into Kiji.
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            + voidsetup(KijiTableContext context) + +
            +          Called once to initialize this producer before any calls to + produce(Object, Object, org.kiji.mapreduce.KijiTableContext).
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiBulkImporter

            +
            +public KijiBulkImporter()
            +
            +
            Your subclass of KijiBulkImporter must have a default constructor if it is to be used + in a bulk import job. The constructors should be lightweight, since the framework is + free to create KijiBulkImporters at any time. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +forName

            +
            +public static Class<? extends KijiBulkImporter> forName(String className)
+                                                 throws ClassNotFoundException
            +
            +
            Loads a KijiBulkImporter class by name. +

            +

            +
            +
            +
            +
            Parameters:
            className - Fully qualified name of the class to load. +
            Returns:
            the loaded class. +
            Throws: +
            ClassNotFoundException - if the class is not found. +
            ClassCastException - if the class is not a KijiBulkImporter.
            +
            +
            +
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getRequiredStores

            +
            +public Map<String,KeyValueStore<?,?>> getRequiredStores()
            +
            +

            Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations. + It is an error for any of these default implementations to be null. + If you want to defer KeyValueStore definition to runtime, bind a name + to the UnconfiguredKeyValueStore instead.

            + +

            Note that this method returns default mappings from store names to + concrete implementations. Users may override these mappings, e.g. in MapReduce job + configuration. You should not open a store returned by + getRequiredStores() directly; you should look to a + Context object or similar mechanism exposed by the Kiji framework to + determine the actual KeyValueStoreReader instance to use.

            +

            +

            +
            Specified by:
            getRequiredStores in interface KeyValueStoreClient
            +
            +
            + +
            Returns:
            a map from store names to default KeyValueStore implementations.
            +
            +
            +
            + +

            +setup

            +
            +public void setup(KijiTableContext context)
+           throws IOException
            +
            +
            Called once to initialize this producer before any calls to + produce(Object, Object, org.kiji.mapreduce.KijiTableContext). +

            +

            +
            +
            +
            +
            Parameters:
            context - A context you can use to generate EntityIds and commit writes. + See KijiTableContext.getEntityId(String). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +produce

            +
            +public abstract void produce(K key,
+                             V value,
+                             KijiTableContext context)
+                      throws IOException
            +
            +
            Produces data to be imported into Kiji. +

            +

            +
            +
            +
            +
            Parameters:
            key - The MapReduce input key (its type depends on the InputFormat you use).
            value - The MapReduce input value (its type depends on the InputFormat you use).
            context - A context you can use to generate EntityIds and commit writes. + See KijiTableContext.getEntityId(String). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +cleanup

            +
            +public void cleanup(KijiTableContext context)
+             throws IOException
            +
            +
            Called once to clean up this producer after all + produce(Object, Object, org.kiji.mapreduce.KijiTableContext) calls are made. +

            +

            +
            +
            +
            +
            Parameters:
            context - A context you can use to generate EntityIds and commit writes. + See KijiTableContext.getEntityId(String). +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/AvroBulkImporter.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/AvroBulkImporter.html new file mode 100644 index 00000000..4b9811c2 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/AvroBulkImporter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.bulkimport.AvroBulkImporter (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.bulkimport.AvroBulkImporter

            +
            +No usage of org.kiji.mapreduce.bulkimport.AvroBulkImporter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/BinaryHTableBulkImporter.ColumnDescriptor.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/BinaryHTableBulkImporter.ColumnDescriptor.html new file mode 100644 index 00000000..57529ddd --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/BinaryHTableBulkImporter.ColumnDescriptor.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter.ColumnDescriptor (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter.ColumnDescriptor

            +
            + + + + + + + + + +
            +Packages that use BinaryHTableBulkImporter.ColumnDescriptor
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            +  +

            + + + + + +
            +Uses of BinaryHTableBulkImporter.ColumnDescriptor in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport that return BinaryHTableBulkImporter.ColumnDescriptor
            +static BinaryHTableBulkImporter.ColumnDescriptorBinaryHTableBulkImporter.ColumnDescriptor.parse(String input) + +
            +          Parses an input string into a ColumnDescriptor.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport with parameters of type BinaryHTableBulkImporter.ColumnDescriptor
            +protected  org.kiji.schema.DecodedCell<?>BinaryHTableBulkImporter.decodeHBaseCell(BinaryHTableBulkImporter.ColumnDescriptor columnDescriptor, + byte[] hbaseCell) + +
            +          Converts the contents of an HBase cell into a typed Kiji cell.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/BinaryHTableBulkImporter.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/BinaryHTableBulkImporter.html new file mode 100644 index 00000000..529b78d4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/BinaryHTableBulkImporter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter

            +
            +No usage of org.kiji.mapreduce.bulkimport.BinaryHTableBulkImporter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/KijiBulkImportJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/KijiBulkImportJobBuilder.html new file mode 100644 index 00000000..54a23621 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/KijiBulkImportJobBuilder.html @@ -0,0 +1,258 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.bulkimport.KijiBulkImportJobBuilder

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiBulkImportJobBuilder
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            +  +

            + + + + + +
            +Uses of KijiBulkImportJobBuilder in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport that return KijiBulkImportJobBuilder
            +static KijiBulkImportJobBuilderKijiBulkImportJobBuilder.create() + +
            +          Creates a new builder for Kiji bulk import jobs.
            + KijiBulkImportJobBuilderKijiBulkImportJobBuilder.withBulkImporter(Class<? extends KijiBulkImporter> bulkImporterClass) + +
            +          Configures the job with a bulk importer to run in the map phase.
            + KijiBulkImportJobBuilderKijiBulkImportJobBuilder.withInput(MapReduceJobInput jobInput) + +
            +          Configures the job with input.
            + KijiBulkImportJobBuilderKijiBulkImportJobBuilder.withOutput(KijiTableMapReduceJobOutput jobOutput) + +
            +          Configures the bulk-importer output Kiji table.
            + KijiBulkImportJobBuilderKijiBulkImportJobBuilder.withOutput(MapReduceJobOutput jobOutput) + +
            +          Configures the job output.
            +  +

            + + + + + +
            +Uses of KijiBulkImportJobBuilder in org.kiji.mapreduce.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools that return KijiBulkImportJobBuilder
            +protected  KijiBulkImportJobBuilderKijiBulkImport.createJobBuilder() + +
            +          Creates a new job builder.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools with parameters of type KijiBulkImportJobBuilder
            +protected  voidKijiBulkImport.configure(KijiBulkImportJobBuilder jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/KijiBulkImporter.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/KijiBulkImporter.html new file mode 100644 index 00000000..0495162c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/class-use/KijiBulkImporter.html @@ -0,0 +1,259 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.bulkimport.KijiBulkImporter (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.bulkimport.KijiBulkImporter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiBulkImporter
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers. 
            +  +

            + + + + + +
            +Uses of KijiBulkImporter in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + + + + + +
            Subclasses of KijiBulkImporter in org.kiji.mapreduce.bulkimport
            + classAvroBulkImporter<T> + +
            +          Base class for Kiji bulk importers that process Avro container + files.
            + classBinaryHTableBulkImporter + +
            +          A bulk importer that reads columns from an HTable that were encoded using the Bytes utility class.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport that return types with arguments of type KijiBulkImporter
            +static Class<? extends KijiBulkImporter>KijiBulkImporter.forName(String className) + +
            +          Loads a KijiBulkImporter class by name.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.mapreduce.bulkimport with type arguments of type KijiBulkImporter
            + KijiBulkImportJobBuilderKijiBulkImportJobBuilder.withBulkImporter(Class<? extends KijiBulkImporter> bulkImporterClass) + +
            +          Configures the job with a bulk importer to run in the map phase.
            +  +

            + + + + + +
            +Uses of KijiBulkImporter in org.kiji.mapreduce.bulkimport.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport.impl that return KijiBulkImporter
            +static + + + + +
            +<K,V> KijiBulkImporter<K,V>
            +            		KijiBulkImporters.create(org.apache.hadoop.conf.Configuration conf) + +
            +          Create an instance of the bulk importer specified by the + Configuration.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/BulkImportMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/BulkImportMapper.html new file mode 100644 index 00000000..c18a29c7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/BulkImportMapper.html @@ -0,0 +1,574 @@ + + + + + + + +BulkImportMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.bulkimport.impl +
            +Class BulkImportMapper<K,V>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Mapper<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiMapper<K,V,HFileKeyValue,org.apache.hadoop.io.NullWritable>
+          extended by org.kiji.mapreduce.bulkimport.impl.BulkImportMapper<K,V>
+
            +
            +
            Type Parameters:
            K - Type of the MapReduce input key.
            V - Type of the MapReduce input value.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, AvroKeyReader, AvroValueReader, HTableReader, KVOutputJob
            +
            +
            +
            +
            @ApiAudience.Private
+public final class BulkImportMapper<K,V>
            extends KijiMapper<K,V,HFileKeyValue,org.apache.hadoop.io.NullWritable>
            implements org.apache.hadoop.conf.Configurable, AvroKeyReader, AvroValueReader, HTableReader
            + + +

            +Hadoop mapper that runs a KijiBulkImporter. + +

            The input to this mapper depends on the format of the data being imported. For + example, if you were importing data from text files using a TextInputFormat, the + key would be a LongWritable byte file offset, and the value would be a Text containing + a line from the file.

            + +

            The task of generating ProducedWrites that represent data to be imported into a Kiji table + is delegated to a KijiBulkImporter subclass whose classname is set in the + Configuration. This mapper will forward each input record to the KijiBulkImporter to + allow it to produce the ProducedWrites. The obtained ProducedWrites will be used to + generate an appropriate HBase Put object (output as the map output value). The map + output key is the row of the HTable the Put should be applied to.

            + +

            When paired with a PutSortReducer and an HFileOutputFormat, HFiles will be generated + that are ready to be loaded directly into the HBase HTables used for the backing store + of a Kiji table. When run as a map-only job with an HBase TableOutputFormat, the Puts + will be sent directly to the HTable for committing.

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Mapper
            org.apache.hadoop.mapreduce.Mapper.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            BulkImportMapper() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup(org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          
            + org.apache.avro.SchemagetAvroKeyReaderSchema() + +
            +          If the input key class is AvroKey, this method + returns the Avro reader schema of the wrapped datum; otherwise null.
            + org.apache.avro.SchemagetAvroValueReaderSchema() + +
            +          If the input value class is AvroValue, this method + returns the Avro reader schema of the wrapped datum; otherwise null.
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +          
            + org.apache.hadoop.hbase.client.ScangetInputHTableScan(org.apache.hadoop.conf.Configuration conf) + +
            +          Returns an HBase scan descriptor that specifies what subset of rows and cells should + be read from the input HTable.
            + Class<?>getOutputKeyClass() + +
            +          
            + Class<?>getOutputValueClass() + +
            +          
            +protected  voidmap(K key, + V value, + org.apache.hadoop.mapreduce.Mapper.Context mapContext) + +
            +           
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            +protected  voidsetup(org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiMapper
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Mapper
            run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +BulkImportMapper

            +
            +public BulkImportMapper()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +setup

            +
            +protected void setup(org.apache.hadoop.mapreduce.Mapper.Context context)
+              throws IOException
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.apache.hadoop.mapreduce.Mapper<K,V,HFileKeyValue,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +map

            +
            +protected void map(K key,
+                   V value,
+                   org.apache.hadoop.mapreduce.Mapper.Context mapContext)
+            throws IOException
            +
            +
            +
            Overrides:
            map in class org.apache.hadoop.mapreduce.Mapper<K,V,HFileKeyValue,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup(org.apache.hadoop.mapreduce.Mapper.Context context)
+                throws IOException
            +
            +
            +

            +

            +
            Overrides:
            cleanup in class org.apache.hadoop.mapreduce.Mapper<K,V,HFileKeyValue,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getAvroKeyReaderSchema

            +
            +public org.apache.avro.Schema getAvroKeyReaderSchema()
+                                              throws IOException
            +
            +
            If the input key class is AvroKey, this method + returns the Avro reader schema of the wrapped datum; otherwise null. +

            +

            +
            Specified by:
            getAvroKeyReaderSchema in interface AvroKeyReader
            +
            +
            + +
            Returns:
            The Avro reader schema of the datum wrapped in the AvroKey input. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getAvroValueReaderSchema

            +
            +public org.apache.avro.Schema getAvroValueReaderSchema()
+                                                throws IOException
            +
            +
            If the input value class is AvroValue, this method + returns the Avro reader schema of the wrapped datum; otherwise null. +

            +

            +
            Specified by:
            getAvroValueReaderSchema in interface AvroValueReader
            +
            +
            + +
            Returns:
            The Avro reader schema of the datum wrapped in the AvroValue input. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getInputHTableScan

            +
            +public org.apache.hadoop.hbase.client.Scan getInputHTableScan(org.apache.hadoop.conf.Configuration conf)
+                                                       throws IOException
            +
            +
            Returns an HBase scan descriptor that specifies what subset of rows and cells should + be read from the input HTable. + +

            This method may return null, meaning that this instance is not really able to read + from an HTable.

            +

            +

            +
            Specified by:
            getInputHTableScan in interface HTableReader
            +
            +
            +
            Parameters:
            conf - The job configuration. +
            Returns:
            A new scan descriptor. +
            Throws: +
            IOException - If the scan descriptor cannot be constructed.
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputKeyClass in interface KVOutputJob
            +
            +
            + +
            Returns:
            the type of keys emitted by this task.
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputValueClass in interface KVOutputJob
            +
            +
            + +
            Returns:
            the type of values emitted by this task.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/KijiBulkImporters.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/KijiBulkImporters.html new file mode 100644 index 00000000..4734b189 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/KijiBulkImporters.html @@ -0,0 +1,244 @@ + + + + + + + +KijiBulkImporters (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.bulkimport.impl +
            +Class KijiBulkImporters

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.bulkimport.impl.KijiBulkImporters
+
            +
            +
            +
            @ApiAudience.Private
+public final class KijiBulkImporters
            extends Object
            + + +

            +Utility methods for working with KijiBulkImporter. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<K,V> KijiBulkImporter<K,V>
            +            		create(org.apache.hadoop.conf.Configuration conf) + +
            +          Create an instance of the bulk importer specified by the + Configuration.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static <K,V> KijiBulkImporter<K,V> create(org.apache.hadoop.conf.Configuration conf)
+                                    throws IOException
            +
            +

            Create an instance of the bulk importer specified by the + Configuration.

            + + The configuration would have stored the bulk importer + name only if it was configured by a KijiBulkImportJob, so don't try + calling this method with any old Configuration object. +

            +

            +
            Type Parameters:
            K - The map input key for the bulk importer.
            V - The map input value for the bulk importer.
            Parameters:
            conf - The job configuration. +
            Returns:
            a brand-spankin'-new KijiBulkImporter instance. +
            Throws: +
            IOException - If the bulk importer cannot be loaded.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/class-use/BulkImportMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/class-use/BulkImportMapper.html new file mode 100644 index 00000000..d9d851ef --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/class-use/BulkImportMapper.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.bulkimport.impl.BulkImportMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.bulkimport.impl.BulkImportMapper

            +
            +No usage of org.kiji.mapreduce.bulkimport.impl.BulkImportMapper +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/class-use/KijiBulkImporters.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/class-use/KijiBulkImporters.html new file mode 100644 index 00000000..fe1de379 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/class-use/KijiBulkImporters.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.bulkimport.impl.KijiBulkImporters (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.bulkimport.impl.KijiBulkImporters

            +
            +No usage of org.kiji.mapreduce.bulkimport.impl.KijiBulkImporters +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-frame.html new file mode 100644 index 00000000..0a3079d1 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +org.kiji.mapreduce.bulkimport.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.bulkimport.impl + + + + +
            +Classes  + +
            +BulkImportMapper +
            +KijiBulkImporters
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-summary.html new file mode 100644 index 00000000..8812f46d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-summary.html @@ -0,0 +1,177 @@ + + + + + + + +org.kiji.mapreduce.bulkimport.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.bulkimport.impl +

            +Internal classes for KijiMR bulk importers. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + +
            +Class Summary
            BulkImportMapper<K,V>Hadoop mapper that runs a KijiBulkImporter.
            KijiBulkImportersUtility methods for working with KijiBulkImporter.
            +  + +

            +

            +Package org.kiji.mapreduce.bulkimport.impl Description +

            + +

            +Internal classes for KijiMR bulk importers. These classes should not be used by clients. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-tree.html new file mode 100644 index 00000000..e5e51f1d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.mapreduce.bulkimport.impl Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.bulkimport.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-use.html new file mode 100644 index 00000000..18e6cb88 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/impl/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.bulkimport.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.bulkimport.impl

            +
            +No usage of org.kiji.mapreduce.bulkimport.impl +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-frame.html new file mode 100644 index 00000000..1cdb9d30 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-frame.html @@ -0,0 +1,41 @@ + + + + + + + +org.kiji.mapreduce.bulkimport (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.bulkimport + + + + +
            +Classes  + +
            +AvroBulkImporter +
            +BinaryHTableBulkImporter +
            +BinaryHTableBulkImporter.ColumnDescriptor +
            +KijiBulkImporter +
            +KijiBulkImportJobBuilder
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-summary.html new file mode 100644 index 00000000..7871537c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-summary.html @@ -0,0 +1,233 @@ + + + + + + + +org.kiji.mapreduce.bulkimport (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.bulkimport +

            +Bulk importer classes for KijiMR clients. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AvroBulkImporter<T>Base class for Kiji bulk importers that process Avro container + files.
            BinaryHTableBulkImporterA bulk importer that reads columns from an HTable that were encoded using the Bytes utility class.
            BinaryHTableBulkImporter.ColumnDescriptorDescribes an input HTable column, its type, and a the target column in a Kiji table + it should be imported into.
            KijiBulkImporter<K,V>Base class for all Kiji bulk importers.
            KijiBulkImportJobBuilderBuilds a job that runs a KijiBulkImporter to import data into a Kiji table.
            +  + +

            +

            +Package org.kiji.mapreduce.bulkimport Description +

            + +

            +Bulk importer classes for KijiMR clients. + +

            + The KijiBulkImporter class is the base class for all + bulk importers. Subclasses take inputs from MapReduceJobInput + and produce output to Kiji either directly or through HFiles. +

            + +

            Constructing a bulk import job:

            +

            + A bulk import job that outputs to an intermediary HFile(which can subsequently be imported + via a kiji bulk-load command can be created here: +

            + 
            
+   // Configure and create the MapReduce job.
+   final MapReduceJob job = KijiBulkImportJobBuilder.create()
+       .withConf(conf)
+       .withBulkImporter(JSONBulkImporter.class)
+       .withInput(new TextMapReduceJobInput(new Path(inputFile.toString())))
+       .withOutput(new DirectKijiTableMapReduceJobOutput(mOutputTable))
+       .build();
+
            +

            + Alternately a bulk import job that directly outputs to a Kiji table can be performed by + replacing the .withOutput parameter. This is generally not recommended as this can result + in heavy load on the target HBase cluster. Also if the job doesn't complete, this can result + in partial writes. +

            + 
            
+   // Configure and create the MapReduce job.
+   final MapReduceJob job = KijiBulkImportJobBuilder.create()
+       .withConf(conf)
+       .withBulkImporter(JSONBulkImporter.class)
+       .withInput(new TextMapReduceJobInput(new Path(inputFile.toString())))
+       .withOutput(new HFileMapReduceJobOutput(mOutputTable, hfileDirPath))
+       .build();
+
            +

            + The kiji bulk-import command line tool wraps this functionality and can be used + for constructing bulk import jobs. If HFiles are created as the output for a bulk import job + they can be loaded into HBase using the kiji bulk-load command. +

            +

            + +

            +

            +
            See Also:
            HFileMapReduceJobOutput, +DirectKijiTableMapReduceJobOutput
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-tree.html new file mode 100644 index 00000000..d498618b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-tree.html @@ -0,0 +1,161 @@ + + + + + + + +org.kiji.mapreduce.bulkimport Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.bulkimport +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-use.html new file mode 100644 index 00000000..eb505ea7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/bulkimport/package-use.html @@ -0,0 +1,222 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.bulkimport (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.bulkimport

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.bulkimport
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers. 
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.bulkimport used by org.kiji.mapreduce.bulkimport
            BinaryHTableBulkImporter.ColumnDescriptor + +
            +          Describes an input HTable column, its type, and a the target column in a Kiji table + it should be imported into.
            KijiBulkImporter + +
            +          Base class for all Kiji bulk importers.
            KijiBulkImportJobBuilder + +
            +          Builds a job that runs a KijiBulkImporter to import data into a Kiji table.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.bulkimport used by org.kiji.mapreduce.bulkimport.impl
            KijiBulkImporter + +
            +          Base class for all Kiji bulk importers.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.bulkimport used by org.kiji.mapreduce.tools
            KijiBulkImportJobBuilder + +
            +          Builds a job that runs a KijiBulkImporter to import data into a Kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/DistributedCacheJars.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/DistributedCacheJars.html new file mode 100644 index 00000000..7aa1fbf8 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/DistributedCacheJars.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.DistributedCacheJars (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.DistributedCacheJars

            +
            +No usage of org.kiji.mapreduce.DistributedCacheJars +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/HFileLoader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/HFileLoader.html new file mode 100644 index 00000000..d78ff164 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/HFileLoader.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.HFileLoader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.HFileLoader

            +
            + + + + + + + + + +
            +Packages that use HFileLoader
            org.kiji.mapreduceKijiMR utilities. 
            +  +

            + + + + + +
            +Uses of HFileLoader in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce that return HFileLoader
            +static HFileLoaderHFileLoader.create(org.apache.hadoop.conf.Configuration conf) + +
            +          Creates a new HFile loader.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/JobConfigurationException.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/JobConfigurationException.html new file mode 100644 index 00000000..39fd31b7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/JobConfigurationException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.JobConfigurationException (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.JobConfigurationException

            +
            +No usage of org.kiji.mapreduce.JobConfigurationException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KVOutputJob.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KVOutputJob.html new file mode 100644 index 00000000..2b002d89 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KVOutputJob.html @@ -0,0 +1,373 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.KVOutputJob (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.KVOutputJob

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KVOutputJob
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            org.kiji.mapreduce.reducerBasic identity reducer which is required for KijiMR jobs. 
            +  +

            + + + + + +
            +Uses of KVOutputJob in org.kiji.mapreduce
            +  +

            + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.mapreduce that implement KVOutputJob
            + classKijiMapper<INKEY,INVALUE,OUTKEY,OUTVALUE> + +
            +          Base class for Kiji mappers.
            + classKijiReducer<INKEY,INVALUE,OUTKEY,OUTVALUE> + +
            +          Base class for Kiji reducer.
            + classKijiTableReducer<K,V> + +
            +          Base class for reducers that emit to a Kiji table.
            +  +

            + + + + + +
            +Uses of KVOutputJob in org.kiji.mapreduce.bulkimport.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.bulkimport.impl that implement KVOutputJob
            + classBulkImportMapper<K,V> + +
            +          Hadoop mapper that runs a KijiBulkImporter.
            +  +

            + + + + + +
            +Uses of KVOutputJob in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.gather that implement KVOutputJob
            + classKijiGatherer<K,V> + +
            +           + Base class for all Kiji Gatherers.
            +  +

            + + + + + +
            +Uses of KVOutputJob in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.gather.impl that implement KVOutputJob
            + classGatherMapper<K,V> + +
            +          Mapper that executes a gatherer over the rows of a Kiji table.
            +  +

            + + + + + +
            +Uses of KVOutputJob in org.kiji.mapreduce.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.impl that implement KVOutputJob
            + classKijiTableMapper<K,V> + +
            +          Base class for mappers reading from a Kiji table.
            +  +

            + + + + + +
            +Uses of KVOutputJob in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.produce.impl that implement KVOutputJob
            + classProduceMapper + +
            +          Hadoop mapper that runs a Kiji producer.
            +  +

            + + + + + +
            +Uses of KVOutputJob in org.kiji.mapreduce.reducer
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.reducer that implement KVOutputJob
            + classIdentityReducer<K,V> + +
            +          This MapReduce reducer will pass through all of the input key-value + pairs unchanged.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiContext.html new file mode 100644 index 00000000..6c77c1f6 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiContext.html @@ -0,0 +1,384 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.KijiContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.KijiContext

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiContext
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + +
            +Uses of KijiContext in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiContext in org.kiji.mapreduce
            + interfaceKijiTableContext + +
            +          Context for Kiji bulk-importers or reducers to output to a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiContext in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiContext in org.kiji.mapreduce.gather
            + interfaceGathererContext<K,V> + +
            +          Context for gatherers.
            +  +

            + + + + + +
            +Uses of KijiContext in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.gather.impl that implement KijiContext
            + classInternalGathererContext<K,V> + +
            +          Concrete context for gatherers that emit key/value pairs.
            +  +

            + + + + + +
            +Uses of KijiContext in org.kiji.mapreduce.impl
            +  +

            + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.mapreduce.impl that implement KijiContext
            + classDirectKijiTableWriterContext + +
            +          Kiji context that writes cells to a configured output table.
            + classHFileWriterContext + +
            +          Kiji context that emits puts for the configured output table to HFiles.
            + classInternalKijiContext + +
            +          Implements KijiContext.
            +  +

            + + + + + +
            +Uses of KijiContext in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiContext in org.kiji.mapreduce.produce
            + interfaceProducerContext + +
            +          Context for producers to output new cells in the currently processed row.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce with parameters of type KijiContext
            + voidKijiProducer.cleanup(KijiContext context) + +
            +          Called once to clean up this producer after all + KijiProducer.produce(KijiRowData, ProducerContext) calls are made.
            + voidKijiProducer.setup(KijiContext context) + +
            +          Called once to initialize this producer before any calls to + KijiProducer.produce(KijiRowData, ProducerContext).
            +  +

            + + + + + +
            +Uses of KijiContext in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiContext in org.kiji.mapreduce.produce.impl
            + interfaceInternalProducerContextInterface + +
            +          Internal interface for producer contexts.
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.produce.impl that implement KijiContext
            + classInternalProducerContext + +
            +          Implementation of a producer context.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiDataRequester.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiDataRequester.html new file mode 100644 index 00000000..0fa04495 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiDataRequester.html @@ -0,0 +1,300 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.KijiDataRequester (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.KijiDataRequester

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiDataRequester
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + +
            +Uses of KijiDataRequester in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.gather that implement KijiDataRequester
            + classKijiGatherer<K,V> + +
            +           + Base class for all Kiji Gatherers.
            +  +

            + + + + + +
            +Uses of KijiDataRequester in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.gather.impl that implement KijiDataRequester
            + classGatherMapper<K,V> + +
            +          Mapper that executes a gatherer over the rows of a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiDataRequester in org.kiji.mapreduce.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.impl that implement KijiDataRequester
            + classKijiTableMapper<K,V> + +
            +          Base class for mappers reading from a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiDataRequester in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.produce that implement KijiDataRequester
            + classKijiProducer + +
            +           + Base class for all Kiji Producers used to generate per-row derived + entity data.
            +  +

            + + + + + +
            +Uses of KijiDataRequester in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.produce.impl that implement KijiDataRequester
            + classProduceMapper + +
            +          Hadoop mapper that runs a Kiji producer.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiMapReduceJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiMapReduceJobBuilder.html new file mode 100644 index 00000000..ffa8b7a9 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiMapReduceJobBuilder.html @@ -0,0 +1,258 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.KijiMapReduceJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.KijiMapReduceJobBuilder

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiMapReduceJobBuilder
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            +  +

            + + + + + +
            +Uses of KijiMapReduceJobBuilder in org.kiji.mapreduce
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce that return KijiMapReduceJobBuilder
            +static KijiMapReduceJobBuilderKijiMapReduceJobBuilder.create() + +
            +          Creates a new builder for Kiji transform jobs.
            + KijiMapReduceJobBuilderKijiMapReduceJobBuilder.withCombiner(Class<? extends KijiReducer> combinerClass) + +
            +          Configures the job with a combiner to run (optional).
            + KijiMapReduceJobBuilderKijiMapReduceJobBuilder.withInput(MapReduceJobInput jobInput) + +
            +          Configures the job with input.
            + KijiMapReduceJobBuilderKijiMapReduceJobBuilder.withMapper(Class<? extends KijiMapper> mapperClass) + +
            +          Configures the job with a mapper to run in the map phase.
            + KijiMapReduceJobBuilderKijiMapReduceJobBuilder.withReducer(Class<? extends KijiReducer> reducerClass) + +
            +          Configures the job with a reducer to run (optional).
            +  +

            + + + + + +
            +Uses of KijiMapReduceJobBuilder in org.kiji.mapreduce.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools that return KijiMapReduceJobBuilder
            +protected  KijiMapReduceJobBuilderKijiLaunchMapReduce.createJobBuilder() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools with parameters of type KijiMapReduceJobBuilder
            +protected  voidKijiLaunchMapReduce.configure(KijiMapReduceJobBuilder jobBuilder) + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiMapper.html new file mode 100644 index 00000000..52d1e45b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiMapper.html @@ -0,0 +1,471 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.KijiMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.KijiMapper

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiMapper
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + +
            +Uses of KijiMapper in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce that return KijiMapper
            +protected  KijiMapper<?,?,?,?>KijiMapReduceJobBuilder.getMapper() + +
            +          Gets an instance of the MapReduce mapper to be used for this job.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce that return types with arguments of type KijiMapper
            +static Class<? extends KijiMapper>KijiMapper.forName(String className) + +
            +          Loads a KijiMapper class by name.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.mapreduce with type arguments of type KijiMapper
            + KijiMapReduceJobBuilderKijiMapReduceJobBuilder.withMapper(Class<? extends KijiMapper> mapperClass) + +
            +          Configures the job with a mapper to run in the map phase.
            +  +

            + + + + + +
            +Uses of KijiMapper in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport that return KijiMapper
            +protected  KijiMapper<?,?,?,?>KijiBulkImportJobBuilder.getMapper() + +
            +          Gets an instance of the MapReduce mapper to be used for this job.
            +  +

            + + + + + +
            +Uses of KijiMapper in org.kiji.mapreduce.bulkimport.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiMapper in org.kiji.mapreduce.bulkimport.impl
            + classBulkImportMapper<K,V> + +
            +          Hadoop mapper that runs a KijiBulkImporter.
            +  +

            + + + + + +
            +Uses of KijiMapper in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return KijiMapper
            +protected abstract  KijiMapper<?,?,?,?>MapReduceJobBuilder.getMapper() + +
            +          Gets an instance of the MapReduce mapper to be used for this job.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework with parameters of type KijiMapper
            +protected  voidMapReduceJobBuilder.configureAvro(org.apache.hadoop.mapreduce.Job job, + KijiMapper<?,?,?,?> mapper) + +
            +          Configures the job with any Avro reader or writer schemas specified by the mapper class.
            +protected  voidMapReduceJobBuilder.configureHTableInput(org.apache.hadoop.mapreduce.Job job, + KijiMapper<?,?,?,?> mapper) + +
            +          Configures HTable input for the job if the mapper is an HTableReader.
            +  +

            + + + + + +
            +Uses of KijiMapper in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.gather that return KijiMapper
            +protected  KijiMapper<?,?,?,?>KijiGatherJobBuilder.getMapper() + +
            +          Gets an instance of the MapReduce mapper to be used for this job.
            +  +

            + + + + + +
            +Uses of KijiMapper in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiMapper in org.kiji.mapreduce.gather.impl
            + classGatherMapper<K,V> + +
            +          Mapper that executes a gatherer over the rows of a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiMapper in org.kiji.mapreduce.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiMapper in org.kiji.mapreduce.impl
            + classKijiTableMapper<K,V> + +
            +          Base class for mappers reading from a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiMapper in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce that return KijiMapper
            +protected  KijiMapper<?,?,?,?>KijiProduceJobBuilder.getMapper() + +
            +          Gets an instance of the MapReduce mapper to be used for this job.
            +  +

            + + + + + +
            +Uses of KijiMapper in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiMapper in org.kiji.mapreduce.produce.impl
            + classProduceMapper + +
            +          Hadoop mapper that runs a Kiji producer.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiReducer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiReducer.html new file mode 100644 index 00000000..dae47dce --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiReducer.html @@ -0,0 +1,447 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.KijiReducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.KijiReducer

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiReducer
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.reducerBasic identity reducer which is required for KijiMR jobs. 
            +  +

            + + + + + +
            +Uses of KijiReducer in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Subclasses of KijiReducer in org.kiji.mapreduce
            + classKijiTableReducer<K,V> + +
            +          Base class for reducers that emit to a Kiji table.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce that return KijiReducer
            +protected  KijiReducer<?,?,?,?>KijiMapReduceJobBuilder.getCombiner() + +
            +          Gets an instance of the MapReduce combiner to be used for this job.
            +protected  KijiReducer<?,?,?,?>KijiMapReduceJobBuilder.getReducer() + +
            +          Gets an instance of the MapReduce reducer to be used for this job.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce that return types with arguments of type KijiReducer
            +static Class<? extends KijiReducer>KijiReducer.forName(String className) + +
            +          Loads a KijiReducer class by name.
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.mapreduce with type arguments of type KijiReducer
            + KijiMapReduceJobBuilderKijiMapReduceJobBuilder.withCombiner(Class<? extends KijiReducer> combinerClass) + +
            +          Configures the job with a combiner to run (optional).
            + KijiMapReduceJobBuilderKijiMapReduceJobBuilder.withReducer(Class<? extends KijiReducer> reducerClass) + +
            +          Configures the job with a reducer to run (optional).
            +  +

            + + + + + +
            +Uses of KijiReducer in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport that return KijiReducer
            +protected  KijiReducer<?,?,?,?>KijiBulkImportJobBuilder.getCombiner() + +
            +          Gets an instance of the MapReduce combiner to be used for this job.
            +protected  KijiReducer<?,?,?,?>KijiBulkImportJobBuilder.getReducer() + +
            +          Gets an instance of the MapReduce reducer to be used for this job.
            +  +

            + + + + + +
            +Uses of KijiReducer in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return KijiReducer
            +protected abstract  KijiReducer<?,?,?,?>MapReduceJobBuilder.getCombiner() + +
            +          Gets an instance of the MapReduce combiner to be used for this job.
            +protected abstract  KijiReducer<?,?,?,?>MapReduceJobBuilder.getReducer() + +
            +          Gets an instance of the MapReduce reducer to be used for this job.
            +  +

            + + + + + +
            +Uses of KijiReducer in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.gather that return KijiReducer
            +protected  KijiReducer<?,?,?,?>KijiGatherJobBuilder.getCombiner() + +
            +          Gets an instance of the MapReduce combiner to be used for this job.
            +protected  KijiReducer<?,?,?,?>KijiGatherJobBuilder.getReducer() + +
            +          Gets an instance of the MapReduce reducer to be used for this job.
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.mapreduce.gather with type arguments of type KijiReducer
            + KijiGatherJobBuilderKijiGatherJobBuilder.withCombiner(Class<? extends KijiReducer> combinerClass) + +
            +          Configures the job with a combiner to run (optional).
            + KijiGatherJobBuilderKijiGatherJobBuilder.withReducer(Class<? extends KijiReducer> reducerClass) + +
            +          Configures the job with a reducer to run (optional).
            +  +

            + + + + + +
            +Uses of KijiReducer in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce that return KijiReducer
            +protected  KijiReducer<?,?,?,?>KijiProduceJobBuilder.getCombiner() + +
            +          Gets an instance of the MapReduce combiner to be used for this job.
            +protected  KijiReducer<?,?,?,?>KijiProduceJobBuilder.getReducer() + +
            +          Gets an instance of the MapReduce reducer to be used for this job.
            +  +

            + + + + + +
            +Uses of KijiReducer in org.kiji.mapreduce.reducer
            +  +

            + + + + + + + + + +
            Subclasses of KijiReducer in org.kiji.mapreduce.reducer
            + classIdentityReducer<K,V> + +
            +          This MapReduce reducer will pass through all of the input key-value + pairs unchanged.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiTableContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiTableContext.html new file mode 100644 index 00000000..269bf3d7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiTableContext.html @@ -0,0 +1,324 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.KijiTableContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.KijiTableContext

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiTableContext
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            +  +

            + + + + + +
            +Uses of KijiTableContext in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce with parameters of type KijiTableContext
            +protected abstract  voidKijiTableReducer.reduce(K key, + Iterable<V> values, + KijiTableContext context) + +
            +          Kiji reducer function that processes the values for a key and emits to the output table.
            +  +

            + + + + + +
            +Uses of KijiTableContext in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport with parameters of type KijiTableContext
            + voidKijiBulkImporter.cleanup(KijiTableContext context) + +
            +          Called once to clean up this producer after all + KijiBulkImporter.produce(Object, Object, org.kiji.mapreduce.KijiTableContext) calls are made.
            + voidAvroBulkImporter.produce(org.apache.avro.mapred.AvroKey<T> key, + org.apache.hadoop.io.NullWritable ignore, + KijiTableContext context) + +
            +           
            + voidBinaryHTableBulkImporter.produce(org.apache.hadoop.hbase.io.ImmutableBytesWritable hbaseRowKey, + org.apache.hadoop.hbase.client.Result hbaseRow, + KijiTableContext context) + +
            +          Produces data to be imported into Kiji.
            +abstract  voidKijiBulkImporter.produce(K key, + V value, + KijiTableContext context) + +
            +          Produces data to be imported into Kiji.
            +protected abstract  voidAvroBulkImporter.produce(T datum, + KijiTableContext context) + +
            +          Process an Avro datum from the input container file to produce + Kiji output.
            + voidKijiBulkImporter.setup(KijiTableContext context) + +
            +          Called once to initialize this producer before any calls to + KijiBulkImporter.produce(Object, Object, org.kiji.mapreduce.KijiTableContext).
            + voidBinaryHTableBulkImporter.setup(KijiTableContext context) + +
            +          Called once to initialize this producer before any calls to + KijiBulkImporter.produce(Object, Object, org.kiji.mapreduce.KijiTableContext).
            +  +

            + + + + + +
            +Uses of KijiTableContext in org.kiji.mapreduce.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.mapreduce.impl that implement KijiTableContext
            + classDirectKijiTableWriterContext + +
            +          Kiji context that writes cells to a configured output table.
            + classHFileWriterContext + +
            +          Kiji context that emits puts for the configured output table to HFiles.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.impl that return KijiTableContext
            +static KijiTableContextKijiTableContextFactory.create(org.apache.hadoop.mapreduce.TaskInputOutputContext taskContext) + +
            +          Instantiates the configured KijiTableContext.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiTableReducer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiTableReducer.html new file mode 100644 index 00000000..ebfd4589 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/KijiTableReducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.KijiTableReducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.KijiTableReducer

            +
            +No usage of org.kiji.mapreduce.KijiTableReducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJob.Status.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJob.Status.html new file mode 100644 index 00000000..b9177935 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJob.Status.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.MapReduceJob.Status (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.MapReduceJob.Status

            +
            + + + + + + + + + + + + + +
            +Packages that use MapReduceJob.Status
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            +  +

            + + + + + +
            +Uses of MapReduceJob.Status in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce that return MapReduceJob.Status
            + MapReduceJob.StatusMapReduceJob.submit() + +
            +          Starts the job and return immediately.
            +  +

            + + + + + +
            +Uses of MapReduceJob.Status in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return MapReduceJob.Status
            + MapReduceJob.StatusKijiMapReduceJob.submit() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJob.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJob.html new file mode 100644 index 00000000..b0f858b7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJob.html @@ -0,0 +1,321 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.MapReduceJob (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.MapReduceJob

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use MapReduceJob
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            +  +

            + + + + + +
            +Uses of MapReduceJob in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce that return MapReduceJob
            +protected  MapReduceJobKijiMapReduceJobBuilder.build(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop MR job in a MapReduceJob.
            +  +

            + + + + + +
            +Uses of MapReduceJob in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport that return MapReduceJob
            +protected  MapReduceJobKijiBulkImportJobBuilder.build(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop MR job in a MapReduceJob.
            +  +

            + + + + + +
            +Uses of MapReduceJob in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Subclasses of MapReduceJob in org.kiji.mapreduce.framework
            + classKijiMapReduceJob + +
            +          An implementation of a runnable MapReduce job that interacts with Kiji tables.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return MapReduceJob
            + MapReduceJobMapReduceJobBuilder.build() + +
            +          Builds a runnable MapReduce job.
            +protected abstract  MapReduceJobMapReduceJobBuilder.build(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop MR job in a MapReduceJob.
            +  +

            + + + + + +
            +Uses of MapReduceJob in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.gather that return MapReduceJob
            +protected  MapReduceJobKijiGatherJobBuilder.build(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop MR job in a MapReduceJob.
            +  +

            + + + + + +
            +Uses of MapReduceJob in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce that return MapReduceJob
            +protected  MapReduceJobKijiProduceJobBuilder.build(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop MR job in a MapReduceJob.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJobInput.html new file mode 100644 index 00000000..06b42013 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJobInput.html @@ -0,0 +1,408 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.MapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.MapReduceJobInput

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use MapReduceJobInput
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.inputMapReduce job input types. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of MapReduceJobInput in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce that return MapReduceJobInput
            +protected  MapReduceJobInputKijiMapReduceJobBuilder.getJobInput() + +
            +          Gets the input to configure the job with.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce with parameters of type MapReduceJobInput
            + KijiMapReduceJobBuilderKijiMapReduceJobBuilder.withInput(MapReduceJobInput jobInput) + +
            +          Configures the job with input.
            +  +

            + + + + + +
            +Uses of MapReduceJobInput in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport that return MapReduceJobInput
            +protected  MapReduceJobInputKijiBulkImportJobBuilder.getJobInput() + +
            +          Gets the input to configure the job with.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport with parameters of type MapReduceJobInput
            + KijiBulkImportJobBuilderKijiBulkImportJobBuilder.withInput(MapReduceJobInput jobInput) + +
            +          Configures the job with input.
            +  +

            + + + + + +
            +Uses of MapReduceJobInput in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return MapReduceJobInput
            +protected  MapReduceJobInputKijiTableInputJobBuilder.getJobInput() + +
            +          Gets the input to configure the job with.
            +protected abstract  MapReduceJobInputMapReduceJobBuilder.getJobInput() + +
            +          Gets the input to configure the job with.
            +  +

            + + + + + +
            +Uses of MapReduceJobInput in org.kiji.mapreduce.input
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of MapReduceJobInput in org.kiji.mapreduce.input
            + classAvroKeyMapReduceJobInput + +
            +          The class AvroKeyMapReduceJobInput is used to indicate the usage of Avro container + files containing keys as input to a MapReduce job.
            + classAvroKeyValueMapReduceJobInput + +
            +          The class AvroKeyValueMapReduceJobInput is used to indicate the usage of Avro container + files containing key-value pairs as input to a MapReduce job.
            + classFileMapReduceJobInput + +
            +          Base class for MapReduce job input that is read from files.
            + classHTableMapReduceJobInput + +
            +          The class HTableMapReduceJobInput is used to indicate the usage of a HBase table + as input to a MapReduce job.
            + classKijiTableMapReduceJobInput + +
            +          The class KijiTableMapReduceJobInput is used to indicate the usage of a KijiTable + as input to a MapReduce job.
            + classSequenceFileMapReduceJobInput + +
            +          The class SequenceFileMapReduceJobInput is used to indicate the usage of a Hadoop + sequence file as input to a MapReduce job.
            + classTextMapReduceJobInput + +
            +          The class TextMapReduceJobInput is used to indicate the usage of lines in text files + in HDFS as input to a MapReduce job.
            + classWholeTextFileMapReduceJobInput + +
            +          The class WholeTextFileMapReduceJobInput is used to indicate the usage of entire text + files as rows for input to a MapReduce job.
            +  +

            + + + + + +
            +Uses of MapReduceJobInput in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework that return MapReduceJobInput
            + MapReduceJobInputMapReduceJobInputFactory.fromSpaceSeparatedMap(String ssm) + +
            +          Creates a job input from a command-line flag space-separated parameters map.
            +protected  MapReduceJobInputJobTool.getJobInput() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJobOutput.html new file mode 100644 index 00000000..84794a25 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/class-use/MapReduceJobOutput.html @@ -0,0 +1,442 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.MapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.MapReduceJobOutput

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use MapReduceJobOutput
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.outputMapReduce job output types. 
            org.kiji.mapreduce.output.frameworkFramework-level classes supporting KijiMR job output classes. 
            org.kiji.mapreduce.output.implImplementation details for KijiMR's Hadoop output classes. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of MapReduceJobOutput in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport with parameters of type MapReduceJobOutput
            + KijiBulkImportJobBuilderKijiBulkImportJobBuilder.withOutput(MapReduceJobOutput jobOutput) + +
            +          Configures the job output.
            +  +

            + + + + + +
            +Uses of MapReduceJobOutput in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return MapReduceJobOutput
            +protected  MapReduceJobOutputMapReduceJobBuilder.getJobOutput() + +
            +          Provides access to the job output that the builder is configured with.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework with parameters of type MapReduceJobOutput
            + TMapReduceJobBuilder.withOutput(MapReduceJobOutput jobOutput) + +
            +          Configures the job output.
            +  +

            + + + + + +
            +Uses of MapReduceJobOutput in org.kiji.mapreduce.output
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of MapReduceJobOutput in org.kiji.mapreduce.output
            + classAvroKeyMapReduceJobOutput + +
            +          The class AvroKeyMapReduceJobOutput is used to indicate the usage of Avro container files + as output for a MapReduce job.
            + classAvroKeyValueMapReduceJobOutput + +
            +          The class AvroKeyValueMapReduceJobOutput is used to indicate the usage of Avro container files + as output for a MapReduce job.
            + classDirectKijiTableMapReduceJobOutput + +
            +          The class DirectKijiTableMapReduceJobOutput is used to indicate the usage of a Kiji table + as an output for a MapReduce job.
            + classFileMapReduceJobOutput + +
            +          Base class for MapReduce job output types that write to files.
            + classHFileMapReduceJobOutput + +
            +          The class HFileMapReduceJobOutput is used to indicate the usage of HFiles based on the layout + of a Kiji table as output for a MapReduce job.
            + classMapFileMapReduceJobOutput + +
            +          The class MapFileMapReduceJobOutput is used to indicate the usage of Hadoop map files as + output for a MapReduce job.
            + classSequenceFileMapReduceJobOutput + +
            +          The class SequenceFileMapReduceJobOutput is used to indicate the usage of Hadoop + sequence files as output for a MapReduce job.
            + classTextMapReduceJobOutput + +
            +          The class TextMapReduceJobOutput is used to indicate the usage of text files as output + for a MapReduce job.
            +  +

            + + + + + +
            +Uses of MapReduceJobOutput in org.kiji.mapreduce.output.framework
            +  +

            + + + + + + + + + +
            Subclasses of MapReduceJobOutput in org.kiji.mapreduce.output.framework
            + classHFileReducerMapReduceJobOutput + +
            +          M/R job output configuration for a job intending to reduce into HFiles.
            +  +

            + + + + + +
            +Uses of MapReduceJobOutput in org.kiji.mapreduce.output.impl
            +  +

            + + + + + + + + + +
            Subclasses of MapReduceJobOutput in org.kiji.mapreduce.output.impl
            + classKijiTableMapReduceJobOutput + +
            +          MapReduce job output configuration that outputs to a Kiji table.
            +  +

            + + + + + +
            +Uses of MapReduceJobOutput in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce with parameters of type MapReduceJobOutput
            + KijiProduceJobBuilderKijiProduceJobBuilder.withOutput(MapReduceJobOutput jobOutput) + +
            +          Configures the job output.
            +  +

            + + + + + +
            +Uses of MapReduceJobOutput in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework that return MapReduceJobOutput
            + MapReduceJobOutputMapReduceJobOutputFactory.fromSpaceSeparatedMap(String ssm) + +
            +          Creates a job output from a command-line flag space-separated parameters map.
            +protected  MapReduceJobOutputJobTool.getJobOutput() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/HFileKeyValue.FastComparator.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/HFileKeyValue.FastComparator.html new file mode 100644 index 00000000..6b3391f9 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/HFileKeyValue.FastComparator.html @@ -0,0 +1,302 @@ + + + + + + + +HFileKeyValue.FastComparator (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.framework +
            +Class HFileKeyValue.FastComparator

            +
            +java.lang.Object
+  extended by org.apache.hadoop.io.WritableComparator
+      extended by org.kiji.mapreduce.framework.HFileKeyValue.FastComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator, org.apache.hadoop.io.RawComparator
            +
            +
            +
            Enclosing class:
            HFileKeyValue
            +
            +
            +
            +
            public static class HFileKeyValue.FastComparator
            extends org.apache.hadoop.io.WritableComparator
            + + +

            +A comparator that works over byte arrays, to avoid serialization. + +

            This comparator is registered with the Writable serialization framework so it is + used when comparing HFileKeyValue keys.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HFileKeyValue.FastComparator() + +
            +          Constructor.
            +  + + + + + + + + + + + +
            +Method Summary
            + intcompare(byte[] b1, + int s1, + int l1, + byte[] b2, + int s2, + int l2) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.io.WritableComparator
            compare, compare, compareBytes, define, get, getKeyClass, hashBytes, hashBytes, newKey, readDouble, readFloat, readInt, readLong, readUnsignedShort, readVInt, readVLong
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

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

            +HFileKeyValue.FastComparator

            +
            +public HFileKeyValue.FastComparator()
            +
            +
            Constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(byte[] b1,
+                   int s1,
+                   int l1,
+                   byte[] b2,
+                   int s2,
+                   int l2)
            +
            +
            +

            +

            +
            Specified by:
            compare in interface org.apache.hadoop.io.RawComparator
            Overrides:
            compare in class org.apache.hadoop.io.WritableComparator
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/HFileKeyValue.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/HFileKeyValue.html new file mode 100644 index 00000000..454746cf --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/HFileKeyValue.html @@ -0,0 +1,562 @@ + + + + + + + +HFileKeyValue (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.framework +
            +Class HFileKeyValue

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.framework.HFileKeyValue
+
            +
            +
            All Implemented Interfaces:
            Comparable<HFileKeyValue>, org.apache.hadoop.io.Writable, org.apache.hadoop.io.WritableComparable<HFileKeyValue>
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class HFileKeyValue
            extends Object
            implements org.apache.hadoop.io.WritableComparable<HFileKeyValue>
            + + +

            +A KeyValue-like object that implements WritableComparable. + +

            This class works around two shortcomings in the existing KeyValue implementation + within HBase: +

              +
            1. KeyValue is Writable, but not WritableComparable.
              2. +
            2. KeyValue maintains state in private caches, which is not cleared + during Writable deserialization.
              3. +
            +

            + +

            HFileKeyValue wraps a KeyValue object, and resets it during + Writable deserialization to clear any cached state.

            +

            Note: this class has a natural ordering that is inconsistent with equals.

            +

            + +

            +

            +
            See Also:
            KeyValue
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classHFileKeyValue.FastComparator + +
            +          A comparator that works over byte arrays, to avoid serialization.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            HFileKeyValue() + +
            +          Default constructor for Writable instantiation -- you probably don't want to use this.
            HFileKeyValue(byte[] rowKey, + byte[] family, + byte[] qualifier, + long timestamp, + byte[] value) + +
            +          Constructor that builds a filled HFileKeyValue.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + intcompareTo(HFileKeyValue other) + +
            +          
            +static HFileKeyValuecreateFromRowKey(byte[] rowKey) + +
            +          Creates a new HFileKeyValue with a row key (all other fields left empty).
            + byte[]getFamily() + +
            +          Gets the KeyValue's column family.
            + org.apache.hadoop.hbase.KeyValuegetKeyValue() + +
            +          Provides access to the wrapped KeyValue object.
            + intgetLength() + +
            +          Gets the length of the serialized HFileKeyValue in bytes.
            + byte[]getRowKey() + +
            +          Gets the KeyValue's row key.
            + voidreadFields(DataInput in) + +
            +          
            + StringtoString() + +
            +          
            + booleanupdateLatestStamp(byte[] now) + +
            +          Sets the timestamp that should be used if the KeyValue is using + HConstants.LATEST_TIMESTAMP.
            + voidwrite(DataOutput out) + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +HFileKeyValue

            +
            +public HFileKeyValue()
            +
            +
            Default constructor for Writable instantiation -- you probably don't want to use this. +

            +

            +
            + +

            +HFileKeyValue

            +
            +public HFileKeyValue(byte[] rowKey,
+                     byte[] family,
+                     byte[] qualifier,
+                     long timestamp,
+                     byte[] value)
            +
            +
            Constructor that builds a filled HFileKeyValue. +

            +

            +
            Parameters:
            rowKey - The row key.
            family - The column family.
            qualifier - The column qualifier.
            timestamp - The cell timestamp.
            value - The cell value.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createFromRowKey

            +
            +public static HFileKeyValue createFromRowKey(byte[] rowKey)
            +
            +
            Creates a new HFileKeyValue with a row key (all other fields left empty). +

            +

            +
            +
            +
            +
            Parameters:
            rowKey - An HBase row key. +
            Returns:
            A new HFileKeyValue.
            +
            +
            +
            + +

            +getFamily

            +
            +public byte[] getFamily()
            +
            +
            Gets the KeyValue's column family. + +

            This requires some array copying, which is only done once within the wrapped + KeyValue object and cached.

            +

            +

            +
            +
            +
            + +
            Returns:
            The column family.
            See Also:
            KeyValue
            +
            +
            +
            + +

            +getRowKey

            +
            +public byte[] getRowKey()
            +
            +
            Gets the KeyValue's row key. + +

            This requires some array copying, which is only done once within the wrapped + KeyValue object and cached.

            +

            +

            +
            +
            +
            + +
            Returns:
            The row key.
            See Also:
            KeyValue
            +
            +
            +
            + +

            +getKeyValue

            +
            +public org.apache.hadoop.hbase.KeyValue getKeyValue()
            +
            +
            Provides access to the wrapped KeyValue object. +

            +

            +
            +
            +
            + +
            Returns:
            The wrapped HBase KeyValue object.
            See Also:
            KeyValue
            +
            +
            +
            + +

            +updateLatestStamp

            +
            +public boolean updateLatestStamp(byte[] now)
            +
            +
            Sets the timestamp that should be used if the KeyValue is using + HConstants.LATEST_TIMESTAMP. +

            +

            +
            +
            +
            +
            Parameters:
            now - The timestamp as a byte array. +
            Returns:
            Whether the timestamp of the KeyValue was modified.
            See Also:
            KeyValue
            +
            +
            +
            + +

            +getLength

            +
            +public int getLength()
            +
            +
            Gets the length of the serialized HFileKeyValue in bytes. +

            +

            +
            +
            +
            + +
            Returns:
            The size of the HFileKeyValue in bytes.
            +
            +
            +
            + +

            +compareTo

            +
            +public int compareTo(HFileKeyValue other)
            +
            +
            +

            +

            +
            Specified by:
            compareTo in interface Comparable<HFileKeyValue>
            +
            +
            +
            +
            +
            +
            + +

            +readFields

            +
            +public void readFields(DataInput in)
+                throws IOException
            +
            +
            +

            +

            +
            Specified by:
            readFields in interface org.apache.hadoop.io.Writable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +write

            +
            +public void write(DataOutput out)
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            write in interface org.apache.hadoop.io.Writable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/JobHistoryCounters.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/JobHistoryCounters.html new file mode 100644 index 00000000..2a854059 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/JobHistoryCounters.html @@ -0,0 +1,376 @@ + + + + + + + +JobHistoryCounters (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.framework +
            +Enum JobHistoryCounters

            +
            +java.lang.Object
+  extended by java.lang.Enum<JobHistoryCounters>
+      extended by org.kiji.mapreduce.framework.JobHistoryCounters
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<JobHistoryCounters>
            +
            +
            +
            +
            @ApiAudience.Framework
+public enum JobHistoryCounters
            extends Enum<JobHistoryCounters>
            + + +

            +An enumeration for the various hadoop job counters we collect. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            BULKIMPORTER_RECORDS_INCOMPLETE + +
            +           
            BULKIMPORTER_RECORDS_PROCESSED + +
            +           
            BULKIMPORTER_RECORDS_REJECTED + +
            +           
            GATHERER_ROWS_PROCESSED + +
            +           
            PRODUCER_ROWS_PROCESSED + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static JobHistoryCountersvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static JobHistoryCounters[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +PRODUCER_ROWS_PROCESSED

            +
            +public static final JobHistoryCounters PRODUCER_ROWS_PROCESSED
            +
            +
            +
            +
            +
            + +

            +GATHERER_ROWS_PROCESSED

            +
            +public static final JobHistoryCounters GATHERER_ROWS_PROCESSED
            +
            +
            +
            +
            +
            + +

            +BULKIMPORTER_RECORDS_PROCESSED

            +
            +public static final JobHistoryCounters BULKIMPORTER_RECORDS_PROCESSED
            +
            +
            +
            +
            +
            + +

            +BULKIMPORTER_RECORDS_INCOMPLETE

            +
            +public static final JobHistoryCounters BULKIMPORTER_RECORDS_INCOMPLETE
            +
            +
            +
            +
            +
            + +

            +BULKIMPORTER_RECORDS_REJECTED

            +
            +public static final JobHistoryCounters BULKIMPORTER_RECORDS_REJECTED
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static JobHistoryCounters[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (JobHistoryCounters c : JobHistoryCounters.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static JobHistoryCounters valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/JobHistoryKijiTable.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/JobHistoryKijiTable.html new file mode 100644 index 00000000..8100ca4f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/JobHistoryKijiTable.html @@ -0,0 +1,376 @@ + + + + + + + +JobHistoryKijiTable (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.framework +
            +Class JobHistoryKijiTable

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.framework.JobHistoryKijiTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class JobHistoryKijiTable
            extends Object
            implements Closeable
            + + +

            +A class providing an API to install and access the job history kiji table. + + Used in places like KijiMapReduceJob to record information about jobs run through Kiji. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +           
            +static StringgetInstallName() + +
            +          Returns the default name of the job history table.
            + org.kiji.schema.KijiRowDatagetJobDetails(String jobId) + +
            +          Get the saved information for a particular JobID.
            +static voidinstall(org.kiji.schema.Kiji kiji) + +
            +          Install the job history table into a Kiji instance.
            +static JobHistoryKijiTableopen(org.kiji.schema.Kiji kiji) + +
            +          Opens a JobHistoryKijiTable for a given kiji.
            + voidrecordJob(org.apache.hadoop.mapreduce.Job job, + long startTime, + long endTime) + +
            +          Writes a job into the JobHistoryKijiTable.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +open

            +
            +public static JobHistoryKijiTable open(org.kiji.schema.Kiji kiji)
+                                throws IOException
            +
            +
            Opens a JobHistoryKijiTable for a given kiji. Outside code should use this to access the + JobHistory table. +

            +

            +
            +
            +
            +
            Parameters:
            kiji - The kiji instance to use. +
            Returns:
            An opened JobHistoryKijiTable. +
            Throws: +
            IOException - If there is an error opening the table.
            +
            +
            +
            + +

            +getInstallName

            +
            +public static String getInstallName()
            +
            +
            Returns the default name of the job history table. +

            +

            +
            +
            +
            + +
            Returns:
            The name of the job history table as used by the installer.
            +
            +
            +
            + +

            +recordJob

            +
            +public void recordJob(org.apache.hadoop.mapreduce.Job job,
+                      long startTime,
+                      long endTime)
+               throws IOException
            +
            +
            Writes a job into the JobHistoryKijiTable. +

            +

            +
            +
            +
            +
            Parameters:
            job - The job to save.
            startTime - The time the job began, in milliseconds.
            endTime - The time the job ended, in milliseconds +
            Throws: +
            IOException - If there is an error writing to the table.
            +
            +
            +
            + +

            +install

            +
            +public static void install(org.kiji.schema.Kiji kiji)
+                    throws IOException
            +
            +
            Install the job history table into a Kiji instance. +

            +

            +
            +
            +
            +
            Parameters:
            kiji - The Kiji instance to install this table in. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getJobDetails

            +
            +public org.kiji.schema.KijiRowData getJobDetails(String jobId)
+                                          throws IOException
            +
            +
            Get the saved information for a particular JobID. +

            +

            +
            +
            +
            +
            Parameters:
            jobId - The id of the job to retrieve. +
            Returns:
            A KijiRowData containing all the information for the requested Job. +
            Throws: +
            IOException - If there is an IO error retrieving the data.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiConfKeys.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiConfKeys.html new file mode 100644 index 00000000..73cc7a09 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiConfKeys.html @@ -0,0 +1,375 @@ + + + + + + + +KijiConfKeys (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.framework +
            +Class KijiConfKeys

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.framework.KijiConfKeys
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiConfKeys
            extends Object
            + + +

            +Configuration keys used by KijiMR in Hadoop Configuration objects. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringKIJI_BULK_IMPORTER_CLASS + +
            +          Fully qualified name of the KijiBulkImporter class to run.
            +static StringKIJI_GATHERER_CLASS + +
            +          Fully qualified name of the KijiGatherer class to run.
            +static StringKIJI_INPUT_DATA_REQUEST + +
            +          Serialized input data request.
            +static StringKIJI_INPUT_TABLE_URI + +
            +          URI of the input table to read from.
            +static StringKIJI_INSTANCE_NAME + +
            +          Kiji Instance Name.
            +static StringKIJI_OUTPUT_TABLE_URI + +
            +          URI of the output Kiji table to write to.
            +static StringKIJI_PRODUCER_CLASS + +
            +          Fully qualified name of the KijiProducer class to run.
            +static StringKIJI_TABLE_CONTEXT_CLASS + +
            +          Name of the KijiTableContext class to use.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +KIJI_INPUT_TABLE_URI

            +
            +public static final String KIJI_INPUT_TABLE_URI
            +
            +
            URI of the input table to read from. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_OUTPUT_TABLE_URI

            +
            +public static final String KIJI_OUTPUT_TABLE_URI
            +
            +
            URI of the output Kiji table to write to. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_TABLE_CONTEXT_CLASS

            +
            +public static final String KIJI_TABLE_CONTEXT_CLASS
            +
            +
            Name of the KijiTableContext class to use. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_INPUT_DATA_REQUEST

            +
            +public static final String KIJI_INPUT_DATA_REQUEST
            +
            +
            Serialized input data request. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_GATHERER_CLASS

            +
            +public static final String KIJI_GATHERER_CLASS
            +
            +
            Fully qualified name of the KijiGatherer class to run. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_PRODUCER_CLASS

            +
            +public static final String KIJI_PRODUCER_CLASS
            +
            +
            Fully qualified name of the KijiProducer class to run. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_BULK_IMPORTER_CLASS

            +
            +public static final String KIJI_BULK_IMPORTER_CLASS
            +
            +
            Fully qualified name of the KijiBulkImporter class to run. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_INSTANCE_NAME

            +
            +public static final String KIJI_INSTANCE_NAME
            +
            +
            Kiji Instance Name. +

            +

            +
            See Also:
            Constant Field Values
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiMapReduceJob.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiMapReduceJob.html new file mode 100644 index 00000000..91c8e11f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiMapReduceJob.html @@ -0,0 +1,324 @@ + + + + + + + +KijiMapReduceJob (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.framework +
            +Class KijiMapReduceJob

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJob
+      extended by org.kiji.mapreduce.framework.KijiMapReduceJob
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiMapReduceJob
            extends MapReduceJob
            + + +

            +An implementation of a runnable MapReduce job that interacts with Kiji tables. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.mapreduce.MapReduceJob
            MapReduceJob.Status
            +  + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiMapReduceJobcreate(org.apache.hadoop.mapreduce.Job job) + +
            +          Creates a new KijiMapReduceJob.
            + booleanrun() + +
            +          Runs the job (blocks until it is complete).
            + MapReduceJob.Statussubmit() + +
            +          Starts the job and return immediately.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.MapReduceJob
            getHadoopJob
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiMapReduceJob create(org.apache.hadoop.mapreduce.Job job)
            +
            +
            Creates a new KijiMapReduceJob. +

            +

            +
            Parameters:
            job - is a Hadoop Job that interacts with Kiji and will be wrapped by the new + KijiMapReduceJob. +
            Returns:
            A new KijiMapReduceJob backed by a Hadoop Job.
            +
            +
            +
            + +

            +submit

            +
            +public MapReduceJob.Status submit()
+                           throws ClassNotFoundException,
+                                  IOException,
+                                  InterruptedException
            +
            +
            Description copied from class: MapReduceJob
            +
            Starts the job and return immediately. +

            +

            +
            Overrides:
            submit in class MapReduceJob
            +
            +
            + +
            Returns:
            The job status. This can be queried for completion and success or failure. +
            Throws: +
            ClassNotFoundException - If a required class cannot be found on the classpath. +
            IOException - If there is an IO error. +
            InterruptedException - If the thread is interrupted.
            +
            +
            +
            + +

            +run

            +
            +public boolean run()
+            throws ClassNotFoundException,
+                   IOException,
+                   InterruptedException
            +
            +
            Description copied from class: MapReduceJob
            +
            Runs the job (blocks until it is complete). +

            +

            +
            Overrides:
            run in class MapReduceJob
            +
            +
            + +
            Returns:
            Whether the job was successful. +
            Throws: +
            ClassNotFoundException - If a required class cannot be found on the classpath. +
            IOException - If there is an IO error. +
            InterruptedException - If the thread is interrupted.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiTableInputFormat.KijiTableRecordReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiTableInputFormat.KijiTableRecordReader.html new file mode 100644 index 00000000..ab78581e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiTableInputFormat.KijiTableRecordReader.html @@ -0,0 +1,453 @@ + + + + + + + +KijiTableInputFormat.KijiTableRecordReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.framework +
            +Class KijiTableInputFormat.KijiTableRecordReader

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.RecordReader<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
+      extended by org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Enclosing class:
            KijiTableInputFormat
            +
            +
            +
            +
            public static class KijiTableInputFormat.KijiTableRecordReader
            extends org.apache.hadoop.mapreduce.RecordReader<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
            + + +

            +Hadoop record reader for Kiji table rows. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +protected  org.kiji.schema.KijiDataRequestmDataRequest + +
            +          Data request.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableInputFormat.KijiTableRecordReader(org.apache.hadoop.conf.Configuration conf) + +
            +          Creates a new RecordReader for this input format.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + org.kiji.schema.EntityIdgetCurrentKey() + +
            +          
            + org.kiji.schema.KijiRowDatagetCurrentValue() + +
            +          
            + floatgetProgress() + +
            +          
            + voidinitialize(org.apache.hadoop.mapreduce.InputSplit split, + org.apache.hadoop.mapreduce.TaskAttemptContext context) + +
            +          
            + booleannextKeyValue() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +mDataRequest

            +
            +protected final org.kiji.schema.KijiDataRequest mDataRequest
            +
            +
            Data request. +

            +

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

            +KijiTableInputFormat.KijiTableRecordReader

            +
            +public KijiTableInputFormat.KijiTableRecordReader(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Creates a new RecordReader for this input format. + + Perform the actual reads from Kiji. +

            +

            +
            Parameters:
            conf - Configuration for the target Kiji.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(org.apache.hadoop.mapreduce.InputSplit split,
+                       org.apache.hadoop.mapreduce.TaskAttemptContext context)
+                throws IOException
            +
            +
            +

            +

            +
            Specified by:
            initialize in class org.apache.hadoop.mapreduce.RecordReader<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getCurrentKey

            +
            +public org.kiji.schema.EntityId getCurrentKey()
+                                       throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getCurrentKey in class org.apache.hadoop.mapreduce.RecordReader<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getCurrentValue

            +
            +public org.kiji.schema.KijiRowData getCurrentValue()
+                                            throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getCurrentValue in class org.apache.hadoop.mapreduce.RecordReader<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getProgress

            +
            +public float getProgress()
+                  throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getProgress in class org.apache.hadoop.mapreduce.RecordReader<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +nextKeyValue

            +
            +public boolean nextKeyValue()
+                     throws IOException
            +
            +
            +

            +

            +
            Specified by:
            nextKeyValue in class org.apache.hadoop.mapreduce.RecordReader<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in class org.apache.hadoop.mapreduce.RecordReader<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiTableInputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiTableInputFormat.html new file mode 100644 index 00000000..d79dbf0d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiTableInputFormat.html @@ -0,0 +1,399 @@ + + + + + + + +KijiTableInputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.framework +
            +Class KijiTableInputFormat

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.InputFormat<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
+      extended by org.kiji.mapreduce.framework.KijiTableInputFormat
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiTableInputFormat
            extends org.apache.hadoop.mapreduce.InputFormat<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
            implements org.apache.hadoop.conf.Configurable
            + + +

            +InputFormat for Hadoop MapReduce jobs reading from a Kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTableInputFormat.KijiTableRecordReader + +
            +          Hadoop record reader for Kiji table rows.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableInputFormat() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidconfigureJob(org.apache.hadoop.mapreduce.Job job, + org.kiji.schema.KijiURI tableURI, + org.kiji.schema.KijiDataRequest dataRequest, + String startRow, + String endRow) + +
            +          Configures a Hadoop M/R job to read from a given table.
            + org.apache.hadoop.mapreduce.RecordReader<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>createRecordReader(org.apache.hadoop.mapreduce.InputSplit split, + org.apache.hadoop.mapreduce.TaskAttemptContext context) + +
            +          
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +          
            + List<org.apache.hadoop.mapreduce.InputSplit>getSplits(org.apache.hadoop.mapreduce.JobContext context) + +
            +          
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableInputFormat

            +
            +public KijiTableInputFormat()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +createRecordReader

            +
            +public org.apache.hadoop.mapreduce.RecordReader<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData> createRecordReader(org.apache.hadoop.mapreduce.InputSplit split,
+                                                                                                                         org.apache.hadoop.mapreduce.TaskAttemptContext context)
+                                                                                                                  throws IOException
            +
            +
            +

            +

            +
            Specified by:
            createRecordReader in class org.apache.hadoop.mapreduce.InputFormat<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getSplits

            +
            +public List<org.apache.hadoop.mapreduce.InputSplit> getSplits(org.apache.hadoop.mapreduce.JobContext context)
+                                                       throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getSplits in class org.apache.hadoop.mapreduce.InputFormat<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +configureJob

            +
            +public static void configureJob(org.apache.hadoop.mapreduce.Job job,
+                                org.kiji.schema.KijiURI tableURI,
+                                org.kiji.schema.KijiDataRequest dataRequest,
+                                String startRow,
+                                String endRow)
+                         throws IOException
            +
            +
            Configures a Hadoop M/R job to read from a given table. +

            +

            +
            +
            +
            +
            Parameters:
            job - Job to configure.
            tableURI - URI of the table to read from.
            dataRequest - Data request.
            startRow - Minimum row key to process.
            endRow - Maximum row Key to process. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiTableInputJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiTableInputJobBuilder.html new file mode 100644 index 00000000..31795cd7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/KijiTableInputJobBuilder.html @@ -0,0 +1,490 @@ + + + + + + + +KijiTableInputJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.framework +
            +Class KijiTableInputJobBuilder<T extends KijiTableInputJobBuilder<T>>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.framework.MapReduceJobBuilder<T>
+      extended by org.kiji.mapreduce.framework.KijiTableInputJobBuilder<T>
+
            +
            +
            Type Parameters:
            T - Type of the builder class.
            +
            +
            Direct Known Subclasses:
            KijiGatherJobBuilder, KijiProduceJobBuilder
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public abstract class KijiTableInputJobBuilder<T extends KijiTableInputJobBuilder<T>>
            extends MapReduceJobBuilder<T>
            + + +

            +Base class for MapReduce jobs that use a Kiji table as input. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected KijiTableInputJobBuilder() + +
            +          Constructs a builder for jobs that use a Kiji table as input.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidconfigureJob(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures a Hadoop MR job.
            +protected abstract  org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          Subclasses must override this to provide a Kiji data request for the input table.
            +protected  org.kiji.schema.KijiURIgetInputTableURI() + +
            +           
            +protected  MapReduceJobInputgetJobInput() + +
            +          Gets the input to configure the job with.
            +protected  voidvalidateInputTable(org.kiji.schema.KijiTable table) + +
            +          Validates the input table.
            + TwithFilter(org.kiji.schema.filter.KijiRowFilter rowFilter) + +
            +          Configures the job to exclude rows not accepted by a row filter.
            + TwithInputTable(org.kiji.schema.KijiURI inputTableURI) + +
            +          Configures the job with the Kiji table to use as input.
            + TwithJobInput(KijiTableMapReduceJobInput input) + +
            +          Configures the job input table.
            + TwithLimitRow(org.kiji.schema.EntityId entityId) + +
            +          Configures the job to process rows before an entity id.
            + TwithStartRow(org.kiji.schema.EntityId entityId) + +
            +          Configures the job to process rows after and including an entity id.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.framework.MapReduceJobBuilder
            addJarDirectory, addJarDirectory, build, build, configureAvro, configureCombiner, configureHTableInput, configureInput, configureJars, configureMapper, configureOutput, configureReducer, configureStores, getCombiner, getConf, getJarClass, getJobOutput, getMapper, getReducer, getRequiredStores, mergeStores, withConf, withOutput, withStore, withStoreBindings, withStoreBindingsFile
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableInputJobBuilder

            +
            +protected KijiTableInputJobBuilder()
            +
            +
            Constructs a builder for jobs that use a Kiji table as input. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +withJobInput

            +
            +public T withJobInput(KijiTableMapReduceJobInput input)
            +
            +
            Configures the job input table. +

            +

            +
            Parameters:
            input - The job input table. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withInputTable

            +
            +public T withInputTable(org.kiji.schema.KijiURI inputTableURI)
            +
            +
            Configures the job with the Kiji table to use as input. +

            +

            +
            Parameters:
            inputTableURI - The Kiji table to use as input for the job. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withStartRow

            +
            +public T withStartRow(org.kiji.schema.EntityId entityId)
            +
            +
            Configures the job to process rows after and including an entity id. +

            +

            +
            Parameters:
            entityId - The entity id of the first row input. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withLimitRow

            +
            +public T withLimitRow(org.kiji.schema.EntityId entityId)
            +
            +
            Configures the job to process rows before an entity id. +

            +

            +
            Parameters:
            entityId - The entity id of the first row to exclude from the input. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withFilter

            +
            +public T withFilter(org.kiji.schema.filter.KijiRowFilter rowFilter)
            +
            +
            Configures the job to exclude rows not accepted by a row filter. +

            +

            +
            Parameters:
            rowFilter - A filter that specifies which rows to exclude from the input table. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +configureJob

            +
            +protected void configureJob(org.apache.hadoop.mapreduce.Job job)
+                     throws IOException
            +
            +
            Configures a Hadoop MR job. +

            +

            +
            Overrides:
            configureJob in class MapReduceJobBuilder<T extends KijiTableInputJobBuilder<T>>
            +
            +
            +
            Parameters:
            job - The Hadoop MR job. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getJobInput

            +
            +protected MapReduceJobInput getJobInput()
            +
            +
            Gets the input to configure the job with. +

            +

            +
            Specified by:
            getJobInput in class MapReduceJobBuilder<T extends KijiTableInputJobBuilder<T>>
            +
            +
            + +
            Returns:
            The job input.
            +
            +
            +
            + +

            +getInputTableURI

            +
            +protected org.kiji.schema.KijiURI getInputTableURI()
            +
            +
            + +
            Returns:
            the URI of the input table.
            +
            +
            +
            + +

            +getDataRequest

            +
            +protected abstract org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            Subclasses must override this to provide a Kiji data request for the input table. +

            +

            + +
            Returns:
            the Kiji data request to configure the input table scanner with.
            +
            +
            +
            + +

            +validateInputTable

            +
            +protected void validateInputTable(org.kiji.schema.KijiTable table)
+                           throws IOException
            +
            +
            Validates the input table. + + Sub-classes may override this method to perform additional validation requiring an active + connection to the input table. +

            +

            +
            Parameters:
            table - Input table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/MapReduceJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/MapReduceJobBuilder.html new file mode 100644 index 00000000..ffa18db2 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/MapReduceJobBuilder.html @@ -0,0 +1,950 @@ + + + + + + + +MapReduceJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.framework +
            +Class MapReduceJobBuilder<T extends MapReduceJobBuilder<T>>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.framework.MapReduceJobBuilder<T>
+
            +
            +
            Type Parameters:
            T - The type of the builder class. Users should use a concrete + implementation such as KijiGatherJobBuilder.
            +
            +
            Direct Known Subclasses:
            KijiBulkImportJobBuilder, KijiMapReduceJobBuilder, KijiTableInputJobBuilder
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public abstract class MapReduceJobBuilder<T extends MapReduceJobBuilder<T>>
            extends Object
            + + +

            +Base class for builders that configure MapReduceJobs. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected MapReduceJobBuilder() + +
            +          Creates a new MapReduceJobBuilder instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TaddJarDirectory(File jarDirectory) + +
            +          Adds a local directory of jars to the distributed cache of the job.
            + TaddJarDirectory(String jarDirectory) + +
            +          Adds a local directory of jars to the distributed cache of the job.
            + MapReduceJobbuild() + +
            +          Builds a runnable MapReduce job.
            +protected abstract  MapReduceJobbuild(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop MR job in a MapReduceJob.
            +protected  voidconfigureAvro(org.apache.hadoop.mapreduce.Job job, + KijiMapper<?,?,?,?> mapper) + +
            +          Configures the job with any Avro reader or writer schemas specified by the mapper class.
            +protected  voidconfigureCombiner(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the MapReduce combiner for the job.
            +protected  voidconfigureHTableInput(org.apache.hadoop.mapreduce.Job job, + KijiMapper<?,?,?,?> mapper) + +
            +          Configures HTable input for the job if the mapper is an HTableReader.
            +protected  voidconfigureInput(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the input for the job.
            +protected  voidconfigureJars(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the jars to be added to the distributed cache during the job.
            +protected  voidconfigureJob(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures a Hadoop MR job.
            +protected  voidconfigureMapper(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the MapReduce mapper for the job.
            +protected  voidconfigureOutput(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the output for the job.
            +protected  voidconfigureReducer(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the MapReduce reducer for the job.
            +protected  voidconfigureStores(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the key-value stores to be attached to the job.
            +protected abstract  KijiReducer<?,?,?,?>getCombiner() + +
            +          Gets an instance of the MapReduce combiner to be used for this job.
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +           
            +protected abstract  Class<?>getJarClass() + +
            +          Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks.
            +protected abstract  MapReduceJobInputgetJobInput() + +
            +          Gets the input to configure the job with.
            +protected  MapReduceJobOutputgetJobOutput() + +
            +          Provides access to the job output that the builder is configured with.
            +protected abstract  KijiMapper<?,?,?,?>getMapper() + +
            +          Gets an instance of the MapReduce mapper to be used for this job.
            +protected abstract  KijiReducer<?,?,?,?>getReducer() + +
            +          Gets an instance of the MapReduce reducer to be used for this job.
            +protected  Map<String,KeyValueStore<?,?>>getRequiredStores() + +
            +          Method for job components to declare required KeyValueStore entries (and their default + implementations).
            +protected  voidmergeStores(Map<String,KeyValueStore<?,?>> dest, + Map<String,KeyValueStore<?,?>> src) + +
            +          Adds all KeyValueStore mappings from src to the 'dest' map.
            + TwithConf(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the base Hadoop configuration used to build the MapReduce job.
            + TwithOutput(MapReduceJobOutput jobOutput) + +
            +          Configures the job output.
            + TwithStore(String storeName, + KeyValueStore<?,?> storeImpl) + +
            +          Binds a key-value store name to the specified KeyValueStore implementation.
            + TwithStoreBindings(InputStream inputSpec) + +
            +          Parses the inputSpec as a KeyValueStore xml configuration file.
            + TwithStoreBindingsFile(String specFilename) + +
            +          Parses the KeyValueStore specification XML file and adds all store bindings in the + file to the job.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MapReduceJobBuilder

            +
            +protected MapReduceJobBuilder()
            +
            +
            Creates a new MapReduceJobBuilder instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +build

            +
            +public MapReduceJob build()
+                   throws IOException
            +
            +
            Builds a runnable MapReduce job. +

            +

            + +
            Returns:
            A configured MapReduce job, ready to be run. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +addJarDirectory

            +
            +public T addJarDirectory(File jarDirectory)
            +
            +
            Adds a local directory of jars to the distributed cache of the job. +

            +

            +
            Parameters:
            jarDirectory - The path to a directory of jar files. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +addJarDirectory

            +
            +public T addJarDirectory(String jarDirectory)
            +
            +
            Adds a local directory of jars to the distributed cache of the job. +

            +

            +
            Parameters:
            jarDirectory - The path to a directory of jar files. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withOutput

            +
            +public T withOutput(MapReduceJobOutput jobOutput)
            +
            +
            Configures the job output. +

            +

            +
            Parameters:
            jobOutput - The output for the job. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +getJobOutput

            +
            +protected MapReduceJobOutput getJobOutput()
            +
            +
            Provides access to the job output that the builder is configured with. +

            +

            + +
            Returns:
            The output for the job the builder will create.
            +
            +
            +
            + +

            +withStore

            +
            +public T withStore(String storeName,
+                   KeyValueStore<?,?> storeImpl)
            +
            +
            Binds a key-value store name to the specified KeyValueStore implementation. +

            +

            +
            Parameters:
            storeName - the name of the KeyValueStore.
            storeImpl - the KeyValueStore implementation to use. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withStoreBindingsFile

            +
            +public T withStoreBindingsFile(String specFilename)
+                                                       throws IOException
            +
            +
            Parses the KeyValueStore specification XML file and adds all store bindings in the + file to the job. +

            +

            +
            Parameters:
            specFilename - the name of the XML file specifying the input stores. +
            Returns:
            This builder instance so you may chain configuration method calls. +
            Throws: +
            IOException - if there is an error reading or parsing the spec file.
            See Also:
            withStoreBindings(InputStream)
            +
            +
            +
            + +

            +withStoreBindings

            +
            +public T withStoreBindings(InputStream inputSpec)
+                                                   throws IOException
            +
            +

            Parses the inputSpec as a KeyValueStore xml configuration file. + Adds the name-to-KeyValueStore bindings defined there to this job. + See the user guide on "Specifying KeyValueStore bindings from the Command Line" + for xml format for this config file.

            + +

            The caller of this method is responsible for closing the InputStream + argument.

            +

            +

            +
            Parameters:
            inputSpec - the InputStream that provides the XML file specifying the input stores. +
            Returns:
            This builder instance so you may chain configuration method calls. +
            Throws: +
            IOException - if there is an error reading or parsing the input spec.
            +
            +
            +
            + +

            +withConf

            +
            +public T withConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Sets the base Hadoop configuration used to build the MapReduce job. +

            +

            +
            Parameters:
            conf - Base Hadoop configuration used to build the MapReduce job. +
            Returns:
            this.
            +
            +
            +
            + +

            +getConf

            +
            +public final org.apache.hadoop.conf.Configuration getConf()
            +
            +
            + +
            Returns:
            the base Hadoop configuration used to build the MapReduce job.
            +
            +
            +
            + +

            +configureJob

            +
            +protected void configureJob(org.apache.hadoop.mapreduce.Job job)
+                     throws IOException
            +
            +
            Configures a Hadoop MR job. +

            +

            +
            Parameters:
            job - The Hadoop MR job. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +configureInput

            +
            +protected void configureInput(org.apache.hadoop.mapreduce.Job job)
+                       throws IOException
            +
            +
            Configures the input for the job. +

            +

            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +configureMapper

            +
            +protected void configureMapper(org.apache.hadoop.mapreduce.Job job)
+                        throws IOException
            +
            +
            Configures the MapReduce mapper for the job. +

            +

            +
            Parameters:
            job - The Hadoop MR job. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +configureAvro

            +
            +protected void configureAvro(org.apache.hadoop.mapreduce.Job job,
+                             KijiMapper<?,?,?,?> mapper)
+                      throws IOException
            +
            +
            Configures the job with any Avro reader or writer schemas specified by the mapper class. + +

            If the job's mapper class uses AvroKey as the job's input key class, it should + have implemented the AvroKeyReader interface to specify the reader schema for the + input key. Likewise, if it uses AvroValue as the job's input value class, it should + have implemented the AvroValueReader interface.

            + +

            If the job's mapper class uses AvroKey as the output key class, it should + have implemented the AvroKeyWriter interface to specify the writer schema for the + output key. Likewise, if it uses AvroValue as the output value class, it should have + implemented the AvroValueWriter interface.

            + +

            This method makes sure those interfaces were implemented correctly, uses them to + fetch the reader/writer schemas as necessary, and sets them in the Job configuration + so the Avro input format and serialization framework can access them.

            +

            +

            +
            Parameters:
            job - The job to configure.
            mapper - The Kiji mapper the job is configured to run. +
            Throws: +
            IOException - If the Avro schemas cannot be configured.
            +
            +
            +
            + +

            +configureHTableInput

            +
            +protected void configureHTableInput(org.apache.hadoop.mapreduce.Job job,
+                                    KijiMapper<?,?,?,?> mapper)
+                             throws IOException
            +
            +
            Configures HTable input for the job if the mapper is an HTableReader. + +

            If the mapper the job is configured to run is reading from an HBase table + (HTable), this method will make sure the mapper implements the HTableReader interface + and use its methods to configure the table scan specification required for the + HTableInputFormat.

            + +

            A mapper that reads its input from an HTable needs to specify the Scan descriptor + that describes what subset of rows and column cells should be processed. The mapper + communicates this by implementing the methods of the HTableReader interface. This + method calls the methods of that interface on the job's mapper and sets Scan + descriptor into the job configuration so the HTableInputFormat can read it.

            +

            +

            +
            Parameters:
            job - The job to configure.
            mapper - The Kiji mapper the job is configured to run. +
            Throws: +
            IOException - If the HTable input cannot be configured.
            +
            +
            +
            + +

            +configureCombiner

            +
            +protected void configureCombiner(org.apache.hadoop.mapreduce.Job job)
            +
            +
            Configures the MapReduce combiner for the job. +

            +

            +
            Parameters:
            job - The Hadoop MR job.
            +
            +
            +
            + +

            +configureReducer

            +
            +protected void configureReducer(org.apache.hadoop.mapreduce.Job job)
+                         throws IOException
            +
            +
            Configures the MapReduce reducer for the job. +

            +

            +
            Parameters:
            job - The Hadoop MR job. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +configureOutput

            +
            +protected void configureOutput(org.apache.hadoop.mapreduce.Job job)
+                        throws IOException
            +
            +
            Configures the output for the job. +

            +

            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +configureStores

            +
            +protected void configureStores(org.apache.hadoop.mapreduce.Job job)
+                        throws IOException
            +
            +
            Configures the key-value stores to be attached to the job. + +

            This adds the key-value stores defined by the user and the + job components (producer, gatherer, etc) to the job configuration. +

            +

            +

            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - if there is an error configuring the stores. This + may include, e.g., the case where a store is required but not defined.
            +
            +
            +
            + +

            +mergeStores

            +
            +protected void mergeStores(Map<String,KeyValueStore<?,?>> dest,
+                           Map<String,KeyValueStore<?,?>> src)
            +
            +
            Adds all KeyValueStore mappings from src to the 'dest' map. + Warns the user if the same store name is defined multiple times with a different + store implementation. +

            +

            +
            Parameters:
            dest - the map to modify; will contain the union of its current data and + all mappings in src.
            src - an additional set of KeyValueStore mappings to apply.
            +
            +
            +
            + +

            +getRequiredStores

            +
            +protected Map<String,KeyValueStore<?,?>> getRequiredStores()
+                                                    throws IOException
            +
            +
            Method for job components to declare required KeyValueStore entries (and their default + implementations). +

            +

            + +
            Returns:
            a map of required names to default KeyValueStore implementations to add. These will + be used to augment the existing map if any names are not defined by withStore(). +
            Throws: +
            IOException - if there is an error configuring stores.
            +
            +
            +
            + +

            +configureJars

            +
            +protected void configureJars(org.apache.hadoop.mapreduce.Job job)
+                      throws IOException
            +
            +
            Configures the jars to be added to the distributed cache during the job. + +

            This adds the jar class containing the mapper to the job via + setJarByClass() and adds the jars kiji depends on from the kiji release + lib directory, which is assumed to be the same directory as the kiji jar.

            +

            +

            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - If there is an error reading the jars from the file system.
            +
            +
            +
            + +

            +build

            +
            +protected abstract MapReduceJob build(org.apache.hadoop.mapreduce.Job job)
            +
            +
            Wraps a Hadoop MR job in a MapReduceJob. +

            +

            +
            Parameters:
            job - The Hadoop MR job. +
            Returns:
            The built MapReduceJob.
            +
            +
            +
            + +

            +getJobInput

            +
            +protected abstract MapReduceJobInput getJobInput()
            +
            +
            Gets the input to configure the job with. +

            +

            + +
            Returns:
            The job input.
            +
            +
            +
            + +

            +getMapper

            +
            +protected abstract KijiMapper<?,?,?,?> getMapper()
            +
            +
            Gets an instance of the MapReduce mapper to be used for this job. +

            +

            + +
            Returns:
            An instance of the mapper.
            +
            +
            +
            + +

            +getCombiner

            +
            +protected abstract KijiReducer<?,?,?,?> getCombiner()
            +
            +
            Gets an instance of the MapReduce combiner to be used for this job. +

            +

            + +
            Returns:
            An instance of the combiner, or null if this job should not use a combiner.
            +
            +
            +
            + +

            +getReducer

            +
            +protected abstract KijiReducer<?,?,?,?> getReducer()
            +
            +
            Gets an instance of the MapReduce reducer to be used for this job. +

            +

            + +
            Returns:
            An instance of the reducer, or null if this job should be map-only.
            +
            +
            +
            + +

            +getJarClass

            +
            +protected abstract Class<?> getJarClass()
            +
            +
            Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks. +

            +

            + +
            Returns:
            A class contained in the jar to be included on the MR classpath.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/HFileKeyValue.FastComparator.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/HFileKeyValue.FastComparator.html new file mode 100644 index 00000000..1b1276be --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/HFileKeyValue.FastComparator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.framework.HFileKeyValue.FastComparator (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.framework.HFileKeyValue.FastComparator

            +
            +No usage of org.kiji.mapreduce.framework.HFileKeyValue.FastComparator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/HFileKeyValue.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/HFileKeyValue.html new file mode 100644 index 00000000..10af25bb --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/HFileKeyValue.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.framework.HFileKeyValue (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.framework.HFileKeyValue

            +
            + + + + + + + + + + + + + +
            +Packages that use HFileKeyValue
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.output.frameworkFramework-level classes supporting KijiMR job output classes. 
            +  +

            + + + + + +
            +Uses of HFileKeyValue in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return HFileKeyValue
            +static HFileKeyValueHFileKeyValue.createFromRowKey(byte[] rowKey) + +
            +          Creates a new HFileKeyValue with a row key (all other fields left empty).
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework with parameters of type HFileKeyValue
            + intHFileKeyValue.compareTo(HFileKeyValue other) + +
            +          
            +  +

            + + + + + +
            +Uses of HFileKeyValue in org.kiji.mapreduce.output.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.output.framework that return types with arguments of type HFileKeyValue
            + org.apache.hadoop.mapreduce.RecordWriter<HFileKeyValue,org.apache.hadoop.io.NullWritable>KijiHFileOutputFormat.getRecordWriter(org.apache.hadoop.mapreduce.TaskAttemptContext context) + +
            +          
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/JobHistoryCounters.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/JobHistoryCounters.html new file mode 100644 index 00000000..a5cd8241 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/JobHistoryCounters.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.framework.JobHistoryCounters (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.framework.JobHistoryCounters

            +
            + + + + + + + + + +
            +Packages that use JobHistoryCounters
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            +  +

            + + + + + +
            +Uses of JobHistoryCounters in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return JobHistoryCounters
            +static JobHistoryCountersJobHistoryCounters.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static JobHistoryCounters[]JobHistoryCounters.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/JobHistoryKijiTable.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/JobHistoryKijiTable.html new file mode 100644 index 00000000..8c34c28b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/JobHistoryKijiTable.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.framework.JobHistoryKijiTable (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.framework.JobHistoryKijiTable

            +
            + + + + + + + + + +
            +Packages that use JobHistoryKijiTable
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            +  +

            + + + + + +
            +Uses of JobHistoryKijiTable in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return JobHistoryKijiTable
            +static JobHistoryKijiTableJobHistoryKijiTable.open(org.kiji.schema.Kiji kiji) + +
            +          Opens a JobHistoryKijiTable for a given kiji.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiConfKeys.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiConfKeys.html new file mode 100644 index 00000000..4d6599bd --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiConfKeys.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.framework.KijiConfKeys (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.framework.KijiConfKeys

            +
            +No usage of org.kiji.mapreduce.framework.KijiConfKeys +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiMapReduceJob.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiMapReduceJob.html new file mode 100644 index 00000000..c63a0cc9 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiMapReduceJob.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.framework.KijiMapReduceJob (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.framework.KijiMapReduceJob

            +
            + + + + + + + + + +
            +Packages that use KijiMapReduceJob
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            +  +

            + + + + + +
            +Uses of KijiMapReduceJob in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return KijiMapReduceJob
            +static KijiMapReduceJobKijiMapReduceJob.create(org.apache.hadoop.mapreduce.Job job) + +
            +          Creates a new KijiMapReduceJob.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiTableInputFormat.KijiTableRecordReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiTableInputFormat.KijiTableRecordReader.html new file mode 100644 index 00000000..e37fb7c2 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiTableInputFormat.KijiTableRecordReader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader

            +
            +No usage of org.kiji.mapreduce.framework.KijiTableInputFormat.KijiTableRecordReader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiTableInputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiTableInputFormat.html new file mode 100644 index 00000000..c041502e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiTableInputFormat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.framework.KijiTableInputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.framework.KijiTableInputFormat

            +
            +No usage of org.kiji.mapreduce.framework.KijiTableInputFormat +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiTableInputJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiTableInputJobBuilder.html new file mode 100644 index 00000000..0eb81c09 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/KijiTableInputJobBuilder.html @@ -0,0 +1,268 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.framework.KijiTableInputJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.framework.KijiTableInputJobBuilder

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiTableInputJobBuilder
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of KijiTableInputJobBuilder in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.framework with type parameters of type KijiTableInputJobBuilder
            + classKijiTableInputJobBuilder<T extends KijiTableInputJobBuilder<T>> + +
            +          Base class for MapReduce jobs that use a Kiji table as input.
            +  +

            + + + + + +
            +Uses of KijiTableInputJobBuilder in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + +
            Subclasses of KijiTableInputJobBuilder in org.kiji.mapreduce.gather
            + classKijiGatherJobBuilder + +
            +          Builds jobs that run a gatherer over a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiTableInputJobBuilder in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Subclasses of KijiTableInputJobBuilder in org.kiji.mapreduce.produce
            + classKijiProduceJobBuilder + +
            +          Builds jobs that run a producer over a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiTableInputJobBuilder in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.tools.framework with type parameters of type KijiTableInputJobBuilder
            + classKijiJobTool<B extends KijiTableInputJobBuilder> + +
            +          Base class for tools that run MapReduce jobs over kiji tables.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/MapReduceJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/MapReduceJobBuilder.html new file mode 100644 index 00000000..3f42d233 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/class-use/MapReduceJobBuilder.html @@ -0,0 +1,342 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.framework.MapReduceJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.framework.MapReduceJobBuilder

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use MapReduceJobBuilder
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of MapReduceJobBuilder in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Subclasses of MapReduceJobBuilder in org.kiji.mapreduce
            + classKijiMapReduceJobBuilder + +
            +          Builds general MapReduce jobs around Kiji mappers and reducers.
            +  +

            + + + + + +
            +Uses of MapReduceJobBuilder in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + +
            Subclasses of MapReduceJobBuilder in org.kiji.mapreduce.bulkimport
            + classKijiBulkImportJobBuilder + +
            +          Builds a job that runs a KijiBulkImporter to import data into a Kiji table.
            +  +

            + + + + + +
            +Uses of MapReduceJobBuilder in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.framework with type parameters of type MapReduceJobBuilder
            + classMapReduceJobBuilder<T extends MapReduceJobBuilder<T>> + +
            +          Base class for builders that configure MapReduceJobs.
            +  +

            + + + + + + + + + +
            Subclasses of MapReduceJobBuilder in org.kiji.mapreduce.framework
            + classKijiTableInputJobBuilder<T extends KijiTableInputJobBuilder<T>> + +
            +          Base class for MapReduce jobs that use a Kiji table as input.
            +  +

            + + + + + +
            +Uses of MapReduceJobBuilder in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + +
            Subclasses of MapReduceJobBuilder in org.kiji.mapreduce.gather
            + classKijiGatherJobBuilder + +
            +          Builds jobs that run a gatherer over a Kiji table.
            +  +

            + + + + + +
            +Uses of MapReduceJobBuilder in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Subclasses of MapReduceJobBuilder in org.kiji.mapreduce.produce
            + classKijiProduceJobBuilder + +
            +          Builds jobs that run a producer over a Kiji table.
            +  +

            + + + + + +
            +Uses of MapReduceJobBuilder in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.tools.framework with type parameters of type MapReduceJobBuilder
            + classJobTool<B extends MapReduceJobBuilder> + +
            +          Base class for tools that run MapReduce jobs.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-frame.html new file mode 100644 index 00000000..bf0d1844 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-frame.html @@ -0,0 +1,60 @@ + + + + + + + +org.kiji.mapreduce.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.framework + + + + +
            +Classes  + +
            +HFileKeyValue +
            +HFileKeyValue.FastComparator +
            +JobHistoryKijiTable +
            +KijiConfKeys +
            +KijiMapReduceJob +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader +
            +KijiTableInputJobBuilder +
            +MapReduceJobBuilder
            + + + + + + +
            +Enums  + +
            +JobHistoryCounters
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-summary.html new file mode 100644 index 00000000..130b62d1 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-summary.html @@ -0,0 +1,220 @@ + + + + + + + +org.kiji.mapreduce.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.framework +

            +Framework-level classes supporting basic KijiMR classes. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            HFileKeyValueA KeyValue-like object that implements WritableComparable.
            HFileKeyValue.FastComparatorA comparator that works over byte arrays, to avoid serialization.
            JobHistoryKijiTableA class providing an API to install and access the job history kiji table.
            KijiConfKeysConfiguration keys used by KijiMR in Hadoop Configuration objects.
            KijiMapReduceJobAn implementation of a runnable MapReduce job that interacts with Kiji tables.
            KijiTableInputFormatInputFormat for Hadoop MapReduce jobs reading from a Kiji table.
            KijiTableInputFormat.KijiTableRecordReaderHadoop record reader for Kiji table rows.
            KijiTableInputJobBuilder<T extends KijiTableInputJobBuilder<T>>Base class for MapReduce jobs that use a Kiji table as input.
            MapReduceJobBuilder<T extends MapReduceJobBuilder<T>>Base class for builders that configure MapReduceJobs.
            +  + +

            + + + + + + + + + +
            +Enum Summary
            JobHistoryCountersAn enumeration for the various hadoop job counters we collect.
            +  + +

            +

            +Package org.kiji.mapreduce.framework Description +

            + +

            +Framework-level classes supporting basic KijiMR classes. Applications + should not use these. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-tree.html new file mode 100644 index 00000000..af428a2c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-tree.html @@ -0,0 +1,179 @@ + + + + + + + +org.kiji.mapreduce.framework Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.framework +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-use.html new file mode 100644 index 00000000..60997f2e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/framework/package-use.html @@ -0,0 +1,333 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.framework

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.framework
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.output.frameworkFramework-level classes supporting KijiMR job output classes. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.framework used by org.kiji.mapreduce
            MapReduceJobBuilder + +
            +          Base class for builders that configure MapReduceJobs.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.framework used by org.kiji.mapreduce.bulkimport
            MapReduceJobBuilder + +
            +          Base class for builders that configure MapReduceJobs.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.framework used by org.kiji.mapreduce.framework
            HFileKeyValue + +
            +          A KeyValue-like object that implements WritableComparable.
            JobHistoryCounters + +
            +          An enumeration for the various hadoop job counters we collect.
            JobHistoryKijiTable + +
            +          A class providing an API to install and access the job history kiji table.
            KijiMapReduceJob + +
            +          An implementation of a runnable MapReduce job that interacts with Kiji tables.
            KijiTableInputJobBuilder + +
            +          Base class for MapReduce jobs that use a Kiji table as input.
            MapReduceJobBuilder + +
            +          Base class for builders that configure MapReduceJobs.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.framework used by org.kiji.mapreduce.gather
            KijiTableInputJobBuilder + +
            +          Base class for MapReduce jobs that use a Kiji table as input.
            MapReduceJobBuilder + +
            +          Base class for builders that configure MapReduceJobs.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.framework used by org.kiji.mapreduce.output.framework
            HFileKeyValue + +
            +          A KeyValue-like object that implements WritableComparable.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.framework used by org.kiji.mapreduce.produce
            KijiTableInputJobBuilder + +
            +          Base class for MapReduce jobs that use a Kiji table as input.
            MapReduceJobBuilder + +
            +          Base class for builders that configure MapReduceJobs.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.framework used by org.kiji.mapreduce.tools.framework
            KijiTableInputJobBuilder + +
            +          Base class for MapReduce jobs that use a Kiji table as input.
            MapReduceJobBuilder + +
            +          Base class for builders that configure MapReduceJobs.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/GathererContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/GathererContext.html new file mode 100644 index 00000000..3b51dc84 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/GathererContext.html @@ -0,0 +1,258 @@ + + + + + + + +GathererContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.gather +
            +Interface GathererContext<K,V>

            +
            +
            Type Parameters:
            K - Type of the keys to emit.
            V - Type of the values to emit.
            +
            +
            All Superinterfaces:
            Closeable, Flushable, KijiContext
            +
            +
            +
            All Known Implementing Classes:
            InternalGathererContext
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface GathererContext<K,V>
            extends KijiContext
            + + +

            +Context for gatherers. GathererContexts emit key/value pairs. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + voidwrite(K key, + V value) + +
            +          Emits a key/value pair.
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KijiContext
            getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +write

            +
            +void write(K key,
+           V value)
+           throws IOException
            +
            +
            Emits a key/value pair. +

            +

            +
            +
            +
            +
            Parameters:
            key - Emit this key.
            value - Emit this value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/KijiGatherJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/KijiGatherJobBuilder.html new file mode 100644 index 00000000..de367ffe --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/KijiGatherJobBuilder.html @@ -0,0 +1,562 @@ + + + + + + + +KijiGatherJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.gather +
            +Class KijiGatherJobBuilder

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.framework.MapReduceJobBuilder<T>
+      extended by org.kiji.mapreduce.framework.KijiTableInputJobBuilder<KijiGatherJobBuilder>
+          extended by org.kiji.mapreduce.gather.KijiGatherJobBuilder
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiGatherJobBuilder
            extends KijiTableInputJobBuilder<KijiGatherJobBuilder>
            + + +

            +Builds jobs that run a gatherer over a Kiji table. + +

            Example usage:

            + 
            
+ MapReduceJob job = KijiGatherJobBuilder.create()
+     .withInputTable(myTable)
+     .withGatherer(MyCountGatherer.class)
+     .withReducer(SimpleIntSumReducer.class)
+     .withOutput(new TextMapReduceJobOutput("path/to/counts", numSplits))
+     .build();
+ boolean success = job.run();
+
            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  MapReduceJobbuild(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop MR job in a MapReduceJob.
            +protected  voidconfigureJob(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures a Hadoop MR job.
            +protected  voidconfigureOutput(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the output for the job.
            +static KijiGatherJobBuildercreate() + +
            +          Creates a new builder for Kiji gather jobs.
            +protected  KijiReducer<?,?,?,?>getCombiner() + +
            +          Gets an instance of the MapReduce combiner to be used for this job.
            +protected  org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          Subclasses must override this to provide a Kiji data request for the input table.
            +protected  Class<?>getJarClass() + +
            +          Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks.
            +protected  KijiMapper<?,?,?,?>getMapper() + +
            +          Gets an instance of the MapReduce mapper to be used for this job.
            +protected  KijiReducer<?,?,?,?>getReducer() + +
            +          Gets an instance of the MapReduce reducer to be used for this job.
            +protected  Map<String,KeyValueStore<?,?>>getRequiredStores() + +
            +          Method for job components to declare required KeyValueStore entries (and their default + implementations).
            + KijiGatherJobBuilderwithCombiner(Class<? extends KijiReducer> combinerClass) + +
            +          Configures the job with a combiner to run (optional).
            + KijiGatherJobBuilderwithGatherer(Class<? extends KijiGatherer> gathererClass) + +
            +          Configures the job with the Kiji gatherer to run in the map phase.
            + KijiGatherJobBuilderwithReducer(Class<? extends KijiReducer> reducerClass) + +
            +          Configures the job with a reducer to run (optional).
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.framework.KijiTableInputJobBuilder
            getInputTableURI, getJobInput, validateInputTable, withFilter, withInputTable, withJobInput, withLimitRow, withStartRow
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.framework.MapReduceJobBuilder
            addJarDirectory, addJarDirectory, build, configureAvro, configureCombiner, configureHTableInput, configureInput, configureJars, configureMapper, configureReducer, configureStores, getConf, getJobOutput, mergeStores, withConf, withOutput, withStore, withStoreBindings, withStoreBindingsFile
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiGatherJobBuilder create()
            +
            +
            Creates a new builder for Kiji gather jobs. +

            +

            + +
            Returns:
            a new Kiji gather job builder.
            +
            +
            +
            + +

            +withGatherer

            +
            +public KijiGatherJobBuilder withGatherer(Class<? extends KijiGatherer> gathererClass)
            +
            +
            Configures the job with the Kiji gatherer to run in the map phase. +

            +

            +
            Parameters:
            gathererClass - The gatherer class. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withCombiner

            +
            +public KijiGatherJobBuilder withCombiner(Class<? extends KijiReducer> combinerClass)
            +
            +
            Configures the job with a combiner to run (optional). +

            +

            +
            Parameters:
            combinerClass - The combiner class. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withReducer

            +
            +public KijiGatherJobBuilder withReducer(Class<? extends KijiReducer> reducerClass)
            +
            +
            Configures the job with a reducer to run (optional). +

            +

            +
            Parameters:
            reducerClass - The reducer class. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +configureJob

            +
            +protected void configureJob(org.apache.hadoop.mapreduce.Job job)
+                     throws IOException
            +
            +
            Configures a Hadoop MR job. +

            +

            +
            Overrides:
            configureJob in class KijiTableInputJobBuilder<KijiGatherJobBuilder>
            +
            +
            +
            Parameters:
            job - The Hadoop MR job. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getRequiredStores

            +
            +protected Map<String,KeyValueStore<?,?>> getRequiredStores()
+                                                    throws IOException
            +
            +
            Method for job components to declare required KeyValueStore entries (and their default + implementations). +

            +

            +
            Overrides:
            getRequiredStores in class MapReduceJobBuilder<KijiGatherJobBuilder>
            +
            +
            + +
            Returns:
            a map of required names to default KeyValueStore implementations to add. These will + be used to augment the existing map if any names are not defined by withStore(). +
            Throws: +
            IOException - if there is an error configuring stores.
            +
            +
            +
            + +

            +build

            +
            +protected MapReduceJob build(org.apache.hadoop.mapreduce.Job job)
            +
            +
            Wraps a Hadoop MR job in a MapReduceJob. +

            +

            +
            Specified by:
            build in class MapReduceJobBuilder<KijiGatherJobBuilder>
            +
            +
            +
            Parameters:
            job - The Hadoop MR job. +
            Returns:
            The built MapReduceJob.
            +
            +
            +
            + +

            +getDataRequest

            +
            +protected org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            Subclasses must override this to provide a Kiji data request for the input table. +

            +

            +
            Specified by:
            getDataRequest in class KijiTableInputJobBuilder<KijiGatherJobBuilder>
            +
            +
            + +
            Returns:
            the Kiji data request to configure the input table scanner with.
            +
            +
            +
            + +

            +getMapper

            +
            +protected KijiMapper<?,?,?,?> getMapper()
            +
            +
            Gets an instance of the MapReduce mapper to be used for this job. +

            +

            +
            Specified by:
            getMapper in class MapReduceJobBuilder<KijiGatherJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the mapper.
            +
            +
            +
            + +

            +getCombiner

            +
            +protected KijiReducer<?,?,?,?> getCombiner()
            +
            +
            Gets an instance of the MapReduce combiner to be used for this job. +

            +

            +
            Specified by:
            getCombiner in class MapReduceJobBuilder<KijiGatherJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the combiner, or null if this job should not use a combiner.
            +
            +
            +
            + +

            +getReducer

            +
            +protected KijiReducer<?,?,?,?> getReducer()
            +
            +
            Gets an instance of the MapReduce reducer to be used for this job. +

            +

            +
            Specified by:
            getReducer in class MapReduceJobBuilder<KijiGatherJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the reducer, or null if this job should be map-only.
            +
            +
            +
            + +

            +getJarClass

            +
            +protected Class<?> getJarClass()
            +
            +
            Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks. +

            +

            +
            Specified by:
            getJarClass in class MapReduceJobBuilder<KijiGatherJobBuilder>
            +
            +
            + +
            Returns:
            A class contained in the jar to be included on the MR classpath.
            +
            +
            +
            + +

            +configureOutput

            +
            +protected void configureOutput(org.apache.hadoop.mapreduce.Job job)
+                        throws IOException
            +
            +
            Configures the output for the job. +

            +

            +
            Overrides:
            configureOutput in class MapReduceJobBuilder<KijiGatherJobBuilder>
            +
            +
            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/KijiGatherer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/KijiGatherer.html new file mode 100644 index 00000000..074e253a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/KijiGatherer.html @@ -0,0 +1,497 @@ + + + + + + + +KijiGatherer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.gather +
            +Class KijiGatherer<K,V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.gather.KijiGatherer<K,V>
+
            +
            +
            Type Parameters:
            K - The type of the output key from the gatherer.
            V - The type of the output value from the gatherer.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, KijiDataRequester, KVOutputJob, KeyValueStoreClient
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KijiGatherer<K,V>
            extends Object
            implements org.apache.hadoop.conf.Configurable, KeyValueStoreClient, KijiDataRequester, KVOutputJob
            + + +

            +

            + Base class for all Kiji Gatherers. Gatherers are jobs that scan a + kiji table and aggregate data into an external file. +

            + +

            Lifecycle:

            + +

            + Instance are created using ReflectionUtils, so the Configuration is automagically set immediately after + instantiation with a call to setConf(). In order to initialize internal state + before any other methods are called, override the setConf() method. +

            + +

            + As a KeyValueStoreClient, KijiGatherers will have access to all + stores defined by KeyValueStoreClient.getRequiredStores(). Readers for + these stores are surfaced in the setup(), produce(), and cleanup() methods + via the Context provided to each by calling + KijiContext.getStore(String). +

            + +

            + Once the internal state is set, functions may be called in any order, except for + restrictions on setup(), gather(), and cleanup(). +

            + +

            + setup() will get called once at the beginning of the map phase, followed by + a call to gather() for each input row. Once all of these gather() + calls have completed, cleanup() will be called exactly once. It is possible + that this setup-gather-cleanup cycle may repeat any number of times. +

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiGatherer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidcleanup(GathererContext<K,V> context) + +
            +          Called once to dispose of any resources used by the gatherer after all calls to gather().
            +static Class<? extends KijiGatherer>forName(String className) + +
            +          Loads a KijiGatherer class by name.
            +abstract  voidgather(org.kiji.schema.KijiRowData input, + GathererContext<K,V> context) + +
            +          Called once per row in the kiji table.
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +          
            + Map<String,KeyValueStore<?,?>>getRequiredStores() + +
            +          Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations.
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Configuration for this instance.
            + voidsetup(GathererContext<K,V> context) + +
            +          Called once to initialize the gatherer before any calls to gather().
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KijiDataRequester
            getDataRequest
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KVOutputJob
            getOutputKeyClass, getOutputValueClass
            +  +

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

            +KijiGatherer

            +
            +public KijiGatherer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +forName

            +
            +public static Class<? extends KijiGatherer> forName(String className)
+                                             throws ClassNotFoundException
            +
            +
            Loads a KijiGatherer class by name. +

            +

            +
            +
            +
            +
            Parameters:
            className - Fully qualified name of the class to load. +
            Returns:
            the loaded class. +
            Throws: +
            ClassNotFoundException - if the class is not found. +
            ClassCastException - if the class is not a KijiGatherer.
            +
            +
            +
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Sets the Configuration for this instance. + This method will be called immediately after instantiation. + Override this method to initialize internal state from a configuration. +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            Parameters:
            conf - The Configuration to use.
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +setup

            +
            +public void setup(GathererContext<K,V> context)
+           throws IOException
            +
            +
            Called once to initialize the gatherer before any calls to gather(). + You may override this to add any one-time setup operations to your gather job. +

            +

            +
            +
            +
            +
            Parameters:
            context - A gatherer context used to write key/value output, access stores, etc. +
            Throws: +
            IOException - if there is an error.
            +
            +
            +
            + +

            +gather

            +
            +public abstract void gather(org.kiji.schema.KijiRowData input,
+                            GathererContext<K,V> context)
+                     throws IOException
            +
            +
            Called once per row in the kiji table. +

            +

            +
            +
            +
            +
            Parameters:
            input - A single for of input from the Kiji table, filled with the data requested.
            context - A gatherer context, used to write key/value output. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +public void cleanup(GathererContext<K,V> context)
+             throws IOException
            +
            +
            Called once to dispose of any resources used by the gatherer after all calls to gather(). + You may override this to add any final cleanup operations to your gather job. +

            +

            +
            +
            +
            +
            Parameters:
            context - A gatherer context used to write key/value output, access stores, etc. +
            Throws: +
            IOException - if there is an error.
            +
            +
            +
            + +

            +getRequiredStores

            +
            +public Map<String,KeyValueStore<?,?>> getRequiredStores()
            +
            +

            Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations. + It is an error for any of these default implementations to be null. + If you want to defer KeyValueStore definition to runtime, bind a name + to the UnconfiguredKeyValueStore instead.

            + +

            Note that this method returns default mappings from store names to + concrete implementations. Users may override these mappings, e.g. in MapReduce job + configuration. You should not open a store returned by + getRequiredStores() directly; you should look to a + Context object or similar mechanism exposed by the Kiji framework to + determine the actual KeyValueStoreReader instance to use.

            +

            +

            +
            Specified by:
            getRequiredStores in interface KeyValueStoreClient
            +
            +
            + +
            Returns:
            a map from store names to default KeyValueStore implementations.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/class-use/GathererContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/class-use/GathererContext.html new file mode 100644 index 00000000..2b1eec42 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/class-use/GathererContext.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.gather.GathererContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.gather.GathererContext

            +
            + + + + + + + + + + + + + +
            +Packages that use GathererContext
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            +  +

            + + + + + +
            +Uses of GathererContext in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.gather with parameters of type GathererContext
            + voidKijiGatherer.cleanup(GathererContext<K,V> context) + +
            +          Called once to dispose of any resources used by the gatherer after all calls to gather().
            +abstract  voidKijiGatherer.gather(org.kiji.schema.KijiRowData input, + GathererContext<K,V> context) + +
            +          Called once per row in the kiji table.
            + voidKijiGatherer.setup(GathererContext<K,V> context) + +
            +          Called once to initialize the gatherer before any calls to gather().
            +  +

            + + + + + +
            +Uses of GathererContext in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.gather.impl that implement GathererContext
            + classInternalGathererContext<K,V> + +
            +          Concrete context for gatherers that emit key/value pairs.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/class-use/KijiGatherJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/class-use/KijiGatherJobBuilder.html new file mode 100644 index 00000000..8e871b5c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/class-use/KijiGatherJobBuilder.html @@ -0,0 +1,250 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.gather.KijiGatherJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.gather.KijiGatherJobBuilder

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiGatherJobBuilder
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            +  +

            + + + + + +
            +Uses of KijiGatherJobBuilder in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.gather that return KijiGatherJobBuilder
            +static KijiGatherJobBuilderKijiGatherJobBuilder.create() + +
            +          Creates a new builder for Kiji gather jobs.
            + KijiGatherJobBuilderKijiGatherJobBuilder.withCombiner(Class<? extends KijiReducer> combinerClass) + +
            +          Configures the job with a combiner to run (optional).
            + KijiGatherJobBuilderKijiGatherJobBuilder.withGatherer(Class<? extends KijiGatherer> gathererClass) + +
            +          Configures the job with the Kiji gatherer to run in the map phase.
            + KijiGatherJobBuilderKijiGatherJobBuilder.withReducer(Class<? extends KijiReducer> reducerClass) + +
            +          Configures the job with a reducer to run (optional).
            +  +

            + + + + + +
            +Uses of KijiGatherJobBuilder in org.kiji.mapreduce.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools that return KijiGatherJobBuilder
            +protected  KijiGatherJobBuilderKijiGather.createJobBuilder() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools with parameters of type KijiGatherJobBuilder
            +protected  voidKijiGather.configure(KijiGatherJobBuilder jobBuilder) + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/class-use/KijiGatherer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/class-use/KijiGatherer.html new file mode 100644 index 00000000..01547ea0 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/class-use/KijiGatherer.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.gather.KijiGatherer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.gather.KijiGatherer

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiGatherer
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            +  +

            + + + + + +
            +Uses of KijiGatherer in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.gather that return types with arguments of type KijiGatherer
            +static Class<? extends KijiGatherer>KijiGatherer.forName(String className) + +
            +          Loads a KijiGatherer class by name.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.mapreduce.gather with type arguments of type KijiGatherer
            + KijiGatherJobBuilderKijiGatherJobBuilder.withGatherer(Class<? extends KijiGatherer> gathererClass) + +
            +          Configures the job with the Kiji gatherer to run in the map phase.
            +  +

            + + + + + +
            +Uses of KijiGatherer in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.gather.impl that return KijiGatherer
            +protected  KijiGatherer<K,V>GatherMapper.createGatherer(org.apache.hadoop.conf.Configuration conf) + +
            +          Initialize the gatherer instance to execute.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/GatherMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/GatherMapper.html new file mode 100644 index 00000000..ccb19ce0 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/GatherMapper.html @@ -0,0 +1,567 @@ + + + + + + + +GatherMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.gather.impl +
            +Class GatherMapper<K,V>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Mapper<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiMapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>
+          extended by org.kiji.mapreduce.impl.KijiTableMapper<K,V>
+              extended by org.kiji.mapreduce.gather.impl.GatherMapper<K,V>
+
            +
            +
            Type Parameters:
            K - The type of the MapReduce output key.
            V - The type of the MapReduce output value.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, AvroKeyWriter, AvroValueWriter, KijiDataRequester, KVOutputJob
            +
            +
            +
            +
            @ApiAudience.Private
+public final class GatherMapper<K,V>
            extends KijiTableMapper<K,V>
            implements AvroKeyWriter, AvroValueWriter
            + + +

            +Mapper that executes a gatherer over the rows of a Kiji table. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Mapper
            org.apache.hadoop.mapreduce.Mapper.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            GatherMapper() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup(org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          
            +protected  KijiGatherer<K,V>createGatherer(org.apache.hadoop.conf.Configuration conf) + +
            +          Initialize the gatherer instance to execute.
            + org.apache.avro.SchemagetAvroKeyWriterSchema() + +
            +          If the output key class is AvroKey, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is.
            + org.apache.avro.SchemagetAvroValueWriterSchema() + +
            +          If the output key class is AvroValue, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is.
            + org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          Return a KijiDataRequest that describes which input columns need to be available.
            + Class<?>getOutputKeyClass() + +
            +          
            + Class<?>getOutputValueClass() + +
            +          
            +protected  voidmap(org.kiji.schema.KijiRowData input, + org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          Kiji mapper function that processes an input row.
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            +protected  voidsetup(org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.impl.KijiTableMapper
            getConf, map
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiMapper
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Mapper
            run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +GatherMapper

            +
            +public GatherMapper()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Description copied from class: KijiTableMapper
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            Overrides:
            setConf in class KijiTableMapper<K,V>
            +
            +
            +
            +
            +
            +
            + +

            +getDataRequest

            +
            +public org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            Return a KijiDataRequest that describes which input columns need to be available. +

            +

            +
            Specified by:
            getDataRequest in interface KijiDataRequester
            +
            +
            + +
            Returns:
            A kiji data request.
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputKeyClass in interface KVOutputJob
            +
            +
            + +
            Returns:
            the type of keys emitted by this task.
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputValueClass in interface KVOutputJob
            +
            +
            + +
            Returns:
            the type of values emitted by this task.
            +
            +
            +
            + +

            +createGatherer

            +
            +protected KijiGatherer<K,V> createGatherer(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Initialize the gatherer instance to execute. +

            +

            +
            +
            +
            +
            Parameters:
            conf - the Configuration to use to initialize the gatherer instance. +
            Returns:
            a KijiGatherer instance.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup(org.apache.hadoop.mapreduce.Mapper.Context context)
+              throws IOException
            +
            +
            +

            +

            +
            Overrides:
            setup in class KijiTableMapper<K,V>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +map

            +
            +protected void map(org.kiji.schema.KijiRowData input,
+                   org.apache.hadoop.mapreduce.Mapper.Context context)
+            throws IOException
            +
            +
            Kiji mapper function that processes an input row. +

            +

            +
            Specified by:
            map in class KijiTableMapper<K,V>
            +
            +
            +
            Parameters:
            input - Input row from the configured Kiji table.
            context - Hadoop mapper context. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup(org.apache.hadoop.mapreduce.Mapper.Context context)
+                throws IOException
            +
            +
            +

            +

            +
            Overrides:
            cleanup in class KijiTableMapper<K,V>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getAvroKeyWriterSchema

            +
            +public org.apache.avro.Schema getAvroKeyWriterSchema()
+                                              throws IOException
            +
            +
            If the output key class is AvroKey, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. + +

            If this class does not use an AvroKey as its output key class, the return value from + this method will not be used. It may be null.

            +

            +

            +
            Specified by:
            getAvroKeyWriterSchema in interface AvroKeyWriter
            +
            +
            + +
            Returns:
            The Avro schema of the datum wrapped in the AvroKey output. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getAvroValueWriterSchema

            +
            +public org.apache.avro.Schema getAvroValueWriterSchema()
+                                                throws IOException
            +
            +
            If the output key class is AvroValue, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. + +

            If this class does not use an AvroKey as its output key class, the return value from + this method will not be used. It may be null.

            +

            +

            +
            Specified by:
            getAvroValueWriterSchema in interface AvroValueWriter
            +
            +
            + +
            Returns:
            The Avro schema of the datum wrapped in the AvroValue output. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/InternalGathererContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/InternalGathererContext.html new file mode 100644 index 00000000..6301f38a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/InternalGathererContext.html @@ -0,0 +1,313 @@ + + + + + + + +InternalGathererContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.gather.impl +
            +Class InternalGathererContext<K,V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.impl.InternalKijiContext
+      extended by org.kiji.mapreduce.gather.impl.InternalGathererContext<K,V>
+
            +
            +
            Type Parameters:
            K - Type of the keys to emit.
            V - Type of the values to emit.
            +
            +
            All Implemented Interfaces:
            Closeable, Flushable, GathererContext<K,V>, KijiContext
            +
            +
            +
            +
            @ApiAudience.Private
+public final class InternalGathererContext<K,V>
            extends InternalKijiContext
            implements GathererContext<K,V>
            + + +

            +Concrete context for gatherers that emit key/value pairs. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<K,V> InternalGathererContext<K,V>
            +            		create(org.apache.hadoop.mapreduce.TaskInputOutputContext<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V> context) + +
            +          Creates a new context for gatherers.
            + voidwrite(K key, + V value) + +
            +          Emits a key/value pair.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.impl.InternalKijiContext
            close, flush, getMapReduceContext, getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KijiContext
            getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static <K,V> InternalGathererContext<K,V> create(org.apache.hadoop.mapreduce.TaskInputOutputContext<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V> context)
+                                           throws IOException
            +
            +
            Creates a new context for gatherers. +

            +

            +
            +
            +
            +
            Type Parameters:
            K - is the type of key that can be written by the new context.
            V - is the type of value that can be written by the new context.
            Parameters:
            context - is the Hadoop TaskInputOutputContext that will back the new context + for MapReduce jobs. +
            Returns:
            a new context for a gatherer. +
            Throws: +
            IOException - if there is an I/O error.
            +
            +
            +
            + +

            +write

            +
            +public void write(K key,
+                  V value)
+           throws IOException
            +
            +
            Emits a key/value pair. +

            +

            +
            Specified by:
            write in interface GathererContext<K,V>
            +
            +
            +
            Parameters:
            key - Emit this key.
            value - Emit this value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/class-use/GatherMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/class-use/GatherMapper.html new file mode 100644 index 00000000..e3039649 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/class-use/GatherMapper.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.gather.impl.GatherMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.gather.impl.GatherMapper

            +
            +No usage of org.kiji.mapreduce.gather.impl.GatherMapper +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/class-use/InternalGathererContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/class-use/InternalGathererContext.html new file mode 100644 index 00000000..92b049e1 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/class-use/InternalGathererContext.html @@ -0,0 +1,188 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.gather.impl.InternalGathererContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.gather.impl.InternalGathererContext

            +
            + + + + + + + + + +
            +Packages that use InternalGathererContext
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            +  +

            + + + + + +
            +Uses of InternalGathererContext in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.gather.impl that return InternalGathererContext
            +static + + + + +
            +<K,V> InternalGathererContext<K,V>
            +            		InternalGathererContext.create(org.apache.hadoop.mapreduce.TaskInputOutputContext<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V> context) + +
            +          Creates a new context for gatherers.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-frame.html new file mode 100644 index 00000000..c1777de4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +org.kiji.mapreduce.gather.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.gather.impl + + + + +
            +Classes  + +
            +GatherMapper +
            +InternalGathererContext
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-summary.html new file mode 100644 index 00000000..67a0daeb --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-summary.html @@ -0,0 +1,177 @@ + + + + + + + +org.kiji.mapreduce.gather.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.gather.impl +

            +Kiji gatherer implementation details. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + +
            +Class Summary
            GatherMapper<K,V>Mapper that executes a gatherer over the rows of a Kiji table.
            InternalGathererContext<K,V>Concrete context for gatherers that emit key/value pairs.
            +  + +

            +

            +Package org.kiji.mapreduce.gather.impl Description +

            + +

            +Kiji gatherer implementation details. Clients should not use these. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-tree.html new file mode 100644 index 00000000..0637c71d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-tree.html @@ -0,0 +1,167 @@ + + + + + + + +org.kiji.mapreduce.gather.impl Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.gather.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-use.html new file mode 100644 index 00000000..adecdc81 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/impl/package-use.html @@ -0,0 +1,171 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.gather.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.gather.impl

            +
            + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.gather.impl
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.gather.impl used by org.kiji.mapreduce.gather.impl
            InternalGathererContext + +
            +          Concrete context for gatherers that emit key/value pairs.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-frame.html new file mode 100644 index 00000000..d787c401 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-frame.html @@ -0,0 +1,46 @@ + + + + + + + +org.kiji.mapreduce.gather (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.gather + + + + +
            +Interfaces  + +
            +GathererContext
            + + + + + + +
            +Classes  + +
            +KijiGatherer +
            +KijiGatherJobBuilder
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-summary.html new file mode 100644 index 00000000..bbce9a75 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-summary.html @@ -0,0 +1,220 @@ + + + + + + + +org.kiji.mapreduce.gather (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.gather +

            +Gatherer classes for KijiMR clients. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            GathererContext<K,V>Context for gatherers.
            +  + +

            + + + + + + + + + + + + + +
            +Class Summary
            KijiGatherer<K,V> + Base class for all Kiji Gatherers.
            KijiGatherJobBuilderBuilds jobs that run a gatherer over a Kiji table.
            +  + +

            +

            +Package org.kiji.mapreduce.gather Description +

            + +

            +Gatherer classes for KijiMR clients. + +

            + A Kiji Gatherer scans over the rows of a Kiji table using the MapReduce framework to + aggregate information which can be passed to a reducer. + The KijiGatherer class is the base class for all gatherers. + Subclasses take inputs from KijiTable and produce output to + to HFiles. +

            + +

            Constructing a gatherer job:

            +

            + A gatherer job that outputs to HFiles can be created here: +

            + 
            
+   // Configure and create the MapReduce job.
+   final MapReduceJob job = KijiGatherJobBuilder.create()
+       .withConf(conf)
+       .withInputTable(mTable)
+       .withGatherer(SimpleGatherer.class)
+       .withCombiner(MyCombiner.class)
+       .withReducer(MyReducer.class)
+       .withOutput(new TextMapReduceJobOutput(new Path("mypath"), 10))
+       .build();
+
            +

            + The kiji gather command line tool wraps this functionality and can be used + for constructing gathererjobs. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-tree.html new file mode 100644 index 00000000..7516f8ec --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-tree.html @@ -0,0 +1,174 @@ + + + + + + + +org.kiji.mapreduce.gather Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.gather +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-use.html new file mode 100644 index 00000000..881748dd --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/gather/package-use.html @@ -0,0 +1,229 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.gather (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.gather

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.gather
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.gather used by org.kiji.mapreduce.gather
            GathererContext + +
            +          Context for gatherers.
            KijiGatherer + +
            +           + Base class for all Kiji Gatherers.
            KijiGatherJobBuilder + +
            +          Builds jobs that run a gatherer over a Kiji table.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.gather used by org.kiji.mapreduce.gather.impl
            GathererContext + +
            +          Context for gatherers.
            KijiGatherer + +
            +           + Base class for all Kiji Gatherers.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.gather used by org.kiji.mapreduce.tools
            KijiGatherJobBuilder + +
            +          Builds jobs that run a gatherer over a Kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/DirectKijiTableWriterContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/DirectKijiTableWriterContext.html new file mode 100644 index 00000000..a8f71d17 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/DirectKijiTableWriterContext.html @@ -0,0 +1,465 @@ + + + + + + + +DirectKijiTableWriterContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.impl +
            +Class DirectKijiTableWriterContext

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.impl.InternalKijiContext
+      extended by org.kiji.mapreduce.impl.DirectKijiTableWriterContext
+
            +
            +
            All Implemented Interfaces:
            Closeable, Flushable, KijiContext, KijiTableContext, org.kiji.schema.KijiPutter
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DirectKijiTableWriterContext
            extends InternalKijiContext
            implements KijiTableContext
            + + +

            +Kiji context that writes cells to a configured output table. + +

            Implemented as direct writes sent to the HTable. + +

            Using this table writer context in a MapReduce is strongly discouraged : + pushing a lot of data into a running HBase instance may trigger region splits + and cause the HBase instance to go offline. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DirectKijiTableWriterContext(org.apache.hadoop.mapreduce.TaskInputOutputContext<?,?,?,?> hadoopContext) + +
            +          Constructs a new context that can write cells directly to a Kiji table.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +static DirectKijiTableWriterContextcreate(org.apache.hadoop.mapreduce.TaskInputOutputContext<?,?,?,?> hadoopContext) + +
            +          Creates a new context that can write cells directly to a Kiji table.
            + voidflush() + +
            +          
            + org.kiji.schema.EntityIdgetEntityId(String key) + +
            +          Creates an entity ID for the specified Kiji row key.
            + + + + + +
            +<T> void
            +            		put(org.kiji.schema.EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          
            + + + + + +
            +<T> void
            +            		put(org.kiji.schema.EntityId entityId, + String family, + String qualifier, + T value) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.impl.InternalKijiContext
            getMapReduceContext, getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KijiContext
            getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  +

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

            +DirectKijiTableWriterContext

            +
            +public DirectKijiTableWriterContext(org.apache.hadoop.mapreduce.TaskInputOutputContext<?,?,?,?> hadoopContext)
+                             throws IOException
            +
            +
            Constructs a new context that can write cells directly to a Kiji table. +

            +

            +
            Parameters:
            hadoopContext - is the Hadoop TaskInputOutputContext that will be used to perform + the writes. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static DirectKijiTableWriterContext create(org.apache.hadoop.mapreduce.TaskInputOutputContext<?,?,?,?> hadoopContext)
+                                           throws IOException
            +
            +
            Creates a new context that can write cells directly to a Kiji table. +

            +

            +
            +
            +
            +
            Parameters:
            hadoopContext - is the Hadoop TaskInputOutputContext that will be used to perform + the writes. +
            Returns:
            a new context that can write cells directly to a Kiji table. +
            Throws: +
            IOException - if there is an I/O error.
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(org.kiji.schema.EntityId entityId,
+                    String family,
+                    String qualifier,
+                    T value)
+         throws IOException
            +
            +
            +

            +

            +
            Specified by:
            put in interface org.kiji.schema.KijiPutter
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(org.kiji.schema.EntityId entityId,
+                    String family,
+                    String qualifier,
+                    long timestamp,
+                    T value)
+         throws IOException
            +
            +
            +

            +

            +
            Specified by:
            put in interface org.kiji.schema.KijiPutter
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getEntityId

            +
            +public org.kiji.schema.EntityId getEntityId(String key)
            +
            +
            Creates an entity ID for the specified Kiji row key. +

            +

            +
            Specified by:
            getEntityId in interface KijiTableContext
            +
            +
            +
            Parameters:
            key - Kiji row key. +
            Returns:
            the entity ID for the specified Kiji row key.
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            flush in interface Flushable
            Overrides:
            flush in class InternalKijiContext
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Overrides:
            close in class InternalKijiContext
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/HFileWriterContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/HFileWriterContext.html new file mode 100644 index 00000000..9e207e98 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/HFileWriterContext.html @@ -0,0 +1,451 @@ + + + + + + + +HFileWriterContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.impl +
            +Class HFileWriterContext

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.impl.InternalKijiContext
+      extended by org.kiji.mapreduce.impl.HFileWriterContext
+
            +
            +
            All Implemented Interfaces:
            Closeable, Flushable, KijiContext, KijiTableContext, org.kiji.schema.KijiPutter
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HFileWriterContext
            extends InternalKijiContext
            implements KijiTableContext
            + + +

            +Kiji context that emits puts for the configured output table to HFiles. + + This is the recommended way for writing to an HBase table. +

          • This context provides some level of atomicity and isolation + (no partial writes to the table while the M/R job runs, or if the M/R job fails). +
          • Region servers are not hammered but a sustained stream of puts while the M/R job. +
          • After the M/R job completed successfully, the output is committed to the HBase table + using the HFileLoader. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HFileWriterContext(org.apache.hadoop.mapreduce.TaskInputOutputContext<?,?,?,?> hadoopContext) + +
            +          Constructs a new context that can write cells to an HFile that can be loaded into an HBase + table.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +static HFileWriterContextcreate(org.apache.hadoop.mapreduce.TaskInputOutputContext<?,?,?,?> hadoopContext) + +
            +          Creates a new context that can write cells to an HFile that can be loaded into an HBase table.
            + org.kiji.schema.EntityIdgetEntityId(String key) + +
            +          Creates an entity ID for the specified Kiji row key.
            + + + + + +
            +<T> void
            +            		put(org.kiji.schema.EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          
            + + + + + +
            +<T> void
            +            		put(org.kiji.schema.EntityId entityId, + String family, + String qualifier, + T value) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.impl.InternalKijiContext
            flush, getMapReduceContext, getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KijiContext
            getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

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

            +HFileWriterContext

            +
            +public HFileWriterContext(org.apache.hadoop.mapreduce.TaskInputOutputContext<?,?,?,?> hadoopContext)
+                   throws IOException
            +
            +
            Constructs a new context that can write cells to an HFile that can be loaded into an HBase + table. +

            +

            +
            Parameters:
            hadoopContext - is the Hadoop TaskInputOutputContext that will be used to perform + the writes. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static HFileWriterContext create(org.apache.hadoop.mapreduce.TaskInputOutputContext<?,?,?,?> hadoopContext)
+                                 throws IOException
            +
            +
            Creates a new context that can write cells to an HFile that can be loaded into an HBase table. +

            +

            +
            +
            +
            +
            Parameters:
            hadoopContext - is the Hadoop TaskInputOutputContext that will be used to perform + the writes. +
            Returns:
            a new context that can write cells to an HFile that can be loaded into an HBase table. +
            Throws: +
            IOException - if there is an I/O error.
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(org.kiji.schema.EntityId entityId,
+                    String family,
+                    String qualifier,
+                    T value)
+         throws IOException
            +
            +
            +

            +

            +
            Specified by:
            put in interface org.kiji.schema.KijiPutter
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(org.kiji.schema.EntityId entityId,
+                    String family,
+                    String qualifier,
+                    long timestamp,
+                    T value)
+         throws IOException
            +
            +
            +

            +

            +
            Specified by:
            put in interface org.kiji.schema.KijiPutter
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getEntityId

            +
            +public org.kiji.schema.EntityId getEntityId(String key)
            +
            +
            Creates an entity ID for the specified Kiji row key. +

            +

            +
            Specified by:
            getEntityId in interface KijiTableContext
            +
            +
            +
            Parameters:
            key - Kiji row key. +
            Returns:
            the entity ID for the specified Kiji row key.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            Description copied from class: InternalKijiContext
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Overrides:
            close in class InternalKijiContext
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/HTableInputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/HTableInputFormat.html new file mode 100644 index 00000000..e7253bf4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/HTableInputFormat.html @@ -0,0 +1,312 @@ + + + + + + + +HTableInputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.impl +
            +Class HTableInputFormat

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.InputFormat<org.apache.hadoop.hbase.io.ImmutableBytesWritable,org.apache.hadoop.hbase.client.Result>
+      extended by org.apache.hadoop.hbase.mapreduce.TableInputFormatBase
+          extended by org.apache.hadoop.hbase.mapreduce.TableInputFormat
+              extended by org.kiji.mapreduce.impl.HTableInputFormat
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HTableInputFormat
            extends org.apache.hadoop.hbase.mapreduce.TableInputFormat
            + + +

            +An InputFormat for MapReduce jobs over HBase HTables. + +

            HBase ships with a TableInputFormat, but it doesn't clean up its + HTable/Zookeeper connections correctly, so we've extended it here and fixed the bug. + Otherwise, it behaves exactly like the HBase TableInputFormat.

            +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.apache.hadoop.hbase.mapreduce.TableInputFormat
            INPUT_TABLE, SCAN, SCAN_CACHEBLOCKS, SCAN_CACHEDROWS, SCAN_COLUMN_FAMILY, SCAN_COLUMNS, SCAN_MAXVERSIONS, SCAN_TIMERANGE_END, SCAN_TIMERANGE_START, SCAN_TIMESTAMP
            +  + + + + + + + + + + +
            +Constructor Summary
            HTableInputFormat() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + List<org.apache.hadoop.mapreduce.InputSplit>getSplits(org.apache.hadoop.mapreduce.JobContext context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.hbase.mapreduce.TableInputFormat
            addColumns, getConf, setConf
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.hbase.mapreduce.TableInputFormatBase
            createRecordReader, getHTable, getScan, includeRegionInSplit, setHTable, setScan, setTableRecordReader
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HTableInputFormat

            +
            +public HTableInputFormat()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getSplits

            +
            +public List<org.apache.hadoop.mapreduce.InputSplit> getSplits(org.apache.hadoop.mapreduce.JobContext context)
+                                                       throws IOException
            +
            +
            +

            +

            +
            Overrides:
            getSplits in class org.apache.hadoop.hbase.mapreduce.TableInputFormatBase
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/HTableReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/HTableReader.html new file mode 100644 index 00000000..bb54695d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/HTableReader.html @@ -0,0 +1,233 @@ + + + + + + + +HTableReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.impl +
            +Interface HTableReader

            +
            +
            All Known Implementing Classes:
            BinaryHTableBulkImporter, BulkImportMapper
            +
            +
            +
            +
            @ApiAudience.Private
+@Inheritance.Sealed
+public interface HTableReader
            + + +

            +An interface for Kiji mappers or bulk importers that read from HBase HTables. + +

            Reading from an HTable requires knowing what subset of rows and columns should be + read (accomplished by configuring a Scan descriptor).

            + +

            If your mapper or bulk importer uses an HTableInputFormat, you should implement this + interface as a means of specifying the input HTable scan descriptor.

            +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + org.apache.hadoop.hbase.client.ScangetInputHTableScan(org.apache.hadoop.conf.Configuration conf) + +
            +          Returns an HBase scan descriptor that specifies what subset of rows and cells should + be read from the input HTable.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getInputHTableScan

            +
            +org.apache.hadoop.hbase.client.Scan getInputHTableScan(org.apache.hadoop.conf.Configuration conf)
+                                                       throws IOException
            +
            +
            Returns an HBase scan descriptor that specifies what subset of rows and cells should + be read from the input HTable. + +

            This method may return null, meaning that this instance is not really able to read + from an HTable.

            +

            +

            +
            Parameters:
            conf - The job configuration. +
            Returns:
            A new scan descriptor. +
            Throws: +
            IOException - If the scan descriptor cannot be constructed.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/InternalKijiContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/InternalKijiContext.html new file mode 100644 index 00000000..390f240d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/InternalKijiContext.html @@ -0,0 +1,512 @@ + + + + + + + +InternalKijiContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.impl +
            +Class InternalKijiContext

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.impl.InternalKijiContext
+
            +
            +
            All Implemented Interfaces:
            Closeable, Flushable, KijiContext
            +
            +
            +
            Direct Known Subclasses:
            DirectKijiTableWriterContext, HFileWriterContext, InternalGathererContext, InternalProducerContext
            +
            +
            +
            +
            @ApiAudience.Private
+public class InternalKijiContext
            extends Object
            implements KijiContext
            + + +

            +Implements KijiContext. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected InternalKijiContext(org.apache.hadoop.mapreduce.TaskInputOutputContext context) + +
            +          Constructs a new implementation of KijiContext.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + voidflush() + +
            +          
            + org.apache.hadoop.mapreduce.TaskInputOutputContextgetMapReduceContext() + +
            +           
            + StringgetStatus() + +
            +          Returns a previously set status message.
            + + + + + +
            +<K,V> KeyValueStoreReader<K,V>
            +            		getStore(String storeName) + +
            +          Opens a KeyValueStore associated with storeName for read-access.
            + voidincrementCounter(Enum<?> counter) + +
            +          Increments a counter by 1.
            + voidincrementCounter(Enum<?> counter, + long amount) + +
            +          Increment a counter by an amount.
            + voidprogress() + +
            +          Report progress to the kiji framework.
            + voidsetStatus(String msg) + +
            +          Sets a status string for the kiji task.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +InternalKijiContext

            +
            +protected InternalKijiContext(org.apache.hadoop.mapreduce.TaskInputOutputContext context)
+                       throws IOException
            +
            +
            Constructs a new implementation of KijiContext. +

            +

            +
            Parameters:
            context - is the Hadoop TaskInputOutputContext that will back the new + KijiContext +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getMapReduceContext

            +
            +public org.apache.hadoop.mapreduce.TaskInputOutputContext getMapReduceContext()
            +
            +
            +
            +
            +
            + +
            Returns:
            the underlying Hadoop MapReduce context.
            +
            +
            +
            + +

            +getStore

            +
            +public <K,V> KeyValueStoreReader<K,V> getStore(String storeName)
+                                  throws IOException,
+                                         InterruptedException
            +
            +
            Opens a KeyValueStore associated with storeName for read-access. + +

            You should close() the store instance returned by this method + when you are done with it.

            + +

            Calling getStore() multiple times on the same name will reuse the same + reader unless it is closed.

            +

            +

            +
            Specified by:
            getStore in interface KijiContext
            +
            +
            +
            Type Parameters:
            K - The key type for the KeyValueStore.
            V - The value type for the KeyValueStore.
            Parameters:
            storeName - the name of the KeyValueStore to open. +
            Returns:
            A KeyValueStoreReader associated with this storeName, or null + if there is no such KeyValueStore available. +
            Throws: +
            IOException - if there is an error opening the underlying storage resource. +
            InterruptedException - if there is an interruption while connecting to + the underlying storage resource.
            +
            +
            +
            + +

            +incrementCounter

            +
            +public void incrementCounter(Enum<?> counter)
            +
            +
            Increments a counter by 1. +

            +

            +
            Specified by:
            incrementCounter in interface KijiContext
            +
            +
            +
            Parameters:
            counter - The counter to increment.
            +
            +
            +
            + +

            +incrementCounter

            +
            +public void incrementCounter(Enum<?> counter,
+                             long amount)
            +
            +
            Increment a counter by an amount. +

            +

            +
            Specified by:
            incrementCounter in interface KijiContext
            +
            +
            +
            Parameters:
            counter - The counter to increment.
            amount - The amount to increment the counter by.
            +
            +
            +
            + +

            +progress

            +
            +public void progress()
            +
            +
            Report progress to the kiji framework. + +

            If called as part of a MapReduce job, this will indicate progress in the style of + org.apache.hadoop.util.Progressable, keeping the task from being marked as dead. It may also + be called safely from Fresheners, so a producer using this call can be used either as a + Freshener or part of a Hadoop job. +

            +

            +
            Specified by:
            progress in interface KijiContext
            +
            +
            +
            +
            +
            +
            + +

            +setStatus

            +
            +public void setStatus(String msg)
+               throws IOException
            +
            +
            Sets a status string for the kiji task. + +

            If called as part of a MapReduce job, the msg will be used as the task status + string. It may also be called safely from Fresheners, so a producer using this call can be + used either as a Freshener or part of a Hadoop job.

            +

            +

            +
            Specified by:
            setStatus in interface KijiContext
            +
            +
            +
            Parameters:
            msg - The status string. +
            Throws: +
            IOException - if there is an error when setting the status string of the task.
            +
            +
            +
            + +

            +getStatus

            +
            +public String getStatus()
            +
            +
            Returns a previously set status message. +

            +

            +
            Specified by:
            getStatus in interface KijiContext
            +
            +
            + +
            Returns:
            The previously set status message.
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            flush in interface Flushable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/KijiTableContextFactory.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/KijiTableContextFactory.html new file mode 100644 index 00000000..4123e959 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/KijiTableContextFactory.html @@ -0,0 +1,231 @@ + + + + + + + +KijiTableContextFactory (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.impl +
            +Class KijiTableContextFactory

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.impl.KijiTableContextFactory
+
            +
            +
            +
            @ApiAudience.Private
+public final class KijiTableContextFactory
            extends Object
            + + +

            +Instantiates a KijiTableContext according to a configuration. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static KijiTableContextcreate(org.apache.hadoop.mapreduce.TaskInputOutputContext taskContext) + +
            +          Instantiates the configured KijiTableContext.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiTableContext create(org.apache.hadoop.mapreduce.TaskInputOutputContext taskContext)
+                               throws IOException
            +
            +
            Instantiates the configured KijiTableContext. +

            +

            +
            Parameters:
            taskContext - Hadoop task context. +
            Returns:
            the configured KijiTableContext. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/KijiTableMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/KijiTableMapper.html new file mode 100644 index 00000000..0d282a8e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/KijiTableMapper.html @@ -0,0 +1,471 @@ + + + + + + + +KijiTableMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.impl +
            +Class KijiTableMapper<K,V>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Mapper<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiMapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>
+          extended by org.kiji.mapreduce.impl.KijiTableMapper<K,V>
+
            +
            +
            Type Parameters:
            K - Type of the MapReduce output key.
            V - Type of the MapReduce output value.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, KijiDataRequester, KVOutputJob
            +
            +
            +
            Direct Known Subclasses:
            GatherMapper, ProduceMapper
            +
            +
            +
            +
            @ApiAudience.Private
+@Inheritance.Sealed
+public abstract class KijiTableMapper<K,V>
            extends KijiMapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>
            implements org.apache.hadoop.conf.Configurable, KijiDataRequester
            + + +

            +Base class for mappers reading from a Kiji table. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Mapper
            org.apache.hadoop.mapreduce.Mapper.Context
            +  + + + + + + + + + + + + +
            +Constructor Summary
            +protected KijiTableMapper() + +
            +          Constructs a new mapper that reads from a Kiji table.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup(org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +          
            +protected  voidmap(org.kiji.schema.EntityId key, + org.kiji.schema.KijiRowData values, + org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          
            +protected abstract  voidmap(org.kiji.schema.KijiRowData input, + org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          Kiji mapper function that processes an input row.
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            +protected  voidsetup(org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiMapper
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Mapper
            run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KijiDataRequester
            getDataRequest
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KVOutputJob
            getOutputKeyClass, getOutputValueClass
            +  +

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

            +KijiTableMapper

            +
            +protected KijiTableMapper()
            +
            +
            Constructs a new mapper that reads from a Kiji table. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +map

            +
            +protected abstract void map(org.kiji.schema.KijiRowData input,
+                            org.apache.hadoop.mapreduce.Mapper.Context context)
+                     throws IOException
            +
            +
            Kiji mapper function that processes an input row. +

            +

            +
            +
            +
            +
            Parameters:
            input - Input row from the configured Kiji table.
            context - Hadoop mapper context. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup(org.apache.hadoop.mapreduce.Mapper.Context context)
+              throws IOException
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.apache.hadoop.mapreduce.Mapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +map

            +
            +protected void map(org.kiji.schema.EntityId key,
+                   org.kiji.schema.KijiRowData values,
+                   org.apache.hadoop.mapreduce.Mapper.Context context)
+            throws IOException
            +
            +
            +

            +

            +
            Overrides:
            map in class org.apache.hadoop.mapreduce.Mapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup(org.apache.hadoop.mapreduce.Mapper.Context context)
+                throws IOException
            +
            +
            +

            +

            +
            Overrides:
            cleanup in class org.apache.hadoop.mapreduce.Mapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/KijiTableSplit.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/KijiTableSplit.html new file mode 100644 index 00000000..f1c4fb9c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/KijiTableSplit.html @@ -0,0 +1,386 @@ + + + + + + + +KijiTableSplit (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.impl +
            +Class KijiTableSplit

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.InputSplit
+      extended by org.apache.hadoop.hbase.mapreduce.TableSplit
+          extended by org.kiji.mapreduce.impl.KijiTableSplit
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.hadoop.hbase.mapreduce.TableSplit>, org.apache.hadoop.io.Writable
            +
            +
            +
            +
            @ApiAudience.Private
+public final class KijiTableSplit
            extends org.apache.hadoop.hbase.mapreduce.TableSplit
            + + +

            +An KijiTableSplit stores exactly the same data as TableSplit, but + does a better job handling default split sizes. +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiTableSplit() + +
            +          The default constructor.
            KijiTableSplit(org.apache.hadoop.hbase.mapreduce.TableSplit tableSplit, + byte[] regionStartKey) + +
            +          Create a new KijiTableSplit instance from an HBase TableSplit.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + longgetLength() + +
            +          Returns the length of the split.
            + byte[]getRegionStartKey() + +
            +          Returns the start key of the region associated with this split.
            + voidreadFields(DataInput in) + +
            +          
            + voidwrite(DataOutput out) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.hbase.mapreduce.TableSplit
            compareTo, equals, getEndRow, getLocations, getRegionLocation, getStartRow, getTableName, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiTableSplit

            +
            +public KijiTableSplit()
            +
            +
            The default constructor. +

            +

            +
            + +

            +KijiTableSplit

            +
            +public KijiTableSplit(org.apache.hadoop.hbase.mapreduce.TableSplit tableSplit,
+                      byte[] regionStartKey)
            +
            +
            Create a new KijiTableSplit instance from an HBase TableSplit. +

            +

            +
            Parameters:
            tableSplit - the HBase TableSplit to clone.
            regionStartKey - the starting key of the region associated with this split.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getRegionStartKey

            +
            +public byte[] getRegionStartKey()
            +
            +
            Returns the start key of the region associated with this split. If this split + is the first in the total scan, this may differ from the value returned by + getStartRow(). +

            +

            + +
            Returns:
            the start key of the region associated with this split.
            +
            +
            +
            + +

            +getLength

            +
            +public long getLength()
            +
            +
            Returns the length of the split. + + This method does not currently examine the data in the region + represented by the split. We assume that each split is 3/4 full (where + "full" is defined as hbase.hregion.max.filesize). If the region had + that many bytes in it, it would split in two, each containing 1/2 that + many bytes. So we expect, on average, regions to be halfway between + "newly split" and "just about to split." +

            +

            +
            Overrides:
            getLength in class org.apache.hadoop.hbase.mapreduce.TableSplit
            +
            +
            + +
            Returns:
            the length of the split.
            See Also:
            InputSplit.getLength()
            +
            +
            +
            + +

            +readFields

            +
            +public void readFields(DataInput in)
+                throws IOException
            +
            +
            +

            +

            +
            Specified by:
            readFields in interface org.apache.hadoop.io.Writable
            Overrides:
            readFields in class org.apache.hadoop.hbase.mapreduce.TableSplit
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +write

            +
            +public void write(DataOutput out)
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            write in interface org.apache.hadoop.io.Writable
            Overrides:
            write in class org.apache.hadoop.hbase.mapreduce.TableSplit
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/DirectKijiTableWriterContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/DirectKijiTableWriterContext.html new file mode 100644 index 00000000..3eade4c8 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/DirectKijiTableWriterContext.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.impl.DirectKijiTableWriterContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.impl.DirectKijiTableWriterContext

            +
            + + + + + + + + + +
            +Packages that use DirectKijiTableWriterContext
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            +  +

            + + + + + +
            +Uses of DirectKijiTableWriterContext in org.kiji.mapreduce.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.impl that return DirectKijiTableWriterContext
            +static DirectKijiTableWriterContextDirectKijiTableWriterContext.create(org.apache.hadoop.mapreduce.TaskInputOutputContext<?,?,?,?> hadoopContext) + +
            +          Creates a new context that can write cells directly to a Kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/HFileWriterContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/HFileWriterContext.html new file mode 100644 index 00000000..79e61e24 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/HFileWriterContext.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.impl.HFileWriterContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.impl.HFileWriterContext

            +
            + + + + + + + + + +
            +Packages that use HFileWriterContext
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            +  +

            + + + + + +
            +Uses of HFileWriterContext in org.kiji.mapreduce.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.impl that return HFileWriterContext
            +static HFileWriterContextHFileWriterContext.create(org.apache.hadoop.mapreduce.TaskInputOutputContext<?,?,?,?> hadoopContext) + +
            +          Creates a new context that can write cells to an HFile that can be loaded into an HBase table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/HTableInputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/HTableInputFormat.html new file mode 100644 index 00000000..4142cae8 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/HTableInputFormat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.impl.HTableInputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.impl.HTableInputFormat

            +
            +No usage of org.kiji.mapreduce.impl.HTableInputFormat +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/HTableReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/HTableReader.html new file mode 100644 index 00000000..8d9a8b1c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/HTableReader.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.impl.HTableReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.impl.HTableReader

            +
            + + + + + + + + + + + + + +
            +Packages that use HTableReader
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers. 
            +  +

            + + + + + +
            +Uses of HTableReader in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.bulkimport that implement HTableReader
            + classBinaryHTableBulkImporter + +
            +          A bulk importer that reads columns from an HTable that were encoded using the Bytes utility class.
            +  +

            + + + + + +
            +Uses of HTableReader in org.kiji.mapreduce.bulkimport.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.bulkimport.impl that implement HTableReader
            + classBulkImportMapper<K,V> + +
            +          Hadoop mapper that runs a KijiBulkImporter.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/InternalKijiContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/InternalKijiContext.html new file mode 100644 index 00000000..cf26cb04 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/InternalKijiContext.html @@ -0,0 +1,247 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.impl.InternalKijiContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.impl.InternalKijiContext

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use InternalKijiContext
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + +
            +Uses of InternalKijiContext in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Subclasses of InternalKijiContext in org.kiji.mapreduce.gather.impl
            + classInternalGathererContext<K,V> + +
            +          Concrete context for gatherers that emit key/value pairs.
            +  +

            + + + + + +
            +Uses of InternalKijiContext in org.kiji.mapreduce.impl
            +  +

            + + + + + + + + + + + + + +
            Subclasses of InternalKijiContext in org.kiji.mapreduce.impl
            + classDirectKijiTableWriterContext + +
            +          Kiji context that writes cells to a configured output table.
            + classHFileWriterContext + +
            +          Kiji context that emits puts for the configured output table to HFiles.
            +  +

            + + + + + +
            +Uses of InternalKijiContext in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + +
            Subclasses of InternalKijiContext in org.kiji.mapreduce.produce.impl
            + classInternalProducerContext + +
            +          Implementation of a producer context.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/KijiTableContextFactory.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/KijiTableContextFactory.html new file mode 100644 index 00000000..8414d959 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/KijiTableContextFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.impl.KijiTableContextFactory (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.impl.KijiTableContextFactory

            +
            +No usage of org.kiji.mapreduce.impl.KijiTableContextFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/KijiTableMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/KijiTableMapper.html new file mode 100644 index 00000000..414853b2 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/KijiTableMapper.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.impl.KijiTableMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.impl.KijiTableMapper

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableMapper
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + +
            +Uses of KijiTableMapper in org.kiji.mapreduce.gather.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiTableMapper in org.kiji.mapreduce.gather.impl
            + classGatherMapper<K,V> + +
            +          Mapper that executes a gatherer over the rows of a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiTableMapper in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiTableMapper in org.kiji.mapreduce.produce.impl
            + classProduceMapper + +
            +          Hadoop mapper that runs a Kiji producer.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/KijiTableSplit.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/KijiTableSplit.html new file mode 100644 index 00000000..277db163 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/class-use/KijiTableSplit.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.impl.KijiTableSplit (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.impl.KijiTableSplit

            +
            +No usage of org.kiji.mapreduce.impl.KijiTableSplit +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-frame.html new file mode 100644 index 00000000..a866f650 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-frame.html @@ -0,0 +1,56 @@ + + + + + + + +org.kiji.mapreduce.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.impl + + + + +
            +Interfaces  + +
            +HTableReader
            + + + + + + +
            +Classes  + +
            +DirectKijiTableWriterContext +
            +HFileWriterContext +
            +HTableInputFormat +
            +InternalKijiContext +
            +KijiTableContextFactory +
            +KijiTableMapper +
            +KijiTableSplit
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-summary.html new file mode 100644 index 00000000..3bb4b62c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-summary.html @@ -0,0 +1,213 @@ + + + + + + + +org.kiji.mapreduce.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.impl +

            +Internal implementation details for KijiMR's top level classes. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            HTableReaderAn interface for Kiji mappers or bulk importers that read from HBase HTables.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            DirectKijiTableWriterContextKiji context that writes cells to a configured output table.
            HFileWriterContextKiji context that emits puts for the configured output table to HFiles.
            HTableInputFormatAn InputFormat for MapReduce jobs over HBase HTables.
            InternalKijiContextImplements KijiContext.
            KijiTableContextFactoryInstantiates a KijiTableContext according to a configuration.
            KijiTableMapper<K,V>Base class for mappers reading from a Kiji table.
            KijiTableSplitAn KijiTableSplit stores exactly the same data as TableSplit, but + does a better job handling default split sizes.
            +  + +

            +

            +Package org.kiji.mapreduce.impl Description +

            + +

            +Internal implementation details for KijiMR's top level classes. Clients should not + use these. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-tree.html new file mode 100644 index 00000000..6ac8de04 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-tree.html @@ -0,0 +1,182 @@ + + + + + + + +org.kiji.mapreduce.impl Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-use.html new file mode 100644 index 00000000..e38649d6 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/impl/package-use.html @@ -0,0 +1,271 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.impl

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.impl
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers. 
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.impl used by org.kiji.mapreduce.bulkimport
            HTableReader + +
            +          An interface for Kiji mappers or bulk importers that read from HBase HTables.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.impl used by org.kiji.mapreduce.bulkimport.impl
            HTableReader + +
            +          An interface for Kiji mappers or bulk importers that read from HBase HTables.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.impl used by org.kiji.mapreduce.gather.impl
            InternalKijiContext + +
            +          Implements KijiContext.
            KijiTableMapper + +
            +          Base class for mappers reading from a Kiji table.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.impl used by org.kiji.mapreduce.impl
            DirectKijiTableWriterContext + +
            +          Kiji context that writes cells to a configured output table.
            HFileWriterContext + +
            +          Kiji context that emits puts for the configured output table to HFiles.
            InternalKijiContext + +
            +          Implements KijiContext.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.impl used by org.kiji.mapreduce.produce.impl
            InternalKijiContext + +
            +          Implements KijiContext.
            KijiTableMapper + +
            +          Base class for mappers reading from a Kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/AvroKeyMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/AvroKeyMapReduceJobInput.html new file mode 100644 index 00000000..691341ec --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/AvroKeyMapReduceJobInput.html @@ -0,0 +1,296 @@ + + + + + + + +AvroKeyMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input +
            +Class AvroKeyMapReduceJobInput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobInput
+      extended by org.kiji.mapreduce.input.FileMapReduceJobInput
+          extended by org.kiji.mapreduce.input.AvroKeyMapReduceJobInput
+
            +
            +
            +
            @ApiAudience.Public
+public final class AvroKeyMapReduceJobInput
            extends FileMapReduceJobInput
            + + +

            +The class AvroKeyMapReduceJobInput is used to indicate the usage of Avro container + files containing keys as input to a MapReduce job. Any MapReduce job configured to + read from an Avro container file using this job input should expect to receive keys + of the same type that were used to write the container file. + +

            Configuring an input:

            +

            + AvroKeyMapReduceJobInput must be configured with the paths of Avro container files + to read from: +

            + 
            +   
+     final Path avroContainerFile = new Path("/path/to/avro/container/file");
+     final MapReduceJobInput avroJobInput = new AvroKeyMapReduceJobInput(avroContainerFile);
+   
+
            +

            + +

            +

            +
            See Also:
            AvroKeyValueMapReduceJobInput
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            AvroKeyMapReduceJobInput(org.apache.hadoop.fs.Path... paths) + +
            +          Constructs job input from a varags of paths to Avro container files.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  Class<? extends org.apache.hadoop.mapreduce.InputFormat>getInputFormatClass() + +
            +          Returns the class to use for this MapReduce input format type.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.input.FileMapReduceJobInput
            configure, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroKeyMapReduceJobInput

            +
            +public AvroKeyMapReduceJobInput(org.apache.hadoop.fs.Path... paths)
            +
            +
            Constructs job input from a varags of paths to Avro container files. +

            +

            +
            Parameters:
            paths - The paths to the Avro input files.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getInputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.InputFormat> getInputFormatClass()
            +
            +
            Returns the class to use for this MapReduce input format type. +

            +

            +
            Specified by:
            getInputFormatClass in class MapReduceJobInput
            +
            +
            + +
            Returns:
            The MR input format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/AvroKeyValueMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/AvroKeyValueMapReduceJobInput.html new file mode 100644 index 00000000..dd82c00b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/AvroKeyValueMapReduceJobInput.html @@ -0,0 +1,296 @@ + + + + + + + +AvroKeyValueMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input +
            +Class AvroKeyValueMapReduceJobInput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobInput
+      extended by org.kiji.mapreduce.input.FileMapReduceJobInput
+          extended by org.kiji.mapreduce.input.AvroKeyValueMapReduceJobInput
+
            +
            +
            +
            @ApiAudience.Public
+public final class AvroKeyValueMapReduceJobInput
            extends FileMapReduceJobInput
            + + +

            +The class AvroKeyValueMapReduceJobInput is used to indicate the usage of Avro container + files containing key-value pairs as input to a MapReduce job. Any MapReduce job configured + to read from an Avro container file using this job input should expect to receive key-value + pairs of the same type that were used to write the container file. + +

            Configuring an input:

            +

            + AvroKeyValueMapReduceJobInput must be configured with the paths of Avro container files + to read from: +

            + 
            +   
+     final Path avroContainerFile = new Path("/path/to/avro/container/file");
+     final MapReduceJobInput avroJobInput = new AvroKeyMapReduceJobInput(avroContainerFile);
+   
+
            +

            + +

            +

            +
            See Also:
            AvroKeyMapReduceJobInput
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            AvroKeyValueMapReduceJobInput(org.apache.hadoop.fs.Path... paths) + +
            +          Constructs job input from a varargs of paths to Avro container files.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  Class<? extends org.apache.hadoop.mapreduce.InputFormat>getInputFormatClass() + +
            +          Returns the class to use for this MapReduce input format type.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.input.FileMapReduceJobInput
            configure, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroKeyValueMapReduceJobInput

            +
            +public AvroKeyValueMapReduceJobInput(org.apache.hadoop.fs.Path... paths)
            +
            +
            Constructs job input from a varargs of paths to Avro container files. +

            +

            +
            Parameters:
            paths - The paths to the avro input files.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getInputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.InputFormat> getInputFormatClass()
            +
            +
            Returns the class to use for this MapReduce input format type. +

            +

            +
            Specified by:
            getInputFormatClass in class MapReduceJobInput
            +
            +
            + +
            Returns:
            The MR input format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/FileMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/FileMapReduceJobInput.html new file mode 100644 index 00000000..b8d6ca9d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/FileMapReduceJobInput.html @@ -0,0 +1,275 @@ + + + + + + + +FileMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input +
            +Class FileMapReduceJobInput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobInput
+      extended by org.kiji.mapreduce.input.FileMapReduceJobInput
+
            +
            +
            Direct Known Subclasses:
            AvroKeyMapReduceJobInput, AvroKeyValueMapReduceJobInput, SequenceFileMapReduceJobInput, TextMapReduceJobInput, WholeTextFileMapReduceJobInput
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract class FileMapReduceJobInput
            extends MapReduceJobInput
            + + +

            +Base class for MapReduce job input that is read from files. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidconfigure(org.apache.hadoop.mapreduce.Job job) + +
            +          Configure a job to use this type of input for the MapReduce.
            + voidinitialize(Map<String,String> params) + +
            +          Initializes the job input with the given parameters.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.MapReduceJobInput
            getInputFormatClass
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(Map<String,String> params)
+                throws IOException
            +
            +
            Initializes the job input with the given parameters. +

            +

            +
            Specified by:
            initialize in class MapReduceJobInput
            +
            +
            +
            Parameters:
            params - Parameters, usually parsed from the command-line. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +configure

            +
            +public void configure(org.apache.hadoop.mapreduce.Job job)
+               throws IOException
            +
            +
            Description copied from class: MapReduceJobInput
            +
            Configure a job to use this type of input for the MapReduce. +

            +

            +
            Overrides:
            configure in class MapReduceJobInput
            +
            +
            +
            Parameters:
            job - The job to configure with input. +
            Throws: +
            IOException - If there is an error during configuration.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/HTableMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/HTableMapReduceJobInput.html new file mode 100644 index 00000000..1ee6e367 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/HTableMapReduceJobInput.html @@ -0,0 +1,352 @@ + + + + + + + +HTableMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input +
            +Class HTableMapReduceJobInput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobInput
+      extended by org.kiji.mapreduce.input.HTableMapReduceJobInput
+
            +
            +
            +
            @ApiAudience.Public
+public final class HTableMapReduceJobInput
            extends MapReduceJobInput
            + + +

            +The class HTableMapReduceJobInput is used to indicate the usage of a HBase table + as input to a MapReduce job. Any MapReduce job configured to read from an HBase + table should expect to receive an ImmutableBytesWritable as a key + and a Result as a value. + +

            Configuring an input:

            +

            + HTableMapReduceJobInput must be configured with the name of the input HBase table: +

            + 
            +   
+     final MapReduceJobInput htableJobInput = new HTableMapReduceJobInput("mytable");
+   
+
            +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            HTableMapReduceJobInput() + +
            +          Default constructor.
            HTableMapReduceJobInput(String tableName) + +
            +          Creates a new HTableMapReduceJobInput instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidconfigure(org.apache.hadoop.mapreduce.Job job) + +
            +          Configure a job to use this type of input for the MapReduce.
            +protected  Class<? extends org.apache.hadoop.mapreduce.InputFormat<?,?>>getInputFormatClass() + +
            +          Returns the class to use for this MapReduce input format type.
            + voidinitialize(Map<String,String> params) + +
            +          Initializes the job input with the given parameters.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HTableMapReduceJobInput

            +
            +public HTableMapReduceJobInput()
            +
            +
            Default constructor. Do not use directly. +

            +

            +
            + +

            +HTableMapReduceJobInput

            +
            +public HTableMapReduceJobInput(String tableName)
            +
            +
            Creates a new HTableMapReduceJobInput instance. +

            +

            +
            Parameters:
            tableName - The name of the HBase table (HTable) to use as input for the job.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(Map<String,String> params)
+                throws IOException
            +
            +
            Initializes the job input with the given parameters. +

            +

            +
            Specified by:
            initialize in class MapReduceJobInput
            +
            +
            +
            Parameters:
            params - Parameters, usually parsed from the command-line. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +configure

            +
            +public void configure(org.apache.hadoop.mapreduce.Job job)
+               throws IOException
            +
            +
            Configure a job to use this type of input for the MapReduce. +

            +

            +
            Overrides:
            configure in class MapReduceJobInput
            +
            +
            +
            Parameters:
            job - The job to configure with input. +
            Throws: +
            IOException - If there is an error during configuration.
            +
            +
            +
            + +

            +getInputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.InputFormat<?,?>> getInputFormatClass()
            +
            +
            Returns the class to use for this MapReduce input format type. +

            +

            +
            Specified by:
            getInputFormatClass in class MapReduceJobInput
            +
            +
            + +
            Returns:
            The MR input format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/KijiTableMapReduceJobInput.RowOptions.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/KijiTableMapReduceJobInput.RowOptions.html new file mode 100644 index 00000000..e6b85c60 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/KijiTableMapReduceJobInput.RowOptions.html @@ -0,0 +1,346 @@ + + + + + + + +KijiTableMapReduceJobInput.RowOptions (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input +
            +Class KijiTableMapReduceJobInput.RowOptions

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.input.KijiTableMapReduceJobInput.RowOptions
+
            +
            +
            Enclosing class:
            KijiTableMapReduceJobInput
            +
            +
            +
            +
            public static class KijiTableMapReduceJobInput.RowOptions
            extends Object
            + + +

            +Options that specify which rows from the input table should be included. + +

            + The settings here are used conjunctively with an AND operator. In other words, a + row will be included if and only if it is: +

              +
            • lexicographically equal to or after the start row, and
              • +
            • lexicographically before the limit row, and
              • +
            • accepted by the row filter.
              • +
            +

            +

            + +

            +

            +
            See Also:
            for more information about filtering which rows get read from + the Kiji table.
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiTableMapReduceJobInput.RowOptions() + +
            +          Constructs options with default settings to include all the rows of the table.
            KijiTableMapReduceJobInput.RowOptions(org.kiji.schema.EntityId startRow, + org.kiji.schema.EntityId limitRow, + org.kiji.schema.filter.KijiRowFilter rowFilter) + +
            +          Creates a new RowOptions instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.kiji.schema.EntityIdgetLimitRow() + +
            +          Gets the entity id of the row to stop reading at (exclusive).
            + org.kiji.schema.filter.KijiRowFiltergetRowFilter() + +
            +           
            + org.kiji.schema.EntityIdgetStartRow() + +
            +          Gets the entity id of the row to start reading from (inclusive).
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableMapReduceJobInput.RowOptions

            +
            +public KijiTableMapReduceJobInput.RowOptions()
            +
            +
            Constructs options with default settings to include all the rows of the table. +

            +

            +
            + +

            +KijiTableMapReduceJobInput.RowOptions

            +
            +public KijiTableMapReduceJobInput.RowOptions(org.kiji.schema.EntityId startRow,
+                                             org.kiji.schema.EntityId limitRow,
+                                             org.kiji.schema.filter.KijiRowFilter rowFilter)
            +
            +
            Creates a new RowOptions instance. +

            +

            +
            Parameters:
            startRow - Entity id of the row to start reading from (inclusive). Specify null + to indicate starting at the first row of the table.
            limitRow - Entity id of the row to stop reading at (exclusive). Specify null to + indicate stopping at the last row of the table.
            rowFilter - A row filter to apply to the Kiji table.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getStartRow

            +
            +public org.kiji.schema.EntityId getStartRow()
            +
            +
            Gets the entity id of the row to start reading from (inclusive). May be null to + indicate starting at the first row of the table. +

            +

            + +
            Returns:
            Entity id of the row to start reading from.
            +
            +
            +
            + +

            +getLimitRow

            +
            +public org.kiji.schema.EntityId getLimitRow()
            +
            +
            Gets the entity id of the row to stop reading at (exclusive). May be null to + indicate ending at the last row of the table. +

            +

            + +
            Returns:
            Entity id of the row to stop reading at.
            +
            +
            +
            + +

            +getRowFilter

            +
            +public org.kiji.schema.filter.KijiRowFilter getRowFilter()
            +
            +
            + +
            Returns:
            Row filter to apply to all rows being read (may be null).
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/KijiTableMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/KijiTableMapReduceJobInput.html new file mode 100644 index 00000000..7007e363 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/KijiTableMapReduceJobInput.html @@ -0,0 +1,428 @@ + + + + + + + +KijiTableMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input +
            +Class KijiTableMapReduceJobInput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobInput
+      extended by org.kiji.mapreduce.input.KijiTableMapReduceJobInput
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableMapReduceJobInput
            extends MapReduceJobInput
            + + +

            +The class KijiTableMapReduceJobInput is used to indicate the usage of a KijiTable + as input to a MapReduce job. Any MapReduce job configured to read from a KijiTable + should expect to receive an EntityId as a key and a KijiRowData + as a value. + +

            Configuring an input:

            +

            + KijiTableMapReduceJobInput must be configured with a KijiDataRequest + specifying the columns to read during the MapReduce job. KijiTableMapReduceJobInput + can also be configured with optional row bounds that will limit section of rows + that the job will use. Use a RowOptions to specify these options: +

            + 
            +   
+     // Request the latest 3 versions of column 'info:email':
+     final KijiDataRequestBuilder builder = KijiDataRequest.builder();
+     builder.newColumnsDef().withMaxVersions(3).add("info", "email");
+     final KijiDataRequest dataRequest = builder.build();
+
+     // Read from 'here' to 'there':
+     final EntityId startRow = RawEntityId.getEntityId(Bytes.toBytes("here"));
+     final EntityId limitRow = RawEntityId.getEntityId(Bytes.toBytes("there"));
+     final KijiTableMapReduceJobInput.RowOptions rowOptions =
+         new KijiTableMapReduceJobInput.RowOptions(startRow, limitRow, null);
+     final MapReduceJobInput kijiTableJobInput =
+         new KijiTableMapReduceJobInput(mTable.getURI(), dataRequest, rowOptions);
+   
+
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTableMapReduceJobInput.RowOptions + +
            +          Options that specify which rows from the input table should be included.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            KijiTableMapReduceJobInput() + +
            +          Default constructor.
            KijiTableMapReduceJobInput(org.kiji.schema.KijiURI inputTableURI, + org.kiji.schema.KijiDataRequest dataRequest, + KijiTableMapReduceJobInput.RowOptions rowOptions) + +
            +          Constructs job input from column data in a Kiji table over a row range.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidconfigure(org.apache.hadoop.mapreduce.Job job) + +
            +          Configure a job to use this type of input for the MapReduce.
            +protected  Class<? extends org.apache.hadoop.mapreduce.InputFormat<?,?>>getInputFormatClass() + +
            +          Returns the class to use for this MapReduce input format type.
            + org.kiji.schema.KijiURIgetInputTableURI() + +
            +           
            + KijiTableMapReduceJobInput.RowOptionsgetRowOptions() + +
            +           
            + voidinitialize(Map<String,String> params) + +
            +          Initializes the job input with the given parameters.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableMapReduceJobInput

            +
            +public KijiTableMapReduceJobInput()
            +
            +
            Default constructor. +

            +

            +
            + +

            +KijiTableMapReduceJobInput

            +
            +public KijiTableMapReduceJobInput(org.kiji.schema.KijiURI inputTableURI,
+                                  org.kiji.schema.KijiDataRequest dataRequest,
+                                  KijiTableMapReduceJobInput.RowOptions rowOptions)
            +
            +
            Constructs job input from column data in a Kiji table over a row range. +

            +

            +
            Parameters:
            inputTableURI - URI of the input table.
            dataRequest - Specifies the columns and versions of cells to read from the table.
            rowOptions - Specifies optional settings for restricting the input from the + table to some subset of the rows.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(Map<String,String> params)
+                throws IOException
            +
            +
            Initializes the job input with the given parameters. +

            +

            +
            Specified by:
            initialize in class MapReduceJobInput
            +
            +
            +
            Parameters:
            params - Parameters, usually parsed from the command-line. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +configure

            +
            +public void configure(org.apache.hadoop.mapreduce.Job job)
+               throws IOException
            +
            +
            Configure a job to use this type of input for the MapReduce. +

            +

            +
            Overrides:
            configure in class MapReduceJobInput
            +
            +
            +
            Parameters:
            job - The job to configure with input. +
            Throws: +
            IOException - If there is an error during configuration.
            +
            +
            +
            + +

            +getInputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.InputFormat<?,?>> getInputFormatClass()
            +
            +
            Returns the class to use for this MapReduce input format type. +

            +

            +
            Specified by:
            getInputFormatClass in class MapReduceJobInput
            +
            +
            + +
            Returns:
            The MR input format class.
            +
            +
            +
            + +

            +getInputTableURI

            +
            +public org.kiji.schema.KijiURI getInputTableURI()
            +
            +
            + +
            Returns:
            Input table URI.
            +
            +
            +
            + +

            +getRowOptions

            +
            +public KijiTableMapReduceJobInput.RowOptions getRowOptions()
            +
            +
            + +
            Returns:
            Specified row options.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/SequenceFileMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/SequenceFileMapReduceJobInput.html new file mode 100644 index 00000000..8abe5e45 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/SequenceFileMapReduceJobInput.html @@ -0,0 +1,294 @@ + + + + + + + +SequenceFileMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input +
            +Class SequenceFileMapReduceJobInput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobInput
+      extended by org.kiji.mapreduce.input.FileMapReduceJobInput
+          extended by org.kiji.mapreduce.input.SequenceFileMapReduceJobInput
+
            +
            +
            +
            @ApiAudience.Public
+public final class SequenceFileMapReduceJobInput
            extends FileMapReduceJobInput
            + + +

            +The class SequenceFileMapReduceJobInput is used to indicate the usage of a Hadoop + sequence file as input to a MapReduce job. Any MapReduce job configured to read from a + sequence file should expect to receive key-value pairs of same type that were used to + write the sequence file. + +

            Configuring an input:

            +

            + SequenceFileMapReduceJobInput must be configured with the paths of the sequence files + to read from: +

            + 
            +   
+     final Path sequenceFile = new Path("/path/to/sequence/file");
+     final MapReduceJobInput seqFileJobInput = new SequenceFileMapReduceJobInput(sequenceFile);
+   
+
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            SequenceFileMapReduceJobInput(org.apache.hadoop.fs.Path... paths) + +
            +          Constructs job input from a varargs of paths to sequence files.
            +  + + + + + + + + + + + +
            +Method Summary
            + Class<? extends org.apache.hadoop.mapreduce.InputFormat>getInputFormatClass() + +
            +          Returns the class to use for this MapReduce input format type.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.input.FileMapReduceJobInput
            configure, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +SequenceFileMapReduceJobInput

            +
            +public SequenceFileMapReduceJobInput(org.apache.hadoop.fs.Path... paths)
            +
            +
            Constructs job input from a varargs of paths to sequence files. +

            +

            +
            Parameters:
            paths - The paths to the input sequence files.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getInputFormatClass

            +
            +public Class<? extends org.apache.hadoop.mapreduce.InputFormat> getInputFormatClass()
            +
            +
            Returns the class to use for this MapReduce input format type. +

            +

            +
            Specified by:
            getInputFormatClass in class MapReduceJobInput
            +
            +
            + +
            Returns:
            The MR input format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/TextMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/TextMapReduceJobInput.html new file mode 100644 index 00000000..aee0ee3a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/TextMapReduceJobInput.html @@ -0,0 +1,297 @@ + + + + + + + +TextMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input +
            +Class TextMapReduceJobInput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobInput
+      extended by org.kiji.mapreduce.input.FileMapReduceJobInput
+          extended by org.kiji.mapreduce.input.TextMapReduceJobInput
+
            +
            +
            +
            @ApiAudience.Public
+public final class TextMapReduceJobInput
            extends FileMapReduceJobInput
            + + +

            +The class TextMapReduceJobInput is used to indicate the usage of lines in text files + in HDFS as input to a MapReduce job. Any MapReduce job configured to read lines from + text files in HDFS should expect to receive LongWritable as a key (line + number) and Text as a value (text of the line). + +

            Configuring an input:

            +

            + TextMapReduceJobInput must be configured with the paths of the files to read from. + Each block from the specified files will be read by one MapReduce split. To setup + reading from a single text file: +

            + 
            +   
+     final Path inputFile = new Path("/path/to/input");
+     final MapReduceJobInput textJobInput = new TextMapReduceJobInput(inputFile);
+   
+
            +

            + +

            +

            +
            See Also:
            WholeTextFileMapReduceJobInput
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            TextMapReduceJobInput(org.apache.hadoop.fs.Path... paths) + +
            +          Constructs job input from a varargs of paths to text files.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  Class<? extends org.apache.hadoop.mapreduce.InputFormat>getInputFormatClass() + +
            +          Returns the class to use for this MapReduce input format type.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.input.FileMapReduceJobInput
            configure, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +TextMapReduceJobInput

            +
            +public TextMapReduceJobInput(org.apache.hadoop.fs.Path... paths)
            +
            +
            Constructs job input from a varargs of paths to text files. +

            +

            +
            Parameters:
            paths - The paths to the job input files.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getInputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.InputFormat> getInputFormatClass()
            +
            +
            Returns the class to use for this MapReduce input format type. +

            +

            +
            Specified by:
            getInputFormatClass in class MapReduceJobInput
            +
            +
            + +
            Returns:
            The MR input format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/WholeTextFileMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/WholeTextFileMapReduceJobInput.html new file mode 100644 index 00000000..0b007bf5 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/WholeTextFileMapReduceJobInput.html @@ -0,0 +1,304 @@ + + + + + + + +WholeTextFileMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input +
            +Class WholeTextFileMapReduceJobInput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobInput
+      extended by org.kiji.mapreduce.input.FileMapReduceJobInput
+          extended by org.kiji.mapreduce.input.WholeTextFileMapReduceJobInput
+
            +
            +
            +
            @ApiAudience.Public
+public final class WholeTextFileMapReduceJobInput
            extends FileMapReduceJobInput
            + + +

            +The class WholeTextFileMapReduceJobInput is used to indicate the usage of entire text + files as rows for input to a MapReduce job. Any MapReduce job configured to read whole files + from HDFS should expect to receive Text as a key (path to the file) and + Text as a value (contents of the file). + +

            Configuring an input:

            +

            + WholeTextFileMapReduceJobInput must be configured with paths of the files to read: +

            + 
            +   
+     // Get paths of input files in a directory on HDFS.
+     final FileSystem fs = FileSystem.get(myConf);
+     final FileStatus[] statuses = fs.listStatus(fs);
+     final List<Path> paths = new ArrayList<Path>();
+     for (FileStatus status : statuses) {
+       paths.add(status.getPath());
+     }
+
+     // Configure the job input.
+     final MapReduceJobInput wholeFileJobInput =
+         new WholeTextFileMapReduceJobInput(paths.toArray());
+   
+
            +

            + +

            +

            +
            See Also:
            TextMapReduceJobInput
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            WholeTextFileMapReduceJobInput(org.apache.hadoop.fs.Path... paths) + +
            +          Constructs job input from a varargs of paths to text files.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  Class<? extends org.apache.hadoop.mapreduce.InputFormat<?,?>>getInputFormatClass() + +
            +          Returns the class to use for this MapReduce input format type.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.input.FileMapReduceJobInput
            configure, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +WholeTextFileMapReduceJobInput

            +
            +public WholeTextFileMapReduceJobInput(org.apache.hadoop.fs.Path... paths)
            +
            +
            Constructs job input from a varargs of paths to text files. +

            +

            +
            Parameters:
            paths - The paths to the job input files.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getInputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.InputFormat<?,?>> getInputFormatClass()
            +
            +
            Returns the class to use for this MapReduce input format type. +

            +

            +
            Specified by:
            getInputFormatClass in class MapReduceJobInput
            +
            +
            + +
            Returns:
            The MR input format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/AvroKeyMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/AvroKeyMapReduceJobInput.html new file mode 100644 index 00000000..5eab0f24 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/AvroKeyMapReduceJobInput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.AvroKeyMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.AvroKeyMapReduceJobInput

            +
            +No usage of org.kiji.mapreduce.input.AvroKeyMapReduceJobInput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/AvroKeyValueMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/AvroKeyValueMapReduceJobInput.html new file mode 100644 index 00000000..c7e1f475 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/AvroKeyValueMapReduceJobInput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.AvroKeyValueMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.AvroKeyValueMapReduceJobInput

            +
            +No usage of org.kiji.mapreduce.input.AvroKeyValueMapReduceJobInput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/FileMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/FileMapReduceJobInput.html new file mode 100644 index 00000000..4c0c14cf --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/FileMapReduceJobInput.html @@ -0,0 +1,218 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.FileMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.FileMapReduceJobInput

            +
            + + + + + + + + + +
            +Packages that use FileMapReduceJobInput
            org.kiji.mapreduce.inputMapReduce job input types. 
            +  +

            + + + + + +
            +Uses of FileMapReduceJobInput in org.kiji.mapreduce.input
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of FileMapReduceJobInput in org.kiji.mapreduce.input
            + classAvroKeyMapReduceJobInput + +
            +          The class AvroKeyMapReduceJobInput is used to indicate the usage of Avro container + files containing keys as input to a MapReduce job.
            + classAvroKeyValueMapReduceJobInput + +
            +          The class AvroKeyValueMapReduceJobInput is used to indicate the usage of Avro container + files containing key-value pairs as input to a MapReduce job.
            + classSequenceFileMapReduceJobInput + +
            +          The class SequenceFileMapReduceJobInput is used to indicate the usage of a Hadoop + sequence file as input to a MapReduce job.
            + classTextMapReduceJobInput + +
            +          The class TextMapReduceJobInput is used to indicate the usage of lines in text files + in HDFS as input to a MapReduce job.
            + classWholeTextFileMapReduceJobInput + +
            +          The class WholeTextFileMapReduceJobInput is used to indicate the usage of entire text + files as rows for input to a MapReduce job.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/HTableMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/HTableMapReduceJobInput.html new file mode 100644 index 00000000..456a29ed --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/HTableMapReduceJobInput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.HTableMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.HTableMapReduceJobInput

            +
            +No usage of org.kiji.mapreduce.input.HTableMapReduceJobInput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/KijiTableMapReduceJobInput.RowOptions.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/KijiTableMapReduceJobInput.RowOptions.html new file mode 100644 index 00000000..cc4dc09f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/KijiTableMapReduceJobInput.RowOptions.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.KijiTableMapReduceJobInput.RowOptions (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.KijiTableMapReduceJobInput.RowOptions

            +
            + + + + + + + + + +
            +Packages that use KijiTableMapReduceJobInput.RowOptions
            org.kiji.mapreduce.inputMapReduce job input types. 
            +  +

            + + + + + +
            +Uses of KijiTableMapReduceJobInput.RowOptions in org.kiji.mapreduce.input
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.input that return KijiTableMapReduceJobInput.RowOptions
            + KijiTableMapReduceJobInput.RowOptionsKijiTableMapReduceJobInput.getRowOptions() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.mapreduce.input with parameters of type KijiTableMapReduceJobInput.RowOptions
            KijiTableMapReduceJobInput(org.kiji.schema.KijiURI inputTableURI, + org.kiji.schema.KijiDataRequest dataRequest, + KijiTableMapReduceJobInput.RowOptions rowOptions) + +
            +          Constructs job input from column data in a Kiji table over a row range.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/KijiTableMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/KijiTableMapReduceJobInput.html new file mode 100644 index 00000000..afa47a8c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/KijiTableMapReduceJobInput.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.KijiTableMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.KijiTableMapReduceJobInput

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableMapReduceJobInput
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of KijiTableMapReduceJobInput in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework with parameters of type KijiTableMapReduceJobInput
            + TKijiTableInputJobBuilder.withJobInput(KijiTableMapReduceJobInput input) + +
            +          Configures the job input table.
            +  +

            + + + + + +
            +Uses of KijiTableMapReduceJobInput in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework that return KijiTableMapReduceJobInput
            +protected  KijiTableMapReduceJobInputKijiJobTool.getJobInputTable() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/SequenceFileMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/SequenceFileMapReduceJobInput.html new file mode 100644 index 00000000..3cec4a6c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/SequenceFileMapReduceJobInput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.SequenceFileMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.SequenceFileMapReduceJobInput

            +
            +No usage of org.kiji.mapreduce.input.SequenceFileMapReduceJobInput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/TextMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/TextMapReduceJobInput.html new file mode 100644 index 00000000..032920ff --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/TextMapReduceJobInput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.TextMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.TextMapReduceJobInput

            +
            +No usage of org.kiji.mapreduce.input.TextMapReduceJobInput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/WholeTextFileMapReduceJobInput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/WholeTextFileMapReduceJobInput.html new file mode 100644 index 00000000..7fe7ab39 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/class-use/WholeTextFileMapReduceJobInput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.WholeTextFileMapReduceJobInput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.WholeTextFileMapReduceJobInput

            +
            +No usage of org.kiji.mapreduce.input.WholeTextFileMapReduceJobInput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/WholeFileInputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/WholeFileInputFormat.html new file mode 100644 index 00000000..e6a9fe59 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/WholeFileInputFormat.html @@ -0,0 +1,341 @@ + + + + + + + +WholeFileInputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input.impl +
            +Class WholeFileInputFormat

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.InputFormat<K,V>
+      extended by org.apache.hadoop.mapreduce.lib.input.FileInputFormat<K,V>
+          extended by org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
+              extended by org.kiji.mapreduce.input.impl.WholeFileInputFormat
+
            +
            +
            +
            @ApiAudience.Private
+public final class WholeFileInputFormat
            extends CombineFileInputFormat<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            + + +

            +An input format for reading multiple files in a single map task. + Exactly one (unsplit) file will be read by each record passed to the mapper. + Records are constructed from WholeFileRecordReaders. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat
            SPLIT_MINSIZE_PERNODE, SPLIT_MINSIZE_PERRACK
            +  + + + + + + + + + + +
            +Constructor Summary
            WholeFileInputFormat() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>createRecordReader(org.apache.hadoop.mapreduce.InputSplit split, + org.apache.hadoop.mapreduce.TaskAttemptContext context) + +
            +          Creates a CombineFileRecordReader to read each file assigned to this InputSplit.
            +protected  booleanisSplitable(org.apache.hadoop.mapreduce.JobContext context, + org.apache.hadoop.fs.Path filename) + +
            +          Guarantees that no file is split.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.lib.input.CombineFileInputFormat
            createPool, createPool, getSplits, setMaxSplitSize, setMinSplitSizeNode, setMinSplitSizeRack
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.lib.input.FileInputFormat
            addInputPath, addInputPaths, computeSplitSize, getBlockIndex, getFormatMinSplitSize, getInputPathFilter, getInputPaths, getMaxSplitSize, getMinSplitSize, listStatus, setInputPathFilter, setInputPaths, setInputPaths, setMaxInputSplitSize, setMinInputSplitSize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +WholeFileInputFormat

            +
            +public WholeFileInputFormat()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +isSplitable

            +
            +protected boolean isSplitable(org.apache.hadoop.mapreduce.JobContext context,
+                              org.apache.hadoop.fs.Path filename)
            +
            +
            Guarantees that no file is split. +

            +

            +
            Overrides:
            isSplitable in class org.apache.hadoop.mapreduce.lib.input.FileInputFormat<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            +
            Parameters:
            context - The JobContext. Unused.
            filename - The path to this file. Unused. +
            Returns:
            false so that no files are split.
            +
            +
            +
            + +

            +createRecordReader

            +
            +public org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text> createRecordReader(org.apache.hadoop.mapreduce.InputSplit split,
+                                                                                                                        org.apache.hadoop.mapreduce.TaskAttemptContext context)
+                                                                                                                 throws IOException
            +
            +
            Creates a CombineFileRecordReader to read each file assigned to this InputSplit. + Note, that unlike ordinary InputSplits, split must be a CombineFileSplit, and therefore + is expected to specify multiple files. +

            +

            +
            Specified by:
            createRecordReader in class CombineFileInputFormat<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            +
            Parameters:
            split - The InputSplit to read. Throws an IllegalArgumentException if this is + not a CombineFileSplit.
            context - The context for this task. +
            Returns:
            a CombineFileRecordReader to process each file in split. + It will read each file with a WholeFileRecordReader. +
            Throws: +
            IOException - if there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/WholeFileRecordReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/WholeFileRecordReader.html new file mode 100644 index 00000000..6076bfab --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/WholeFileRecordReader.html @@ -0,0 +1,445 @@ + + + + + + + +WholeFileRecordReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.input.impl +
            +Class WholeFileRecordReader

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
+      extended by org.kiji.mapreduce.input.impl.WholeFileRecordReader
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Private
+public final class WholeFileRecordReader
            extends org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            + + +

            +

            A RecordReader that reads an entire file as a single key-value. + The key is the qualified path to this file, and the value is the Text contents of the file. + This is intended for reading small files. + (Note that the entire file must be able to fit in ram)

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            WholeFileRecordReader(CombineFileSplit fileSplit, + org.apache.hadoop.mapreduce.TaskAttemptContext context, + Integer pathToProcess) + +
            +          Implementation detail: This constructor is built to be called via + reflection from within CombineFileRecordReader.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + org.apache.hadoop.io.TextgetCurrentKey() + +
            +          Returns the absolute path to the current file.
            + org.apache.hadoop.io.TextgetCurrentValue() + +
            +          Returns the current value.
            + floatgetProgress() + +
            +          Returns whether the file has been processed or not.
            + voidinitialize(org.apache.hadoop.mapreduce.InputSplit split, + org.apache.hadoop.mapreduce.TaskAttemptContext context) + +
            +          All of the internal state is already set on instantiation.
            + booleannextKeyValue() + +
            +          If the file has not already been read, this reads it into memory, so that a call + to getCurrentValue() will return the entire contents of this file as Text, + and getCurrentKey() will return the qualified path to this file as Text.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +WholeFileRecordReader

            +
            +public WholeFileRecordReader(CombineFileSplit fileSplit,
+                             org.apache.hadoop.mapreduce.TaskAttemptContext context,
+                             Integer pathToProcess)
            +
            +
            Implementation detail: This constructor is built to be called via + reflection from within CombineFileRecordReader. +

            +

            +
            Parameters:
            fileSplit - The CombineFileSplit that this will read from.
            context - The context for this task.
            pathToProcess - The path index from the CombineFileSplit to process in this record.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in class org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getCurrentKey

            +
            +public org.apache.hadoop.io.Text getCurrentKey()
+                                        throws IOException,
+                                               InterruptedException
            +
            +
            Returns the absolute path to the current file. +

            +

            +
            Specified by:
            getCurrentKey in class org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            + +
            Returns:
            The absolute path to the current file. +
            Throws: +
            IOException - never. +
            InterruptedException - never.
            +
            +
            +
            + +

            +getCurrentValue

            +
            +public org.apache.hadoop.io.Text getCurrentValue()
+                                          throws IOException,
+                                                 InterruptedException
            +
            +

            Returns the current value. If the file has been read with a call to NextKeyValue(), + this returns the contents of the file as a BytesWritable. Otherwise, it returns an + empty BytesWritable.

            + +

            Throws an IllegalStateException if initialize() is not called first.

            +

            +

            +
            Specified by:
            getCurrentValue in class org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            + +
            Returns:
            A BytesWritable containing the contents of the file to read. +
            Throws: +
            IOException - never. +
            InterruptedException - never.
            +
            +
            +
            + +

            +getProgress

            +
            +public float getProgress()
+                  throws IOException,
+                         InterruptedException
            +
            +
            Returns whether the file has been processed or not. Since only one record + will be generated for a file, progress will be 0.0 if it has not been processed, + and 1.0 if it has. +

            +

            +
            Specified by:
            getProgress in class org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            + +
            Returns:
            0.0 if the file has not been processed. 1.0 if it has. +
            Throws: +
            IOException - never. +
            InterruptedException - never.
            +
            +
            +
            + +

            +initialize

            +
            +public void initialize(org.apache.hadoop.mapreduce.InputSplit split,
+                       org.apache.hadoop.mapreduce.TaskAttemptContext context)
+                throws IOException,
+                       InterruptedException
            +
            +
            All of the internal state is already set on instantiation. This is a no-op. +

            +

            +
            Specified by:
            initialize in class org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            +
            Parameters:
            split - The InputSplit to read. Unused.
            context - The context for this task. Unused. +
            Throws: +
            IOException - never. +
            InterruptedException - never.
            +
            +
            +
            + +

            +nextKeyValue

            +
            +public boolean nextKeyValue()
+                     throws IOException,
+                            InterruptedException
            +
            +

            If the file has not already been read, this reads it into memory, so that a call + to getCurrentValue() will return the entire contents of this file as Text, + and getCurrentKey() will return the qualified path to this file as Text. Then, returns + true. If it has already been read, then returns false without updating any internal state.

            +

            +

            +
            Specified by:
            nextKeyValue in class org.apache.hadoop.mapreduce.RecordReader<org.apache.hadoop.io.Text,org.apache.hadoop.io.Text>
            +
            +
            + +
            Returns:
            Whether the file was read or not. +
            Throws: +
            IOException - if there is an error reading the file. +
            InterruptedException - if there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/class-use/WholeFileInputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/class-use/WholeFileInputFormat.html new file mode 100644 index 00000000..4aefcfdc --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/class-use/WholeFileInputFormat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.impl.WholeFileInputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.impl.WholeFileInputFormat

            +
            +No usage of org.kiji.mapreduce.input.impl.WholeFileInputFormat +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/class-use/WholeFileRecordReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/class-use/WholeFileRecordReader.html new file mode 100644 index 00000000..a92272ff --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/class-use/WholeFileRecordReader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.input.impl.WholeFileRecordReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.input.impl.WholeFileRecordReader

            +
            +No usage of org.kiji.mapreduce.input.impl.WholeFileRecordReader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-frame.html new file mode 100644 index 00000000..6b879abe --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +org.kiji.mapreduce.input.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.input.impl + + + + +
            +Classes  + +
            +WholeFileInputFormat +
            +WholeFileRecordReader
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-summary.html new file mode 100644 index 00000000..92cd0d53 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-summary.html @@ -0,0 +1,178 @@ + + + + + + + +org.kiji.mapreduce.input.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.input.impl +

            +Internal implementation details for KijiMR's job input classes. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + +
            +Class Summary
            WholeFileInputFormatAn input format for reading multiple files in a single map task.
            WholeFileRecordReaderA RecordReader that reads an entire file as a single key-value.
            +  + +

            +

            +Package org.kiji.mapreduce.input.impl Description +

            + +

            +Internal implementation details for KijiMR's job input classes. Clients should not + use these. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-tree.html new file mode 100644 index 00000000..3f4f46a3 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-tree.html @@ -0,0 +1,163 @@ + + + + + + + +org.kiji.mapreduce.input.impl Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.input.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.hadoop.mapreduce.InputFormat<K,V> +
              • org.apache.hadoop.mapreduce.RecordReader<KEYIN,VALUEIN> (implements java.io.Closeable) + +
              +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-use.html new file mode 100644 index 00000000..acb273a0 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/impl/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.input.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.input.impl

            +
            +No usage of org.kiji.mapreduce.input.impl +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-frame.html new file mode 100644 index 00000000..f524e2a7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-frame.html @@ -0,0 +1,49 @@ + + + + + + + +org.kiji.mapreduce.input (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.input + + + + +
            +Classes  + +
            +AvroKeyMapReduceJobInput +
            +AvroKeyValueMapReduceJobInput +
            +FileMapReduceJobInput +
            +HTableMapReduceJobInput +
            +KijiTableMapReduceJobInput +
            +KijiTableMapReduceJobInput.RowOptions +
            +SequenceFileMapReduceJobInput +
            +TextMapReduceJobInput +
            +WholeTextFileMapReduceJobInput
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-summary.html new file mode 100644 index 00000000..c8ae1fe0 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-summary.html @@ -0,0 +1,232 @@ + + + + + + + +org.kiji.mapreduce.input (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.input +

            +MapReduce job input types. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AvroKeyMapReduceJobInputThe class AvroKeyMapReduceJobInput is used to indicate the usage of Avro container + files containing keys as input to a MapReduce job.
            AvroKeyValueMapReduceJobInputThe class AvroKeyValueMapReduceJobInput is used to indicate the usage of Avro container + files containing key-value pairs as input to a MapReduce job.
            FileMapReduceJobInputBase class for MapReduce job input that is read from files.
            HTableMapReduceJobInputThe class HTableMapReduceJobInput is used to indicate the usage of a HBase table + as input to a MapReduce job.
            KijiTableMapReduceJobInputThe class KijiTableMapReduceJobInput is used to indicate the usage of a KijiTable + as input to a MapReduce job.
            KijiTableMapReduceJobInput.RowOptionsOptions that specify which rows from the input table should be included.
            SequenceFileMapReduceJobInputThe class SequenceFileMapReduceJobInput is used to indicate the usage of a Hadoop + sequence file as input to a MapReduce job.
            TextMapReduceJobInputThe class TextMapReduceJobInput is used to indicate the usage of lines in text files + in HDFS as input to a MapReduce job.
            WholeTextFileMapReduceJobInputThe class WholeTextFileMapReduceJobInput is used to indicate the usage of entire text + files as rows for input to a MapReduce job.
            +  + +

            +

            +Package org.kiji.mapreduce.input Description +

            + +

            +MapReduce job input types. + +

            + MapReduceJobInput is the base type for classes that can act + as inputs to a MapReduce job for jobs that are created using a + MapReduceJobBuilder. +

            + +

            Usable KijiMR input types

            +
          • AvroKeyMapReduceJobInput - Avro container files containing + keys as input.
            • +
          • AvroKeyValueMapReduceJobInput - Avro container files + containing key value pairs as input.
            • +
          • HTableMapReduceJobInput - HBase table as input.
            • +
          • KijiTableMapReduceJobInput - Kiji table as input.
            • +
          • SequenceFileMapReduceJobInput - Hadoop sequence file as + input.
            • +
          • TextMapReduceJobInput - text files in HDFS as input with + each line as a row.
            • +
          • WholeTextFileMapReduceJobInput - text files in HDFS as + input with each file as a row.
            • +

            + +

            +

            +
            See Also:
            MapReduceJobBuilder
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-tree.html new file mode 100644 index 00000000..1c6089d7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-tree.html @@ -0,0 +1,158 @@ + + + + + + + +org.kiji.mapreduce.input Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.input +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-use.html new file mode 100644 index 00000000..f7f0e6b2 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/input/package-use.html @@ -0,0 +1,217 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.input (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.input

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.input
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.inputMapReduce job input types. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.input used by org.kiji.mapreduce.framework
            KijiTableMapReduceJobInput + +
            +          The class KijiTableMapReduceJobInput is used to indicate the usage of a KijiTable + as input to a MapReduce job.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.input used by org.kiji.mapreduce.input
            FileMapReduceJobInput + +
            +          Base class for MapReduce job input that is read from files.
            KijiTableMapReduceJobInput.RowOptions + +
            +          Options that specify which rows from the input table should be included.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.input used by org.kiji.mapreduce.tools.framework
            KijiTableMapReduceJobInput + +
            +          The class KijiTableMapReduceJobInput is used to indicate the usage of a KijiTable + as input to a MapReduce job.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStore.html new file mode 100644 index 00000000..47a43af4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStore.html @@ -0,0 +1,322 @@ + + + + + + + +KeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore +
            +Interface KeyValueStore<K,V>

            +
            +
            Type Parameters:
            K - the key type expected to be implemented by the keys to this store.
            V - the value type expected to be accessed by the keys to this store.
            +
            +
            All Known Implementing Classes:
            AvroKVRecordKeyValueStore, AvroRecordKeyValueStore, EmptyKeyValueStore, KijiTableKeyValueStore, SeqFileKeyValueStore, TextFileKeyValueStore, UnconfiguredKeyValueStore
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface KeyValueStore<K,V>
            + + +

            +

            A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store. This may be defined on + files, a Kiji table, or some other resource like a different NoSQL database. + See the org.kiji.mapreduce.kvstore.lib package for implementations.

            + +

            The KeyValueStoreReader interface defines + an implementation that actually accesses these key-value pairs, given + sufficient configuration info from the KeyValueStore itself. KeyValueStoreReaders + are opened by the open() method of KeyValueStore.

            + +

            Within the Kiji framework, a KeyValueStore may be used within a MapReduce job, + or outside of one, e.g. in a streaming process. In a MapReduce job, it will have access + to the job Configuration. In other environments, it may not have access to the same + resources. + As a result, you should be careful that your KeyValueStore implementation + can be run with the resources available in any expected operating environment. + (For example, you should not use the DistributedCache + in storeToConf() when a KeyValueStore is used within a non-MapReduce process.)

            + +

            Lifecycle in the Kiji ecosystem:

            +

            A KeyValueStore is bound to a name by the KeyValueStoreClient.getRequiredStores() method. + At runtime, you may override these name-to-KeyValueStore bindings + by specifying XML configuration files, or specifying individual name-to-store bindings + programmatically by using a subclass of MapReduceJobBuilder (e.g., KijiProduceJobBuilder). + These KeyValueStores will be instantiated with the default constructor, + the XML will be parsed into configuration name-value pairs, and those will be passed to + initFromConf(). + +

            In a MapReduce job, configuration will be serialized using + storeToConf(), which copies data into the job Configuration. On the + mapper side, this KeyValueStore will be deserialized by instantiating a KeyValueStore + instance through reflection, which uses the default constructor then initialized with a + single call to initFromConf(). Thus, if you implement this interface, + it is required that you provide a public no-argument constructor so your KeyValueStore + can be used within MapReduce.

            + +

            To actually read key-value pairs, get a KeyValueStoreReader with the + open() method. Close it when you're finished using it.

            + +

            KeyValueStore implementations may disallow calls to initFromConf() + after calling open(); it's expected that an "opened" KeyValueStore + must be treated as immutable. Implementations may throw InvalidStateException + if you do this.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidinitFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + KeyValueStoreReader<K,V>open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + voidstoreToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +storeToConf

            +
            +void storeToConf(KeyValueStoreConfiguration conf)
+                 throws IOException
            +
            +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +

            +

            +
            Parameters:
            conf - the KeyValueStoreConfiguration to serialize state into. + This will be placed in a unique namespace of the job Configuration, + so it can write any key. +
            Throws: +
            IOException - if there is an error writing state to the configuration.
            +
            +
            +
            + +

            +initFromConf

            +
            +void initFromConf(KeyValueStoreConfiguration conf)
+                  throws IOException
            +
            +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +

            +

            +
            Parameters:
            conf - the KeyValueStoreConfiguration storing state for this KeyValueStore. +
            Throws: +
            IOException - if there is an error reading from the configuration.
            +
            +
            +
            + +

            +open

            +
            +KeyValueStoreReader<K,V> open()
+                              throws IOException
            +
            +
            Opens a KeyValueStoreReader instance for access by clients to this store. + After calling this method, some implementations may deny subsequent calls to + initFromConf() by throwing InvalidStateException. +

            +

            + +
            Returns:
            the KeyValueStoreReader associated with this KeyValueStore. +
            Throws: +
            IOException - if there is an error opening the underlying storage resource.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStoreClient.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStoreClient.html new file mode 100644 index 00000000..e5c4aca5 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStoreClient.html @@ -0,0 +1,255 @@ + + + + + + + +KeyValueStoreClient (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore +
            +Interface KeyValueStoreClient

            +
            +
            All Known Implementing Classes:
            AvroBulkImporter, BinaryHTableBulkImporter, KijiBulkImporter, KijiGatherer, KijiProducer
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface KeyValueStoreClient
            + + +

            +

            A KeyValueStoreClient defines a mapping between store names and their + KeyValueStore implementations via the getRequiredStores() method. + When used in the Kiji framework, you may override these default implementations + at runtime with either MapReduceJobBuilder.withStore() + or MapReduceJobBuilder.withStoreBindingsFile().

            + +

            How the KeyValueStores are surfaced to a KeyValueStoreClient varies across + implementations; often KijiContext.getStore(String) is used within + methods that receive Context objects as arguments. + You should not open KeyValueStoreReaders directly by repeatedly calling getRequiredStores(). This will create a new store and reader each time, and the + reader may not be properly initialized to read, e.g., from the distributed cache.

            + +

            Look to the implementing class for details on how the class distinguishes betweeen + defining the store configurations you require and opening an initialized + KeyValueStoreReader implementation. For example, KijiProducer and KijiGatherer + classes can use the getStore(String storeName) method of the Context + object passed in as an argument to produce(), gather(), etc. + You should refer to the documentation for the API you are implementing against.

            + +

            If you are implementing your own + handler for data using MapReduce or other means "from scratch", you may want to use a + KeyValueStoreReaderFactory to deserialize a set of KeyValueStores from a + Configuration object.

            +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + Map<String,KeyValueStore<?,?>>getRequiredStores() + +
            +          Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getRequiredStores

            +
            +Map<String,KeyValueStore<?,?>> getRequiredStores()
            +
            +

            Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations. + It is an error for any of these default implementations to be null. + If you want to defer KeyValueStore definition to runtime, bind a name + to the UnconfiguredKeyValueStore instead.

            + +

            Note that this method returns default mappings from store names to + concrete implementations. Users may override these mappings, e.g. in MapReduce job + configuration. You should not open a store returned by + getRequiredStores() directly; you should look to a + Context object or similar mechanism exposed by the Kiji framework to + determine the actual KeyValueStoreReader instance to use.

            +

            +

            + +
            Returns:
            a map from store names to default KeyValueStore implementations.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStoreReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStoreReader.html new file mode 100644 index 00000000..4539a905 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStoreReader.html @@ -0,0 +1,308 @@ + + + + + + + +KeyValueStoreReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore +
            +Interface KeyValueStoreReader<K,V>

            +
            +
            Type Parameters:
            K - the type associated with keys in this store.
            V - the type associated with values in this store.
            +
            +
            All Superinterfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface KeyValueStoreReader<K,V>
            extends Closeable
            + + +

            +Allows users to read from a KeyValueStore. + +

            A KeyValueStoreReader is created and configured by KeyValueStore.open(). From there, it performs the required + I/O or computational operations required to retrieve values by key.

            + +

            By default, this data is presented to you as a read-only, non-iterable map. + Only get() requests for an explicit key are supported by default, though some + implementations may offer iteration. +

            + +

            An opened KeyValueStore may contain state or connect to external resources; + you should call the close() method when you are finished using this KeyValueStoreReader. +

            + +

            KeyValueStoreReader implementations may throw IOException + from their constructor or other initialization routines called by KeyValueStore.open() + when attempting to connect to underlying resources.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleancontainsKey(K key) + +
            +          Determines if the specified key exists in the KeyValueStore.
            + Vget(K key) + +
            +          Looks up the specified key in the KeyValueStore and returns the associated + value if available.
            + booleanisOpen() + +
            +           
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +V get(K key)
+      throws IOException
            +
            +
            Looks up the specified key in the KeyValueStore and returns the associated + value if available. +

            +

            +
            +
            +
            +
            Parameters:
            key - the non-null key that defines an entity in the KeyValueStore to + retrieve. +
            Returns:
            the value associated with 'key', or null if no such value is available. +
            Throws: +
            IOException - if there is an IO error communicating with the underlying + storage medium for the KeyValueStore.
            +
            +
            +
            + +

            +containsKey

            +
            +boolean containsKey(K key)
+                    throws IOException
            +
            +
            Determines if the specified key exists in the KeyValueStore. +

            +

            +
            +
            +
            +
            Parameters:
            key - the non-null key that may define an entity in the KeyValueStore. +
            Returns:
            true if the key is present in the KeyValueStore. +
            Throws: +
            IOException - if there is an IO error communicating with the underlying + storage medium for the KeyValueStore.
            +
            +
            +
            + +

            +isOpen

            +
            +boolean isOpen()
            +
            +
            +
            +
            +
            + +
            Returns:
            true if the reader is open; false if close() has already been called.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStoreReaderFactory.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStoreReaderFactory.html new file mode 100644 index 00000000..93013c21 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/KeyValueStoreReaderFactory.html @@ -0,0 +1,366 @@ + + + + + + + +KeyValueStoreReaderFactory (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore +
            +Class KeyValueStoreReaderFactory

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.KeyValueStoreReaderFactory
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KeyValueStoreReaderFactory
            extends Object
            implements Closeable
            + + +

            +Class that manages the creation of KeyValueStoreReaders associated + with a set of bound KeyValueStore name--instance pairs. + +

            This also manages a cache of opened readers, which will be returned + if available, rather than creating a new store reader for a given named + store.

            + +

            The close() method of this object will close all KeyValueStoreReaders + associated with it. You should call this when you are done with the + readers, or close them all individually.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Closes all KeyValueStoreReaders opened by this factory.
            +static KeyValueStoreReaderFactorycreate(org.apache.hadoop.conf.Configuration conf) + +
            +          Creates a KeyValueStoreReaderFactory backed by store bindings specified in a Configuration.
            +static KeyValueStoreReaderFactorycreate(Map<String,KeyValueStore<?,?>> storeBindings) + +
            +          Creates a KeyValueStoreReaderFactory backed by a map of specific store bindings.
            +static KeyValueStoreReaderFactorycreateEmpty() + +
            +          Creates an empty KeyValueStoreReaderFactory.
            + + + + + +
            +<K,V> KeyValueStoreReader<K,V>
            +            		openStore(String storeName) + +
            +          Opens a KeyValueStore associated with storeName for read-access.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +createEmpty

            +
            +public static KeyValueStoreReaderFactory createEmpty()
            +
            +
            Creates an empty KeyValueStoreReaderFactory. +

            +

            +
            +
            +
            + +
            Returns:
            a new, empty KeyValueStoreReaderFactory.
            +
            +
            +
            + +

            +create

            +
            +public static KeyValueStoreReaderFactory create(Map<String,KeyValueStore<?,?>> storeBindings)
            +
            +
            Creates a KeyValueStoreReaderFactory backed by a map of specific store bindings. +

            +

            +
            +
            +
            +
            Parameters:
            storeBindings - defines the set of KeyValueStores available, and the + names by which they are registered. +
            Returns:
            a new KeyValueStoreReaderFactory backed by a copy of the specified storeBindings.
            +
            +
            +
            + +

            +create

            +
            +public static KeyValueStoreReaderFactory create(org.apache.hadoop.conf.Configuration conf)
+                                         throws IOException
            +
            +
            Creates a KeyValueStoreReaderFactory backed by store bindings specified in a Configuration. +

            +

            +
            +
            +
            +
            Parameters:
            conf - the Configuration from which a set of KeyValueStore bindings should + be deserialized and initialized. +
            Returns:
            a new KeyValueStoreReaderFactory backed by the storeBindings specified in conf. +
            Throws: +
            IOException - if there is an error deserializing or initializing a + KeyValueStore instance.
            +
            +
            +
            + +

            +close

            +
            +public void close()
            +
            +
            Closes all KeyValueStoreReaders opened by this factory. +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            +
            +
            +
            +
            + +

            +openStore

            +
            +public <K,V> KeyValueStoreReader<K,V> openStore(String storeName)
+                                   throws IOException
            +
            +
            Opens a KeyValueStore associated with storeName for read-access. + +

            You should close() the store instance returned by this method + when you are done with it. (Or close this KeyValueStoreReaderFactory + when you are done with all stores.)

            + +

            Calling openStore() multiple times on the same name will reuse the same + reader unless it is closed.

            +

            +

            +
            +
            +
            +
            Type Parameters:
            K - The key type for the KeyValueStore.
            V - The value type for the KeyValueStore.
            Parameters:
            storeName - the name of the KeyValueStore to open. +
            Returns:
            A KeyValueStoreReader associated with this storeName, or null + if there is no such KeyValueStore available. +
            Throws: +
            IOException - if there is an error opening the underlying storage resource.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/RequiredStores.StoreMap.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/RequiredStores.StoreMap.html new file mode 100644 index 00000000..d4eff847 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/RequiredStores.StoreMap.html @@ -0,0 +1,289 @@ + + + + + + + +RequiredStores.StoreMap (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore +
            +Class RequiredStores.StoreMap

            +
            +java.lang.Object
+  extended by java.util.AbstractMap<K,V>
+      extended by java.util.HashMap<String,KeyValueStore<?,?>>
+          extended by org.kiji.mapreduce.kvstore.RequiredStores.StoreMap
+
            +
            +
            All Implemented Interfaces:
            Serializable, Cloneable, Map<String,KeyValueStore<?,?>>
            +
            +
            +
            Enclosing class:
            RequiredStores
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class RequiredStores.StoreMap
            extends HashMap<String,KeyValueStore<?,?>>
            + + +

            +A Map from names to KeyValueStore entries, created by RequiredStores.with(). + +

            Includes a with() method that allows you to daisy-chain calls + to add multiple stores in a concise fashion.

            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class java.util.AbstractMap
            AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
            +  + + + + + + + + + + + + +
            +Method Summary
            + RequiredStores.StoreMapwith(String name, + KeyValueStore<?,?> store) + +
            +          Add the associated name-to-store mapping.
            +  + + + + + + + +
            Methods inherited from class java.util.HashMap
            clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values
            +  + + + + + + + +
            Methods inherited from class java.util.AbstractMap
            equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            finalize, getClass, notify, notifyAll, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Map
            equals, hashCode
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +with

            +
            +public RequiredStores.StoreMap with(String name,
+                                    KeyValueStore<?,?> store)
            +
            +
            Add the associated name-to-store mapping. +

            +

            +
            Parameters:
            name - the name of the single KeyValueStore required.
            store - the default implementation of the single KeyValueStore required. +
            Returns:
            this object.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/RequiredStores.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/RequiredStores.html new file mode 100644 index 00000000..239d1db5 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/RequiredStores.html @@ -0,0 +1,315 @@ + + + + + + + +RequiredStores (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore +
            +Class RequiredStores

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.RequiredStores
+
            +
            +
            +
            @ApiAudience.Public
+public final class RequiredStores
            extends Object
            + + +

            +Convenient methods for assembling maps from names to KeyValueStore + implementations in getRequiredStores() calls. + +

            Assembling maps from store names to KeyValueStore implementations + in the getRequiredStores() method of KijiProducer, KijiGatherer, etc. + can be cumbersome. This utility class contains methods that allow you + to assemble these in a more concise fashion.

            + +

            Using the RequiredStores.with(name, store) method will return a + java.util.Map subclass augmented with a 'with(name, store)' method + that can be used to chain such calls together: + RequiredStores.with("a", A).with("b", B)....

            + + KeyValueStore + KijiProducer +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classRequiredStores.StoreMap + +
            +          A Map from names to KeyValueStore entries, created by RequiredStores.with().
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<K,V> Map<String,KeyValueStore<?,?>>
            +            		just(String name, + KeyValueStore<K,V> store) + +
            +          Create an immutable required store map of a single entry.
            +static Map<String,KeyValueStore<?,?>>none() + +
            +          Returns an immutable, empty mapping from names to store implementations.
            +static RequiredStores.StoreMapwith(String name, + KeyValueStore<?,?> store) + +
            +          Creates a map from names to stores with an initial entry.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +none

            +
            +public static Map<String,KeyValueStore<?,?>> none()
            +
            +
            Returns an immutable, empty mapping from names to store implementations. +

            +

            + +
            Returns:
            an immutable, empty mapping from names to store implementations.
            +
            +
            +
            + +

            +just

            +
            +public static <K,V> Map<String,KeyValueStore<?,?>> just(String name,
+                                                        KeyValueStore<K,V> store)
            +
            +
            Create an immutable required store map of a single entry. +

            +

            +
            Type Parameters:
            K - the inferred KeyValueStore's key type.
            V - the inferred KeyValueStore's value type.
            Parameters:
            name - the name of the single KeyValueStore required.
            store - the default implementation of the single KeyValueStore required. +
            Returns:
            a mapping from that name to the store.
            +
            +
            +
            + +

            +with

            +
            +public static RequiredStores.StoreMap with(String name,
+                                           KeyValueStore<?,?> store)
            +
            +
            Creates a map from names to stores with an initial entry. Returns a StoreMap that + can be populated with additional mappings. +

            +

            +
            Parameters:
            name - the name of the single KeyValueStore required.
            store - the default implementation of the single KeyValueStore required. +
            Returns:
            a mapping from that name to the store.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStore.html new file mode 100644 index 00000000..75e4f236 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStore.html @@ -0,0 +1,633 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.kvstore.KeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.kvstore.KeyValueStore

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KeyValueStore
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.kvstoreKey-value store APIs. 
            org.kiji.mapreduce.kvstore.implKey value store implementation details. 
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            +  +

            + + + + + +
            +Uses of KeyValueStore in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce that return types with arguments of type KeyValueStore
            +protected  Map<String,KeyValueStore<?,?>>KijiMapReduceJobBuilder.getRequiredStores() + +
            +          Method for job components to declare required KeyValueStore entries (and their default + implementations).
            +  +

            + + + + + +
            +Uses of KeyValueStore in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport that return types with arguments of type KeyValueStore
            +protected  Map<String,KeyValueStore<?,?>>KijiBulkImportJobBuilder.getRequiredStores() + +
            +          Method for job components to declare required KeyValueStore entries (and their default + implementations).
            + Map<String,KeyValueStore<?,?>>KijiBulkImporter.getRequiredStores() + +
            +          Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations.
            +  +

            + + + + + +
            +Uses of KeyValueStore in org.kiji.mapreduce.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework that return types with arguments of type KeyValueStore
            +protected  Map<String,KeyValueStore<?,?>>MapReduceJobBuilder.getRequiredStores() + +
            +          Method for job components to declare required KeyValueStore entries (and their default + implementations).
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.framework with parameters of type KeyValueStore
            + TMapReduceJobBuilder.withStore(String storeName, + KeyValueStore<?,?> storeImpl) + +
            +          Binds a key-value store name to the specified KeyValueStore implementation.
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.mapreduce.framework with type arguments of type KeyValueStore
            +protected  voidMapReduceJobBuilder.mergeStores(Map<String,KeyValueStore<?,?>> dest, + Map<String,KeyValueStore<?,?>> src) + +
            +          Adds all KeyValueStore mappings from src to the 'dest' map.
            +protected  voidMapReduceJobBuilder.mergeStores(Map<String,KeyValueStore<?,?>> dest, + Map<String,KeyValueStore<?,?>> src) + +
            +          Adds all KeyValueStore mappings from src to the 'dest' map.
            +  +

            + + + + + +
            +Uses of KeyValueStore in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.gather that return types with arguments of type KeyValueStore
            +protected  Map<String,KeyValueStore<?,?>>KijiGatherJobBuilder.getRequiredStores() + +
            +          Method for job components to declare required KeyValueStore entries (and their default + implementations).
            + Map<String,KeyValueStore<?,?>>KijiGatherer.getRequiredStores() + +
            +          Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations.
            +  +

            + + + + + +
            +Uses of KeyValueStore in org.kiji.mapreduce.kvstore
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore that return types with arguments of type KeyValueStore
            + Map<String,KeyValueStore<?,?>>KeyValueStoreClient.getRequiredStores() + +
            +          Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations.
            +static + + + + +
            +<K,V> Map<String,KeyValueStore<?,?>>
            +            		RequiredStores.just(String name, + KeyValueStore<K,V> store) + +
            +          Create an immutable required store map of a single entry.
            +static Map<String,KeyValueStore<?,?>>RequiredStores.none() + +
            +          Returns an immutable, empty mapping from names to store implementations.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore with parameters of type KeyValueStore
            +static + + + + +
            +<K,V> Map<String,KeyValueStore<?,?>>
            +            		RequiredStores.just(String name, + KeyValueStore<K,V> store) + +
            +          Create an immutable required store map of a single entry.
            +static RequiredStores.StoreMapRequiredStores.with(String name, + KeyValueStore<?,?> store) + +
            +          Creates a map from names to stores with an initial entry.
            + RequiredStores.StoreMapRequiredStores.StoreMap.with(String name, + KeyValueStore<?,?> store) + +
            +          Add the associated name-to-store mapping.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.mapreduce.kvstore with type arguments of type KeyValueStore
            +static KeyValueStoreReaderFactoryKeyValueStoreReaderFactory.create(Map<String,KeyValueStore<?,?>> storeBindings) + +
            +          Creates a KeyValueStoreReaderFactory backed by a map of specific store bindings.
            +  +

            + + + + + +
            +Uses of KeyValueStore in org.kiji.mapreduce.kvstore.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.impl that return types with arguments of type KeyValueStore
            + Map<String,KeyValueStore<?,?>>XmlKeyValueStoreParser.loadStoresFromXml(InputStream xmlStream) + +
            +          Given an InputStream pointing to an opened resource that specifies a set of KeyValueStores + via XML, return the map of names to configured KeyValueStore instances.
            +  +

            + + + + + + + + + + + + + + + + + +
            Method parameters in org.kiji.mapreduce.kvstore.impl with type arguments of type KeyValueStore
            + voidKeyValueStoreConfigSerializer.addStoreMapToConfiguration(Map<String,KeyValueStore<?,?>> stores, + org.apache.hadoop.conf.Configuration conf) + +
            +          Given a set of KeyValueStores, add their configuration data to the provided Configuration.
            + voidKeyValueStoreConfigValidator.bindAndValidateRequiredStores(Map<String,KeyValueStore<?,?>> requiredStores, + Map<String,KeyValueStore<?,?>> storeBindings) + +
            +          Fills any unbound stores in storeBindings with the default + implementations found in requiredStores.
            + voidKeyValueStoreConfigValidator.bindAndValidateRequiredStores(Map<String,KeyValueStore<?,?>> requiredStores, + Map<String,KeyValueStore<?,?>> storeBindings) + +
            +          Fills any unbound stores in storeBindings with the default + implementations found in requiredStores.
            +  +

            + + + + + +
            +Uses of KeyValueStore in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.mapreduce.kvstore.lib that implement KeyValueStore
            + classAvroKVRecordKeyValueStore<K,V> + +
            +          An interface for providing read access to Avro container files of (key, value) + records.
            + classAvroRecordKeyValueStore<K,V extends IndexedRecord> + +
            +          An interface for providing read access to Avro container files of records.
            + classEmptyKeyValueStore<K,V> + +
            +          A KeyValueStore that contains no data.
            + classKijiTableKeyValueStore<V> + +
            +          KeyValueStore lookup implementation based on a Kiji table.
            + classSeqFileKeyValueStore<K,V> + +
            +          KeyValueStore implementation that reads records from SequenceFiles.
            + classTextFileKeyValueStore + +
            +          KeyValueStore implementation that reads delimited records from text files.
            + classUnconfiguredKeyValueStore<K,V> + +
            +          A KeyValueStore that is not configured.
            +  +

            + + + + + +
            +Uses of KeyValueStore in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce that return types with arguments of type KeyValueStore
            + Map<String,KeyValueStore<?,?>>KijiProducer.getRequiredStores() + +
            +          Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations.
            +protected  Map<String,KeyValueStore<?,?>>KijiProduceJobBuilder.getRequiredStores() + +
            +          Method for job components to declare required KeyValueStore entries (and their default + implementations).
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStoreClient.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStoreClient.html new file mode 100644 index 00000000..08821709 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStoreClient.html @@ -0,0 +1,259 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.kvstore.KeyValueStoreClient (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.kvstore.KeyValueStoreClient

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KeyValueStoreClient
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            +  +

            + + + + + +
            +Uses of KeyValueStoreClient in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.mapreduce.bulkimport that implement KeyValueStoreClient
            + classAvroBulkImporter<T> + +
            +          Base class for Kiji bulk importers that process Avro container + files.
            + classBinaryHTableBulkImporter + +
            +          A bulk importer that reads columns from an HTable that were encoded using the Bytes utility class.
            + classKijiBulkImporter<K,V> + +
            +          Base class for all Kiji bulk importers.
            +  +

            + + + + + +
            +Uses of KeyValueStoreClient in org.kiji.mapreduce.gather
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.gather that implement KeyValueStoreClient
            + classKijiGatherer<K,V> + +
            +           + Base class for all Kiji Gatherers.
            +  +

            + + + + + +
            +Uses of KeyValueStoreClient in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.produce that implement KeyValueStoreClient
            + classKijiProducer + +
            +           + Base class for all Kiji Producers used to generate per-row derived + entity data.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStoreReader.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStoreReader.html new file mode 100644 index 00000000..d43645df --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStoreReader.html @@ -0,0 +1,345 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.kvstore.KeyValueStoreReader (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.kvstore.KeyValueStoreReader

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KeyValueStoreReader
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            org.kiji.mapreduce.kvstoreKey-value store APIs. 
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of KeyValueStoreReader in org.kiji.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce that return KeyValueStoreReader
            + + + + + +
            +<K,V> KeyValueStoreReader<K,V>
            +            		KijiContext.getStore(String storeName) + +
            +          Opens a KeyValueStore associated with storeName for read-access.
            +  +

            + + + + + +
            +Uses of KeyValueStoreReader in org.kiji.mapreduce.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.impl that return KeyValueStoreReader
            + + + + + +
            +<K,V> KeyValueStoreReader<K,V>
            +            		InternalKijiContext.getStore(String storeName) + +
            +          Opens a KeyValueStore associated with storeName for read-access.
            +  +

            + + + + + +
            +Uses of KeyValueStoreReader in org.kiji.mapreduce.kvstore
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore that return KeyValueStoreReader
            + KeyValueStoreReader<K,V>KeyValueStore.open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + + + + + +
            +<K,V> KeyValueStoreReader<K,V>
            +            		KeyValueStoreReaderFactory.openStore(String storeName) + +
            +          Opens a KeyValueStore associated with storeName for read-access.
            +  +

            + + + + + +
            +Uses of KeyValueStoreReader in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return KeyValueStoreReader
            + KeyValueStoreReader<K,V>UnconfiguredKeyValueStore.open() + +
            +          Throws IllegalStateException; you cannot open an unconfigured store.
            + KeyValueStoreReader<K,V>EmptyKeyValueStore.open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + KeyValueStoreReader<String,V>KijiTableKeyValueStore.open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + KeyValueStoreReader<String,String>TextFileKeyValueStore.open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + KeyValueStoreReader<K,V>AvroRecordKeyValueStore.open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + KeyValueStoreReader<K,V>AvroKVRecordKeyValueStore.open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + KeyValueStoreReader<K,V>SeqFileKeyValueStore.open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStoreReaderFactory.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStoreReaderFactory.html new file mode 100644 index 00000000..a916626f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/KeyValueStoreReaderFactory.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.KeyValueStoreReaderFactory (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.KeyValueStoreReaderFactory

            +
            + + + + + + + + + +
            +Packages that use KeyValueStoreReaderFactory
            org.kiji.mapreduce.kvstoreKey-value store APIs. 
            +  +

            + + + + + +
            +Uses of KeyValueStoreReaderFactory in org.kiji.mapreduce.kvstore
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore that return KeyValueStoreReaderFactory
            +static KeyValueStoreReaderFactoryKeyValueStoreReaderFactory.create(org.apache.hadoop.conf.Configuration conf) + +
            +          Creates a KeyValueStoreReaderFactory backed by store bindings specified in a Configuration.
            +static KeyValueStoreReaderFactoryKeyValueStoreReaderFactory.create(Map<String,KeyValueStore<?,?>> storeBindings) + +
            +          Creates a KeyValueStoreReaderFactory backed by a map of specific store bindings.
            +static KeyValueStoreReaderFactoryKeyValueStoreReaderFactory.createEmpty() + +
            +          Creates an empty KeyValueStoreReaderFactory.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/RequiredStores.StoreMap.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/RequiredStores.StoreMap.html new file mode 100644 index 00000000..ba4c9705 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/RequiredStores.StoreMap.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.RequiredStores.StoreMap (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.RequiredStores.StoreMap

            +
            + + + + + + + + + +
            +Packages that use RequiredStores.StoreMap
            org.kiji.mapreduce.kvstoreKey-value store APIs. 
            +  +

            + + + + + +
            +Uses of RequiredStores.StoreMap in org.kiji.mapreduce.kvstore
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore that return RequiredStores.StoreMap
            +static RequiredStores.StoreMapRequiredStores.with(String name, + KeyValueStore<?,?> store) + +
            +          Creates a map from names to stores with an initial entry.
            + RequiredStores.StoreMapRequiredStores.StoreMap.with(String name, + KeyValueStore<?,?> store) + +
            +          Add the associated name-to-store mapping.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/RequiredStores.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/RequiredStores.html new file mode 100644 index 00000000..54506d84 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/class-use/RequiredStores.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.RequiredStores (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.RequiredStores

            +
            +No usage of org.kiji.mapreduce.kvstore.RequiredStores +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/KeyValueStoreConfiguration.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/KeyValueStoreConfiguration.html new file mode 100644 index 00000000..ade6fe45 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/KeyValueStoreConfiguration.html @@ -0,0 +1,853 @@ + + + + + + + +KeyValueStoreConfiguration (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.framework +
            +Class KeyValueStoreConfiguration

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KeyValueStoreConfiguration
            extends Object
            + + +

            +Used to serialize KeyValueStore information into a unique namespace + inside a Configuration object. All conf keys written to this object (e.g., "foo") + are prefixed by a namespace ("ns") specific to the particular key-value store + instance (e.g., "ns.foo"). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static StringKEY_VALUE_STORE_NAMESPACE + +
            +          KeyValueStore definitions are serialized to the Configuration as a set of + keys under the "kiji.kvstores.[i]" namespace.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            KeyValueStoreConfiguration(org.apache.hadoop.conf.Configuration parent, + int storeIndex) + +
            +          Creates a KeyValueStoreConfiguration that writes to the storeIndexth + KeyValueStore namespace.
            KeyValueStoreConfiguration(org.apache.hadoop.conf.Configuration parent, + String namespace) + +
            +          Constructs a new KeyValueStoreConfiguration that will read and write + values to the parent Configuration, under an arbitrary namespace.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KeyValueStoreConfigurationfromConf(org.apache.hadoop.conf.Configuration conf) + +
            +          Factory method to wrap a Configuration in a KeyValueStoreConfiguration.
            + Stringget(String name) + +
            +          Get the value of the name property, or null + if no such property exists.
            + Stringget(String name, + String defaultValue) + +
            +          Get the value of the name property.
            + booleangetBoolean(String name, + boolean defaultValue) + +
            +          Get the value of the name property as a boolean.
            + Class<?>getClass(String name, + Class<?> defaultValue) + +
            +          Gets the value of the name property as a Class.
            + + + + + +
            +<U> Class<? extends U>
            +            		getClass(String name, + Class<? extends U> defaultValue, + Class<U> xface) + +
            +          Get the value of the name property as a Class implementing the + interface specified by xface.
            + Class<?>getClassByName(String name) + +
            +          Gets the value of the name property as a Class.
            + org.apache.hadoop.conf.ConfigurationgetDelegate() + +
            +          Returns the parent Configuration that backs this KeyValueStoreConfiguration.
            + floatgetFloat(String name, + float defaultValue) + +
            +          Gets the value of the name property as a float.
            + intgetInt(String name, + int defaultValue) + +
            +          Gets the value of the name property as an int.
            + longgetLong(String name, + long defaultValue) + +
            +          Gets the value of the name property as a long.
            + StringgetNamespace() + +
            +          Returns the namespace that this KeyValueStoreConfiguration works in.
            + StringgetRaw(String name) + +
            +          Get the value of the name property, without doing variable expansion.
            + String[]getStrings(String name) + +
            +          Get the comma delimited values of the name property + as an array of Strings.
            + String[]getStrings(String name, + String... defaultValue) + +
            +          Get the comma delimited values of the name property + as an array of Strings.
            + voidset(String name, + String value) + +
            +          Sets the value of the name property.
            + voidsetBoolean(String name, + boolean value) + +
            +          Sets the value of the name property to a boolean.
            + voidsetClass(String name, + Class<?> theClass, + Class<?> xface) + +
            +          Sets the value of the name property to be a Class.
            + voidsetFloat(String name, + float value) + +
            +          Sets the value of the name property to be a float.
            + voidsetInt(String name, + int value) + +
            +          Sets the value of the name property to be an int.
            + voidsetLong(String name, + long value) + +
            +          Sets the value of the name property to be a long.
            + voidsetStrings(String name, + String... values) + +
            +          Set the array of string values for the name property as comma + delimited values.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +KEY_VALUE_STORE_NAMESPACE

            +
            +public static final String KEY_VALUE_STORE_NAMESPACE
            +
            +
            KeyValueStore definitions are serialized to the Configuration as a set of + keys under the "kiji.kvstores.[i]" namespace. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +KeyValueStoreConfiguration

            +
            +public KeyValueStoreConfiguration(org.apache.hadoop.conf.Configuration parent,
+                                  int storeIndex)
            +
            +
            Creates a KeyValueStoreConfiguration that writes to the storeIndexth + KeyValueStore namespace. +

            +

            +
            Parameters:
            parent - The parent Configuration to back data.
            storeIndex - The namespace index to write to.
            +
            +
            + +

            +KeyValueStoreConfiguration

            +
            +public KeyValueStoreConfiguration(org.apache.hadoop.conf.Configuration parent,
+                                  String namespace)
            +
            +
            Constructs a new KeyValueStoreConfiguration that will read and write + values to the parent Configuration, under an arbitrary namespace. +

            +

            +
            Parameters:
            parent - The Configuration to back this KeyValueStoreConfiguration.
            namespace - The namespace to write to.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +fromConf

            +
            +public static KeyValueStoreConfiguration fromConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Factory method to wrap a Configuration in a KeyValueStoreConfiguration. + +

            The resulting KeyValueStoreConfiguration will have all key-value pairs that the + parent does. The resulting KeyValueStoreConfiguration will write to the "0"'th + KeyValueStore entry in the "kiji.job.kvstores" namespace (e.g., calling + set("foo", ...) on the resulting namespace will set key + kiji.job.kvstores.0.foo within the backing Configuration.

            +

            +

            +
            Parameters:
            conf - the Configuration to wrap in a KeyValueStoreConfiguration. +
            Returns:
            A new KeyValueStoreConfiguration that is configured to write to + a namespace within the supplied Configuration.
            +
            +
            +
            + +

            +getDelegate

            +
            +public org.apache.hadoop.conf.Configuration getDelegate()
            +
            +
            Returns the parent Configuration that backs this KeyValueStoreConfiguration. +

            +

            + +
            Returns:
            The parent Configuration.
            +
            +
            +
            + +

            +getNamespace

            +
            +public String getNamespace()
            +
            +
            Returns the namespace that this KeyValueStoreConfiguration works in. +

            +

            + +
            Returns:
            The namespace.
            +
            +
            +
            + +

            +get

            +
            +public String get(String name)
            +
            +
            Get the value of the name property, or null + if no such property exists. +

            +

            +
            Parameters:
            name - The property to get a value for. +
            Returns:
            The value, or null, if no such property exists.
            +
            +
            +
            + +

            +get

            +
            +public String get(String name,
+                  String defaultValue)
            +
            +
            Get the value of the name property. +

            +

            +
            Parameters:
            name - The property to get a value for.
            defaultValue - The default value if none is specified. +
            Returns:
            The value.
            +
            +
            +
            + +

            +set

            +
            +public void set(String name,
+                String value)
            +
            +
            Sets the value of the name property. +

            +

            +
            Parameters:
            name - The property to set.
            value - The value to set.
            +
            +
            +
            + +

            +getBoolean

            +
            +public boolean getBoolean(String name,
+                          boolean defaultValue)
            +
            +
            Get the value of the name property as a boolean. +

            +

            +
            Parameters:
            name - The property to get a boolean for.
            defaultValue - The value to return if it is not set. +
            Returns:
            The value of this property as a boolean.
            +
            +
            +
            + +

            +setBoolean

            +
            +public void setBoolean(String name,
+                       boolean value)
            +
            +
            Sets the value of the name property to a boolean. +

            +

            +
            Parameters:
            name - The property to set.
            value - The boolean to set.
            +
            +
            +
            + +

            +getClass

            +
            +public Class<?> getClass(String name,
+                         Class<?> defaultValue)
            +
            +
            Gets the value of the name property as a Class. +

            +

            +
            Parameters:
            name - The property to get a Class for.
            defaultValue - The value to return if it is not set. +
            Returns:
            The value of this property as a Class.
            +
            +
            +
            + +

            +getClass

            +
            +public <U> Class<? extends U> getClass(String name,
+                                       Class<? extends U> defaultValue,
+                                       Class<U> xface)
            +
            +
            Get the value of the name property as a Class implementing the + interface specified by xface. If no such property is specified, + then defaultValue is returned. An exception is thrown if the + returned class does not implement the named interface. +

            +

            +
            Type Parameters:
            U - The interface to deserialize this class to.
            Parameters:
            name - The property to get a Class for.
            defaultValue - The value to return if it is not set.
            xface - The interface implemented by the named class. +
            Returns:
            The value of this property as a Class implementing xface.
            +
            +
            +
            + +

            +getClassByName

            +
            +public Class<?> getClassByName(String name)
+                        throws ClassNotFoundException
            +
            +
            Gets the value of the name property as a Class. +

            +

            +
            Parameters:
            name - The property to get a Class for. +
            Returns:
            The value of this property as a Class. +
            Throws: +
            ClassNotFoundException - If the class is not found.
            +
            +
            +
            + +

            +setClass

            +
            +public void setClass(String name,
+                     Class<?> theClass,
+                     Class<?> xface)
            +
            +
            Sets the value of the name property to be a Class. +

            +

            +
            Parameters:
            name - The property to set.
            theClass - The Class to set.
            xface - The interface implemented by the named class.
            +
            +
            +
            + +

            +getFloat

            +
            +public float getFloat(String name,
+                      float defaultValue)
            +
            +
            Gets the value of the name property as a float. +

            +

            +
            Parameters:
            name - The property to get a float for.
            defaultValue - The value to return if it is not set. +
            Returns:
            The value of this property as a float.
            +
            +
            +
            + +

            +setFloat

            +
            +public void setFloat(String name,
+                     float value)
            +
            +
            Sets the value of the name property to be a float. +

            +

            +
            Parameters:
            name - The property to set.
            value - The float to set.
            +
            +
            +
            + +

            +getInt

            +
            +public int getInt(String name,
+                  int defaultValue)
            +
            +
            Gets the value of the name property as an int. +

            +

            +
            Parameters:
            name - The property to get an int for.
            defaultValue - The value to return if it is not set. +
            Returns:
            The value of this property as an int.
            +
            +
            +
            + +

            +setInt

            +
            +public void setInt(String name,
+                   int value)
            +
            +
            Sets the value of the name property to be an int. +

            +

            +
            Parameters:
            name - The property to set.
            value - The int to set.
            +
            +
            +
            + +

            +getLong

            +
            +public long getLong(String name,
+                    long defaultValue)
            +
            +
            Gets the value of the name property as a long. +

            +

            +
            Parameters:
            name - The property to get a long for.
            defaultValue - The value to return if it is not set. +
            Returns:
            The value of this property as a long.
            +
            +
            +
            + +

            +setLong

            +
            +public void setLong(String name,
+                    long value)
            +
            +
            Sets the value of the name property to be a long. +

            +

            +
            Parameters:
            name - The property to set.
            value - The long to set.
            +
            +
            +
            + +

            +getStrings

            +
            +public String[] getStrings(String name)
            +
            +
            Get the comma delimited values of the name property + as an array of Strings. +

            +

            +
            Parameters:
            name - The property to get a String array for. +
            Returns:
            The value of this property as a String array.
            +
            +
            +
            + +

            +getStrings

            +
            +public String[] getStrings(String name,
+                           String... defaultValue)
            +
            +
            Get the comma delimited values of the name property + as an array of Strings. If none found, returns + the default value instead. +

            +

            +
            Parameters:
            name - The property to get a String array for.
            defaultValue - The value to return if it is not set. +
            Returns:
            The value of this property as a String array.
            +
            +
            +
            + +

            +setStrings

            +
            +public void setStrings(String name,
+                       String... values)
            +
            +
            Set the array of string values for the name property as comma + delimited values. +

            +

            +
            Parameters:
            name - The property to set.
            values - The values.
            +
            +
            +
            + +

            +getRaw

            +
            +public String getRaw(String name)
            +
            +
            Get the value of the name property, without doing variable expansion. +

            +

            +
            Parameters:
            name - The property to get a raw value for. +
            Returns:
            The raw value.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/class-use/KeyValueStoreConfiguration.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/class-use/KeyValueStoreConfiguration.html new file mode 100644 index 00000000..418e1a87 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/class-use/KeyValueStoreConfiguration.html @@ -0,0 +1,385 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.framework.KeyValueStoreConfiguration

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KeyValueStoreConfiguration
            org.kiji.mapreduce.kvstoreKey-value store APIs. 
            org.kiji.mapreduce.kvstore.frameworkFramework-level classes supporting KijiMR key value stores. 
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of KeyValueStoreConfiguration in org.kiji.mapreduce.kvstore
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore with parameters of type KeyValueStoreConfiguration
            + voidKeyValueStore.initFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + voidKeyValueStore.storeToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            +  +

            + + + + + +
            +Uses of KeyValueStoreConfiguration in org.kiji.mapreduce.kvstore.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.framework that return KeyValueStoreConfiguration
            +static KeyValueStoreConfigurationKeyValueStoreConfiguration.fromConf(org.apache.hadoop.conf.Configuration conf) + +
            +          Factory method to wrap a Configuration in a KeyValueStoreConfiguration.
            +  +

            + + + + + +
            +Uses of KeyValueStoreConfiguration in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib with parameters of type KeyValueStoreConfiguration
            + voidFileStoreHelper.initFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes file- and DistributedCache-specific properties associated + with the KeyValueStore that owns this FileStoreHelper from the specified configuration.
            + voidUnconfiguredKeyValueStore.initFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + voidEmptyKeyValueStore.initFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + voidKijiTableKeyValueStore.initFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + voidTextFileKeyValueStore.initFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + voidAvroRecordKeyValueStore.initFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + voidAvroKVRecordKeyValueStore.initFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + voidSeqFileKeyValueStore.initFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + voidFileStoreHelper.storeToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes file- and DistributedCache-specific properties associated + with the KeyValueStore that owns this FileStoreHelper to the specified configuration.
            + voidUnconfiguredKeyValueStore.storeToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            + voidEmptyKeyValueStore.storeToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            + voidKijiTableKeyValueStore.storeToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            + voidTextFileKeyValueStore.storeToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            + voidAvroRecordKeyValueStore.storeToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            + voidAvroKVRecordKeyValueStore.storeToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            + voidSeqFileKeyValueStore.storeToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-frame.html new file mode 100644 index 00000000..464e67d5 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.kiji.mapreduce.kvstore.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.kvstore.framework + + + + +
            +Classes  + +
            +KeyValueStoreConfiguration
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-summary.html new file mode 100644 index 00000000..f5dee465 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-summary.html @@ -0,0 +1,175 @@ + + + + + + + +org.kiji.mapreduce.kvstore.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.kvstore.framework +

            +Framework-level classes supporting KijiMR key value stores. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Class Summary
            KeyValueStoreConfigurationUsed to serialize KeyValueStore information into a unique namespace + inside a Configuration object.
            +  + +

            +

            +Package org.kiji.mapreduce.kvstore.framework Description +

            + +

            +Framework-level classes supporting KijiMR key value stores. Applications + should not use these. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-tree.html new file mode 100644 index 00000000..77c3bd76 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +org.kiji.mapreduce.kvstore.framework Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.kvstore.framework +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-use.html new file mode 100644 index 00000000..d048b08e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/framework/package-use.html @@ -0,0 +1,212 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.kvstore.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.kvstore.framework

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.kvstore.framework
            org.kiji.mapreduce.kvstoreKey-value store APIs. 
            org.kiji.mapreduce.kvstore.frameworkFramework-level classes supporting KijiMR key value stores. 
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore.framework used by org.kiji.mapreduce.kvstore
            KeyValueStoreConfiguration + +
            +          Used to serialize KeyValueStore information into a unique namespace + inside a Configuration object.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore.framework used by org.kiji.mapreduce.kvstore.framework
            KeyValueStoreConfiguration + +
            +          Used to serialize KeyValueStore information into a unique namespace + inside a Configuration object.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore.framework used by org.kiji.mapreduce.kvstore.lib
            KeyValueStoreConfiguration + +
            +          Used to serialize KeyValueStore information into a unique namespace + inside a Configuration object.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/KeyValueStoreConfigSerializer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/KeyValueStoreConfigSerializer.html new file mode 100644 index 00000000..4f20b6ae --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/KeyValueStoreConfigSerializer.html @@ -0,0 +1,354 @@ + + + + + + + +KeyValueStoreConfigSerializer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.impl +
            +Class KeyValueStoreConfigSerializer

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigSerializer
+
            +
            +
            +
            @ApiAudience.Private
+public final class KeyValueStoreConfigSerializer
            extends Object
            + + +

            +Serialize multiple KeyValueStoreConfigurations into a Hadoop Configuration + or deserialize the reverse. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_CLASS + +
            +          KeyValueStoreConfiguration variable storing the class name to deserialize the store.
            +static StringCONF_KEY_VALUE_STORE_COUNT + +
            +          How many KeyValueStore definitions were serialized in the configuration?
            +static StringCONF_NAME + +
            +          KeyValueStoreConfiguration variable storing the name of this KeyValueStore.
            +static intDEFAULT_KEY_VALUE_STORE_COUNT + +
            +          Default value for CONF_KEY_VALUE_STORE_COUNT.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + voidaddStoreMapToConfiguration(Map<String,KeyValueStore<?,?>> stores, + org.apache.hadoop.conf.Configuration conf) + +
            +          Given a set of KeyValueStores, add their configuration data to the provided Configuration.
            +static KeyValueStoreConfigSerializerget() + +
            +          This method returns a KeyValueStoreConfigSerializer instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +CONF_CLASS

            +
            +public static final String CONF_CLASS
            +
            +
            KeyValueStoreConfiguration variable storing the class name to deserialize the store. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_NAME

            +
            +public static final String CONF_NAME
            +
            +
            KeyValueStoreConfiguration variable storing the name of this KeyValueStore. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_KEY_VALUE_STORE_COUNT

            +
            +public static final String CONF_KEY_VALUE_STORE_COUNT
            +
            +
            How many KeyValueStore definitions were serialized in the configuration? +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULT_KEY_VALUE_STORE_COUNT

            +
            +public static final int DEFAULT_KEY_VALUE_STORE_COUNT
            +
            +
            Default value for CONF_KEY_VALUE_STORE_COUNT. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KeyValueStoreConfigSerializer get()
            +
            +
            This method returns a KeyValueStoreConfigSerializer instance. +

            +

            + +
            Returns:
            a KeyValueStoreConfigSerializer.
            +
            +
            +
            + +

            +addStoreMapToConfiguration

            +
            +public void addStoreMapToConfiguration(Map<String,KeyValueStore<?,?>> stores,
+                                       org.apache.hadoop.conf.Configuration conf)
+                                throws IOException
            +
            +
            Given a set of KeyValueStores, add their configuration data to the provided Configuration. + This replaces any previous KeyValueStore configs in the Configuration. +

            +

            +
            Parameters:
            stores - the map from names to KeyValueStores to serialize.
            conf - the Configuration to hold the stores. +
            Throws: +
            IOException - if there is an error serializing the configuration of a store.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/KeyValueStoreConfigValidator.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/KeyValueStoreConfigValidator.html new file mode 100644 index 00000000..0a45d7a2 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/KeyValueStoreConfigValidator.html @@ -0,0 +1,267 @@ + + + + + + + +KeyValueStoreConfigValidator (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.impl +
            +Class KeyValueStoreConfigValidator

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigValidator
+
            +
            +
            +
            @ApiAudience.Private
+public final class KeyValueStoreConfigValidator
            extends Object
            + + +

            +Merges default required store configs with per-job store configuration overrides, + and validates that the required stores are present. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidbindAndValidateRequiredStores(Map<String,KeyValueStore<?,?>> requiredStores, + Map<String,KeyValueStore<?,?>> storeBindings) + +
            +          Fills any unbound stores in storeBindings with the default + implementations found in requiredStores.
            +static KeyValueStoreConfigValidatorget() + +
            +          This method returns a KeyValueStoreConfigValidator instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KeyValueStoreConfigValidator get()
            +
            +
            This method returns a KeyValueStoreConfigValidator instance. +

            +

            + +
            Returns:
            a KeyValueStoreConfigValidator.
            +
            +
            +
            + +

            +bindAndValidateRequiredStores

            +
            +public void bindAndValidateRequiredStores(Map<String,KeyValueStore<?,?>> requiredStores,
+                                          Map<String,KeyValueStore<?,?>> storeBindings)
+                                   throws IOException
            +
            +
            Fills any unbound stores in storeBindings with the default + implementations found in requiredStores. + +

            Each store in requiredStores must have either:

            +
              +
            • A default implementation, or
              • +
            • An implementation defined in storeBindings.
              • +
            + +

            If not, an exception is thrown.

            +

            +

            +
            Parameters:
            requiredStores - A map of required store names to their default implementations + (may be null).
            storeBindings - A map of bound stores, which will be modified to contain default + implementations from requiredStores if not yet bound. +
            Throws: +
            IOException - If any of the required stores do not validate.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/XmlKeyValueStoreParser.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/XmlKeyValueStoreParser.html new file mode 100644 index 00000000..9f10b562 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/XmlKeyValueStoreParser.html @@ -0,0 +1,260 @@ + + + + + + + +XmlKeyValueStoreParser (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.impl +
            +Class XmlKeyValueStoreParser

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.impl.XmlKeyValueStoreParser
+
            +
            +
            +
            @ApiAudience.Private
+public final class XmlKeyValueStoreParser
            extends Object
            + + +

            +Utility that parses an XML file that specifies KeyValueStore implementations + to bind in an application. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static XmlKeyValueStoreParserget() + +
            +          This method returns XmlKeyValueStoreParser instance.
            + Map<String,KeyValueStore<?,?>>loadStoresFromXml(InputStream xmlStream) + +
            +          Given an InputStream pointing to an opened resource that specifies a set of KeyValueStores + via XML, return the map of names to configured KeyValueStore instances.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static XmlKeyValueStoreParser get()
            +
            +
            This method returns XmlKeyValueStoreParser instance. +

            +

            + +
            Returns:
            an XmlKeyValueStoreParser instance.
            +
            +
            +
            + +

            +loadStoresFromXml

            +
            +public Map<String,KeyValueStore<?,?>> loadStoresFromXml(InputStream xmlStream)
+                                                 throws IOException
            +
            +
            Given an InputStream pointing to an opened resource that specifies a set of KeyValueStores + via XML, return the map of names to configured KeyValueStore instances. The caller is + responsible for closing the InputStream. + +

            If an XML file tries to bind the same name to multiple stores, this will throw an + IOException.

            +

            +

            +
            Parameters:
            xmlStream - the InputStream pointing to the XML resource to load +
            Returns:
            a map from names to configured KeyValueStore instances. +
            Throws: +
            IOException - if there is an error reading from the input stream or parsing the XML.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/class-use/KeyValueStoreConfigSerializer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/class-use/KeyValueStoreConfigSerializer.html new file mode 100644 index 00000000..6cb06abf --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/class-use/KeyValueStoreConfigSerializer.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigSerializer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigSerializer

            +
            + + + + + + + + + +
            +Packages that use KeyValueStoreConfigSerializer
            org.kiji.mapreduce.kvstore.implKey value store implementation details. 
            +  +

            + + + + + +
            +Uses of KeyValueStoreConfigSerializer in org.kiji.mapreduce.kvstore.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.impl that return KeyValueStoreConfigSerializer
            +static KeyValueStoreConfigSerializerKeyValueStoreConfigSerializer.get() + +
            +          This method returns a KeyValueStoreConfigSerializer instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/class-use/KeyValueStoreConfigValidator.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/class-use/KeyValueStoreConfigValidator.html new file mode 100644 index 00000000..d6714f3b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/class-use/KeyValueStoreConfigValidator.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigValidator (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.impl.KeyValueStoreConfigValidator

            +
            + + + + + + + + + +
            +Packages that use KeyValueStoreConfigValidator
            org.kiji.mapreduce.kvstore.implKey value store implementation details. 
            +  +

            + + + + + +
            +Uses of KeyValueStoreConfigValidator in org.kiji.mapreduce.kvstore.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.impl that return KeyValueStoreConfigValidator
            +static KeyValueStoreConfigValidatorKeyValueStoreConfigValidator.get() + +
            +          This method returns a KeyValueStoreConfigValidator instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/class-use/XmlKeyValueStoreParser.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/class-use/XmlKeyValueStoreParser.html new file mode 100644 index 00000000..14e5eb77 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/class-use/XmlKeyValueStoreParser.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.impl.XmlKeyValueStoreParser (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.impl.XmlKeyValueStoreParser

            +
            + + + + + + + + + +
            +Packages that use XmlKeyValueStoreParser
            org.kiji.mapreduce.kvstore.implKey value store implementation details. 
            +  +

            + + + + + +
            +Uses of XmlKeyValueStoreParser in org.kiji.mapreduce.kvstore.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.impl that return XmlKeyValueStoreParser
            +static XmlKeyValueStoreParserXmlKeyValueStoreParser.get() + +
            +          This method returns XmlKeyValueStoreParser instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-frame.html new file mode 100644 index 00000000..60a359e7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-frame.html @@ -0,0 +1,37 @@ + + + + + + + +org.kiji.mapreduce.kvstore.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.kvstore.impl + + + + +
            +Classes  + +
            +KeyValueStoreConfigSerializer +
            +KeyValueStoreConfigValidator +
            +XmlKeyValueStoreParser
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-summary.html new file mode 100644 index 00000000..60a4b7f4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-summary.html @@ -0,0 +1,184 @@ + + + + + + + +org.kiji.mapreduce.kvstore.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.kvstore.impl +

            +Key value store implementation details. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + +
            +Class Summary
            KeyValueStoreConfigSerializerSerialize multiple KeyValueStoreConfigurations into a Hadoop Configuration + or deserialize the reverse.
            KeyValueStoreConfigValidatorMerges default required store configs with per-job store configuration overrides, + and validates that the required stores are present.
            XmlKeyValueStoreParserUtility that parses an XML file that specifies KeyValueStore implementations + to bind in an application.
            +  + +

            +

            +Package org.kiji.mapreduce.kvstore.impl Description +

            + +

            +Key value store implementation details. Clients should not use these. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-tree.html new file mode 100644 index 00000000..384d6959 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-tree.html @@ -0,0 +1,154 @@ + + + + + + + +org.kiji.mapreduce.kvstore.impl Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.kvstore.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-use.html new file mode 100644 index 00000000..5131d8ca --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/impl/package-use.html @@ -0,0 +1,186 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.kvstore.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.kvstore.impl

            +
            + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.kvstore.impl
            org.kiji.mapreduce.kvstore.implKey value store implementation details. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore.impl used by org.kiji.mapreduce.kvstore.impl
            KeyValueStoreConfigSerializer + +
            +          Serialize multiple KeyValueStoreConfigurations into a Hadoop Configuration + or deserialize the reverse.
            KeyValueStoreConfigValidator + +
            +          Merges default required store configs with per-job store configuration overrides, + and validates that the required stores are present.
            XmlKeyValueStoreParser + +
            +          Utility that parses an XML file that specifies KeyValueStore implementations + to bind in an application.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroKVRecordKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroKVRecordKeyValueStore.Builder.html new file mode 100644 index 00000000..1652fc47 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroKVRecordKeyValueStore.Builder.html @@ -0,0 +1,355 @@ + + + + + + + +AvroKVRecordKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class AvroKVRecordKeyValueStore.Builder

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore.Builder
+
            +
            +
            Enclosing class:
            AvroKVRecordKeyValueStore<K,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class AvroKVRecordKeyValueStore.Builder
            extends Object
            + + +

            +A Builder-pattern class that configures and creates new AvroKVRecordKeyValueStore + instances. You should use this to specify the input to this KeyValueStore. + Call the build() method to return a new, configured AvroKVRecordKeyValueStore instance. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<K,V> AvroKVRecordKeyValueStore<K,V>
            +            		build() + +
            +          Build a new AvroKVRecordKeyValueStore instance.
            + AvroKVRecordKeyValueStore.BuilderwithConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Hadoop configuration instance to use.
            + AvroKVRecordKeyValueStore.BuilderwithDistributedCache(boolean enabled) + +
            +          Sets a flag indicating the use of the DistributedCache to distribute + input files.
            + AvroKVRecordKeyValueStore.BuilderwithInputPath(org.apache.hadoop.fs.Path path) + +
            +          Adds a path to the list of files to load.
            + AvroKVRecordKeyValueStore.BuilderwithInputPaths(List<org.apache.hadoop.fs.Path> paths) + +
            +          Replaces the current list of files to load with the set of files + specified as an argument.
            + AvroKVRecordKeyValueStore.BuilderwithReaderSchema(org.apache.avro.Schema schema) + +
            +          Sets the schema to read the records with.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +withReaderSchema

            +
            +public AvroKVRecordKeyValueStore.Builder withReaderSchema(org.apache.avro.Schema schema)
            +
            +
            Sets the schema to read the records with. + This may be null; the schema used when writing the input files will be used directly. +

            +

            +
            Parameters:
            schema - The reader schema. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withConfiguration

            +
            +public AvroKVRecordKeyValueStore.Builder withConfiguration(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Sets the Hadoop configuration instance to use. +

            +

            +
            Parameters:
            conf - The configuration. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withInputPath

            +
            +public AvroKVRecordKeyValueStore.Builder withInputPath(org.apache.hadoop.fs.Path path)
            +
            +
            Adds a path to the list of files to load. +

            +

            +
            Parameters:
            path - The input file/directory path. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withInputPaths

            +
            +public AvroKVRecordKeyValueStore.Builder withInputPaths(List<org.apache.hadoop.fs.Path> paths)
            +
            +
            Replaces the current list of files to load with the set of files + specified as an argument. +

            +

            +
            Parameters:
            paths - The input file/directory paths. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withDistributedCache

            +
            +public AvroKVRecordKeyValueStore.Builder withDistributedCache(boolean enabled)
            +
            +
            Sets a flag indicating the use of the DistributedCache to distribute + input files. +

            +

            +
            Parameters:
            enabled - true if the DistributedCache should be used, false otherwise. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +build

            +
            +public <K,V> AvroKVRecordKeyValueStore<K,V> build()
            +
            +
            Build a new AvroKVRecordKeyValueStore instance. +

            +

            +
            Type Parameters:
            K - the key type used to look up each record.
            V - the value type returned by each record. +
            Returns:
            the initialized KeyValueStore.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroKVRecordKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroKVRecordKeyValueStore.html new file mode 100644 index 00000000..ffd05f99 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroKVRecordKeyValueStore.html @@ -0,0 +1,398 @@ + + + + + + + +AvroKVRecordKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class AvroKVRecordKeyValueStore<K,V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore<K,V>
+
            +
            +
            Type Parameters:
            K - The type of the key field.
            V - The type of the value field.
            +
            +
            All Implemented Interfaces:
            KeyValueStore<K,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class AvroKVRecordKeyValueStore<K,V>
            extends Object
            implements KeyValueStore<K,V>
            + + +

            +An interface for providing read access to Avro container files of (key, value) + records. + +

            This KeyValueStore provides lookup access to an Avro container file by reading + the entire file into memory. The Avro file is assumed to contain records with (at + least) two fields, named "key" and "value." This store will decompose the top-level + record into its two fields, and index the "value" field by the key.

            + +

            A kvstores XML file may contain the following properties when specifying the + behavior of this class:

            +
              +
            • dcache - True if files should be accessed by jobs through the DistributedCache. +
            • paths - A comma-separated list of HDFS paths to files backing this store. +
            • avro.reader.schema - The reader schema to apply to records in the + input file(s).
              • +
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classAvroKVRecordKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new AvroKVRecordKeyValueStore + instances.
            +  + + + + + + + + + + +
            +Constructor Summary
            AvroKVRecordKeyValueStore() + +
            +          Reflection-only constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static AvroKVRecordKeyValueStore.Builderbuilder() + +
            +          Creates a new AvroKVRecordKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore.
            + voidinitFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + KeyValueStoreReader<K,V>open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + voidstoreToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroKVRecordKeyValueStore

            +
            +public AvroKVRecordKeyValueStore()
            +
            +
            Reflection-only constructor. Used only for reflection. You should create and configure + AvroKVRecordKeyValueStore instances by using a builder; + call AvroKVRecordKeyValueStore.builder() to get a new builder instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +builder

            +
            +public static AvroKVRecordKeyValueStore.Builder builder()
            +
            +
            Creates a new AvroKVRecordKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore. +

            +

            +
            +
            +
            + +
            Returns:
            a new Builder instance.
            +
            +
            +
            + +

            +storeToConf

            +
            +public void storeToConf(KeyValueStoreConfiguration conf)
+                 throws IOException
            +
            +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            storeToConf in interface KeyValueStore<K,V>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration to serialize state into. + This will be placed in a unique namespace of the job Configuration, + so it can write any key. +
            Throws: +
            IOException - if there is an error writing state to the configuration.
            +
            +
            +
            + +

            +initFromConf

            +
            +public void initFromConf(KeyValueStoreConfiguration conf)
+                  throws IOException
            +
            +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            initFromConf in interface KeyValueStore<K,V>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration storing state for this KeyValueStore. +
            Throws: +
            IOException - if there is an error reading from the configuration.
            +
            +
            +
            + +

            +open

            +
            +public KeyValueStoreReader<K,V> open()
+                              throws IOException
            +
            +
            Opens a KeyValueStoreReader instance for access by clients to this store. + After calling this method, some implementations may deny subsequent calls to + initFromConf() by throwing InvalidStateException. +

            +

            +
            Specified by:
            open in interface KeyValueStore<K,V>
            +
            +
            + +
            Returns:
            the KeyValueStoreReader associated with this KeyValueStore. +
            Throws: +
            IOException - if there is an error opening the underlying storage resource.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroRecordKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroRecordKeyValueStore.Builder.html new file mode 100644 index 00000000..f9103c33 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroRecordKeyValueStore.Builder.html @@ -0,0 +1,379 @@ + + + + + + + +AvroRecordKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class AvroRecordKeyValueStore.Builder

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore.Builder
+
            +
            +
            Enclosing class:
            AvroRecordKeyValueStore<K,V extends org.apache.avro.generic.IndexedRecord>
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class AvroRecordKeyValueStore.Builder
            extends Object
            + + +

            +A Builder-pattern class that configures and creates new AvroRecordKeyValueStore + instances. You should use this to specify the input to this KeyValueStore. + Call the build() method to return a new, configured AvroRecordKeyValueStore instance. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<K,V extends org.apache.avro.generic.IndexedRecord> +
            +AvroRecordKeyValueStore<K,V>
            +            		build() + +
            +          Build a new AvroRecordKeyValueStore instance.
            + AvroRecordKeyValueStore.BuilderwithConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Hadoop configuration instance to use.
            + AvroRecordKeyValueStore.BuilderwithDistributedCache(boolean enabled) + +
            +          Sets a flag indicating the use of the DistributedCache to distribute + input files.
            + AvroRecordKeyValueStore.BuilderwithInputPath(org.apache.hadoop.fs.Path path) + +
            +          Adds a path to the list of files to load.
            + AvroRecordKeyValueStore.BuilderwithInputPaths(List<org.apache.hadoop.fs.Path> paths) + +
            +          Replaces the current list of files to load with the set of files + specified as an argument.
            + AvroRecordKeyValueStore.BuilderwithKeyFieldName(String keyFieldName) + +
            +          Sets the name of the record field to use as the lookup key.
            + AvroRecordKeyValueStore.BuilderwithReaderSchema(org.apache.avro.Schema schema) + +
            +          Sets the schema to read the records with.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +withReaderSchema

            +
            +public AvroRecordKeyValueStore.Builder withReaderSchema(org.apache.avro.Schema schema)
            +
            +
            Sets the schema to read the records with. + This may be null; the schema used when writing the input files will be used directly. +

            +

            +
            Parameters:
            schema - The reader schema. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withKeyFieldName

            +
            +public AvroRecordKeyValueStore.Builder withKeyFieldName(String keyFieldName)
            +
            +
            Sets the name of the record field to use as the lookup key. +

            +

            +
            Parameters:
            keyFieldName - The name of the key field. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withConfiguration

            +
            +public AvroRecordKeyValueStore.Builder withConfiguration(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Sets the Hadoop configuration instance to use. +

            +

            +
            Parameters:
            conf - The configuration. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withInputPath

            +
            +public AvroRecordKeyValueStore.Builder withInputPath(org.apache.hadoop.fs.Path path)
            +
            +
            Adds a path to the list of files to load. +

            +

            +
            Parameters:
            path - The input file/directory path. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withInputPaths

            +
            +public AvroRecordKeyValueStore.Builder withInputPaths(List<org.apache.hadoop.fs.Path> paths)
            +
            +
            Replaces the current list of files to load with the set of files + specified as an argument. +

            +

            +
            Parameters:
            paths - The input file/directory paths. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withDistributedCache

            +
            +public AvroRecordKeyValueStore.Builder withDistributedCache(boolean enabled)
            +
            +
            Sets a flag indicating the use of the DistributedCache to distribute + input files. +

            +

            +
            Parameters:
            enabled - true if the DistributedCache should be used, false otherwise. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +build

            +
            +public <K,V extends org.apache.avro.generic.IndexedRecord> AvroRecordKeyValueStore<K,V> build()
            +
            +
            Build a new AvroRecordKeyValueStore instance. +

            +

            +
            Type Parameters:
            K - The type of the key field.
            V - The type of record in the Avro container file. +
            Returns:
            the initialized KeyValueStore.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroRecordKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroRecordKeyValueStore.html new file mode 100644 index 00000000..226b629e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/AvroRecordKeyValueStore.html @@ -0,0 +1,400 @@ + + + + + + + +AvroRecordKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class AvroRecordKeyValueStore<K,V extends org.apache.avro.generic.IndexedRecord>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore<K,V>
+
            +
            +
            Type Parameters:
            K - The type of the key field.
            V - The type of record in the Avro container file.
            +
            +
            All Implemented Interfaces:
            KeyValueStore<K,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class AvroRecordKeyValueStore<K,V extends org.apache.avro.generic.IndexedRecord>
            extends Object
            implements KeyValueStore<K,V>
            + + +

            +An interface for providing read access to Avro container files of records. + +

            This KeyValueStore provides lookup access to an Avro container file by reading the + entire file into memory and indexing the records by the key field. The key + field must be specified when constructing the store. The value returned from a + lookup of key K will be the first record whose key field has the value + K.

            + +

            A kvstores XML file may contain the following properties when specifying the behavior of this + class:

            +
              +
            • avro.reader.schema - The reader schema to apply to records in the + input file(s).
              • +
            • dcache - True if files should be accessed by jobs through the DistributedCache. +
            • key.field - The name of the field of the input records to treat as + the key in the KeyValueStore.
              • +
            • paths - A comma-separated list of HDFS paths to files backing this store. +
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classAvroRecordKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new AvroRecordKeyValueStore + instances.
            +  + + + + + + + + + + +
            +Constructor Summary
            AvroRecordKeyValueStore() + +
            +          Reflection-only constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static AvroRecordKeyValueStore.Builderbuilder() + +
            +          Creates a new AvroRecordKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore.
            + voidinitFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + KeyValueStoreReader<K,V>open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + voidstoreToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroRecordKeyValueStore

            +
            +public AvroRecordKeyValueStore()
            +
            +
            Reflection-only constructor. Used only for reflection. You should create and configure + AvroRecordKeyValueStore instances by using a builder; call AvroRecordKeyValueStore.builder() + to get a new builder instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +builder

            +
            +public static AvroRecordKeyValueStore.Builder builder()
            +
            +
            Creates a new AvroRecordKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore. +

            +

            +
            +
            +
            + +
            Returns:
            a new Builder instance.
            +
            +
            +
            + +

            +storeToConf

            +
            +public void storeToConf(KeyValueStoreConfiguration conf)
+                 throws IOException
            +
            +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            storeToConf in interface KeyValueStore<K,V extends org.apache.avro.generic.IndexedRecord>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration to serialize state into. + This will be placed in a unique namespace of the job Configuration, + so it can write any key. +
            Throws: +
            IOException - if there is an error writing state to the configuration.
            +
            +
            +
            + +

            +initFromConf

            +
            +public void initFromConf(KeyValueStoreConfiguration conf)
+                  throws IOException
            +
            +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            initFromConf in interface KeyValueStore<K,V extends org.apache.avro.generic.IndexedRecord>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration storing state for this KeyValueStore. +
            Throws: +
            IOException - if there is an error reading from the configuration.
            +
            +
            +
            + +

            +open

            +
            +public KeyValueStoreReader<K,V> open()
+                                                                            throws IOException
            +
            +
            Opens a KeyValueStoreReader instance for access by clients to this store. + After calling this method, some implementations may deny subsequent calls to + initFromConf() by throwing InvalidStateException. +

            +

            +
            Specified by:
            open in interface KeyValueStore<K,V extends org.apache.avro.generic.IndexedRecord>
            +
            +
            + +
            Returns:
            the KeyValueStoreReader associated with this KeyValueStore. +
            Throws: +
            IOException - if there is an error opening the underlying storage resource.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/EmptyKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/EmptyKeyValueStore.Builder.html new file mode 100644 index 00000000..0f1a243a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/EmptyKeyValueStore.Builder.html @@ -0,0 +1,235 @@ + + + + + + + +EmptyKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class EmptyKeyValueStore.Builder<K,V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore.Builder<K,V>
+
            +
            +
            Type Parameters:
            K - The type of the key field for the store.
            V - The type of value field for the store.
            +
            +
            Enclosing class:
            EmptyKeyValueStore<K,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class EmptyKeyValueStore.Builder<K,V>
            extends Object
            + + +

            +A Builder-pattern class that configures and creates new EmptyKeyValueStore + instances. You should use this to specify the input to this KeyValueStore. + Call the build() method to return a new EmptyKeyValueStore instance. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + EmptyKeyValueStore<K,V>build() + +
            +          Build a new EmptyKeyValueStore instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +build

            +
            +public EmptyKeyValueStore<K,V> build()
            +
            +
            Build a new EmptyKeyValueStore instance. +

            +

            + +
            Returns:
            the initialized KeyValueStore.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/EmptyKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/EmptyKeyValueStore.html new file mode 100644 index 00000000..332cdeba --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/EmptyKeyValueStore.html @@ -0,0 +1,463 @@ + + + + + + + +EmptyKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class EmptyKeyValueStore<K,V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore<K,V>
+
            +
            +
            Type Parameters:
            K - the key type for the store.
            V - the value type for the store.
            +
            +
            All Implemented Interfaces:
            KeyValueStore<K,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class EmptyKeyValueStore<K,V>
            extends Object
            implements KeyValueStore<K,V>
            + + +

            +A KeyValueStore that contains no data. Perhaps useful for testing. + Get an instance by calling EmptyKeyValueStore.builder().build() + or get a singleton instance by calling EmptyKeyValueStore.get(); +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classEmptyKeyValueStore.Builder<K,V> + +
            +          A Builder-pattern class that configures and creates new EmptyKeyValueStore + instances.
            +  + + + + + + + + + + +
            +Constructor Summary
            EmptyKeyValueStore() + +
            +          Reflection-only constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<KT,VT> EmptyKeyValueStore.Builder<KT,VT>
            +            		builder() + +
            +          Creates a new EmptyKeyValueStore.Builder instance that can be used + to create a new KeyValueStore.
            + booleanequals(Object otherObj) + +
            +          
            +static + + + + +
            +<KT,VT> EmptyKeyValueStore<KT,VT>
            +            		get() + +
            +          Returns a singleton EmptyKeyValueStore instance.
            + inthashCode() + +
            +          
            + voidinitFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + KeyValueStoreReader<K,V>open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + voidstoreToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EmptyKeyValueStore

            +
            +public EmptyKeyValueStore()
            +
            +
            Reflection-only constructor. Used only for reflection. You should create + EmptyKeyValueStore instances by using a builder or factory method. + Call EmptyKeyValueStore.get() to get a singleton instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +builder

            +
            +public static <KT,VT> EmptyKeyValueStore.Builder<KT,VT> builder()
            +
            +
            Creates a new EmptyKeyValueStore.Builder instance that can be used + to create a new KeyValueStore. +

            +

            +
            +
            +
            +
            Type Parameters:
            KT - The type of the key field.
            VT - The type of the value field. +
            Returns:
            a new Builder instance.
            +
            +
            +
            + +

            +get

            +
            +public static <KT,VT> EmptyKeyValueStore<KT,VT> get()
            +
            +
            Returns a singleton EmptyKeyValueStore instance. +

            +

            +
            +
            +
            +
            Type Parameters:
            KT - The type of the key field.
            VT - The type of the value field. +
            Returns:
            a singleton EmptyKeyValueStore instance.
            +
            +
            +
            + +

            +storeToConf

            +
            +public void storeToConf(KeyValueStoreConfiguration conf)
            +
            +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            storeToConf in interface KeyValueStore<K,V>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration to serialize state into. + This will be placed in a unique namespace of the job Configuration, + so it can write any key.
            +
            +
            +
            + +

            +initFromConf

            +
            +public void initFromConf(KeyValueStoreConfiguration conf)
            +
            +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            initFromConf in interface KeyValueStore<K,V>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration storing state for this KeyValueStore.
            +
            +
            +
            + +

            +open

            +
            +public KeyValueStoreReader<K,V> open()
            +
            +
            Opens a KeyValueStoreReader instance for access by clients to this store. + After calling this method, some implementations may deny subsequent calls to + initFromConf() by throwing InvalidStateException. +

            +

            +
            Specified by:
            open in interface KeyValueStore<K,V>
            +
            +
            + +
            Returns:
            the KeyValueStoreReader associated with this KeyValueStore.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object otherObj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/FileStoreHelper.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/FileStoreHelper.Builder.html new file mode 100644 index 00000000..e3cd7040 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/FileStoreHelper.Builder.html @@ -0,0 +1,328 @@ + + + + + + + +FileStoreHelper.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class FileStoreHelper.Builder

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.FileStoreHelper.Builder
+
            +
            +
            Enclosing class:
            FileStoreHelper
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class FileStoreHelper.Builder
            extends Object
            + + +

            +A class that builds configured FileStoreHelper instances. + +

            This object is not exposed to users directly. It is used via composition + in other (FooFile)KeyValueStore.Builder instances. If you add a method here, + you should reflect this via composition in the other file-backed store builder + APIs.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + FileStoreHelperbuild() + +
            +          Builds and returns a new FileStoreHelper instance.
            + FileStoreHelper.BuilderwithConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Hadoop configuration instance to use.
            + FileStoreHelper.BuilderwithDistributedCache(boolean enabled) + +
            +          Sets a flag indicating the use of the DistributedCache to distribute + input files.
            + FileStoreHelper.BuilderwithInputPath(org.apache.hadoop.fs.Path path) + +
            +          Adds a path to the list of files to load.
            + FileStoreHelper.BuilderwithInputPaths(List<org.apache.hadoop.fs.Path> paths) + +
            +          Replaces the current list of files to load with the set of files + specified as an argument.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +withConfiguration

            +
            +public FileStoreHelper.Builder withConfiguration(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Sets the Hadoop configuration instance to use. +

            +

            +
            Parameters:
            conf - The configuration. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withInputPath

            +
            +public FileStoreHelper.Builder withInputPath(org.apache.hadoop.fs.Path path)
            +
            +
            Adds a path to the list of files to load. +

            +

            +
            Parameters:
            path - The input file/directory path. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withInputPaths

            +
            +public FileStoreHelper.Builder withInputPaths(List<org.apache.hadoop.fs.Path> paths)
            +
            +
            Replaces the current list of files to load with the set of files + specified as an argument. +

            +

            +
            Parameters:
            paths - The input file/directory paths. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withDistributedCache

            +
            +public FileStoreHelper.Builder withDistributedCache(boolean enabled)
            +
            +
            Sets a flag indicating the use of the DistributedCache to distribute + input files. +

            +

            +
            Parameters:
            enabled - true if the DistributedCache should be used, false otherwise. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +build

            +
            +public FileStoreHelper build()
            +
            +
            Builds and returns a new FileStoreHelper instance. +

            +

            + +
            Returns:
            a new, configured FileStoreHelper.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/FileStoreHelper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/FileStoreHelper.html new file mode 100644 index 00000000..0dbbe730 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/FileStoreHelper.html @@ -0,0 +1,551 @@ + + + + + + + +FileStoreHelper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class FileStoreHelper

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.FileStoreHelper
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class FileStoreHelper
            extends Object
            implements org.apache.hadoop.conf.Configurable
            + + +

            +Helper class that manages filenames and distributed cache functionality + for KeyValueStore implementations that work with files or collections + of files. + +

            Your KeyValueStore can use a FileStoreHelper to manage all aspects of + configuration of and deserialization regarding file names in a MapReduce + job.

            + +

            Create a FileStoreHelper.Builder object using the builder() method; + your own KeyValueStore's Builder should use composition to delegate + responsibility for Configuration, file, and distributed cache control + to this one. You should use this object's storeToConf() and initFromConf() + methods within your own KeyValueStore's storeToConf() and initFromConf() + methods.

            + +

            When reading files, use getExpandedInputPaths() to get a complete list + of files to read. If the user has enabled the distributed cache, you will + receive a set of local files to read. Otherwise, the initial HDFS paths + will be used.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classFileStoreHelper.Builder + +
            +          A class that builds configured FileStoreHelper instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_DCACHE_PREFIX_KEY + +
            +          Configuration key for the KeyValueStore definition that sets whether input files are + stored in the DistributedCache.
            +static StringCONF_PATHS_KEY + +
            +          Suffix for the KeyValueStore definition that is set to the list of + input paths.
            +static StringCONF_USE_DCACHE_KEY + +
            +          Boolean flag used in XML Configuration files only to state that the files + specified are + HDFS files, but should be loaded into the DistributedCache as part + of the job.
            +static booleanUSE_DCACHE_DEFAULT + +
            +          By default, it is assumed that the user wants to load this KeyValueStore + through the DistributedCache.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static FileStoreHelper.Builderbuilder() + +
            +           
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +          
            + List<org.apache.hadoop.fs.Path>getExpandedInputPaths() + +
            +          Returns the set of input path(s) that should be actually opened for read.
            + List<org.apache.hadoop.fs.Path>getInputPaths() + +
            +          Returns the set of raw input path(s) that were specified for read.
            + voidinitFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes file- and DistributedCache-specific properties associated + with the KeyValueStore that owns this FileStoreHelper from the specified configuration.
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            + voidstoreToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes file- and DistributedCache-specific properties associated + with the KeyValueStore that owns this FileStoreHelper to the specified configuration.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +CONF_DCACHE_PREFIX_KEY

            +
            +public static final String CONF_DCACHE_PREFIX_KEY
            +
            +
            Configuration key for the KeyValueStore definition that sets whether input files are + stored in the DistributedCache. If empty, then DCache is disabled. If non-empty, + then DCache target file names are expected to be prefixed by the string in this + configuration key. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_USE_DCACHE_KEY

            +
            +public static final String CONF_USE_DCACHE_KEY
            +
            +
            Boolean flag used in XML Configuration files only to state that the files + specified are + HDFS files, but should be loaded into the DistributedCache as part + of the job. This flag is not recorded as part of addToConfiguration(). +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +USE_DCACHE_DEFAULT

            +
            +public static final boolean USE_DCACHE_DEFAULT
            +
            +
            By default, it is assumed that the user wants to load this KeyValueStore + through the DistributedCache. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_PATHS_KEY

            +
            +public static final String CONF_PATHS_KEY
            +
            +
            Suffix for the KeyValueStore definition that is set to the list of + input paths. This may be multiple comma-delimited paths. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +builder

            +
            +public static FileStoreHelper.Builder builder()
            +
            +
            +
            +
            +
            + +
            Returns:
            a new FileStoreHelper.Builder instance.
            +
            +
            +
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getInputPaths

            +
            +public List<org.apache.hadoop.fs.Path> getInputPaths()
            +
            +
            Returns the set of raw input path(s) that were specified for read. This may + include wildcards or directories. You should use getExpandedInputPaths() + to determine the set of files to actually read. +

            +

            +
            +
            +
            + +
            Returns:
            a copy of the set of raw input paths specified for read.
            +
            +
            +
            + +

            +getExpandedInputPaths

            +
            +public List<org.apache.hadoop.fs.Path> getExpandedInputPaths()
+                                                      throws IOException
            +
            +
            Returns the set of input path(s) that should be actually opened for read. + This set of paths may be on local disk (e.g., if the DistributedCache was used + to transmit the files), or in HDFS. This will not contain directory names nor + globs; it is expanded to the literal set of files to open. + +

            Each Path object returned is fully qualified, and represents an absolute + path that should be opened by its associated FileSystem object.

            +

            +

            +
            +
            +
            + +
            Returns:
            an unmodifiable list of input paths, backed by the underlying collection + within this KeyValueStore. +
            Throws: +
            IOException - if there is an error communicating with the underlying + FileSystem while expanding paths and globs.
            +
            +
            +
            + +

            +storeToConf

            +
            +public void storeToConf(KeyValueStoreConfiguration conf)
+                 throws IOException
            +
            +
            Serializes file- and DistributedCache-specific properties associated + with the KeyValueStore that owns this FileStoreHelper to the specified configuration. +

            +

            +
            +
            +
            +
            Parameters:
            conf - the configuration to populate. +
            Throws: +
            IOException - if there's an error serializing the state.
            +
            +
            +
            + +

            +initFromConf

            +
            +public void initFromConf(KeyValueStoreConfiguration conf)
+                  throws IOException
            +
            +
            Deserializes file- and DistributedCache-specific properties associated + with the KeyValueStore that owns this FileStoreHelper from the specified configuration. + +

            This retains a reference to the KeyValueStoreConfiguration's backing Configuration + instance to use when opening files specified by this configuration.

            +

            +

            +
            +
            +
            +
            Parameters:
            conf - the configuration to read. +
            Throws: +
            IOException - if there's an error deserializing the configuration.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/KijiTableKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/KijiTableKeyValueStore.Builder.html new file mode 100644 index 00000000..947cb079 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/KijiTableKeyValueStore.Builder.html @@ -0,0 +1,421 @@ + + + + + + + +KijiTableKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class KijiTableKeyValueStore.Builder

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder
+
            +
            +
            Enclosing class:
            KijiTableKeyValueStore<V>
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiTableKeyValueStore.Builder
            extends Object
            + + +

            +A Builder-pattern class that configures and creates new KijiTableKeyValueStore + instances. You should use this to specify the input to this KeyValueStore. + Call the build() method to return a new KijiTableKeyValueStore instance. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<V> KijiTableKeyValueStore<V>
            +            		build() + +
            +          Build a new KijiTableKeyValueStore instance.
            + KijiTableKeyValueStore.BuilderwithCacheLimit(int numValues) + +
            +          Sets the maximum number of lookups to cache in memory.
            + KijiTableKeyValueStore.BuilderwithColumn(org.kiji.schema.KijiColumnName colName) + +
            +          Sets the column to retrieve values from.
            + KijiTableKeyValueStore.BuilderwithColumn(String family, + String qualifier) + +
            +          Sets the column to retrieve values from.
            + KijiTableKeyValueStore.BuilderwithConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Configuration to use to connect to Kiji.
            + KijiTableKeyValueStore.BuilderwithMaxTimestamp(long timestamp) + +
            +          Sets the newest timestamp to retrieve values from in the column.
            + KijiTableKeyValueStore.BuilderwithMinTimestamp(long timestamp) + +
            +          Sets the oldest timestamp to retrieve values from in the column.
            + KijiTableKeyValueStore.BuilderwithReaderSchema(org.apache.avro.Schema schema) + +
            +          Sets the reader schema to use when deserializing values from the value column.
            + KijiTableKeyValueStore.BuilderwithTable(org.kiji.schema.KijiURI tableUri) + +
            +          Sets the table to use as the backing store.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +withConfiguration

            +
            +public KijiTableKeyValueStore.Builder withConfiguration(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Sets the Configuration to use to connect to Kiji. +

            +

            +
            Parameters:
            conf - the Configuration to use. +
            Returns:
            this builder instance.
            +
            +
            +
            + +

            +withTable

            +
            +public KijiTableKeyValueStore.Builder withTable(org.kiji.schema.KijiURI tableUri)
            +
            +
            Sets the table to use as the backing store. +

            +

            +
            Parameters:
            tableUri - the Kiji table URI to use. +
            Returns:
            this builder instance.
            +
            +
            +
            + +

            +withColumn

            +
            +public KijiTableKeyValueStore.Builder withColumn(org.kiji.schema.KijiColumnName colName)
            +
            +
            Sets the column to retrieve values from. +

            +

            +
            Parameters:
            colName - the column to use. +
            Returns:
            this builder instance.
            +
            +
            +
            + +

            +withColumn

            +
            +public KijiTableKeyValueStore.Builder withColumn(String family,
+                                                 String qualifier)
            +
            +
            Sets the column to retrieve values from. +

            +

            +
            Parameters:
            family - the column family to use.
            qualifier - the column qualifier to use. +
            Returns:
            this builder instance.
            +
            +
            +
            + +

            +withMinTimestamp

            +
            +public KijiTableKeyValueStore.Builder withMinTimestamp(long timestamp)
            +
            +
            Sets the oldest timestamp to retrieve values from in the column. +

            +

            +
            Parameters:
            timestamp - the oldest timestamp to consider. +
            Returns:
            this builder instance.
            +
            +
            +
            + +

            +withMaxTimestamp

            +
            +public KijiTableKeyValueStore.Builder withMaxTimestamp(long timestamp)
            +
            +
            Sets the newest timestamp to retrieve values from in the column. +

            +

            +
            Parameters:
            timestamp - the newest timestamp to consider. +
            Returns:
            this builder instance.
            +
            +
            +
            + +

            +withCacheLimit

            +
            +public KijiTableKeyValueStore.Builder withCacheLimit(int numValues)
            +
            +
            Sets the maximum number of lookups to cache in memory. + +

            Defaults to 100.

            +

            +

            +
            Parameters:
            numValues - the maximum number of values to keep in the cache. +
            Returns:
            this builder instance.
            +
            +
            +
            + +

            +withReaderSchema

            +
            +public KijiTableKeyValueStore.Builder withReaderSchema(org.apache.avro.Schema schema)
            +
            +
            Sets the reader schema to use when deserializing values from the value column. + If set to null, will use the common reader schema associated with the column. +

            +

            +
            Parameters:
            schema - the reader schema to use. +
            Returns:
            this builder instance.
            +
            +
            +
            + +

            +build

            +
            +public <V> KijiTableKeyValueStore<V> build()
            +
            +
            Build a new KijiTableKeyValueStore instance. +

            +

            +
            Type Parameters:
            V - The value type for the KeyValueStore. +
            Returns:
            the initialized KeyValueStore.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/KijiTableKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/KijiTableKeyValueStore.html new file mode 100644 index 00000000..b3f2c691 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/KijiTableKeyValueStore.html @@ -0,0 +1,505 @@ + + + + + + + +KijiTableKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class KijiTableKeyValueStore<V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore<V>
+
            +
            +
            Type Parameters:
            V - the value type returned by this key-value store.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, KeyValueStore<String,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableKeyValueStore<V>
            extends Object
            implements org.apache.hadoop.conf.Configurable, KeyValueStore<String,V>
            + + +

            +KeyValueStore lookup implementation based on a Kiji table. + +

            Allows you to use a single fully-qualified column of a Kiji table as a + key-value store (using the EntityId associated with each row as the key).

            + +

            This operates over the most recent timestamped value (within the optionally-configured + timestamp range associated with the Store).

            + +

            This implementation assumes that the column is immutable while being used in this + fashion. It may cache values to improve repeated read performance. You can set the + cache size with KijiTableKeyValueStore.Builder.withCacheLimit(int).

            + +

            When configuring a KijiTableKeyValueStore from a kvstores XML file, the following + properties may be used to specify the behavior of this class:

            +
              +
            • table.uri - The Kiji URI for the table backing this store.
              • +
            • column - The family and qualifier of the column representing the values + in this store. e.g., info:name
              • +
            • min.ts - A long value representing the minimum timestamp to + include in the results for this KeyValueStore.
              • +
            • max.ts - A long value representing the maximum timestamp to + include in the results for this KeyValueStore.
              • +
            • cache.size - An int value representing the number of results + to cache locally. (Default is 100; set to 0 to disable caching.)
              • +
            • avro.reader.schema - The common Avro reader schema used to + deserialize values from + the value column to return them to the client.
              • +
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTableKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new KijiTableKeyValueStore + instances.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableKeyValueStore() + +
            +          Reflection-only constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiTableKeyValueStore.Builderbuilder() + +
            +          Creates a new KijiTableKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore.
            + booleanequals(Object otherObj) + +
            +          
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +           
            + inthashCode() + +
            +          
            + voidinitFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + KeyValueStoreReader<String,V>open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          Set the configuration object to refer to.
            + voidstoreToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableKeyValueStore

            +
            +public KijiTableKeyValueStore()
            +
            +
            Reflection-only constructor. Used only for reflection. You should create and configure + KijiTableKeyValueStore instances by using a builder; + call KijiTableKeyValueStore.builder() to get a new builder instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +builder

            +
            +public static KijiTableKeyValueStore.Builder builder()
            +
            +
            Creates a new KijiTableKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore. +

            +

            +
            +
            +
            + +
            Returns:
            a new Builder instance.
            +
            +
            +
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Set the configuration object to refer to. +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            Parameters:
            conf - the Configuration object to use.
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            + +
            Returns:
            a copy of the Configuration object we are using.
            +
            +
            +
            + +

            +storeToConf

            +
            +public void storeToConf(KeyValueStoreConfiguration conf)
+                 throws IOException
            +
            +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            storeToConf in interface KeyValueStore<String,V>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration to serialize state into. + This will be placed in a unique namespace of the job Configuration, + so it can write any key. +
            Throws: +
            IOException - if there is an error writing state to the configuration.
            +
            +
            +
            + +

            +initFromConf

            +
            +public void initFromConf(KeyValueStoreConfiguration conf)
+                  throws IOException
            +
            +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            initFromConf in interface KeyValueStore<String,V>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration storing state for this KeyValueStore. +
            Throws: +
            IOException - if there is an error reading from the configuration.
            +
            +
            +
            + +

            +open

            +
            +public KeyValueStoreReader<String,V> open()
+                                   throws IOException
            +
            +
            Opens a KeyValueStoreReader instance for access by clients to this store. + After calling this method, some implementations may deny subsequent calls to + initFromConf() by throwing InvalidStateException. +

            +

            +
            Specified by:
            open in interface KeyValueStore<String,V>
            +
            +
            + +
            Returns:
            the KeyValueStoreReader associated with this KeyValueStore. +
            Throws: +
            IOException - if there is an error opening the underlying storage resource.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object otherObj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/SeqFileKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/SeqFileKeyValueStore.Builder.html new file mode 100644 index 00000000..a6fcfe71 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/SeqFileKeyValueStore.Builder.html @@ -0,0 +1,332 @@ + + + + + + + +SeqFileKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class SeqFileKeyValueStore.Builder

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore.Builder
+
            +
            +
            Enclosing class:
            SeqFileKeyValueStore<K,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class SeqFileKeyValueStore.Builder
            extends Object
            + + +

            +A Builder-pattern class that configures and creates new SeqFileKeyValueStore + instances. You should use this to specify the input to this KeyValueStore. + Call the build() method to return a new, configured SeqFileKeyValueStore instance. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<K,V> SeqFileKeyValueStore<K,V>
            +            		build() + +
            +          Build a new SeqFileKeyValueStore instance.
            + SeqFileKeyValueStore.BuilderwithConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Hadoop configuration instance to use.
            + SeqFileKeyValueStore.BuilderwithDistributedCache(boolean enabled) + +
            +          Sets a flag indicating the use of the DistributedCache to distribute + input files.
            + SeqFileKeyValueStore.BuilderwithInputPath(org.apache.hadoop.fs.Path path) + +
            +          Adds a path to the list of files to load.
            + SeqFileKeyValueStore.BuilderwithInputPaths(List<org.apache.hadoop.fs.Path> paths) + +
            +          Replaces the current list of files to load with the set of files + specified as an argument.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +withConfiguration

            +
            +public SeqFileKeyValueStore.Builder withConfiguration(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Sets the Hadoop configuration instance to use. +

            +

            +
            Parameters:
            conf - The configuration. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withInputPath

            +
            +public SeqFileKeyValueStore.Builder withInputPath(org.apache.hadoop.fs.Path path)
            +
            +
            Adds a path to the list of files to load. +

            +

            +
            Parameters:
            path - The input file/directory path. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withInputPaths

            +
            +public SeqFileKeyValueStore.Builder withInputPaths(List<org.apache.hadoop.fs.Path> paths)
            +
            +
            Replaces the current list of files to load with the set of files + specified as an argument. +

            +

            +
            Parameters:
            paths - The input file/directory paths. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withDistributedCache

            +
            +public SeqFileKeyValueStore.Builder withDistributedCache(boolean enabled)
            +
            +
            Sets a flag indicating the use of the DistributedCache to distribute + input files. +

            +

            +
            Parameters:
            enabled - true if the DistributedCache should be used, false otherwise. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +build

            +
            +public <K,V> SeqFileKeyValueStore<K,V> build()
            +
            +
            Build a new SeqFileKeyValueStore instance. +

            +

            +
            Type Parameters:
            K - The type of the key field stored in the SequenceFile(s).
            V - The type of value field stored in the SequenceFile(s). +
            Returns:
            the initialized KeyValueStore.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/SeqFileKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/SeqFileKeyValueStore.html new file mode 100644 index 00000000..558a65a4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/SeqFileKeyValueStore.html @@ -0,0 +1,413 @@ + + + + + + + +SeqFileKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class SeqFileKeyValueStore<K,V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore<K,V>
+
            +
            +
            Type Parameters:
            K - The type of the key field stored in the SequenceFile(s).
            V - The type of value field stored in the SequenceFile(s).
            +
            +
            All Implemented Interfaces:
            KeyValueStore<K,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class SeqFileKeyValueStore<K,V>
            extends Object
            implements KeyValueStore<K,V>
            + + +

            +KeyValueStore implementation that reads records from SequenceFiles. + +

            When specifying a SeqFileKeyValueStore in a kvstores XML file, you may + specify the following properties:

            +
              +
            • dcache - True if files should be accessed by jobs through the DistributedCache. +
            • paths - A comma-separated list of HDFS paths to files backing this store. +
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classSeqFileKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new SeqFileKeyValueStore + instances.
            +  + + + + + + + + + + +
            +Constructor Summary
            SeqFileKeyValueStore() + +
            +          Reflection-only constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static SeqFileKeyValueStore.Builderbuilder() + +
            +          Creates a new SeqFileKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore.
            + List<org.apache.hadoop.fs.Path>getInputPaths() + +
            +           
            + voidinitFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + KeyValueStoreReader<K,V>open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + voidstoreToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +SeqFileKeyValueStore

            +
            +public SeqFileKeyValueStore()
            +
            +
            Reflection-only constructor. Used only for reflection. You should create and configure + new SeqFileKeyValueStore instances by using a builder; + call SeqFileKeyValueStore.builder() to get a new builder instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +builder

            +
            +public static SeqFileKeyValueStore.Builder builder()
            +
            +
            Creates a new SeqFileKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore. +

            +

            +
            +
            +
            + +
            Returns:
            a new Builder instance.
            +
            +
            +
            + +

            +storeToConf

            +
            +public void storeToConf(KeyValueStoreConfiguration conf)
+                 throws IOException
            +
            +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            storeToConf in interface KeyValueStore<K,V>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration to serialize state into. + This will be placed in a unique namespace of the job Configuration, + so it can write any key. +
            Throws: +
            IOException - if there is an error writing state to the configuration.
            +
            +
            +
            + +

            +initFromConf

            +
            +public void initFromConf(KeyValueStoreConfiguration conf)
+                  throws IOException
            +
            +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            initFromConf in interface KeyValueStore<K,V>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration storing state for this KeyValueStore. +
            Throws: +
            IOException - if there is an error reading from the configuration.
            +
            +
            +
            + +

            +getInputPaths

            +
            +public List<org.apache.hadoop.fs.Path> getInputPaths()
            +
            +
            +
            +
            +
            + +
            Returns:
            the raw input paths specified as input by the user.
            +
            +
            +
            + +

            +open

            +
            +public KeyValueStoreReader<K,V> open()
+                              throws IOException
            +
            +
            Opens a KeyValueStoreReader instance for access by clients to this store. + After calling this method, some implementations may deny subsequent calls to + initFromConf() by throwing InvalidStateException. +

            +

            +
            Specified by:
            open in interface KeyValueStore<K,V>
            +
            +
            + +
            Returns:
            the KeyValueStoreReader associated with this KeyValueStore. +
            Throws: +
            IOException - if there is an error opening the underlying storage resource.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/TextFileKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/TextFileKeyValueStore.Builder.html new file mode 100644 index 00000000..93540d4a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/TextFileKeyValueStore.Builder.html @@ -0,0 +1,347 @@ + + + + + + + +TextFileKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class TextFileKeyValueStore.Builder

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore.Builder
+
            +
            +
            Enclosing class:
            TextFileKeyValueStore
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class TextFileKeyValueStore.Builder
            extends Object
            + + +

            +A Builder-pattern class that configures and creates new TextFileKeyValueStore + instances. You should use this to specify the input to this KeyValueStore. + Call the build() method to return a new, configured TextFileKeyValueStore instance. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TextFileKeyValueStorebuild() + +
            +          Build a new TextFileKeyValueStore instance.
            + TextFileKeyValueStore.BuilderwithConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Hadoop configuration instance to use.
            + TextFileKeyValueStore.BuilderwithDelimiter(String delim) + +
            +          Specifies the delimiter between the key and the value on a line in the file.
            + TextFileKeyValueStore.BuilderwithDistributedCache(boolean enabled) + +
            +          Sets a flag indicating the use of the DistributedCache to distribute + input files.
            + TextFileKeyValueStore.BuilderwithInputPath(org.apache.hadoop.fs.Path path) + +
            +          Adds a path to the list of files to load.
            + TextFileKeyValueStore.BuilderwithInputPaths(List<org.apache.hadoop.fs.Path> paths) + +
            +          Replaces the current list of files to load with the set of files + specified as an argument.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +withDelimiter

            +
            +public TextFileKeyValueStore.Builder withDelimiter(String delim)
            +
            +
            Specifies the delimiter between the key and the value on a line in the file. +

            +

            +
            Parameters:
            delim - the delimiter string to use. +
            Returns:
            this Builder instance.
            +
            +
            +
            + +

            +withConfiguration

            +
            +public TextFileKeyValueStore.Builder withConfiguration(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Sets the Hadoop configuration instance to use. +

            +

            +
            Parameters:
            conf - The configuration. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withInputPath

            +
            +public TextFileKeyValueStore.Builder withInputPath(org.apache.hadoop.fs.Path path)
            +
            +
            Adds a path to the list of files to load. +

            +

            +
            Parameters:
            path - The input file/directory path. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withInputPaths

            +
            +public TextFileKeyValueStore.Builder withInputPaths(List<org.apache.hadoop.fs.Path> paths)
            +
            +
            Replaces the current list of files to load with the set of files + specified as an argument. +

            +

            +
            Parameters:
            paths - The input file/directory paths. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +withDistributedCache

            +
            +public TextFileKeyValueStore.Builder withDistributedCache(boolean enabled)
            +
            +
            Sets a flag indicating the use of the DistributedCache to distribute + input files. +

            +

            +
            Parameters:
            enabled - true if the DistributedCache should be used, false otherwise. +
            Returns:
            This builder instance.
            +
            +
            +
            + +

            +build

            +
            +public TextFileKeyValueStore build()
            +
            +
            Build a new TextFileKeyValueStore instance. +

            +

            + +
            Returns:
            the initialized KeyValueStore.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/TextFileKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/TextFileKeyValueStore.html new file mode 100644 index 00000000..04782a50 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/TextFileKeyValueStore.html @@ -0,0 +1,462 @@ + + + + + + + +TextFileKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class TextFileKeyValueStore

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore
+
            +
            +
            All Implemented Interfaces:
            KeyValueStore<String,String>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class TextFileKeyValueStore
            extends Object
            implements KeyValueStore<String,String>
            + + +

            +KeyValueStore implementation that reads delimited records from text files. + +

            Each line of an input text file is made available as a record in the KeyValueStore. + Lines are separated into keys and values by the first instance of the delimiter string. + The second (and additional) instances of the delimiter string in the line are part of the + value, and are not treated specially.

            + +

            Input lines are read through BufferedReader.readLine(). A line is considered to be + terminated by any of a line feed ('\n'), carriage return ('\r'), or a carriage return + followed immediately by a linefeed.

            + +

            Line termination characters are removed before data is put in the KeyValueStore.

            + +

            By default, keys and values are tab-delimited. The delimiter may be set by the + setDelimiter() method of the TextFileKeyValueStore.Builder instance. + The delimiter may be multiple characters long. + The following rules are applied when breaking lines into keys and values:

            +
              +
            • Keys and values are separated by the first instance of the delimiter in the line. + Further instances of the delimiter string are retained as part of the value.
              • +
            • A key followed immediately by a line terminator has a null value associated + with it. containsKey() will return true for this key, and + get() will return null.
              • +
            • A key followed by the delimiter and then the line terminator has the empty string + ("") as its value.
              • +
            • A line that begins with a delimiter has the empty string as its key; the remainder + of the line following the delimiter is the value.
              • +
            • null is never allowed or possible as a key.
              • +
            • A blank line uses the above rules as follows: the key is the empty string + (""), and the value is null.
              • +
            • The last line in the file does not need to be newline-terminated; this is treated + like any other line in the file.
              • +
            + +

            A kvstores XML file may contain the following properties when specifying the + behavior of this class:

            +
              +
            • dcache - True if files should be accessed by jobs through the DistributedCache. +
            • delim - The delimiter string that separates keys and values within + a line of text. (Default is a tab character.)
              • +
            • paths - A comma-separated list of HDFS paths to files backing this store. +
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTextFileKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new TextFileKeyValueStore + instances.
            +  + + + + + + + + + + +
            +Field Summary
            +static StringDEFAULT_DELIMITER + +
            +          Records are tab-delimited by default, to be compatible with TextOutputFormat, + and function like KeyValueTextInputFormat.
            +  + + + + + + + + + + +
            +Constructor Summary
            TextFileKeyValueStore() + +
            +          Reflection-only constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static TextFileKeyValueStore.Builderbuilder() + +
            +          Creates a new TextFileKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore.
            + voidinitFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + KeyValueStoreReader<String,String>open() + +
            +          Opens a KeyValueStoreReader instance for access by clients to this store.
            + voidstoreToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +DEFAULT_DELIMITER

            +
            +public static final String DEFAULT_DELIMITER
            +
            +
            Records are tab-delimited by default, to be compatible with TextOutputFormat, + and function like KeyValueTextInputFormat. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +TextFileKeyValueStore

            +
            +public TextFileKeyValueStore()
            +
            +
            Reflection-only constructor. Used only for reflection. You should create and configure + TextFileKeyValueStore instances by using a builder; call TextFileKeyValueStore.builder() + to get a new builder instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +builder

            +
            +public static TextFileKeyValueStore.Builder builder()
            +
            +
            Creates a new TextFileKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore. +

            +

            +
            +
            +
            + +
            Returns:
            a new Builder instance.
            +
            +
            +
            + +

            +storeToConf

            +
            +public void storeToConf(KeyValueStoreConfiguration conf)
+                 throws IOException
            +
            +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            storeToConf in interface KeyValueStore<String,String>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration to serialize state into. + This will be placed in a unique namespace of the job Configuration, + so it can write any key. +
            Throws: +
            IOException - if there is an error writing state to the configuration.
            +
            +
            +
            + +

            +initFromConf

            +
            +public void initFromConf(KeyValueStoreConfiguration conf)
+                  throws IOException
            +
            +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            initFromConf in interface KeyValueStore<String,String>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration storing state for this KeyValueStore. +
            Throws: +
            IOException - if there is an error reading from the configuration.
            +
            +
            +
            + +

            +open

            +
            +public KeyValueStoreReader<String,String> open()
+                                        throws IOException
            +
            +
            Opens a KeyValueStoreReader instance for access by clients to this store. + After calling this method, some implementations may deny subsequent calls to + initFromConf() by throwing InvalidStateException. +

            +

            +
            Specified by:
            open in interface KeyValueStore<String,String>
            +
            +
            + +
            Returns:
            the KeyValueStoreReader associated with this KeyValueStore. +
            Throws: +
            IOException - if there is an error opening the underlying storage resource.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/UnconfiguredKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/UnconfiguredKeyValueStore.Builder.html new file mode 100644 index 00000000..1cffebab --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/UnconfiguredKeyValueStore.Builder.html @@ -0,0 +1,235 @@ + + + + + + + +UnconfiguredKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class UnconfiguredKeyValueStore.Builder<K,V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore.Builder<K,V>
+
            +
            +
            Type Parameters:
            K - The type of the key field for the store.
            V - The type of value field for the store.
            +
            +
            Enclosing class:
            UnconfiguredKeyValueStore<K,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class UnconfiguredKeyValueStore.Builder<K,V>
            extends Object
            + + +

            +A Builder-pattern class that creates new UnconfiguredKeyValueStore + instances. You should use this to specify the input to this KeyValueStore. + Call the build() method to return a new UnconfiguredKeyValueStore instance. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + UnconfiguredKeyValueStore<K,V>build() + +
            +          Build a new UnconfiguredKeyValueStore instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +build

            +
            +public UnconfiguredKeyValueStore<K,V> build()
            +
            +
            Build a new UnconfiguredKeyValueStore instance. +

            +

            + +
            Returns:
            the initialized KeyValueStore.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/UnconfiguredKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/UnconfiguredKeyValueStore.html new file mode 100644 index 00000000..2d4a6fcd --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/UnconfiguredKeyValueStore.html @@ -0,0 +1,434 @@ + + + + + + + +UnconfiguredKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.kvstore.lib +
            +Class UnconfiguredKeyValueStore<K,V>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore<K,V>
+
            +
            +
            Type Parameters:
            K - the key type for the store.
            V - the value type for the store.
            +
            +
            All Implemented Interfaces:
            KeyValueStore<K,V>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class UnconfiguredKeyValueStore<K,V>
            extends Object
            implements KeyValueStore<K,V>
            + + +

            +A KeyValueStore that is not configured. This throws an exception when + calling storeToConf() to ensure that the user replaces this "default" + with a proper KeyValueStore on the command line. + +

            Calls to open() will throw IllegalStateException

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classUnconfiguredKeyValueStore.Builder<K,V> + +
            +          A Builder-pattern class that creates new UnconfiguredKeyValueStore + instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<KT,VT> UnconfiguredKeyValueStore.Builder<KT,VT>
            +            		builder() + +
            +          Creates a new UnconfiguredKeyValueStore.Builder instance that can be used + to create a new KeyValueStore.
            + booleanequals(Object otherObj) + +
            +          
            +static + + + + +
            +<KT,VT> UnconfiguredKeyValueStore<KT,VT>
            +            		get() + +
            +          Returns a singleton UnconfiguredKeyValueStore instance.
            + inthashCode() + +
            +          
            + voidinitFromConf(KeyValueStoreConfiguration conf) + +
            +          Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration.
            + KeyValueStoreReader<K,V>open() + +
            +          Throws IllegalStateException; you cannot open an unconfigured store.
            + voidstoreToConf(KeyValueStoreConfiguration conf) + +
            +          Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +builder

            +
            +public static <KT,VT> UnconfiguredKeyValueStore.Builder<KT,VT> builder()
            +
            +
            Creates a new UnconfiguredKeyValueStore.Builder instance that can be used + to create a new KeyValueStore. +

            +

            +
            +
            +
            +
            Type Parameters:
            KT - The type of the key field.
            VT - The type of the value field. +
            Returns:
            a new Builder instance.
            +
            +
            +
            + +

            +get

            +
            +public static <KT,VT> UnconfiguredKeyValueStore<KT,VT> get()
            +
            +
            Returns a singleton UnconfiguredKeyValueStore instance. +

            +

            +
            +
            +
            +
            Type Parameters:
            KT - The type of the key field.
            VT - The type of the value field. +
            Returns:
            a singleton UnconfiguredKeyValueStore instance.
            +
            +
            +
            + +

            +storeToConf

            +
            +public void storeToConf(KeyValueStoreConfiguration conf)
+                 throws IOException
            +
            +
            Serializes the state of the KeyValueStore into + the provided KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            storeToConf in interface KeyValueStore<K,V>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration to serialize state into. + This will be placed in a unique namespace of the job Configuration, + so it can write any key. +
            Throws: +
            IOException - if there is an error writing state to the configuration.
            +
            +
            +
            + +

            +initFromConf

            +
            +public void initFromConf(KeyValueStoreConfiguration conf)
+                  throws IOException
            +
            +
            Deserializes the state of this KeyValueStore from the + KeyValueStoreConfiguration. +

            +

            +
            Specified by:
            initFromConf in interface KeyValueStore<K,V>
            +
            +
            +
            Parameters:
            conf - the KeyValueStoreConfiguration storing state for this KeyValueStore. +
            Throws: +
            IOException - if there is an error reading from the configuration.
            +
            +
            +
            + +

            +open

            +
            +public KeyValueStoreReader<K,V> open()
            +
            +
            Throws IllegalStateException; you cannot open an unconfigured store. +

            +

            +
            Specified by:
            open in interface KeyValueStore<K,V>
            +
            +
            + +
            Returns:
            nothing, since it will always throw IllegalStateException. +
            Throws: +
            IllegalStateException - because you cannot open an unconfigured store.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object otherObj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroKVRecordKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroKVRecordKeyValueStore.Builder.html new file mode 100644 index 00000000..b7155505 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroKVRecordKeyValueStore.Builder.html @@ -0,0 +1,224 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore.Builder

            +
            + + + + + + + + + +
            +Packages that use AvroKVRecordKeyValueStore.Builder
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of AvroKVRecordKeyValueStore.Builder in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return AvroKVRecordKeyValueStore.Builder
            +static AvroKVRecordKeyValueStore.BuilderAvroKVRecordKeyValueStore.builder() + +
            +          Creates a new AvroKVRecordKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore.
            + AvroKVRecordKeyValueStore.BuilderAvroKVRecordKeyValueStore.Builder.withConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Hadoop configuration instance to use.
            + AvroKVRecordKeyValueStore.BuilderAvroKVRecordKeyValueStore.Builder.withDistributedCache(boolean enabled) + +
            +          Sets a flag indicating the use of the DistributedCache to distribute + input files.
            + AvroKVRecordKeyValueStore.BuilderAvroKVRecordKeyValueStore.Builder.withInputPath(org.apache.hadoop.fs.Path path) + +
            +          Adds a path to the list of files to load.
            + AvroKVRecordKeyValueStore.BuilderAvroKVRecordKeyValueStore.Builder.withInputPaths(List<org.apache.hadoop.fs.Path> paths) + +
            +          Replaces the current list of files to load with the set of files + specified as an argument.
            + AvroKVRecordKeyValueStore.BuilderAvroKVRecordKeyValueStore.Builder.withReaderSchema(org.apache.avro.Schema schema) + +
            +          Sets the schema to read the records with.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroKVRecordKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroKVRecordKeyValueStore.html new file mode 100644 index 00000000..bec13882 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroKVRecordKeyValueStore.html @@ -0,0 +1,188 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.AvroKVRecordKeyValueStore

            +
            + + + + + + + + + +
            +Packages that use AvroKVRecordKeyValueStore
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of AvroKVRecordKeyValueStore in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return AvroKVRecordKeyValueStore
            + + + + + +
            +<K,V> AvroKVRecordKeyValueStore<K,V>
            +            		AvroKVRecordKeyValueStore.Builder.build() + +
            +          Build a new AvroKVRecordKeyValueStore instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroRecordKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroRecordKeyValueStore.Builder.html new file mode 100644 index 00000000..bd0591dd --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroRecordKeyValueStore.Builder.html @@ -0,0 +1,232 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore.Builder

            +
            + + + + + + + + + +
            +Packages that use AvroRecordKeyValueStore.Builder
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of AvroRecordKeyValueStore.Builder in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return AvroRecordKeyValueStore.Builder
            +static AvroRecordKeyValueStore.BuilderAvroRecordKeyValueStore.builder() + +
            +          Creates a new AvroRecordKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore.
            + AvroRecordKeyValueStore.BuilderAvroRecordKeyValueStore.Builder.withConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Hadoop configuration instance to use.
            + AvroRecordKeyValueStore.BuilderAvroRecordKeyValueStore.Builder.withDistributedCache(boolean enabled) + +
            +          Sets a flag indicating the use of the DistributedCache to distribute + input files.
            + AvroRecordKeyValueStore.BuilderAvroRecordKeyValueStore.Builder.withInputPath(org.apache.hadoop.fs.Path path) + +
            +          Adds a path to the list of files to load.
            + AvroRecordKeyValueStore.BuilderAvroRecordKeyValueStore.Builder.withInputPaths(List<org.apache.hadoop.fs.Path> paths) + +
            +          Replaces the current list of files to load with the set of files + specified as an argument.
            + AvroRecordKeyValueStore.BuilderAvroRecordKeyValueStore.Builder.withKeyFieldName(String keyFieldName) + +
            +          Sets the name of the record field to use as the lookup key.
            + AvroRecordKeyValueStore.BuilderAvroRecordKeyValueStore.Builder.withReaderSchema(org.apache.avro.Schema schema) + +
            +          Sets the schema to read the records with.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroRecordKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroRecordKeyValueStore.html new file mode 100644 index 00000000..98c36c52 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/AvroRecordKeyValueStore.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.AvroRecordKeyValueStore

            +
            + + + + + + + + + +
            +Packages that use AvroRecordKeyValueStore
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of AvroRecordKeyValueStore in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return AvroRecordKeyValueStore
            + + + + + +
            +<K,V extends org.apache.avro.generic.IndexedRecord> +
            +AvroRecordKeyValueStore<K,V>
            +            		AvroRecordKeyValueStore.Builder.build() + +
            +          Build a new AvroRecordKeyValueStore instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/EmptyKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/EmptyKeyValueStore.Builder.html new file mode 100644 index 00000000..3fcc5605 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/EmptyKeyValueStore.Builder.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore.Builder

            +
            + + + + + + + + + +
            +Packages that use EmptyKeyValueStore.Builder
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of EmptyKeyValueStore.Builder in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return EmptyKeyValueStore.Builder
            +static + + + + +
            +<KT,VT> EmptyKeyValueStore.Builder<KT,VT>
            +            		EmptyKeyValueStore.builder() + +
            +          Creates a new EmptyKeyValueStore.Builder instance that can be used + to create a new KeyValueStore.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/EmptyKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/EmptyKeyValueStore.html new file mode 100644 index 00000000..1d31c013 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/EmptyKeyValueStore.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.EmptyKeyValueStore

            +
            + + + + + + + + + +
            +Packages that use EmptyKeyValueStore
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of EmptyKeyValueStore in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return EmptyKeyValueStore
            + EmptyKeyValueStore<K,V>EmptyKeyValueStore.Builder.build() + +
            +          Build a new EmptyKeyValueStore instance.
            +static + + + + +
            +<KT,VT> EmptyKeyValueStore<KT,VT>
            +            		EmptyKeyValueStore.get() + +
            +          Returns a singleton EmptyKeyValueStore instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/FileStoreHelper.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/FileStoreHelper.Builder.html new file mode 100644 index 00000000..91775edf --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/FileStoreHelper.Builder.html @@ -0,0 +1,215 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.FileStoreHelper.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.FileStoreHelper.Builder

            +
            + + + + + + + + + +
            +Packages that use FileStoreHelper.Builder
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of FileStoreHelper.Builder in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return FileStoreHelper.Builder
            +static FileStoreHelper.BuilderFileStoreHelper.builder() + +
            +           
            + FileStoreHelper.BuilderFileStoreHelper.Builder.withConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Hadoop configuration instance to use.
            + FileStoreHelper.BuilderFileStoreHelper.Builder.withDistributedCache(boolean enabled) + +
            +          Sets a flag indicating the use of the DistributedCache to distribute + input files.
            + FileStoreHelper.BuilderFileStoreHelper.Builder.withInputPath(org.apache.hadoop.fs.Path path) + +
            +          Adds a path to the list of files to load.
            + FileStoreHelper.BuilderFileStoreHelper.Builder.withInputPaths(List<org.apache.hadoop.fs.Path> paths) + +
            +          Replaces the current list of files to load with the set of files + specified as an argument.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/FileStoreHelper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/FileStoreHelper.html new file mode 100644 index 00000000..7667ac01 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/FileStoreHelper.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.FileStoreHelper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.FileStoreHelper

            +
            + + + + + + + + + +
            +Packages that use FileStoreHelper
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of FileStoreHelper in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return FileStoreHelper
            + FileStoreHelperFileStoreHelper.Builder.build() + +
            +          Builds and returns a new FileStoreHelper instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/KijiTableKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/KijiTableKeyValueStore.Builder.html new file mode 100644 index 00000000..57149ce4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/KijiTableKeyValueStore.Builder.html @@ -0,0 +1,247 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore.Builder

            +
            + + + + + + + + + +
            +Packages that use KijiTableKeyValueStore.Builder
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of KijiTableKeyValueStore.Builder in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return KijiTableKeyValueStore.Builder
            +static KijiTableKeyValueStore.BuilderKijiTableKeyValueStore.builder() + +
            +          Creates a new KijiTableKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore.
            + KijiTableKeyValueStore.BuilderKijiTableKeyValueStore.Builder.withCacheLimit(int numValues) + +
            +          Sets the maximum number of lookups to cache in memory.
            + KijiTableKeyValueStore.BuilderKijiTableKeyValueStore.Builder.withColumn(org.kiji.schema.KijiColumnName colName) + +
            +          Sets the column to retrieve values from.
            + KijiTableKeyValueStore.BuilderKijiTableKeyValueStore.Builder.withColumn(String family, + String qualifier) + +
            +          Sets the column to retrieve values from.
            + KijiTableKeyValueStore.BuilderKijiTableKeyValueStore.Builder.withConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Configuration to use to connect to Kiji.
            + KijiTableKeyValueStore.BuilderKijiTableKeyValueStore.Builder.withMaxTimestamp(long timestamp) + +
            +          Sets the newest timestamp to retrieve values from in the column.
            + KijiTableKeyValueStore.BuilderKijiTableKeyValueStore.Builder.withMinTimestamp(long timestamp) + +
            +          Sets the oldest timestamp to retrieve values from in the column.
            + KijiTableKeyValueStore.BuilderKijiTableKeyValueStore.Builder.withReaderSchema(org.apache.avro.Schema schema) + +
            +          Sets the reader schema to use when deserializing values from the value column.
            + KijiTableKeyValueStore.BuilderKijiTableKeyValueStore.Builder.withTable(org.kiji.schema.KijiURI tableUri) + +
            +          Sets the table to use as the backing store.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/KijiTableKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/KijiTableKeyValueStore.html new file mode 100644 index 00000000..de663b9f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/KijiTableKeyValueStore.html @@ -0,0 +1,188 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.KijiTableKeyValueStore

            +
            + + + + + + + + + +
            +Packages that use KijiTableKeyValueStore
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of KijiTableKeyValueStore in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return KijiTableKeyValueStore
            + + + + + +
            +<V> KijiTableKeyValueStore<V>
            +            		KijiTableKeyValueStore.Builder.build() + +
            +          Build a new KijiTableKeyValueStore instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/SeqFileKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/SeqFileKeyValueStore.Builder.html new file mode 100644 index 00000000..24e49f23 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/SeqFileKeyValueStore.Builder.html @@ -0,0 +1,216 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore.Builder

            +
            + + + + + + + + + +
            +Packages that use SeqFileKeyValueStore.Builder
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of SeqFileKeyValueStore.Builder in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return SeqFileKeyValueStore.Builder
            +static SeqFileKeyValueStore.BuilderSeqFileKeyValueStore.builder() + +
            +          Creates a new SeqFileKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore.
            + SeqFileKeyValueStore.BuilderSeqFileKeyValueStore.Builder.withConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Hadoop configuration instance to use.
            + SeqFileKeyValueStore.BuilderSeqFileKeyValueStore.Builder.withDistributedCache(boolean enabled) + +
            +          Sets a flag indicating the use of the DistributedCache to distribute + input files.
            + SeqFileKeyValueStore.BuilderSeqFileKeyValueStore.Builder.withInputPath(org.apache.hadoop.fs.Path path) + +
            +          Adds a path to the list of files to load.
            + SeqFileKeyValueStore.BuilderSeqFileKeyValueStore.Builder.withInputPaths(List<org.apache.hadoop.fs.Path> paths) + +
            +          Replaces the current list of files to load with the set of files + specified as an argument.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/SeqFileKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/SeqFileKeyValueStore.html new file mode 100644 index 00000000..caf06547 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/SeqFileKeyValueStore.html @@ -0,0 +1,188 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.SeqFileKeyValueStore

            +
            + + + + + + + + + +
            +Packages that use SeqFileKeyValueStore
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of SeqFileKeyValueStore in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return SeqFileKeyValueStore
            + + + + + +
            +<K,V> SeqFileKeyValueStore<K,V>
            +            		SeqFileKeyValueStore.Builder.build() + +
            +          Build a new SeqFileKeyValueStore instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/TextFileKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/TextFileKeyValueStore.Builder.html new file mode 100644 index 00000000..4c82f6d8 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/TextFileKeyValueStore.Builder.html @@ -0,0 +1,224 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore.Builder

            +
            + + + + + + + + + +
            +Packages that use TextFileKeyValueStore.Builder
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of TextFileKeyValueStore.Builder in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return TextFileKeyValueStore.Builder
            +static TextFileKeyValueStore.BuilderTextFileKeyValueStore.builder() + +
            +          Creates a new TextFileKeyValueStore.Builder instance that can be used + to configure and create a new KeyValueStore.
            + TextFileKeyValueStore.BuilderTextFileKeyValueStore.Builder.withConfiguration(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Hadoop configuration instance to use.
            + TextFileKeyValueStore.BuilderTextFileKeyValueStore.Builder.withDelimiter(String delim) + +
            +          Specifies the delimiter between the key and the value on a line in the file.
            + TextFileKeyValueStore.BuilderTextFileKeyValueStore.Builder.withDistributedCache(boolean enabled) + +
            +          Sets a flag indicating the use of the DistributedCache to distribute + input files.
            + TextFileKeyValueStore.BuilderTextFileKeyValueStore.Builder.withInputPath(org.apache.hadoop.fs.Path path) + +
            +          Adds a path to the list of files to load.
            + TextFileKeyValueStore.BuilderTextFileKeyValueStore.Builder.withInputPaths(List<org.apache.hadoop.fs.Path> paths) + +
            +          Replaces the current list of files to load with the set of files + specified as an argument.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/TextFileKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/TextFileKeyValueStore.html new file mode 100644 index 00000000..5c0cf801 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/TextFileKeyValueStore.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.TextFileKeyValueStore

            +
            + + + + + + + + + +
            +Packages that use TextFileKeyValueStore
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of TextFileKeyValueStore in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return TextFileKeyValueStore
            + TextFileKeyValueStoreTextFileKeyValueStore.Builder.build() + +
            +          Build a new TextFileKeyValueStore instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/UnconfiguredKeyValueStore.Builder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/UnconfiguredKeyValueStore.Builder.html new file mode 100644 index 00000000..2588a225 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/UnconfiguredKeyValueStore.Builder.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore.Builder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore.Builder

            +
            + + + + + + + + + +
            +Packages that use UnconfiguredKeyValueStore.Builder
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of UnconfiguredKeyValueStore.Builder in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return UnconfiguredKeyValueStore.Builder
            +static + + + + +
            +<KT,VT> UnconfiguredKeyValueStore.Builder<KT,VT>
            +            		UnconfiguredKeyValueStore.builder() + +
            +          Creates a new UnconfiguredKeyValueStore.Builder instance that can be used + to create a new KeyValueStore.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/UnconfiguredKeyValueStore.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/UnconfiguredKeyValueStore.html new file mode 100644 index 00000000..bd175476 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/class-use/UnconfiguredKeyValueStore.html @@ -0,0 +1,196 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.kvstore.lib.UnconfiguredKeyValueStore

            +
            + + + + + + + + + +
            +Packages that use UnconfiguredKeyValueStore
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + +
            +Uses of UnconfiguredKeyValueStore in org.kiji.mapreduce.kvstore.lib
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.kvstore.lib that return UnconfiguredKeyValueStore
            + UnconfiguredKeyValueStore<K,V>UnconfiguredKeyValueStore.Builder.build() + +
            +          Build a new UnconfiguredKeyValueStore instance.
            +static + + + + +
            +<KT,VT> UnconfiguredKeyValueStore<KT,VT>
            +            		UnconfiguredKeyValueStore.get() + +
            +          Returns a singleton UnconfiguredKeyValueStore instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-frame.html new file mode 100644 index 00000000..b95f8cb1 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-frame.html @@ -0,0 +1,63 @@ + + + + + + + +org.kiji.mapreduce.kvstore.lib (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.kvstore.lib + + + + +
            +Classes  + +
            +AvroKVRecordKeyValueStore +
            +AvroKVRecordKeyValueStore.Builder +
            +AvroRecordKeyValueStore +
            +AvroRecordKeyValueStore.Builder +
            +EmptyKeyValueStore +
            +EmptyKeyValueStore.Builder +
            +FileStoreHelper +
            +FileStoreHelper.Builder +
            +KijiTableKeyValueStore +
            +KijiTableKeyValueStore.Builder +
            +SeqFileKeyValueStore +
            +SeqFileKeyValueStore.Builder +
            +TextFileKeyValueStore +
            +TextFileKeyValueStore.Builder +
            +UnconfiguredKeyValueStore +
            +UnconfiguredKeyValueStore.Builder
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-summary.html new file mode 100644 index 00000000..d29e8f12 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-summary.html @@ -0,0 +1,303 @@ + + + + + + + +org.kiji.mapreduce.kvstore.lib (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.kvstore.lib +

            +Key-value store implementations. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AvroKVRecordKeyValueStore<K,V>An interface for providing read access to Avro container files of (key, value) + records.
            AvroKVRecordKeyValueStore.BuilderA Builder-pattern class that configures and creates new AvroKVRecordKeyValueStore + instances.
            AvroRecordKeyValueStore<K,V extends IndexedRecord>An interface for providing read access to Avro container files of records.
            AvroRecordKeyValueStore.BuilderA Builder-pattern class that configures and creates new AvroRecordKeyValueStore + instances.
            EmptyKeyValueStore<K,V>A KeyValueStore that contains no data.
            EmptyKeyValueStore.Builder<K,V>A Builder-pattern class that configures and creates new EmptyKeyValueStore + instances.
            FileStoreHelperHelper class that manages filenames and distributed cache functionality + for KeyValueStore implementations that work with files or collections + of files.
            FileStoreHelper.BuilderA class that builds configured FileStoreHelper instances.
            KijiTableKeyValueStore<V>KeyValueStore lookup implementation based on a Kiji table.
            KijiTableKeyValueStore.BuilderA Builder-pattern class that configures and creates new KijiTableKeyValueStore + instances.
            SeqFileKeyValueStore<K,V>KeyValueStore implementation that reads records from SequenceFiles.
            SeqFileKeyValueStore.BuilderA Builder-pattern class that configures and creates new SeqFileKeyValueStore + instances.
            TextFileKeyValueStoreKeyValueStore implementation that reads delimited records from text files.
            TextFileKeyValueStore.BuilderA Builder-pattern class that configures and creates new TextFileKeyValueStore + instances.
            UnconfiguredKeyValueStore<K,V>A KeyValueStore that is not configured.
            UnconfiguredKeyValueStore.Builder<K,V>A Builder-pattern class that creates new UnconfiguredKeyValueStore + instances.
            +  + +

            +

            +Package org.kiji.mapreduce.kvstore.lib Description +

            + +

            +Key-value store implementations. + +

            This package contains a library of KeyValueStore + implementations that can access key-value pairs in various resources.

            + +

            Available KeyValueStores

            +

            Several file-backed KeyValueStore implementations provide access to + stores in different file formats:

            + + + +

            You can also access a specific column of a Kiji table by the row's entityId + using the KijiTableKeyValueStore.

            + +

            If you want to declare a name binding on a KeyValueStore whose exact configuration cannot + be determined before runtime, use the UnconfiguredKeyValueStore. It will throw an IOException + in its storeToConf() method, ensuring that your MapReduceJobBuilder must call + withStore() to override the definition before launching the job.

            + +

            The EmptyKeyValueStore is a good default + choice when you plan to override the configuration at runtime, but find it acceptable + to operate without this information.

            + +

            Implementers of HDFS file-backed KeyValueStores may find the FileStoreHelper object helpful; it will track the + configuration of filenames and manage their assignment to the DistributedCache on + behalf of your KeyValueStore. Multiple KeyValueStores associated with a job may use + FileStoreHelpers to manage their files without concern for interfering with one + another.

            + +

            Configuring KeyValueStores

            + +

            The KeyValueStore implementations in this package are all configured through an + associated Builder object. Each implementation has a builder() method + that returns the associated Builder object. You can use this Builder to configure + various properties particular to that KeyValueStore implementation. Its build() + method either returns a newly-constructed KeyValueStore, or throws an exception if the + configuration contains an error.

            + +

            In addition, some KeyValueStores (e.g., EmptyKeyValueStore) can also be created through other + factory methods, like get().

            + +

            In your getRequiredStores() method, you may find the RequiredStores class helpful in quickly assembling a set + of KeyValueStore binding definitions.

            + +

            Note that each KeyValueStore also has a public default constructor. You should not + use this directly. When creating individual KeyValueStores, you should use its + associated Builder object. KeyValueStores are instantiated by MapReduce programs using + reflection (through the default constructor), and then configured using + initFromConf(). To initialize a set of KeyValueStores from a Configuration + yourself, you should use a KeyValueStoreReaderFactory object to deserialize all + KeyValueStores in the job configuration.

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-tree.html new file mode 100644 index 00000000..ad8c674c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.mapreduce.kvstore.lib Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.kvstore.lib +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-use.html new file mode 100644 index 00000000..54a549ba --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/lib/package-use.html @@ -0,0 +1,271 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.kvstore.lib (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.kvstore.lib

            +
            + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.kvstore.lib
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore.lib used by org.kiji.mapreduce.kvstore.lib
            AvroKVRecordKeyValueStore + +
            +          An interface for providing read access to Avro container files of (key, value) + records.
            AvroKVRecordKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new AvroKVRecordKeyValueStore + instances.
            AvroRecordKeyValueStore + +
            +          An interface for providing read access to Avro container files of records.
            AvroRecordKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new AvroRecordKeyValueStore + instances.
            EmptyKeyValueStore + +
            +          A KeyValueStore that contains no data.
            EmptyKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new EmptyKeyValueStore + instances.
            FileStoreHelper + +
            +          Helper class that manages filenames and distributed cache functionality + for KeyValueStore implementations that work with files or collections + of files.
            FileStoreHelper.Builder + +
            +          A class that builds configured FileStoreHelper instances.
            KijiTableKeyValueStore + +
            +          KeyValueStore lookup implementation based on a Kiji table.
            KijiTableKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new KijiTableKeyValueStore + instances.
            SeqFileKeyValueStore + +
            +          KeyValueStore implementation that reads records from SequenceFiles.
            SeqFileKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new SeqFileKeyValueStore + instances.
            TextFileKeyValueStore + +
            +          KeyValueStore implementation that reads delimited records from text files.
            TextFileKeyValueStore.Builder + +
            +          A Builder-pattern class that configures and creates new TextFileKeyValueStore + instances.
            UnconfiguredKeyValueStore + +
            +          A KeyValueStore that is not configured.
            UnconfiguredKeyValueStore.Builder + +
            +          A Builder-pattern class that creates new UnconfiguredKeyValueStore + instances.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-frame.html new file mode 100644 index 00000000..6fa6b5e1 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-frame.html @@ -0,0 +1,52 @@ + + + + + + + +org.kiji.mapreduce.kvstore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.kvstore + + + + +
            +Interfaces  + +
            +KeyValueStore +
            +KeyValueStoreClient +
            +KeyValueStoreReader
            + + + + + + +
            +Classes  + +
            +KeyValueStoreReaderFactory +
            +RequiredStores +
            +RequiredStores.StoreMap
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-summary.html new file mode 100644 index 00000000..a2ac6d42 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-summary.html @@ -0,0 +1,248 @@ + + + + + + + +org.kiji.mapreduce.kvstore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.kvstore +

            +Key-value store APIs. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + +
            +Interface Summary
            KeyValueStore<K,V>A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store.
            KeyValueStoreClientA KeyValueStoreClient defines a mapping between store names and their + KeyValueStore implementations via the getRequiredStores() method.
            KeyValueStoreReader<K,V>Allows users to read from a KeyValueStore.
            +  + +

            + + + + + + + + + + + + + + + + + +
            +Class Summary
            KeyValueStoreReaderFactoryClass that manages the creation of KeyValueStoreReaders associated + with a set of bound KeyValueStore name--instance pairs.
            RequiredStoresConvenient methods for assembling maps from names to KeyValueStore + implementations in getRequiredStores() calls.
            RequiredStores.StoreMapA Map from names to KeyValueStore entries, created by RequiredStores.with().
            +  + +

            +

            +Package org.kiji.mapreduce.kvstore Description +

            + +

            +Key-value store APIs. + +

            KeyValueStores are used to provide MapReduce + programs and other operators processing Kiji datasets with the ability to join + datasets. One data set can be specified as a key-value store using the KeyValueStore + API. The program can use a KeyValueStoreReader to look up values associated with keys. + These keys are often driven by records of a dataset being processed by MapReduce.

            + +

            KeyValueStores are read-only and generally depend on their backing store + being considered immutable for the duration of the program's run.

            + +

            Several KeyValueStore implementations are available in org.kiji.mapreduce.kvstore.lib. These implementations read from a variety of file + formats, or Kiji tables.

            + +

            A Kiji table processor (Mapper, Gatherer, Producer, etc.) can specify a set of + key-value stores it requires, by implementing the KeyValueStoreClient class. You can return a set of + key-value store names and default implementations. These implementations may specify a + default directory in HDFS where they expect the data set.

            + +

            Implementers of KeyValueStoreClient may find the RequiredStores static class helpful, as it provides + convenient constructors for sets of KeyValueStore configurations of varying size.

            + +

            You can override these KeyValueStore configurations when submitting a MapReduce + program; use a MapReduceJobBuilder or related class to + specify a different KeyValueStore implementation to use at run-time using the + withStore() method.

            + +

            You can also override the entire set of stores associated with a MapReduce + job by using a kvstores XML file. This XML file may specify a set of store names + bound to different KeyValueStore configurations.

            + +

            MapReduce jobs may specify a dependency on one or more stores. The Context objects + provided as arguments to Producers and Gatherers can open stores by name; the KeyValueStoreReader interface provides a + backing-store-independent reader API that allows them to access values by key. If you + are using MapReduce directly, you can instantiate a KeyValueStoreReaderFactory to get access to the + KeyValueStoreReaders associated with the current job.

            + +

            You can write your own KeyValueStore implementation as well; for instance, you may + want to read key-value pairs from a different file format, or look up values over a + network (e.g., in Redis, MongoDB, or elsewhere). To do so, implement the KeyValueStore interface, and provide a related KeyValueStoreReader implementation as well. You can use the + FileStoreHelper object to manage files in HDFS + that should be sent to your processes via the DistributedCache.

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-tree.html new file mode 100644 index 00000000..d29defef --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-tree.html @@ -0,0 +1,168 @@ + + + + + + + +org.kiji.mapreduce.kvstore Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.kvstore +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-use.html new file mode 100644 index 00000000..3edeed92 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/kvstore/package-use.html @@ -0,0 +1,383 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.kvstore (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.kvstore

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.kvstore
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            org.kiji.mapreduce.kvstoreKey-value store APIs. 
            org.kiji.mapreduce.kvstore.implKey value store implementation details. 
            org.kiji.mapreduce.kvstore.libKey-value store implementations. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore used by org.kiji.mapreduce
            KeyValueStore + +
            +          A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store.
            KeyValueStoreReader + +
            +          Allows users to read from a KeyValueStore.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore used by org.kiji.mapreduce.bulkimport
            KeyValueStore + +
            +          A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store.
            KeyValueStoreClient + +
            +          A KeyValueStoreClient defines a mapping between store names and their + KeyValueStore implementations via the getRequiredStores() method.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore used by org.kiji.mapreduce.framework
            KeyValueStore + +
            +          A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore used by org.kiji.mapreduce.gather
            KeyValueStore + +
            +          A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store.
            KeyValueStoreClient + +
            +          A KeyValueStoreClient defines a mapping between store names and their + KeyValueStore implementations via the getRequiredStores() method.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore used by org.kiji.mapreduce.impl
            KeyValueStoreReader + +
            +          Allows users to read from a KeyValueStore.
            +  +

            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore used by org.kiji.mapreduce.kvstore
            KeyValueStore + +
            +          A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store.
            KeyValueStoreReader + +
            +          Allows users to read from a KeyValueStore.
            KeyValueStoreReaderFactory + +
            +          Class that manages the creation of KeyValueStoreReaders associated + with a set of bound KeyValueStore name--instance pairs.
            RequiredStores.StoreMap + +
            +          A Map from names to KeyValueStore entries, created by RequiredStores.with().
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore used by org.kiji.mapreduce.kvstore.impl
            KeyValueStore + +
            +          A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore used by org.kiji.mapreduce.kvstore.lib
            KeyValueStore + +
            +          A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store.
            KeyValueStoreReader + +
            +          Allows users to read from a KeyValueStore.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.kvstore used by org.kiji.mapreduce.produce
            KeyValueStore + +
            +          A KeyValueStore specifies all the resources needed to surface + key-value pairs from some backing store.
            KeyValueStoreClient + +
            +          A KeyValueStoreClient defines a mapping between store names and their + KeyValueStore implementations via the getRequiredStores() method.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/AvroKeyMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/AvroKeyMapReduceJobOutput.html new file mode 100644 index 00000000..5ba0ac9e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/AvroKeyMapReduceJobOutput.html @@ -0,0 +1,319 @@ + + + + + + + +AvroKeyMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output +
            +Class AvroKeyMapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+      extended by org.kiji.mapreduce.output.FileMapReduceJobOutput
+          extended by org.kiji.mapreduce.output.AvroKeyMapReduceJobOutput
+
            +
            +
            +
            @ApiAudience.Public
+public final class AvroKeyMapReduceJobOutput
            extends FileMapReduceJobOutput
            + + +

            +The class AvroKeyMapReduceJobOutput is used to indicate the usage of Avro container files + as output for a MapReduce job. + +

            + This job output will only permit writing keys to the Avro container file. To write + key-value pairs to a container file use AvroKeyValueMapReduceJobOutput instead. +

            + +

            Configuring an output:

            +

            + AvroKeyMapReduceJobOutput must be configured with a location to write output container files + to and the number of output splits to use: +

            + 
            +   
+     final Path outputPath = new Path("/path/to/output/folder");
+
+     // Create a text file job output with 10 splits.
+     final MapReduceJobOutput textOutput = new AvroKeyMapReduceJobOutput(outputPath, 10);
+   
+
            +

            + +

            +

            +
            See Also:
            AvroKeyValueMapReduceJobOutput
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            AvroKeyMapReduceJobOutput() + +
            +          Default constructor.
            AvroKeyMapReduceJobOutput(org.apache.hadoop.fs.Path filePath, + int numSplits) + +
            +          Creates a new AvroKeyMapReduceJobOutput instance.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  Class<? extends org.apache.hadoop.mapreduce.OutputFormat>getOutputFormatClass() + +
            +          Gets the Hadoop MapReduce output format class.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.output.FileMapReduceJobOutput
            configure, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroKeyMapReduceJobOutput

            +
            +public AvroKeyMapReduceJobOutput()
            +
            +
            Default constructor. Do not use directly. +

            +

            +
            + +

            +AvroKeyMapReduceJobOutput

            +
            +public AvroKeyMapReduceJobOutput(org.apache.hadoop.fs.Path filePath,
+                                 int numSplits)
            +
            +
            Creates a new AvroKeyMapReduceJobOutput instance. +

            +

            +
            Parameters:
            filePath - Path to output folder.
            numSplits - Number of output file splits.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getOutputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.OutputFormat> getOutputFormatClass()
            +
            +
            Gets the Hadoop MapReduce output format class. +

            +

            +
            Specified by:
            getOutputFormatClass in class MapReduceJobOutput
            +
            +
            + +
            Returns:
            The job output format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/AvroKeyValueMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/AvroKeyValueMapReduceJobOutput.html new file mode 100644 index 00000000..a2830d41 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/AvroKeyValueMapReduceJobOutput.html @@ -0,0 +1,319 @@ + + + + + + + +AvroKeyValueMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output +
            +Class AvroKeyValueMapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+      extended by org.kiji.mapreduce.output.FileMapReduceJobOutput
+          extended by org.kiji.mapreduce.output.AvroKeyValueMapReduceJobOutput
+
            +
            +
            +
            @ApiAudience.Public
+public final class AvroKeyValueMapReduceJobOutput
            extends FileMapReduceJobOutput
            + + +

            +The class AvroKeyValueMapReduceJobOutput is used to indicate the usage of Avro container files + as output for a MapReduce job. + +

            + This job output permits writing key-value pairs to the Avro container file. If you only + need to write keys to a container file use AvroKeyMapReduceJobOutput instead. +

            + +

            Configuring an output:

            +

            + AvroKeyValueMapReduceJobOutput must be configured with a location to write output container + files to and the number of output splits to use: +

            + 
            +   
+     final Path outputPath = new Path("/path/to/output/folder");
+
+     // Create a text file job output with 10 splits.
+     final MapReduceJobOutput textOutput = new AvroKeyValueMapReduceJobOutput(outputPath, 10);
+   
+
            +

            + +

            +

            +
            See Also:
            AvroKeyMapReduceJobOutput
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            AvroKeyValueMapReduceJobOutput() + +
            +          Default constructor.
            AvroKeyValueMapReduceJobOutput(org.apache.hadoop.fs.Path filePath, + int numSplits) + +
            +          Creates a new AvroKeyValueMapReduceJobOutput instance.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  Class<? extends org.apache.hadoop.mapreduce.OutputFormat>getOutputFormatClass() + +
            +          Gets the Hadoop MapReduce output format class.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.output.FileMapReduceJobOutput
            configure, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroKeyValueMapReduceJobOutput

            +
            +public AvroKeyValueMapReduceJobOutput()
            +
            +
            Default constructor. Do not use directly. +

            +

            +
            + +

            +AvroKeyValueMapReduceJobOutput

            +
            +public AvroKeyValueMapReduceJobOutput(org.apache.hadoop.fs.Path filePath,
+                                      int numSplits)
            +
            +
            Creates a new AvroKeyValueMapReduceJobOutput instance. +

            +

            +
            Parameters:
            filePath - The file system path for the output files.
            numSplits - The number of output file splits.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getOutputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.OutputFormat> getOutputFormatClass()
            +
            +
            Gets the Hadoop MapReduce output format class. +

            +

            +
            Specified by:
            getOutputFormatClass in class MapReduceJobOutput
            +
            +
            + +
            Returns:
            The job output format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/DirectKijiTableMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/DirectKijiTableMapReduceJobOutput.html new file mode 100644 index 00000000..bb88409c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/DirectKijiTableMapReduceJobOutput.html @@ -0,0 +1,366 @@ + + + + + + + +DirectKijiTableMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output +
            +Class DirectKijiTableMapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+      extended by org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput
+          extended by org.kiji.mapreduce.output.DirectKijiTableMapReduceJobOutput
+
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public class DirectKijiTableMapReduceJobOutput
            extends KijiTableMapReduceJobOutput
            + + +

            +The class DirectKijiTableMapReduceJobOutput is used to indicate the usage of a Kiji table + as an output for a MapReduce job. + +

            + Use of this job output configuration is discouraged for many reasons: +

              +
            • It may induce a very high load on the target HBase cluster. +
            • It may result in partial writes (eg. if the job fails half through). +
            + The recommended way to write to HBase tables is through the HFileMapReduceJobOutput. +

            + +

            Configuring an output:

            +

            + DirectKijiTableMapReduceJobOutput must be configured with the address of the Kiji table to + write to and optionally the number of reduce tasks to use for the job: +

            + 
            +   
+     final MapReduceJobOutput kijiTableOutput = new DirectKijiTableMapReduceJobOutput(myURI);
+   
+
            +

            + +

            +

            +
            See Also:
            HFileMapReduceJobOutput
            +
            + +

            + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            DirectKijiTableMapReduceJobOutput() + +
            +          Default constructor.
            DirectKijiTableMapReduceJobOutput(org.kiji.schema.KijiURI tableURI) + +
            +          Creates a new KijiTableMapReduceJobOutput instance.
            DirectKijiTableMapReduceJobOutput(org.kiji.schema.KijiURI tableURI, + int numReduceTasks) + +
            +          Creates a new KijiTableMapReduceJobOutput instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + voidconfigure(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the output for a MapReduce job.
            +protected  Class<? extends org.apache.hadoop.mapreduce.OutputFormat>getOutputFormatClass() + +
            +          Gets the Hadoop MapReduce output format class.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput
            getNumReduceTasks, getOutputTableURI, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DirectKijiTableMapReduceJobOutput

            +
            +public DirectKijiTableMapReduceJobOutput()
            +
            +
            Default constructor. Do not use directly. +

            +

            +
            + +

            +DirectKijiTableMapReduceJobOutput

            +
            +public DirectKijiTableMapReduceJobOutput(org.kiji.schema.KijiURI tableURI)
            +
            +
            Creates a new KijiTableMapReduceJobOutput instance. +

            +

            +
            Parameters:
            tableURI - The Kiji table to write to.
            +
            +
            + +

            +DirectKijiTableMapReduceJobOutput

            +
            +public DirectKijiTableMapReduceJobOutput(org.kiji.schema.KijiURI tableURI,
+                                         int numReduceTasks)
            +
            +
            Creates a new KijiTableMapReduceJobOutput instance. +

            +

            +
            Parameters:
            tableURI - The Kiji table to write to.
            numReduceTasks - The number of reduce tasks to use (use zero if using a producer).
            +
            + + + + + + + + +
            +Method Detail
            + +

            +configure

            +
            +public void configure(org.apache.hadoop.mapreduce.Job job)
+               throws IOException
            +
            +
            Configures the output for a MapReduce job. +

            +

            +
            Overrides:
            configure in class KijiTableMapReduceJobOutput
            +
            +
            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getOutputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.OutputFormat> getOutputFormatClass()
            +
            +
            Gets the Hadoop MapReduce output format class. +

            +

            +
            Specified by:
            getOutputFormatClass in class MapReduceJobOutput
            +
            +
            + +
            Returns:
            The job output format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/FileMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/FileMapReduceJobOutput.html new file mode 100644 index 00000000..eb763765 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/FileMapReduceJobOutput.html @@ -0,0 +1,274 @@ + + + + + + + +FileMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output +
            +Class FileMapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+      extended by org.kiji.mapreduce.output.FileMapReduceJobOutput
+
            +
            +
            Direct Known Subclasses:
            AvroKeyMapReduceJobOutput, AvroKeyValueMapReduceJobOutput, MapFileMapReduceJobOutput, SequenceFileMapReduceJobOutput, TextMapReduceJobOutput
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract class FileMapReduceJobOutput
            extends MapReduceJobOutput
            + + +

            +Base class for MapReduce job output types that write to files. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidconfigure(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the output for a MapReduce job.
            + voidinitialize(Map<String,String> params) + +
            +          Initializes the job output from command-line parameters.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.MapReduceJobOutput
            getOutputFormatClass
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(Map<String,String> params)
+                throws IOException
            +
            +
            Initializes the job output from command-line parameters. +

            +

            +
            Specified by:
            initialize in class MapReduceJobOutput
            +
            +
            +
            Parameters:
            params - Initialization parameters. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +configure

            +
            +public void configure(org.apache.hadoop.mapreduce.Job job)
+               throws IOException
            +
            +
            Configures the output for a MapReduce job. +

            +

            +
            Overrides:
            configure in class MapReduceJobOutput
            +
            +
            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/HFileMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/HFileMapReduceJobOutput.html new file mode 100644 index 00000000..d7dd6fd4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/HFileMapReduceJobOutput.html @@ -0,0 +1,425 @@ + + + + + + + +HFileMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output +
            +Class HFileMapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+      extended by org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput
+          extended by org.kiji.mapreduce.output.HFileMapReduceJobOutput
+
            +
            +
            +
            @ApiAudience.Public
+public final class HFileMapReduceJobOutput
            extends KijiTableMapReduceJobOutput
            + + +

            +The class HFileMapReduceJobOutput is used to indicate the usage of HFiles based on the layout + of a Kiji table as output for a MapReduce job. + +

            + This job output writes output from MapReduce jobs to HFiles. The generated HFiles + can be directly loaded into the regions of an existing HTable. Use a + HFileLoader to load HFiles into a Kiji table. +

            + +

            Configuring an output:

            +

            + HFileMapReduceJobOutput must be configured with the address of the Kiji table to + write to as well as a location to write output HFiles to: +

            + 
            +   
+     final KijiURI tableURI = KijiURI.newBuilder("kiji://.env/default/mytable").build();
+     final Path hfileLocation = new Path("/path/to/hfile/output");
+
+     final MapReduceJobOutput kijiTableOutput =
+         new HFileMapReduceJobOutput(tableURI, hfileLocation);
+   
+
            +

            + +

            +

            +
            See Also:
            DirectKijiTableMapReduceJobOutput
            +
            + +

            + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            HFileMapReduceJobOutput() + +
            +          Default constructor.
            HFileMapReduceJobOutput(org.kiji.schema.KijiURI tableURI, + org.apache.hadoop.fs.Path path) + +
            +          Create job output of HFiles that can be efficiently loaded into a Kiji table.
            HFileMapReduceJobOutput(org.kiji.schema.KijiURI table, + org.apache.hadoop.fs.Path path, + int numSplits) + +
            +          Create job output of HFiles that can be efficiently loaded into a Kiji table.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidconfigure(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the output for a MapReduce job.
            +protected  Class<? extends org.apache.hadoop.mapreduce.OutputFormat>getOutputFormatClass() + +
            +          Gets the Hadoop MapReduce output format class.
            + org.apache.hadoop.fs.PathgetPath() + +
            +           
            + voidinitialize(Map<String,String> params) + +
            +          Initializes the job output from command-line parameters.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput
            getNumReduceTasks, getOutputTableURI
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HFileMapReduceJobOutput

            +
            +public HFileMapReduceJobOutput()
            +
            +
            Default constructor. Do not use directly. +

            +

            +
            + +

            +HFileMapReduceJobOutput

            +
            +public HFileMapReduceJobOutput(org.kiji.schema.KijiURI tableURI,
+                               org.apache.hadoop.fs.Path path)
            +
            +
            Create job output of HFiles that can be efficiently loaded into a Kiji table. + The number of HFiles created (which determines the number of reduce tasks) will + match the number of existing regions in the target Kiji table. +

            +

            +
            Parameters:
            tableURI - The kiji table the resulting HFiles are intended for.
            path - The directory path to output the HFiles to.
            +
            +
            + +

            +HFileMapReduceJobOutput

            +
            +public HFileMapReduceJobOutput(org.kiji.schema.KijiURI table,
+                               org.apache.hadoop.fs.Path path,
+                               int numSplits)
            +
            +
            Create job output of HFiles that can be efficiently loaded into a Kiji table. + The number of HFiles created (which determines the number of reduce tasks) is + specified with the numSplits argument. Controlling the number of + splits is only possible when targeting a Kiji table with <hashRowKeys> + enabled. Typically, you should allow the system to + match the number of splits to the number of regions in the table by using the + HFileMapReduceJobOutput(KijiURI, Path) constructor instead. +

            +

            +
            Parameters:
            table - The kiji table the resulting HFiles are intended for.
            path - The directory path to output the HFiles to.
            numSplits - Number of splits (determines the number of reduce tasks).
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(Map<String,String> params)
+                throws IOException
            +
            +
            Initializes the job output from command-line parameters. +

            +

            +
            Overrides:
            initialize in class KijiTableMapReduceJobOutput
            +
            +
            +
            Parameters:
            params - Initialization parameters. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +configure

            +
            +public void configure(org.apache.hadoop.mapreduce.Job job)
+               throws IOException
            +
            +
            Configures the output for a MapReduce job. +

            +

            +
            Overrides:
            configure in class KijiTableMapReduceJobOutput
            +
            +
            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getOutputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.OutputFormat> getOutputFormatClass()
            +
            +
            Gets the Hadoop MapReduce output format class. +

            +

            +
            Specified by:
            getOutputFormatClass in class MapReduceJobOutput
            +
            +
            + +
            Returns:
            The job output format class.
            +
            +
            +
            + +

            +getPath

            +
            +public org.apache.hadoop.fs.Path getPath()
            +
            +
            + +
            Returns:
            the path where to write HFiles.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/MapFileMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/MapFileMapReduceJobOutput.html new file mode 100644 index 00000000..24f6b6cc --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/MapFileMapReduceJobOutput.html @@ -0,0 +1,312 @@ + + + + + + + +MapFileMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output +
            +Class MapFileMapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+      extended by org.kiji.mapreduce.output.FileMapReduceJobOutput
+          extended by org.kiji.mapreduce.output.MapFileMapReduceJobOutput
+
            +
            +
            +
            @ApiAudience.Public
+public final class MapFileMapReduceJobOutput
            extends FileMapReduceJobOutput
            + + +

            +The class MapFileMapReduceJobOutput is used to indicate the usage of Hadoop map files as + output for a MapReduce job. + +

            Configuring an output:

            +

            + MapFileMapReduceJobOutput must be configured with a location to write output map files + to and the number of output splits to use: +

            + 
            +   
+     final Path outputPath = new Path("/path/to/output/folder");
+
+     // Create a map file job output with 10 splits.
+     final MapReduceJobOutput textOutput = new MapFileMapReduceJobOutput(outputPath, 10);
+   
+
            +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            MapFileMapReduceJobOutput() + +
            +          Default constructor.
            MapFileMapReduceJobOutput(org.apache.hadoop.fs.Path filePath, + int numSplits) + +
            +          Creates a new MapFileMapReduceJobOutput instance.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  Class<? extends org.apache.hadoop.mapreduce.OutputFormat>getOutputFormatClass() + +
            +          Gets the Hadoop MapReduce output format class.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.output.FileMapReduceJobOutput
            configure, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MapFileMapReduceJobOutput

            +
            +public MapFileMapReduceJobOutput()
            +
            +
            Default constructor. Do not use directly. +

            +

            +
            + +

            +MapFileMapReduceJobOutput

            +
            +public MapFileMapReduceJobOutput(org.apache.hadoop.fs.Path filePath,
+                                 int numSplits)
            +
            +
            Creates a new MapFileMapReduceJobOutput instance. +

            +

            +
            Parameters:
            filePath - Path to output folder.
            numSplits - Number of output file splits.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getOutputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.OutputFormat> getOutputFormatClass()
            +
            +
            Gets the Hadoop MapReduce output format class. +

            +

            +
            Specified by:
            getOutputFormatClass in class MapReduceJobOutput
            +
            +
            + +
            Returns:
            The job output format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/SequenceFileMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/SequenceFileMapReduceJobOutput.html new file mode 100644 index 00000000..dbe5c2ab --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/SequenceFileMapReduceJobOutput.html @@ -0,0 +1,312 @@ + + + + + + + +SequenceFileMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output +
            +Class SequenceFileMapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+      extended by org.kiji.mapreduce.output.FileMapReduceJobOutput
+          extended by org.kiji.mapreduce.output.SequenceFileMapReduceJobOutput
+
            +
            +
            +
            @ApiAudience.Public
+public final class SequenceFileMapReduceJobOutput
            extends FileMapReduceJobOutput
            + + +

            +The class SequenceFileMapReduceJobOutput is used to indicate the usage of Hadoop + sequence files as output for a MapReduce job. + +

            Configuring an output:

            +

            + SequenceFileMapReduceJobOutput must be configured with a location to write output + sequence files to and the number of output splits to use: +

            + 
            +   
+     final Path outputPath = new Path("/path/to/output/folder");
+
+     // Create a sequence file job output with 10 splits.
+     final MapReduceJobOutput textOutput = new SequenceFileMapReduceJobOutput(outputPath, 10);
+   
+
            +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            SequenceFileMapReduceJobOutput() + +
            +          Default constructor.
            SequenceFileMapReduceJobOutput(org.apache.hadoop.fs.Path filePath, + int numSplits) + +
            +          Creates a new SequenceFileMapReduceJobOutput instance.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  Class<? extends org.apache.hadoop.mapreduce.OutputFormat>getOutputFormatClass() + +
            +          Gets the Hadoop MapReduce output format class.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.output.FileMapReduceJobOutput
            configure, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +SequenceFileMapReduceJobOutput

            +
            +public SequenceFileMapReduceJobOutput()
            +
            +
            Default constructor. Do not use directly. +

            +

            +
            + +

            +SequenceFileMapReduceJobOutput

            +
            +public SequenceFileMapReduceJobOutput(org.apache.hadoop.fs.Path filePath,
+                                      int numSplits)
            +
            +
            Creates a new SequenceFileMapReduceJobOutput instance. +

            +

            +
            Parameters:
            filePath - The file system path for the output files.
            numSplits - The number of output file splits.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getOutputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.OutputFormat> getOutputFormatClass()
            +
            +
            Gets the Hadoop MapReduce output format class. +

            +

            +
            Specified by:
            getOutputFormatClass in class MapReduceJobOutput
            +
            +
            + +
            Returns:
            The job output format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/TextMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/TextMapReduceJobOutput.html new file mode 100644 index 00000000..43be3205 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/TextMapReduceJobOutput.html @@ -0,0 +1,312 @@ + + + + + + + +TextMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output +
            +Class TextMapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+      extended by org.kiji.mapreduce.output.FileMapReduceJobOutput
+          extended by org.kiji.mapreduce.output.TextMapReduceJobOutput
+
            +
            +
            +
            @ApiAudience.Public
+public final class TextMapReduceJobOutput
            extends FileMapReduceJobOutput
            + + +

            +The class TextMapReduceJobOutput is used to indicate the usage of text files as output + for a MapReduce job. + +

            Configuring an output:

            +

            + TextMapReduceJobOutput must be configured with a location to write output text files + to and the number of output splits to use: +

            + 
            +   
+     final Path outputPath = new Path("/path/to/output/folder");
+
+     // Create a text file job output with 10 splits.
+     final MapReduceJobOutput textOutput = new TextMapReduceJobOutput(outputPath, 10);
+   
+
            +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            TextMapReduceJobOutput() + +
            +          Default constructor.
            TextMapReduceJobOutput(org.apache.hadoop.fs.Path filePath, + int numSplits) + +
            +          Creates a new TextMapReduceJobOutput instance.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  Class<? extends org.apache.hadoop.mapreduce.OutputFormat>getOutputFormatClass() + +
            +          Gets the Hadoop MapReduce output format class.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.output.FileMapReduceJobOutput
            configure, initialize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +TextMapReduceJobOutput

            +
            +public TextMapReduceJobOutput()
            +
            +
            Default constructor. Do not use directly. +

            +

            +
            + +

            +TextMapReduceJobOutput

            +
            +public TextMapReduceJobOutput(org.apache.hadoop.fs.Path filePath,
+                              int numSplits)
            +
            +
            Creates a new TextMapReduceJobOutput instance. +

            +

            +
            Parameters:
            filePath - Path to output folder.
            numSplits - Number of output file splits.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getOutputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.OutputFormat> getOutputFormatClass()
            +
            +
            Gets the Hadoop MapReduce output format class. +

            +

            +
            Specified by:
            getOutputFormatClass in class MapReduceJobOutput
            +
            +
            + +
            Returns:
            The job output format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/AvroKeyMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/AvroKeyMapReduceJobOutput.html new file mode 100644 index 00000000..e8a76c39 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/AvroKeyMapReduceJobOutput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.AvroKeyMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.AvroKeyMapReduceJobOutput

            +
            +No usage of org.kiji.mapreduce.output.AvroKeyMapReduceJobOutput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/AvroKeyValueMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/AvroKeyValueMapReduceJobOutput.html new file mode 100644 index 00000000..cec53b1b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/AvroKeyValueMapReduceJobOutput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.AvroKeyValueMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.AvroKeyValueMapReduceJobOutput

            +
            +No usage of org.kiji.mapreduce.output.AvroKeyValueMapReduceJobOutput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/DirectKijiTableMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/DirectKijiTableMapReduceJobOutput.html new file mode 100644 index 00000000..1114f61e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/DirectKijiTableMapReduceJobOutput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.DirectKijiTableMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.DirectKijiTableMapReduceJobOutput

            +
            +No usage of org.kiji.mapreduce.output.DirectKijiTableMapReduceJobOutput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/FileMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/FileMapReduceJobOutput.html new file mode 100644 index 00000000..be246cf3 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/FileMapReduceJobOutput.html @@ -0,0 +1,218 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.FileMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.FileMapReduceJobOutput

            +
            + + + + + + + + + +
            +Packages that use FileMapReduceJobOutput
            org.kiji.mapreduce.outputMapReduce job output types. 
            +  +

            + + + + + +
            +Uses of FileMapReduceJobOutput in org.kiji.mapreduce.output
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of FileMapReduceJobOutput in org.kiji.mapreduce.output
            + classAvroKeyMapReduceJobOutput + +
            +          The class AvroKeyMapReduceJobOutput is used to indicate the usage of Avro container files + as output for a MapReduce job.
            + classAvroKeyValueMapReduceJobOutput + +
            +          The class AvroKeyValueMapReduceJobOutput is used to indicate the usage of Avro container files + as output for a MapReduce job.
            + classMapFileMapReduceJobOutput + +
            +          The class MapFileMapReduceJobOutput is used to indicate the usage of Hadoop map files as + output for a MapReduce job.
            + classSequenceFileMapReduceJobOutput + +
            +          The class SequenceFileMapReduceJobOutput is used to indicate the usage of Hadoop + sequence files as output for a MapReduce job.
            + classTextMapReduceJobOutput + +
            +          The class TextMapReduceJobOutput is used to indicate the usage of text files as output + for a MapReduce job.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/HFileMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/HFileMapReduceJobOutput.html new file mode 100644 index 00000000..f20bbc87 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/HFileMapReduceJobOutput.html @@ -0,0 +1,179 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.HFileMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.HFileMapReduceJobOutput

            +
            + + + + + + + + + +
            +Packages that use HFileMapReduceJobOutput
            org.kiji.mapreduce.output.frameworkFramework-level classes supporting KijiMR job output classes. 
            +  +

            + + + + + +
            +Uses of HFileMapReduceJobOutput in org.kiji.mapreduce.output.framework
            +  +

            + + + + + + + + +
            Constructors in org.kiji.mapreduce.output.framework with parameters of type HFileMapReduceJobOutput
            HFileReducerMapReduceJobOutput(HFileMapReduceJobOutput jobOutput) + +
            +          Initializes an instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/MapFileMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/MapFileMapReduceJobOutput.html new file mode 100644 index 00000000..5e2e0d80 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/MapFileMapReduceJobOutput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.MapFileMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.MapFileMapReduceJobOutput

            +
            +No usage of org.kiji.mapreduce.output.MapFileMapReduceJobOutput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/SequenceFileMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/SequenceFileMapReduceJobOutput.html new file mode 100644 index 00000000..b7a8bc5a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/SequenceFileMapReduceJobOutput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.SequenceFileMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.SequenceFileMapReduceJobOutput

            +
            +No usage of org.kiji.mapreduce.output.SequenceFileMapReduceJobOutput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/TextMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/TextMapReduceJobOutput.html new file mode 100644 index 00000000..ae348123 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/class-use/TextMapReduceJobOutput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.TextMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.TextMapReduceJobOutput

            +
            +No usage of org.kiji.mapreduce.output.TextMapReduceJobOutput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/HFileReducerMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/HFileReducerMapReduceJobOutput.html new file mode 100644 index 00000000..0051c202 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/HFileReducerMapReduceJobOutput.html @@ -0,0 +1,327 @@ + + + + + + + +HFileReducerMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output.framework +
            +Class HFileReducerMapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+      extended by org.kiji.mapreduce.output.framework.HFileReducerMapReduceJobOutput
+
            +
            +
            +
            @ApiAudience.Framework
+public class HFileReducerMapReduceJobOutput
            extends MapReduceJobOutput
            + + +

            +M/R job output configuration for a job intending to reduce into HFiles. + + Used for the special case when the user wants a reducer to write HFiles. + Reducers can't write HFiles directly, but must write SequenceFiles that will be post-processed + (sorted) by an identity MapReduce in order to finally write HFiles. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HFileReducerMapReduceJobOutput(HFileMapReduceJobOutput jobOutput) + +
            +          Initializes an instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidconfigure(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the output for a MapReduce job.
            +protected  Class<? extends org.apache.hadoop.mapreduce.OutputFormat>getOutputFormatClass() + +
            +          Gets the Hadoop MapReduce output format class.
            + voidinitialize(Map<String,String> params) + +
            +          Initializes the job output from command-line parameters.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HFileReducerMapReduceJobOutput

            +
            +public HFileReducerMapReduceJobOutput(HFileMapReduceJobOutput jobOutput)
            +
            +
            Initializes an instance. +

            +

            +
            Parameters:
            jobOutput - Wraps this HFile M/R job output.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(Map<String,String> params)
+                throws IOException
            +
            +
            Initializes the job output from command-line parameters. +

            +

            +
            Specified by:
            initialize in class MapReduceJobOutput
            +
            +
            +
            Parameters:
            params - Initialization parameters. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +configure

            +
            +public void configure(org.apache.hadoop.mapreduce.Job job)
+               throws IOException
            +
            +
            Configures the output for a MapReduce job. +

            +

            +
            Overrides:
            configure in class MapReduceJobOutput
            +
            +
            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getOutputFormatClass

            +
            +protected Class<? extends org.apache.hadoop.mapreduce.OutputFormat> getOutputFormatClass()
            +
            +
            Gets the Hadoop MapReduce output format class. +

            +

            +
            Specified by:
            getOutputFormatClass in class MapReduceJobOutput
            +
            +
            + +
            Returns:
            The job output format class.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/KijiHFileOutputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/KijiHFileOutputFormat.html new file mode 100644 index 00000000..868abcd2 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/KijiHFileOutputFormat.html @@ -0,0 +1,424 @@ + + + + + + + +KijiHFileOutputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output.framework +
            +Class KijiHFileOutputFormat

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.OutputFormat<K,V>
+      extended by org.apache.hadoop.mapreduce.lib.output.FileOutputFormat<HFileKeyValue,org.apache.hadoop.io.NullWritable>
+          extended by org.kiji.mapreduce.output.framework.KijiHFileOutputFormat
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiHFileOutputFormat
            extends org.apache.hadoop.mapreduce.lib.output.FileOutputFormat<HFileKeyValue,org.apache.hadoop.io.NullWritable>
            + + +

            +Hadoop output format that writes HFiles that can be loaded directly into HBase region servers. + +

            Allows writing entries to any HBase family of the target table. + Each reduce task generates a set of files per HBase family. + +

            HFile entries must be properly ordered. This is achieved through the shuffle/sort phase + of the M/R job, combined with an identity reducer. + +

            Entries should be partitioned into chunks that fit within an existing region of the target + HTable. + +

            The generated HFiles can be loaded into the target HTable with the + HFileLoader. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_HFILE_BLOCKSIZE + +
            +           
            +static StringCONF_HREGION_MAX_FILESIZE + +
            +           
            +static StringCONF_LATEST_TIMESTAMP + +
            +           
            +static intDEFAULT_HFILE_BLOCKSIZE + +
            +           
            +static longDEFAULT_HREGION_MAX_FILESIZE + +
            +           
            +static StringOUTPUT_EXTENSION + +
            +           
            +  + + + + + + + +
            Fields inherited from class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat
            BASE_OUTPUT_NAME, PART
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiHFileOutputFormat() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + org.apache.hadoop.mapreduce.RecordWriter<HFileKeyValue,org.apache.hadoop.io.NullWritable>getRecordWriter(org.apache.hadoop.mapreduce.TaskAttemptContext context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat
            checkOutputSpecs, getCompressOutput, getDefaultWorkFile, getOutputCommitter, getOutputCompressorClass, getOutputName, getOutputPath, getPathForWorkFile, getUniqueFile, getWorkOutputPath, setCompressOutput, setOutputCompressorClass, setOutputName, setOutputPath
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +OUTPUT_EXTENSION

            +
            +public static final String OUTPUT_EXTENSION
            +
            +
            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_HREGION_MAX_FILESIZE

            +
            +public static final String CONF_HREGION_MAX_FILESIZE
            +
            +
            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULT_HREGION_MAX_FILESIZE

            +
            +public static final long DEFAULT_HREGION_MAX_FILESIZE
            +
            +
            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_HFILE_BLOCKSIZE

            +
            +public static final String CONF_HFILE_BLOCKSIZE
            +
            +
            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULT_HFILE_BLOCKSIZE

            +
            +public static final int DEFAULT_HFILE_BLOCKSIZE
            +
            +
            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_LATEST_TIMESTAMP

            +
            +public static final String CONF_LATEST_TIMESTAMP
            +
            +
            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +KijiHFileOutputFormat

            +
            +public KijiHFileOutputFormat()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getRecordWriter

            +
            +public org.apache.hadoop.mapreduce.RecordWriter<HFileKeyValue,org.apache.hadoop.io.NullWritable> getRecordWriter(org.apache.hadoop.mapreduce.TaskAttemptContext context)
+                                                                                                          throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getRecordWriter in class org.apache.hadoop.mapreduce.lib.output.FileOutputFormat<HFileKeyValue,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/class-use/HFileReducerMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/class-use/HFileReducerMapReduceJobOutput.html new file mode 100644 index 00000000..9084e3d2 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/class-use/HFileReducerMapReduceJobOutput.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.framework.HFileReducerMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.framework.HFileReducerMapReduceJobOutput

            +
            +No usage of org.kiji.mapreduce.output.framework.HFileReducerMapReduceJobOutput +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/class-use/KijiHFileOutputFormat.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/class-use/KijiHFileOutputFormat.html new file mode 100644 index 00000000..efca4de8 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/class-use/KijiHFileOutputFormat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.framework.KijiHFileOutputFormat (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.framework.KijiHFileOutputFormat

            +
            +No usage of org.kiji.mapreduce.output.framework.KijiHFileOutputFormat +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-frame.html new file mode 100644 index 00000000..2c3b5006 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-frame.html @@ -0,0 +1,35 @@ + + + + + + + +org.kiji.mapreduce.output.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.output.framework + + + + +
            +Classes  + +
            +HFileReducerMapReduceJobOutput +
            +KijiHFileOutputFormat
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-summary.html new file mode 100644 index 00000000..4f7ec47a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-summary.html @@ -0,0 +1,178 @@ + + + + + + + +org.kiji.mapreduce.output.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.output.framework +

            +Framework-level classes supporting KijiMR job output classes. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + +
            +Class Summary
            HFileReducerMapReduceJobOutputM/R job output configuration for a job intending to reduce into HFiles.
            KijiHFileOutputFormatHadoop output format that writes HFiles that can be loaded directly into HBase region servers.
            +  + +

            +

            +Package org.kiji.mapreduce.output.framework Description +

            + +

            +Framework-level classes supporting KijiMR job output classes. Applications + should not use these. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-tree.html new file mode 100644 index 00000000..2f68c24c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.mapreduce.output.framework Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.output.framework +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-use.html new file mode 100644 index 00000000..4080abb0 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/framework/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.output.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.output.framework

            +
            +No usage of org.kiji.mapreduce.output.framework +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/KijiTableMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/KijiTableMapReduceJobOutput.html new file mode 100644 index 00000000..25b2114b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/KijiTableMapReduceJobOutput.html @@ -0,0 +1,372 @@ + + + + + + + +KijiTableMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.output.impl +
            +Class KijiTableMapReduceJobOutput

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.MapReduceJobOutput
+      extended by org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput
+
            +
            +
            Direct Known Subclasses:
            DirectKijiTableMapReduceJobOutput, HFileMapReduceJobOutput
            +
            +
            +
            +
            @ApiAudience.Private
+public abstract class KijiTableMapReduceJobOutput
            extends MapReduceJobOutput
            + + +

            +MapReduce job output configuration that outputs to a Kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Constructor Summary
            +protected KijiTableMapReduceJobOutput() + +
            +          Default constructor.
            + KijiTableMapReduceJobOutput(org.kiji.schema.KijiURI tableURI, + int numReduceTasks) + +
            +          Creates a new KijiTableMapReduceJobOutput instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidconfigure(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the output for a MapReduce job.
            + intgetNumReduceTasks() + +
            +           
            + org.kiji.schema.KijiURIgetOutputTableURI() + +
            +           
            + voidinitialize(Map<String,String> params) + +
            +          Initializes the job output from command-line parameters.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.MapReduceJobOutput
            getOutputFormatClass
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableMapReduceJobOutput

            +
            +protected KijiTableMapReduceJobOutput()
            +
            +
            Default constructor. Do not use directly. +

            +

            +
            + +

            +KijiTableMapReduceJobOutput

            +
            +public KijiTableMapReduceJobOutput(org.kiji.schema.KijiURI tableURI,
+                                   int numReduceTasks)
            +
            +
            Creates a new KijiTableMapReduceJobOutput instance. +

            +

            +
            Parameters:
            tableURI - The kiji table to write output to.
            numReduceTasks - The number of reduce tasks to use (use zero if using a producer).
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(Map<String,String> params)
+                throws IOException
            +
            +
            Initializes the job output from command-line parameters. +

            +

            +
            Specified by:
            initialize in class MapReduceJobOutput
            +
            +
            +
            Parameters:
            params - Initialization parameters. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getNumReduceTasks

            +
            +public int getNumReduceTasks()
            +
            +
            + +
            Returns:
            the number of reducers.
            +
            +
            +
            + +

            +getOutputTableURI

            +
            +public org.kiji.schema.KijiURI getOutputTableURI()
            +
            +
            + +
            Returns:
            the URI of the configured output table.
            +
            +
            +
            + +

            +configure

            +
            +public void configure(org.apache.hadoop.mapreduce.Job job)
+               throws IOException
            +
            +
            Configures the output for a MapReduce job. +

            +

            +
            Overrides:
            configure in class MapReduceJobOutput
            +
            +
            +
            Parameters:
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/class-use/KijiTableMapReduceJobOutput.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/class-use/KijiTableMapReduceJobOutput.html new file mode 100644 index 00000000..6a6f2a1a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/class-use/KijiTableMapReduceJobOutput.html @@ -0,0 +1,249 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.output.impl.KijiTableMapReduceJobOutput

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiTableMapReduceJobOutput
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.outputMapReduce job output types. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            +  +

            + + + + + +
            +Uses of KijiTableMapReduceJobOutput in org.kiji.mapreduce.bulkimport
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.bulkimport with parameters of type KijiTableMapReduceJobOutput
            + KijiBulkImportJobBuilderKijiBulkImportJobBuilder.withOutput(KijiTableMapReduceJobOutput jobOutput) + +
            +          Configures the bulk-importer output Kiji table.
            +  +

            + + + + + +
            +Uses of KijiTableMapReduceJobOutput in org.kiji.mapreduce.output
            +  +

            + + + + + + + + + + + + + +
            Subclasses of KijiTableMapReduceJobOutput in org.kiji.mapreduce.output
            + classDirectKijiTableMapReduceJobOutput + +
            +          The class DirectKijiTableMapReduceJobOutput is used to indicate the usage of a Kiji table + as an output for a MapReduce job.
            + classHFileMapReduceJobOutput + +
            +          The class HFileMapReduceJobOutput is used to indicate the usage of HFiles based on the layout + of a Kiji table as output for a MapReduce job.
            +  +

            + + + + + +
            +Uses of KijiTableMapReduceJobOutput in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce with parameters of type KijiTableMapReduceJobOutput
            + KijiProduceJobBuilderKijiProduceJobBuilder.withOutput(KijiTableMapReduceJobOutput jobOutput) + +
            +          Configures the producer output.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-frame.html new file mode 100644 index 00000000..b7b3939f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.kiji.mapreduce.output.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.output.impl + + + + +
            +Classes  + +
            +KijiTableMapReduceJobOutput
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-summary.html new file mode 100644 index 00000000..b13d752e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-summary.html @@ -0,0 +1,174 @@ + + + + + + + +org.kiji.mapreduce.output.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.output.impl +

            +Implementation details for KijiMR's Hadoop output classes. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Class Summary
            KijiTableMapReduceJobOutputMapReduce job output configuration that outputs to a Kiji table.
            +  + +

            +

            +Package org.kiji.mapreduce.output.impl Description +

            + +

            +Implementation details for KijiMR's Hadoop output classes. Clients + should not use these. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-tree.html new file mode 100644 index 00000000..f94450fa --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-tree.html @@ -0,0 +1,156 @@ + + + + + + + +org.kiji.mapreduce.output.impl Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.output.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-use.html new file mode 100644 index 00000000..ea2eff5a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/impl/package-use.html @@ -0,0 +1,209 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.output.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.output.impl

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.output.impl
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.outputMapReduce job output types. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.output.impl used by org.kiji.mapreduce.bulkimport
            KijiTableMapReduceJobOutput + +
            +          MapReduce job output configuration that outputs to a Kiji table.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.output.impl used by org.kiji.mapreduce.output
            KijiTableMapReduceJobOutput + +
            +          MapReduce job output configuration that outputs to a Kiji table.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.output.impl used by org.kiji.mapreduce.produce
            KijiTableMapReduceJobOutput + +
            +          MapReduce job output configuration that outputs to a Kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-frame.html new file mode 100644 index 00000000..a7808ed0 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-frame.html @@ -0,0 +1,47 @@ + + + + + + + +org.kiji.mapreduce.output (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.output + + + + +
            +Classes  + +
            +AvroKeyMapReduceJobOutput +
            +AvroKeyValueMapReduceJobOutput +
            +DirectKijiTableMapReduceJobOutput +
            +FileMapReduceJobOutput +
            +HFileMapReduceJobOutput +
            +MapFileMapReduceJobOutput +
            +SequenceFileMapReduceJobOutput +
            +TextMapReduceJobOutput
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-summary.html new file mode 100644 index 00000000..853d5089 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-summary.html @@ -0,0 +1,228 @@ + + + + + + + +org.kiji.mapreduce.output (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.output +

            +MapReduce job output types. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AvroKeyMapReduceJobOutputThe class AvroKeyMapReduceJobOutput is used to indicate the usage of Avro container files + as output for a MapReduce job.
            AvroKeyValueMapReduceJobOutputThe class AvroKeyValueMapReduceJobOutput is used to indicate the usage of Avro container files + as output for a MapReduce job.
            DirectKijiTableMapReduceJobOutputThe class DirectKijiTableMapReduceJobOutput is used to indicate the usage of a Kiji table + as an output for a MapReduce job.
            FileMapReduceJobOutputBase class for MapReduce job output types that write to files.
            HFileMapReduceJobOutputThe class HFileMapReduceJobOutput is used to indicate the usage of HFiles based on the layout + of a Kiji table as output for a MapReduce job.
            MapFileMapReduceJobOutputThe class MapFileMapReduceJobOutput is used to indicate the usage of Hadoop map files as + output for a MapReduce job.
            SequenceFileMapReduceJobOutputThe class SequenceFileMapReduceJobOutput is used to indicate the usage of Hadoop + sequence files as output for a MapReduce job.
            TextMapReduceJobOutputThe class TextMapReduceJobOutput is used to indicate the usage of text files as output + for a MapReduce job.
            +  + +

            +

            +Package org.kiji.mapreduce.output Description +

            + +

            +MapReduce job output types. + +

            + MapReduceJobOutput is the base type for classes that can act + as outputs to a MapReduce job for jobs that are created using a + MapReduceJobBuilder. +

            + +

            Usable KijiMR output types

            +
          • AvroKeyMapReduceJobOutput - Avro container files containing + keys as output.
            • +
          • AvroKeyValueMapReduceJobOutput - Avro container files + containing key value pairs as output.
            • +
          • DirectKijiTableMapReduceJobOutput - Kiji table as + output
            • +
          • HFileMapReduceJobOutput - HFile as output.
            • +
          • MapFileMapReduceJobOutput - Hadoop map files as + output
            • +
          • SequenceFileMapReduceJobOutput - Hadoop sequence files as + output
            • +
          • TextMapReduceJobOutput - text files as output
            • +

            + +

            +

            +
            See Also:
            MapReduceJobBuilder
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-tree.html new file mode 100644 index 00000000..bb5fab9c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.mapreduce.output Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.output +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-use.html new file mode 100644 index 00000000..4a447c40 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/output/package-use.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.output (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.output

            +
            + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.output
            org.kiji.mapreduce.outputMapReduce job output types. 
            org.kiji.mapreduce.output.frameworkFramework-level classes supporting KijiMR job output classes. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.output used by org.kiji.mapreduce.output
            FileMapReduceJobOutput + +
            +          Base class for MapReduce job output types that write to files.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.output used by org.kiji.mapreduce.output.framework
            HFileMapReduceJobOutput + +
            +          The class HFileMapReduceJobOutput is used to indicate the usage of HFiles based on the layout + of a Kiji table as output for a MapReduce job.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-frame.html new file mode 100644 index 00000000..776a99ca --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-frame.html @@ -0,0 +1,79 @@ + + + + + + + +org.kiji.mapreduce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce + + + + +
            +Interfaces  + +
            +KijiContext +
            +KijiDataRequester +
            +KijiTableContext +
            +KVOutputJob
            + + + + + + +
            +Classes  + +
            +DistributedCacheJars +
            +HFileLoader +
            +KijiMapper +
            +KijiMapReduceJobBuilder +
            +KijiReducer +
            +KijiTableReducer +
            +MapReduceJob +
            +MapReduceJob.Status +
            +MapReduceJobInput +
            +MapReduceJobOutput
            + + + + + + +
            +Exceptions  + +
            +JobConfigurationException
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-summary.html new file mode 100644 index 00000000..4c948d7f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-summary.html @@ -0,0 +1,273 @@ + + + + + + + +org.kiji.mapreduce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce +

            +KijiMR utilities. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + +
            +Interface Summary
            KijiContextInterface for contexts passed to KijiMR methods.
            KijiDataRequesterInterface for classes that specify a set of columns to read from a kiji table.
            KijiTableContextContext for Kiji bulk-importers or reducers to output to a Kiji table.
            KVOutputJobBase interface for tasks that emit (key, value) pairs.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            DistributedCacheJarsUtility class for dealing with Java JAR files and the hadoop distributed cache.
            HFileLoaderLoads HFiles generated by a MapReduce job into a Kiji table.
            KijiMapper<INKEY,INVALUE,OUTKEY,OUTVALUE>Base class for Kiji mappers.
            KijiMapReduceJobBuilderBuilds general MapReduce jobs around Kiji mappers and reducers.
            KijiReducer<INKEY,INVALUE,OUTKEY,OUTVALUE>Base class for Kiji reducer.
            KijiTableReducer<K,V>Base class for reducers that emit to a Kiji table.
            MapReduceJobA Hadoop MapReduce job that runs Kiji mappers and reducers.
            MapReduceJob.StatusThe status of a job that was started asynchronously using MapReduceJob.submit().
            MapReduceJobInputBase class for types of input to a MapReduce job.
            MapReduceJobOutputDescribe class MapReduceJobOutput here.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            JobConfigurationExceptionThrown when a MapReduceJob is being built, but it has missing or incomplete configuration.
            +  + +

            +

            +Package org.kiji.mapreduce Description +

            + +

            +KijiMR utilities. + +

            + KijiMR includes APIs to build MapReduce jobs that run over Kiji tables, bringing + MapReduce-based analytic techniques to a broad base of Kiji Schema users. +

            + +

            Building MapReduce jobs:

            +

            + KijiMR contains many job builders for various types of MapReduce jobs. +

            +
          • Bulk Importers - for the creation of bulk + import jobs which allow data to be inserted into Kiji tables efficiently. +
          • Producers - for the creation of produce jobs + which generate per-row derived entity data. +
          • Gatherers - for the creation of gather jobs + which scan over the rows of a Kiji table to aggregate information which can be passed to a + reducer. +
          • General MapReduce - for the creation of + general MapReduce jobs around Kiji mappers and reducers.
            • + +

            Utility packages for MapReduce job construction:

            +
          • org.kiji.mapreduce.input - input formats for MapReduce jobs
            • +
          • org.kiji.mapreduce.output - output formats for MapReduce jobs
            • +
          • org.kiji.mapreduce.kvstore - Key-Value store API used in MapReduce jobs
            • +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-tree.html new file mode 100644 index 00000000..761fc753 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-tree.html @@ -0,0 +1,196 @@ + + + + + + + +org.kiji.mapreduce Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-use.html new file mode 100644 index 00000000..519bdb3e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/package-use.html @@ -0,0 +1,708 @@ + + + + + + + +Uses of Package org.kiji.mapreduce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce
            org.kiji.mapreduceKijiMR utilities. 
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients. 
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers. 
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes. 
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients. 
            org.kiji.mapreduce.gather.implKiji gatherer implementation details. 
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes. 
            org.kiji.mapreduce.inputMapReduce job input types. 
            org.kiji.mapreduce.outputMapReduce job output types. 
            org.kiji.mapreduce.output.frameworkFramework-level classes supporting KijiMR job output classes. 
            org.kiji.mapreduce.output.implImplementation details for KijiMR's Hadoop output classes. 
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            org.kiji.mapreduce.reducerBasic identity reducer which is required for KijiMR jobs. 
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce
            HFileLoader + +
            +          Loads HFiles generated by a MapReduce job into a Kiji table.
            KijiContext + +
            +          Interface for contexts passed to KijiMR methods.
            KijiMapper + +
            +          Base class for Kiji mappers.
            KijiMapReduceJobBuilder + +
            +          Builds general MapReduce jobs around Kiji mappers and reducers.
            KijiReducer + +
            +          Base class for Kiji reducer.
            KijiTableContext + +
            +          Context for Kiji bulk-importers or reducers to output to a Kiji table.
            KVOutputJob + +
            +          Base interface for tasks that emit (key, value) pairs.
            MapReduceJob + +
            +          A Hadoop MapReduce job that runs Kiji mappers and reducers.
            MapReduceJob.Status + +
            +          The status of a job that was started asynchronously using MapReduceJob.submit().
            MapReduceJobInput + +
            +          Base class for types of input to a MapReduce job.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.bulkimport
            KijiMapper + +
            +          Base class for Kiji mappers.
            KijiReducer + +
            +          Base class for Kiji reducer.
            KijiTableContext + +
            +          Context for Kiji bulk-importers or reducers to output to a Kiji table.
            MapReduceJob + +
            +          A Hadoop MapReduce job that runs Kiji mappers and reducers.
            MapReduceJobInput + +
            +          Base class for types of input to a MapReduce job.
            MapReduceJobOutput + +
            +          Describe class MapReduceJobOutput here.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.bulkimport.impl
            KijiMapper + +
            +          Base class for Kiji mappers.
            KVOutputJob + +
            +          Base interface for tasks that emit (key, value) pairs.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.framework
            KijiMapper + +
            +          Base class for Kiji mappers.
            KijiReducer + +
            +          Base class for Kiji reducer.
            MapReduceJob + +
            +          A Hadoop MapReduce job that runs Kiji mappers and reducers.
            MapReduceJob.Status + +
            +          The status of a job that was started asynchronously using MapReduceJob.submit().
            MapReduceJobInput + +
            +          Base class for types of input to a MapReduce job.
            MapReduceJobOutput + +
            +          Describe class MapReduceJobOutput here.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.gather
            KijiContext + +
            +          Interface for contexts passed to KijiMR methods.
            KijiDataRequester + +
            +          Interface for classes that specify a set of columns to read from a kiji table.
            KijiMapper + +
            +          Base class for Kiji mappers.
            KijiReducer + +
            +          Base class for Kiji reducer.
            KVOutputJob + +
            +          Base interface for tasks that emit (key, value) pairs.
            MapReduceJob + +
            +          A Hadoop MapReduce job that runs Kiji mappers and reducers.
            +  +

            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.gather.impl
            KijiContext + +
            +          Interface for contexts passed to KijiMR methods.
            KijiDataRequester + +
            +          Interface for classes that specify a set of columns to read from a kiji table.
            KijiMapper + +
            +          Base class for Kiji mappers.
            KVOutputJob + +
            +          Base interface for tasks that emit (key, value) pairs.
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.impl
            KijiContext + +
            +          Interface for contexts passed to KijiMR methods.
            KijiDataRequester + +
            +          Interface for classes that specify a set of columns to read from a kiji table.
            KijiMapper + +
            +          Base class for Kiji mappers.
            KijiTableContext + +
            +          Context for Kiji bulk-importers or reducers to output to a Kiji table.
            KVOutputJob + +
            +          Base interface for tasks that emit (key, value) pairs.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.input
            MapReduceJobInput + +
            +          Base class for types of input to a MapReduce job.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.output
            MapReduceJobOutput + +
            +          Describe class MapReduceJobOutput here.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.output.framework
            MapReduceJobOutput + +
            +          Describe class MapReduceJobOutput here.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.output.impl
            MapReduceJobOutput + +
            +          Describe class MapReduceJobOutput here.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.produce
            KijiContext + +
            +          Interface for contexts passed to KijiMR methods.
            KijiDataRequester + +
            +          Interface for classes that specify a set of columns to read from a kiji table.
            KijiMapper + +
            +          Base class for Kiji mappers.
            KijiReducer + +
            +          Base class for Kiji reducer.
            MapReduceJob + +
            +          A Hadoop MapReduce job that runs Kiji mappers and reducers.
            MapReduceJobOutput + +
            +          Describe class MapReduceJobOutput here.
            +  +

            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.produce.impl
            KijiContext + +
            +          Interface for contexts passed to KijiMR methods.
            KijiDataRequester + +
            +          Interface for classes that specify a set of columns to read from a kiji table.
            KijiMapper + +
            +          Base class for Kiji mappers.
            KVOutputJob + +
            +          Base interface for tasks that emit (key, value) pairs.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.reducer
            KijiReducer + +
            +          Base class for Kiji reducer.
            KVOutputJob + +
            +          Base interface for tasks that emit (key, value) pairs.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.tools
            KijiMapReduceJobBuilder + +
            +          Builds general MapReduce jobs around Kiji mappers and reducers.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce used by org.kiji.mapreduce.tools.framework
            MapReduceJobInput + +
            +          Base class for types of input to a MapReduce job.
            MapReduceJobOutput + +
            +          Describe class MapReduceJobOutput here.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/KijiProduceJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/KijiProduceJobBuilder.html new file mode 100644 index 00000000..cfa7c54d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/KijiProduceJobBuilder.html @@ -0,0 +1,611 @@ + + + + + + + +KijiProduceJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.produce +
            +Class KijiProduceJobBuilder

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.framework.MapReduceJobBuilder<T>
+      extended by org.kiji.mapreduce.framework.KijiTableInputJobBuilder<KijiProduceJobBuilder>
+          extended by org.kiji.mapreduce.produce.KijiProduceJobBuilder
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiProduceJobBuilder
            extends KijiTableInputJobBuilder<KijiProduceJobBuilder>
            + + +

            +Builds jobs that run a producer over a Kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  MapReduceJobbuild(org.apache.hadoop.mapreduce.Job job) + +
            +          Wraps a Hadoop MR job in a MapReduceJob.
            +protected  voidconfigureJob(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures a Hadoop MR job.
            +protected  voidconfigureMapper(org.apache.hadoop.mapreduce.Job job) + +
            +          Configures the MapReduce mapper for the job.
            +static KijiProduceJobBuildercreate() + +
            +          Creates a new builder for Kiji produce jobs.
            +protected  KijiReducer<?,?,?,?>getCombiner() + +
            +          Gets an instance of the MapReduce combiner to be used for this job.
            +protected  org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          Subclasses must override this to provide a Kiji data request for the input table.
            +protected  Class<?>getJarClass() + +
            +          Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks.
            +protected  KijiMapper<?,?,?,?>getMapper() + +
            +          Gets an instance of the MapReduce mapper to be used for this job.
            +protected  KijiReducer<?,?,?,?>getReducer() + +
            +          Gets an instance of the MapReduce reducer to be used for this job.
            +protected  Map<String,KeyValueStore<?,?>>getRequiredStores() + +
            +          Method for job components to declare required KeyValueStore entries (and their default + implementations).
            +protected  voidvalidateInputTable(org.kiji.schema.KijiTable inputTable) + +
            +          Validates the input table.
            + KijiProduceJobBuilderwithNumThreads(int numThreads) + +
            +          Sets the number of threads to use for running the producer in parallel.
            + KijiProduceJobBuilderwithOutput(KijiTableMapReduceJobOutput jobOutput) + +
            +          Configures the producer output.
            + KijiProduceJobBuilderwithOutput(MapReduceJobOutput jobOutput) + +
            +          Configures the job output.
            + KijiProduceJobBuilderwithProducer(Class<? extends KijiProducer> producerClass) + +
            +          Configures the job with the Kiji producer to run.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.framework.KijiTableInputJobBuilder
            getInputTableURI, getJobInput, withFilter, withInputTable, withJobInput, withLimitRow, withStartRow
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.framework.MapReduceJobBuilder
            addJarDirectory, addJarDirectory, build, configureAvro, configureCombiner, configureHTableInput, configureInput, configureJars, configureOutput, configureReducer, configureStores, getConf, getJobOutput, mergeStores, withConf, withStore, withStoreBindings, withStoreBindingsFile
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiProduceJobBuilder create()
            +
            +
            Creates a new builder for Kiji produce jobs. +

            +

            + +
            Returns:
            a new Kiji produce job builder.
            +
            +
            +
            + +

            +withProducer

            +
            +public KijiProduceJobBuilder withProducer(Class<? extends KijiProducer> producerClass)
            +
            +
            Configures the job with the Kiji producer to run. +

            +

            +
            Parameters:
            producerClass - The producer class. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withOutput

            +
            +public KijiProduceJobBuilder withOutput(KijiTableMapReduceJobOutput jobOutput)
            +
            +
            Configures the producer output. +

            +

            +
            Parameters:
            jobOutput - Output table of the producer must match the input table. +
            Returns:
            this builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withOutput

            +
            +public KijiProduceJobBuilder withOutput(MapReduceJobOutput jobOutput)
            +
            +
            Configures the job output. +

            +

            +
            Overrides:
            withOutput in class MapReduceJobBuilder<KijiProduceJobBuilder>
            +
            +
            +
            Parameters:
            jobOutput - Output table of the producer must match the input table. Must be an instance + of KijiTableMapReduceJobOutput or a subclass. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withNumThreads

            +
            +public KijiProduceJobBuilder withNumThreads(int numThreads)
            +
            +
            Sets the number of threads to use for running the producer in parallel. + +

            You may use this setting to run multiple instances of your producer in parallel + within each map task of the job. This may useful for increasing throughput when your + producer is not CPU bound.

            +

            +

            +
            Parameters:
            numThreads - The number of produce-runner threads to use per mapper. +
            Returns:
            This build instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +configureJob

            +
            +protected void configureJob(org.apache.hadoop.mapreduce.Job job)
+                     throws IOException
            +
            +
            Configures a Hadoop MR job. +

            +

            +
            Overrides:
            configureJob in class KijiTableInputJobBuilder<KijiProduceJobBuilder>
            +
            +
            +
            Parameters:
            job - The Hadoop MR job. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +configureMapper

            +
            +protected void configureMapper(org.apache.hadoop.mapreduce.Job job)
+                        throws IOException
            +
            +
            Configures the MapReduce mapper for the job. +

            +

            +
            Overrides:
            configureMapper in class MapReduceJobBuilder<KijiProduceJobBuilder>
            +
            +
            +
            Parameters:
            job - The Hadoop MR job. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getRequiredStores

            +
            +protected Map<String,KeyValueStore<?,?>> getRequiredStores()
+                                                    throws IOException
            +
            +
            Method for job components to declare required KeyValueStore entries (and their default + implementations). +

            +

            +
            Overrides:
            getRequiredStores in class MapReduceJobBuilder<KijiProduceJobBuilder>
            +
            +
            + +
            Returns:
            a map of required names to default KeyValueStore implementations to add. These will + be used to augment the existing map if any names are not defined by withStore(). +
            Throws: +
            IOException - if there is an error configuring stores.
            +
            +
            +
            + +

            +build

            +
            +protected MapReduceJob build(org.apache.hadoop.mapreduce.Job job)
            +
            +
            Wraps a Hadoop MR job in a MapReduceJob. +

            +

            +
            Specified by:
            build in class MapReduceJobBuilder<KijiProduceJobBuilder>
            +
            +
            +
            Parameters:
            job - The Hadoop MR job. +
            Returns:
            The built MapReduceJob.
            +
            +
            +
            + +

            +getDataRequest

            +
            +protected org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            Subclasses must override this to provide a Kiji data request for the input table. +

            +

            +
            Specified by:
            getDataRequest in class KijiTableInputJobBuilder<KijiProduceJobBuilder>
            +
            +
            + +
            Returns:
            the Kiji data request to configure the input table scanner with.
            +
            +
            +
            + +

            +validateInputTable

            +
            +protected void validateInputTable(org.kiji.schema.KijiTable inputTable)
+                           throws IOException
            +
            +
            Validates the input table. + + Sub-classes may override this method to perform additional validation requiring an active + connection to the input table. +

            +

            +
            Overrides:
            validateInputTable in class KijiTableInputJobBuilder<KijiProduceJobBuilder>
            +
            +
            +
            Parameters:
            inputTable - Input table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getMapper

            +
            +protected KijiMapper<?,?,?,?> getMapper()
            +
            +
            Gets an instance of the MapReduce mapper to be used for this job. +

            +

            +
            Specified by:
            getMapper in class MapReduceJobBuilder<KijiProduceJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the mapper.
            +
            +
            +
            + +

            +getCombiner

            +
            +protected KijiReducer<?,?,?,?> getCombiner()
            +
            +
            Gets an instance of the MapReduce combiner to be used for this job. +

            +

            +
            Specified by:
            getCombiner in class MapReduceJobBuilder<KijiProduceJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the combiner, or null if this job should not use a combiner.
            +
            +
            +
            + +

            +getReducer

            +
            +protected KijiReducer<?,?,?,?> getReducer()
            +
            +
            Gets an instance of the MapReduce reducer to be used for this job. +

            +

            +
            Specified by:
            getReducer in class MapReduceJobBuilder<KijiProduceJobBuilder>
            +
            +
            + +
            Returns:
            An instance of the reducer, or null if this job should be map-only.
            +
            +
            +
            + +

            +getJarClass

            +
            +protected Class<?> getJarClass()
            +
            +
            Returns a class that should be used to determine which Java jar archive will be + automatically included on the classpath of the MR tasks. +

            +

            +
            Specified by:
            getJarClass in class MapReduceJobBuilder<KijiProduceJobBuilder>
            +
            +
            + +
            Returns:
            A class contained in the jar to be included on the MR classpath.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/KijiProducer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/KijiProducer.html new file mode 100644 index 00000000..0aa637b1 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/KijiProducer.html @@ -0,0 +1,514 @@ + + + + + + + +KijiProducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.produce +
            +Class KijiProducer

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.produce.KijiProducer
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, KijiDataRequester, KeyValueStoreClient
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KijiProducer
            extends Object
            implements org.apache.hadoop.conf.Configurable, KijiDataRequester, KeyValueStoreClient
            + + +

            +

            + Base class for all Kiji Producers used to generate per-row derived + entity data. +

            + +

            Lifecycle:

            + +

            + Instances are created using ReflectionUtils, so the Configuration is automagically set immediately after + instantiation with a call to setConf(). In order to initialize internal state + before any other methods are called, override the setConf() method. +

            + +

            + As a KeyValueStoreClient, KijiProducers will have access to all + stores defined by KeyValueStoreClient.getRequiredStores(). Readers for + these stores are surfaced in the setup(), produce(), and cleanup() methods + via the Context provided to each by calling KijiContext.getStore(String). +

            + +

            + Once the internal state is set, functions may be called in any order, except for + restrictions on setup(), produce(), and cleanup(). +

            + +

            + setup() will get called once at the beginning of the map phase, followed by + a call to produce() for each input row. Once all of these produce() + calls have completed, cleanup() will be called exactly once. It is possible + that this setup-produce-cleanup cycle may repeat any number of times. +

            + +

            + A final guarantee is that setup(), produce(), and cleanup() will be called after + getDataRequest() and getOutputColumn() have each been called at least once. +

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiProducer() + +
            +          Your subclass of KijiProducer must have a default constructor if it is to be used in a + KijiProduceJob.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidcleanup(KijiContext context) + +
            +          Called once to clean up this producer after all + produce(KijiRowData, ProducerContext) calls are made.
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +          
            +abstract  org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          Returns a KijiDataRequest that describes which input columns need to be available to + the producer.
            +abstract  StringgetOutputColumn() + +
            +          Return the name of the output column.
            + Map<String,KeyValueStore<?,?>>getRequiredStores() + +
            +          Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations.
            +abstract  voidproduce(org.kiji.schema.KijiRowData input, + ProducerContext context) + +
            +          Called to compute derived data for a single entity.
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          Sets the Configuration for this KijiProducer to use.
            + voidsetup(KijiContext context) + +
            +          Called once to initialize this producer before any calls to + produce(KijiRowData, ProducerContext).
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiProducer

            +
            +public KijiProducer()
            +
            +
            Your subclass of KijiProducer must have a default constructor if it is to be used in a + KijiProduceJob. The constructors should be lightweight, since the framework is free to + create KijiProducers at any time. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            Sets the Configuration for this KijiProducer to use. + This function is guaranteed to be called immediately after instantiation. + Override this method to initialize internal state from a configuration. +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            Parameters:
            conf - The Configuration to read.
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getDataRequest

            +
            +public abstract org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            Returns a KijiDataRequest that describes which input columns need to be available to + the producer. This method may be called multiple times, perhaps before setup(KijiContext). +

            +

            +
            Specified by:
            getDataRequest in interface KijiDataRequester
            +
            +
            + +
            Returns:
            a kiji data request.
            +
            +
            +
            + +

            +getRequiredStores

            +
            +public Map<String,KeyValueStore<?,?>> getRequiredStores()
            +
            +

            Returns a mapping that specifies the names of all key-value stores that must be loaded + to execute this component, and default KeyValueStore definitions that can be + used if the user does not specify alternate locations/implementations. + It is an error for any of these default implementations to be null. + If you want to defer KeyValueStore definition to runtime, bind a name + to the UnconfiguredKeyValueStore instead.

            + +

            Note that this method returns default mappings from store names to + concrete implementations. Users may override these mappings, e.g. in MapReduce job + configuration. You should not open a store returned by + getRequiredStores() directly; you should look to a + Context object or similar mechanism exposed by the Kiji framework to + determine the actual KeyValueStoreReader instance to use.

            +

            +

            +
            Specified by:
            getRequiredStores in interface KeyValueStoreClient
            +
            +
            + +
            Returns:
            a map from store names to default KeyValueStore implementations.
            +
            +
            +
            + +

            +getOutputColumn

            +
            +public abstract String getOutputColumn()
            +
            +
            Return the name of the output column. An output column is of the form "family" or + "family:qualifier". Family columns can store key/value pairs. A qualifier column + may only contain a single piece of data. +

            +

            +
            +
            +
            + +
            Returns:
            the output column name.
            +
            +
            +
            + +

            +setup

            +
            +public void setup(KijiContext context)
+           throws IOException
            +
            +
            Called once to initialize this producer before any calls to + produce(KijiRowData, ProducerContext). +

            +

            +
            +
            +
            +
            Parameters:
            context - The KijiContext providing access to KeyValueStores, Counters, etc. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +produce

            +
            +public abstract void produce(org.kiji.schema.KijiRowData input,
+                             ProducerContext context)
+                      throws IOException
            +
            +
            Called to compute derived data for a single entity. The input that is included is controlled + by the KijiDataRequest returned in getDataRequest(). +

            +

            +
            +
            +
            +
            Parameters:
            input - The requested input data for the entity.
            context - The producer context, used to output derived data. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +cleanup

            +
            +public void cleanup(KijiContext context)
+             throws IOException
            +
            +
            Called once to clean up this producer after all + produce(KijiRowData, ProducerContext) calls are made. +

            +

            +
            +
            +
            +
            Parameters:
            context - The KijiContext providing access to KeyValueStores, Counters, etc. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/KijiProducerOutputException.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/KijiProducerOutputException.html new file mode 100644 index 00000000..f4f0883f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/KijiProducerOutputException.html @@ -0,0 +1,251 @@ + + + + + + + +KijiProducerOutputException (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.produce +
            +Class KijiProducerOutputException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.mapreduce.produce.KijiProducerOutputException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiProducerOutputException
            extends IOException
            + + +

            +Thrown when a KijiProducer fails to produce output. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiProducerOutputException(String message) + +
            +          Creates a new KijiProducerOutputException instance.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiProducerOutputException

            +
            +public KijiProducerOutputException(String message)
            +
            +
            Creates a new KijiProducerOutputException instance. +

            +

            +
            Parameters:
            message - An exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/ProducerContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/ProducerContext.html new file mode 100644 index 00000000..f89e2afd --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/ProducerContext.html @@ -0,0 +1,405 @@ + + + + + + + +ProducerContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.produce +
            +Interface ProducerContext

            +
            +
            All Superinterfaces:
            Closeable, Flushable, KijiContext
            +
            +
            +
            All Known Subinterfaces:
            InternalProducerContextInterface
            +
            +
            +
            All Known Implementing Classes:
            InternalProducerContext
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface ProducerContext
            extends KijiContext
            + + +

            +Context for producers to output new cells in the currently processed row. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.kiji.schema.EntityIdgetEntityId() + +
            +           
            + + + + + +
            +<T> void
            +            		put(long timestamp, + T value) + +
            +          Outputs a new cell to the configured output column.
            + + + + + +
            +<T> void
            +            		put(String qualifier, + long timestamp, + T value) + +
            +          Outputs a new cell to the configured output column.
            + + + + + +
            +<T> void
            +            		put(String qualifier, + T value) + +
            +          Outputs a new cell to the configured output column with the current timestamp.
            + + + + + +
            +<T> void
            +            		put(T value) + +
            +          Outputs a new cell to the configured output column with the current timestamp.
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KijiContext
            getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEntityId

            +
            +org.kiji.schema.EntityId getEntityId()
            +
            +
            +
            +
            +
            + +
            Returns:
            the entity ID of the row being currently written to.
            +
            +
            +
            + +

            +put

            +
            +<T> void put(T value)
+         throws IOException
            +
            +
            Outputs a new cell to the configured output column with the current timestamp. + + Valid only when the producer is configured to output to a single column. +

            +

            +
            +
            +
            +
            Type Parameters:
            T - Type of the value to emit.
            Parameters:
            value - Value to write. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +put

            +
            +<T> void put(long timestamp,
+             T value)
+         throws IOException
            +
            +
            Outputs a new cell to the configured output column. + + Valid only when the producer is configured to output to a single column. +

            +

            +
            +
            +
            +
            Type Parameters:
            T - Type of the value to emit.
            Parameters:
            timestamp - Timestamp of the cell to write.
            value - Value to write. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +put

            +
            +<T> void put(String qualifier,
+             T value)
+         throws IOException
            +
            +
            Outputs a new cell to the configured output column with the current timestamp. + + Valid only when the producer is configured to output to a map-type family. +

            +

            +
            +
            +
            +
            Type Parameters:
            T - Type of the value to emit.
            Parameters:
            qualifier - Qualifier of the cell to output.
            value - Value of the cell to output. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +put

            +
            +<T> void put(String qualifier,
+             long timestamp,
+             T value)
+         throws IOException
            +
            +
            Outputs a new cell to the configured output column. + + Valid only when the producer is configured to output to a map-type family. +

            +

            +
            +
            +
            +
            Type Parameters:
            T - Type of the value to emit.
            Parameters:
            qualifier - Qualifier of the cell to output.
            timestamp - Timestamp of the cell to write.
            value - Value of the cell to output. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/KijiProduceJobBuilder.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/KijiProduceJobBuilder.html new file mode 100644 index 00000000..03959bb4 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/KijiProduceJobBuilder.html @@ -0,0 +1,258 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.produce.KijiProduceJobBuilder (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.produce.KijiProduceJobBuilder

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiProduceJobBuilder
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            +  +

            + + + + + +
            +Uses of KijiProduceJobBuilder in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce that return KijiProduceJobBuilder
            +static KijiProduceJobBuilderKijiProduceJobBuilder.create() + +
            +          Creates a new builder for Kiji produce jobs.
            + KijiProduceJobBuilderKijiProduceJobBuilder.withNumThreads(int numThreads) + +
            +          Sets the number of threads to use for running the producer in parallel.
            + KijiProduceJobBuilderKijiProduceJobBuilder.withOutput(KijiTableMapReduceJobOutput jobOutput) + +
            +          Configures the producer output.
            + KijiProduceJobBuilderKijiProduceJobBuilder.withOutput(MapReduceJobOutput jobOutput) + +
            +          Configures the job output.
            + KijiProduceJobBuilderKijiProduceJobBuilder.withProducer(Class<? extends KijiProducer> producerClass) + +
            +          Configures the job with the Kiji producer to run.
            +  +

            + + + + + +
            +Uses of KijiProduceJobBuilder in org.kiji.mapreduce.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools that return KijiProduceJobBuilder
            +protected  KijiProduceJobBuilderKijiProduce.createJobBuilder() + +
            +          Creates a new job builder.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools with parameters of type KijiProduceJobBuilder
            +protected  voidKijiProduce.configure(KijiProduceJobBuilder jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/KijiProducer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/KijiProducer.html new file mode 100644 index 00000000..6e033cb1 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/KijiProducer.html @@ -0,0 +1,229 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.produce.KijiProducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.produce.KijiProducer

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiProducer
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + +
            +Uses of KijiProducer in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.mapreduce.produce with type arguments of type KijiProducer
            + KijiProduceJobBuilderKijiProduceJobBuilder.withProducer(Class<? extends KijiProducer> producerClass) + +
            +          Configures the job with the Kiji producer to run.
            +  +

            + + + + + +
            +Uses of KijiProducer in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce.impl that return KijiProducer
            +static KijiProducerKijiProducers.create(org.apache.hadoop.conf.Configuration conf) + +
            +          Creates an instance of the producer specified by the + Configuration.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce.impl with parameters of type KijiProducer
            +static voidKijiProducers.validateOutputColumn(KijiProducer producer, + org.kiji.schema.layout.KijiTableLayout tableLayout) + +
            +          Makes sure the producer's requested output column exists in the + kiji table layout.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/KijiProducerOutputException.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/KijiProducerOutputException.html new file mode 100644 index 00000000..09a3eafa --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/KijiProducerOutputException.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.produce.KijiProducerOutputException (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.produce.KijiProducerOutputException

            +
            + + + + + + + + + +
            +Packages that use KijiProducerOutputException
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + +
            +Uses of KijiProducerOutputException in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce.impl that throw KijiProducerOutputException
            +static voidKijiProducers.validateOutputColumn(KijiProducer producer, + org.kiji.schema.layout.KijiTableLayout tableLayout) + +
            +          Makes sure the producer's requested output column exists in the + kiji table layout.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/ProducerContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/ProducerContext.html new file mode 100644 index 00000000..5c9801fc --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/class-use/ProducerContext.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.produce.ProducerContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.produce.ProducerContext

            +
            + + + + + + + + + + + + + +
            +Packages that use ProducerContext
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + +
            +Uses of ProducerContext in org.kiji.mapreduce.produce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce with parameters of type ProducerContext
            +abstract  voidKijiProducer.produce(org.kiji.schema.KijiRowData input, + ProducerContext context) + +
            +          Called to compute derived data for a single entity.
            +  +

            + + + + + +
            +Uses of ProducerContext in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + +
            Subinterfaces of ProducerContext in org.kiji.mapreduce.produce.impl
            + interfaceInternalProducerContextInterface + +
            +          Internal interface for producer contexts.
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.produce.impl that implement ProducerContext
            + classInternalProducerContext + +
            +          Implementation of a producer context.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/InternalProducerContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/InternalProducerContext.html new file mode 100644 index 00000000..bcdf2dd7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/InternalProducerContext.html @@ -0,0 +1,519 @@ + + + + + + + +InternalProducerContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.produce.impl +
            +Class InternalProducerContext

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.impl.InternalKijiContext
+      extended by org.kiji.mapreduce.produce.impl.InternalProducerContext
+
            +
            +
            All Implemented Interfaces:
            Closeable, Flushable, KijiContext, InternalProducerContextInterface, ProducerContext
            +
            +
            +
            +
            @ApiAudience.Private
+public final class InternalProducerContext
            extends InternalKijiContext
            implements InternalProducerContextInterface
            + + +

            +Implementation of a producer context. + + Wraps a full KijiTableContext and restricts it to puts allowed in a producer. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +static InternalProducerContextcreate(org.apache.hadoop.mapreduce.TaskInputOutputContext<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,?,?> taskContext, + org.kiji.schema.KijiColumnName outputColumn) + +
            +          Creates a new implementation of InternalProducerContextInterface for use by Kiji + producers.
            + voidflush() + +
            +          
            + org.kiji.schema.EntityIdgetEntityId() + +
            +          
            + + + + + +
            +<T> void
            +            		put(long timestamp, + T value) + +
            +          Outputs a new cell to the configured output column.
            + + + + + +
            +<T> void
            +            		put(String qualifier, + long timestamp, + T value) + +
            +          Outputs a new cell to the configured output column.
            + + + + + +
            +<T> void
            +            		put(String qualifier, + T value) + +
            +          Outputs a new cell to the configured output column with the current timestamp.
            + + + + + +
            +<T> void
            +            		put(T value) + +
            +          Outputs a new cell to the configured output column with the current timestamp.
            + InternalProducerContextsetEntityId(org.kiji.schema.EntityId entityId) + +
            +          Sets the entity ID of the current row being processed and written to.
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.impl.InternalKijiContext
            getMapReduceContext, getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KijiContext
            getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static InternalProducerContext create(org.apache.hadoop.mapreduce.TaskInputOutputContext<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,?,?> taskContext,
+                                             org.kiji.schema.KijiColumnName outputColumn)
+                                      throws IOException
            +
            +
            Creates a new implementation of InternalProducerContextInterface for use by Kiji + producers. +

            +

            +
            +
            +
            +
            Parameters:
            taskContext - is the Hadoop TaskInputOutputContext to which the new context's + functionality will be delegated.
            outputColumn - is the name of the Kiji column that the new context can write to. +
            Returns:
            a new context for use by Kiji producers that can write to a column of a Kiji table. +
            Throws: +
            IOException - if there is an I/O error.
            +
            +
            +
            + +

            +getEntityId

            +
            +public org.kiji.schema.EntityId getEntityId()
            +
            +
            +

            +

            +
            Specified by:
            getEntityId in interface ProducerContext
            +
            +
            + +
            Returns:
            the entity ID of the row being currently written to.
            +
            +
            +
            + +

            +setEntityId

            +
            +public InternalProducerContext setEntityId(org.kiji.schema.EntityId entityId)
            +
            +
            Sets the entity ID of the current row being processed and written to. +

            +

            +
            Specified by:
            setEntityId in interface InternalProducerContextInterface
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row being processed and written to. +
            Returns:
            this context.
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(T value)
+         throws IOException
            +
            +
            Outputs a new cell to the configured output column with the current timestamp. + + Valid only when the producer is configured to output to a single column. +

            +

            +
            Specified by:
            put in interface ProducerContext
            +
            +
            +
            Type Parameters:
            T - Type of the value to emit.
            Parameters:
            value - Value to write. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(String qualifier,
+                    T value)
+         throws IOException
            +
            +
            Outputs a new cell to the configured output column with the current timestamp. + + Valid only when the producer is configured to output to a map-type family. +

            +

            +
            Specified by:
            put in interface ProducerContext
            +
            +
            +
            Type Parameters:
            T - Type of the value to emit.
            Parameters:
            qualifier - Qualifier of the cell to output.
            value - Value of the cell to output. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(long timestamp,
+                    T value)
+         throws IOException
            +
            +
            Outputs a new cell to the configured output column. + + Valid only when the producer is configured to output to a single column. +

            +

            +
            Specified by:
            put in interface ProducerContext
            +
            +
            +
            Type Parameters:
            T - Type of the value to emit.
            Parameters:
            timestamp - Timestamp of the cell to write.
            value - Value to write. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(String qualifier,
+                    long timestamp,
+                    T value)
+         throws IOException
            +
            +
            Outputs a new cell to the configured output column. + + Valid only when the producer is configured to output to a map-type family. +

            +

            +
            Specified by:
            put in interface ProducerContext
            +
            +
            +
            Type Parameters:
            T - Type of the value to emit.
            Parameters:
            qualifier - Qualifier of the cell to output.
            timestamp - Timestamp of the cell to write.
            value - Value of the cell to output. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            flush in interface Flushable
            Overrides:
            flush in class InternalKijiContext
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Overrides:
            close in class InternalKijiContext
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/InternalProducerContextInterface.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/InternalProducerContextInterface.html new file mode 100644 index 00000000..78c5a0d5 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/InternalProducerContextInterface.html @@ -0,0 +1,263 @@ + + + + + + + +InternalProducerContextInterface (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.produce.impl +
            +Interface InternalProducerContextInterface

            +
            +
            All Superinterfaces:
            Closeable, Flushable, KijiContext, ProducerContext
            +
            +
            +
            All Known Implementing Classes:
            InternalProducerContext
            +
            +
            +
            +
            @ApiAudience.Private
+@Inheritance.Sealed
+public interface InternalProducerContextInterface
            extends ProducerContext
            + + +

            +Internal interface for producer contexts. + + Allows the produce mapper to set the entity ID. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + InternalProducerContextInterfacesetEntityId(org.kiji.schema.EntityId entityId) + +
            +          Sets the entity ID of the current row being processed and written to.
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.produce.ProducerContext
            getEntityId, put, put, put, put
            +  + + + + + + + +
            Methods inherited from interface org.kiji.mapreduce.KijiContext
            getStatus, getStore, incrementCounter, incrementCounter, progress, setStatus
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +setEntityId

            +
            +InternalProducerContextInterface setEntityId(org.kiji.schema.EntityId entityId)
            +
            +
            Sets the entity ID of the current row being processed and written to. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row being processed and written to. +
            Returns:
            this context.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/KijiProducers.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/KijiProducers.html new file mode 100644 index 00000000..b9bb664c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/KijiProducers.html @@ -0,0 +1,265 @@ + + + + + + + +KijiProducers (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.produce.impl +
            +Class KijiProducers

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.produce.impl.KijiProducers
+
            +
            +
            +
            @ApiAudience.Private
+public final class KijiProducers
            extends Object
            + + +

            +Utility methods for working with KijiProducers. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiProducercreate(org.apache.hadoop.conf.Configuration conf) + +
            +          Creates an instance of the producer specified by the + Configuration.
            +static voidvalidateOutputColumn(KijiProducer producer, + org.kiji.schema.layout.KijiTableLayout tableLayout) + +
            +          Makes sure the producer's requested output column exists in the + kiji table layout.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiProducer create(org.apache.hadoop.conf.Configuration conf)
+                           throws IOException
            +
            +
            Creates an instance of the producer specified by the + Configuration. + +

            The configuration would have stored the producer name only if + it was configured by a KijiProduceJobBuilder, so don't try calling this + method with any old Configuration object.

            +

            +

            +
            Parameters:
            conf - The job configuration. +
            Returns:
            a brand-spankin'-new KijiProducer instance. +
            Throws: +
            IOException - If the producer name cannot be instantiated from the configuration.
            +
            +
            +
            + +

            +validateOutputColumn

            +
            +public static void validateOutputColumn(KijiProducer producer,
+                                        org.kiji.schema.layout.KijiTableLayout tableLayout)
+                                 throws KijiProducerOutputException
            +
            +
            Makes sure the producer's requested output column exists in the + kiji table layout. +

            +

            +
            Parameters:
            producer - The producer whose output column should be validated.
            tableLayout - The layout of the table to validate the output column against. +
            Throws: +
            KijiProducerOutputException - If the output column cannot be written to.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/ProduceMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/ProduceMapper.html new file mode 100644 index 00000000..04e158b3 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/ProduceMapper.html @@ -0,0 +1,440 @@ + + + + + + + +ProduceMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.produce.impl +
            +Class ProduceMapper

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Mapper<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiMapper<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,K,V>
+          extended by org.kiji.mapreduce.impl.KijiTableMapper<HFileKeyValue,org.apache.hadoop.io.NullWritable>
+              extended by org.kiji.mapreduce.produce.impl.ProduceMapper
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, KijiDataRequester, KVOutputJob
            +
            +
            +
            +
            @ApiAudience.Private
+public final class ProduceMapper
            extends KijiTableMapper<HFileKeyValue,org.apache.hadoop.io.NullWritable>
            + + +

            +Hadoop mapper that runs a Kiji producer. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Mapper
            org.apache.hadoop.mapreduce.Mapper.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            ProduceMapper() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup(org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          
            + org.kiji.schema.KijiDataRequestgetDataRequest() + +
            +          Return a KijiDataRequest that describes which input columns need to be available.
            + Class<?>getOutputKeyClass() + +
            +          
            + Class<?>getOutputValueClass() + +
            +          
            +protected  voidmap(org.kiji.schema.KijiRowData input, + org.apache.hadoop.mapreduce.Mapper.Context mapContext) + +
            +          Kiji mapper function that processes an input row.
            +protected  voidsetup(org.apache.hadoop.mapreduce.Mapper.Context context) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.impl.KijiTableMapper
            getConf, map, setConf
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiMapper
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Mapper
            run
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ProduceMapper

            +
            +public ProduceMapper()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public org.kiji.schema.KijiDataRequest getDataRequest()
            +
            +
            Return a KijiDataRequest that describes which input columns need to be available. +

            +

            + +
            Returns:
            A kiji data request.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup(org.apache.hadoop.mapreduce.Mapper.Context context)
+              throws IOException
            +
            +
            +

            +

            +
            Overrides:
            setup in class KijiTableMapper<HFileKeyValue,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +map

            +
            +protected void map(org.kiji.schema.KijiRowData input,
+                   org.apache.hadoop.mapreduce.Mapper.Context mapContext)
+            throws IOException
            +
            +
            Kiji mapper function that processes an input row. +

            +

            +
            Specified by:
            map in class KijiTableMapper<HFileKeyValue,org.apache.hadoop.io.NullWritable>
            +
            +
            +
            Parameters:
            input - Input row from the configured Kiji table.
            mapContext - Hadoop mapper context. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup(org.apache.hadoop.mapreduce.Mapper.Context context)
+                throws IOException
            +
            +
            +

            +

            +
            Overrides:
            cleanup in class KijiTableMapper<HFileKeyValue,org.apache.hadoop.io.NullWritable>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            + +
            Returns:
            the type of keys emitted by this task.
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            + +
            Returns:
            the type of values emitted by this task.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/InternalProducerContext.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/InternalProducerContext.html new file mode 100644 index 00000000..a15ac084 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/InternalProducerContext.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.produce.impl.InternalProducerContext (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.produce.impl.InternalProducerContext

            +
            + + + + + + + + + +
            +Packages that use InternalProducerContext
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + +
            +Uses of InternalProducerContext in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce.impl that return InternalProducerContext
            +static InternalProducerContextInternalProducerContext.create(org.apache.hadoop.mapreduce.TaskInputOutputContext<org.kiji.schema.EntityId,org.kiji.schema.KijiRowData,?,?> taskContext, + org.kiji.schema.KijiColumnName outputColumn) + +
            +          Creates a new implementation of InternalProducerContextInterface for use by Kiji + producers.
            + InternalProducerContextInternalProducerContext.setEntityId(org.kiji.schema.EntityId entityId) + +
            +          Sets the entity ID of the current row being processed and written to.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/InternalProducerContextInterface.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/InternalProducerContextInterface.html new file mode 100644 index 00000000..ff2bed7f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/InternalProducerContextInterface.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Interface org.kiji.mapreduce.produce.impl.InternalProducerContextInterface (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.mapreduce.produce.impl.InternalProducerContextInterface

            +
            + + + + + + + + + +
            +Packages that use InternalProducerContextInterface
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + +
            +Uses of InternalProducerContextInterface in org.kiji.mapreduce.produce.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.mapreduce.produce.impl that implement InternalProducerContextInterface
            + classInternalProducerContext + +
            +          Implementation of a producer context.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.produce.impl that return InternalProducerContextInterface
            + InternalProducerContextInterfaceInternalProducerContextInterface.setEntityId(org.kiji.schema.EntityId entityId) + +
            +          Sets the entity ID of the current row being processed and written to.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/KijiProducers.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/KijiProducers.html new file mode 100644 index 00000000..d3dbc638 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/KijiProducers.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.produce.impl.KijiProducers (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.produce.impl.KijiProducers

            +
            +No usage of org.kiji.mapreduce.produce.impl.KijiProducers +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/ProduceMapper.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/ProduceMapper.html new file mode 100644 index 00000000..b4aafa1c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/class-use/ProduceMapper.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.produce.impl.ProduceMapper (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.produce.impl.ProduceMapper

            +
            +No usage of org.kiji.mapreduce.produce.impl.ProduceMapper +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-frame.html new file mode 100644 index 00000000..91159f7d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-frame.html @@ -0,0 +1,48 @@ + + + + + + + +org.kiji.mapreduce.produce.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.produce.impl + + + + +
            +Interfaces  + +
            +InternalProducerContextInterface
            + + + + + + +
            +Classes  + +
            +InternalProducerContext +
            +KijiProducers +
            +ProduceMapper
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-summary.html new file mode 100644 index 00000000..be5cbc79 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-summary.html @@ -0,0 +1,195 @@ + + + + + + + +org.kiji.mapreduce.produce.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.produce.impl +

            +Kiji producer implementation details. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            InternalProducerContextInterfaceInternal interface for producer contexts.
            +  + +

            + + + + + + + + + + + + + + + + + +
            +Class Summary
            InternalProducerContextImplementation of a producer context.
            KijiProducersUtility methods for working with KijiProducers.
            ProduceMapperHadoop mapper that runs a Kiji producer.
            +  + +

            +

            +Package org.kiji.mapreduce.produce.impl Description +

            + +

            +Kiji producer implementation details. Clients should not use these. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-tree.html new file mode 100644 index 00000000..26184102 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-tree.html @@ -0,0 +1,185 @@ + + + + + + + +org.kiji.mapreduce.produce.impl Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.produce.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-use.html new file mode 100644 index 00000000..21529eea --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/impl/package-use.html @@ -0,0 +1,177 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.produce.impl (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.produce.impl

            +
            + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.produce.impl
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.produce.impl used by org.kiji.mapreduce.produce.impl
            InternalProducerContext + +
            +          Implementation of a producer context.
            InternalProducerContextInterface + +
            +          Internal interface for producer contexts.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-frame.html new file mode 100644 index 00000000..a72870a9 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-frame.html @@ -0,0 +1,57 @@ + + + + + + + +org.kiji.mapreduce.produce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.produce + + + + +
            +Interfaces  + +
            +ProducerContext
            + + + + + + +
            +Classes  + +
            +KijiProduceJobBuilder +
            +KijiProducer
            + + + + + + +
            +Exceptions  + +
            +KijiProducerOutputException
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-summary.html new file mode 100644 index 00000000..48a70b00 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-summary.html @@ -0,0 +1,233 @@ + + + + + + + +org.kiji.mapreduce.produce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.produce +

            +Producer classes for KijiMR clients. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            ProducerContextContext for producers to output new cells in the currently processed row.
            +  + +

            + + + + + + + + + + + + + +
            +Class Summary
            KijiProduceJobBuilderBuilds jobs that run a producer over a Kiji table.
            KijiProducer + Base class for all Kiji Producers used to generate per-row derived + entity data.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            KijiProducerOutputExceptionThrown when a KijiProducer fails to produce output.
            +  + +

            +

            +Package org.kiji.mapreduce.produce Description +

            + +

            +Producer classes for KijiMR clients. +

            + A KijiProducer executes a function over a subset of the columns in a table row and produces + output to be injected back into a column of that row. Producers can be run in the context of + a MapReduce over entire Kiji tables, or on-demand over a single row at a time. + The KijiProducer class is the base class for all producers. + Subclasses take inputs from MapReduceJobInput and produce output to + Kiji. +

            + +

            Constructing a produce job:

            +

            + A producer job that executes its function over each row in a table and injects the result + back into the row can be constructed as follows: +

            + 
            
+   // Configure and create the MapReduce job.
+   final MapReduceJob job = KijiProduceJobBuilder.create()
+       .withProducer(SimpleProducer.class)
+       .withInputTable(mTable.getURI())
+       .withOutput(new DirectKijiTableMapReduceJobOutput(mTable.getURI()))
+       .build();
+
            +

            + The kiji produce command line tool wraps this functionality and can be used + for constructing produce jobs. +

            +

            + +

            +

            +
            See Also:
            DirectKijiTableMapReduceJobOutput
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-tree.html new file mode 100644 index 00000000..3783bbf7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-tree.html @@ -0,0 +1,181 @@ + + + + + + + +org.kiji.mapreduce.produce Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.produce +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-use.html new file mode 100644 index 00000000..9903aea7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/produce/package-use.html @@ -0,0 +1,237 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.produce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.produce

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.produce
            org.kiji.mapreduce.produceProducer classes for KijiMR clients. 
            org.kiji.mapreduce.produce.implKiji producer implementation details. 
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.produce used by org.kiji.mapreduce.produce
            KijiProduceJobBuilder + +
            +          Builds jobs that run a producer over a Kiji table.
            KijiProducer + +
            +           + Base class for all Kiji Producers used to generate per-row derived + entity data.
            ProducerContext + +
            +          Context for producers to output new cells in the currently processed row.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.produce used by org.kiji.mapreduce.produce.impl
            KijiProducer + +
            +           + Base class for all Kiji Producers used to generate per-row derived + entity data.
            KijiProducerOutputException + +
            +          Thrown when a KijiProducer fails to produce output.
            ProducerContext + +
            +          Context for producers to output new cells in the currently processed row.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.mapreduce.produce used by org.kiji.mapreduce.tools
            KijiProduceJobBuilder + +
            +          Builds jobs that run a producer over a Kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/IdentityReducer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/IdentityReducer.html new file mode 100644 index 00000000..b88d9ab7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/IdentityReducer.html @@ -0,0 +1,486 @@ + + + + + + + +IdentityReducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.reducer +
            +Class IdentityReducer<K,V>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.Reducer<INKEY,INVALUE,OUTKEY,OUTVALUE>
+      extended by org.kiji.mapreduce.KijiReducer<K,V,K,V>
+          extended by org.kiji.mapreduce.reducer.IdentityReducer<K,V>
+
            +
            +
            Type Parameters:
            K - The MapReduce input key type.
            V - The MapReduce input value type.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, AvroKeyWriter, AvroValueWriter, KVOutputJob
            +
            +
            +
            +
            @ApiAudience.Public
+public final class IdentityReducer<K,V>
            extends KijiReducer<K,V,K,V>
            implements org.apache.hadoop.conf.Configurable, AvroKeyWriter, AvroValueWriter
            + + +

            +This MapReduce reducer will pass through all of the input key-value + pairs unchanged. This differs from the basic Hadoop MapReduce + IdentityReducer only in that it extends KijiReducer so it can be + run within the Kiji framework. + + This class implements the AvroKeyWriter and the AvroValueWriter interfaces + so that it can be used for Avro output +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.apache.hadoop.mapreduce.Reducer
            org.apache.hadoop.mapreduce.Reducer.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            IdentityReducer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + org.apache.avro.SchemagetAvroKeyWriterSchema() + +
            +          If the output key class is AvroKey, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is.
            + org.apache.avro.SchemagetAvroValueWriterSchema() + +
            +          If the output key class is AvroValue, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is.
            + org.apache.hadoop.conf.ConfigurationgetConf() + +
            +          
            + Class<?>getOutputKeyClass() + +
            +          
            + Class<?>getOutputValueClass() + +
            +          
            +protected  voidreduce(K key, + Iterable<V> values, + org.apache.hadoop.mapreduce.Reducer.Context context) + +
            +          
            + voidsetConf(org.apache.hadoop.conf.Configuration conf) + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.KijiReducer
            forName
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.mapreduce.Reducer
            cleanup, run, setup
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +IdentityReducer

            +
            +public IdentityReducer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(org.apache.hadoop.conf.Configuration conf)
            +
            +
            +

            +

            +
            Specified by:
            setConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public org.apache.hadoop.conf.Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface org.apache.hadoop.conf.Configurable
            +
            +
            +
            +
            +
            +
            + +

            +reduce

            +
            +protected void reduce(K key,
+                      Iterable<V> values,
+                      org.apache.hadoop.mapreduce.Reducer.Context context)
+               throws IOException,
+                      InterruptedException
            +
            +
            +

            +

            +
            Overrides:
            reduce in class org.apache.hadoop.mapreduce.Reducer<K,V,K,V>
            +
            +
            + +
            Throws: +
            IOException +
            InterruptedException
            +
            +
            +
            + +

            +getOutputKeyClass

            +
            +public Class<?> getOutputKeyClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputKeyClass in interface KVOutputJob
            +
            +
            + +
            Returns:
            the type of keys emitted by this task.
            +
            +
            +
            + +

            +getOutputValueClass

            +
            +public Class<?> getOutputValueClass()
            +
            +
            +

            +

            +
            Specified by:
            getOutputValueClass in interface KVOutputJob
            +
            +
            + +
            Returns:
            the type of values emitted by this task.
            +
            +
            +
            + +

            +getAvroKeyWriterSchema

            +
            +public org.apache.avro.Schema getAvroKeyWriterSchema()
+                                              throws IOException
            +
            +
            If the output key class is AvroKey, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. + +

            If this class does not use an AvroKey as its output key class, the return value from + this method will not be used. It may be null.

            +

            +

            +
            Specified by:
            getAvroKeyWriterSchema in interface AvroKeyWriter
            +
            +
            + +
            Returns:
            The Avro schema of the datum wrapped in the AvroKey output. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getAvroValueWriterSchema

            +
            +public org.apache.avro.Schema getAvroValueWriterSchema()
+                                                throws IOException
            +
            +
            If the output key class is AvroValue, the Kiji framework + will call this method to determine what the wrapped datum's writer schema is. + +

            If this class does not use an AvroKey as its output key class, the return value from + this method will not be used. It may be null.

            +

            +

            +
            Specified by:
            getAvroValueWriterSchema in interface AvroValueWriter
            +
            +
            + +
            Returns:
            The Avro schema of the datum wrapped in the AvroValue output. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/class-use/IdentityReducer.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/class-use/IdentityReducer.html new file mode 100644 index 00000000..c688ca6b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/class-use/IdentityReducer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.reducer.IdentityReducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.reducer.IdentityReducer

            +
            +No usage of org.kiji.mapreduce.reducer.IdentityReducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-frame.html new file mode 100644 index 00000000..faff89a7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.kiji.mapreduce.reducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.reducer + + + + +
            +Classes  + +
            +IdentityReducer
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-summary.html new file mode 100644 index 00000000..c8791411 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-summary.html @@ -0,0 +1,175 @@ + + + + + + + +org.kiji.mapreduce.reducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.reducer +

            +Basic identity reducer which is required for KijiMR jobs. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Class Summary
            IdentityReducer<K,V>This MapReduce reducer will pass through all of the input key-value + pairs unchanged.
            +  + +

            +

            +Package org.kiji.mapreduce.reducer Description +

            + +

            +Basic identity reducer which is required for KijiMR jobs. Any additional custom + reducers can be found inside the KijiMR Library. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-tree.html new file mode 100644 index 00000000..488cdfa6 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.mapreduce.reducer Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.reducer +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.hadoop.mapreduce.Reducer<KEYIN,VALUEIN,KEYOUT,VALUEOUT> +
              +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-use.html new file mode 100644 index 00000000..70aa9c46 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/reducer/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.reducer (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.reducer

            +
            +No usage of org.kiji.mapreduce.reducer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiBulkImport.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiBulkImport.html new file mode 100644 index 00000000..498a91f7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiBulkImport.html @@ -0,0 +1,559 @@ + + + + + + + +KijiBulkImport (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools +
            +Class KijiBulkImport

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.mapreduce.tools.framework.JobTool<KijiBulkImportJobBuilder>
+              extended by org.kiji.mapreduce.tools.KijiBulkImport
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.schema.tools.KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class KijiBulkImport
            extends JobTool<KijiBulkImportJobBuilder>
            + + +

            +Bulk imports a file into a Kiji table. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.mapreduce.tools.framework.JobTool
            mInputFlag, mKvStoreFile, mLibDir, mOutputFlag
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiBulkImport() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          
            +protected  voidconfigure(KijiBulkImportJobBuilder jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +protected  KijiBulkImportJobBuildercreateJobBuilder() + +
            +          Creates a new job builder.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          
            +protected  voidsetup() + +
            +          
            +protected  voidvalidateFlags() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.tools.framework.JobTool
            getJobInput, getJobOutput
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +KijiBulkImport

            +
            +public KijiBulkImport()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            +

            +

            +
            Overrides:
            validateFlags in class JobTool<KijiBulkImportJobBuilder>
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            +

            +

            +
            Overrides:
            setup in class org.kiji.schema.tools.BaseTool
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            +

            +

            +
            Overrides:
            cleanup in class org.kiji.schema.tools.BaseTool
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +createJobBuilder

            +
            +protected KijiBulkImportJobBuilder createJobBuilder()
            +
            +
            Creates a new job builder. +

            +

            +
            Specified by:
            createJobBuilder in class JobTool<KijiBulkImportJobBuilder>
            +
            +
            + +
            Returns:
            A new job builder.
            +
            +
            +
            + +

            +configure

            +
            +protected void configure(KijiBulkImportJobBuilder jobBuilder)
+                  throws ClassNotFoundException,
+                         IOException,
+                         JobIOSpecParseException
            +
            +
            Configures the job builder by applying the flags from the user. +

            +

            +
            Overrides:
            configure in class JobTool<KijiBulkImportJobBuilder>
            +
            +
            +
            Parameters:
            jobBuilder - The job builder to configure. +
            Throws: +
            ClassNotFoundException - If a mapper, reducer, or other user class can not be loaded. +
            IOException - if there is an error reading configuration input data. +
            JobIOSpecParseException - If the input or output for the job can not configured.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            +

            +

            +
            Overrides:
            run in class JobTool<KijiBulkImportJobBuilder>
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiBulkLoad.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiBulkLoad.html new file mode 100644 index 00000000..5bfa9fba --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiBulkLoad.html @@ -0,0 +1,430 @@ + + + + + + + +KijiBulkLoad (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools +
            +Class KijiBulkLoad

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.mapreduce.tools.KijiBulkLoad
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.schema.tools.KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class KijiBulkLoad
            extends org.kiji.schema.tools.BaseTool
            + + +

            +Bulk loads HFiles into a Kiji table. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiBulkLoad() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          
            +protected  voidvalidateFlags() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, setup, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +KijiBulkLoad

            +
            +public KijiBulkLoad()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            +

            +

            +
            Overrides:
            validateFlags in class org.kiji.schema.tools.BaseTool
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            +

            +

            +
            Specified by:
            run in class org.kiji.schema.tools.BaseTool
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiGather.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiGather.html new file mode 100644 index 00000000..5b80bf4c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiGather.html @@ -0,0 +1,500 @@ + + + + + + + +KijiGather (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools +
            +Class KijiGather

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.mapreduce.tools.framework.JobTool<B>
+              extended by org.kiji.mapreduce.tools.framework.KijiJobTool<KijiGatherJobBuilder>
+                  extended by org.kiji.mapreduce.tools.KijiGather
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.schema.tools.KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class KijiGather
            extends KijiJobTool<KijiGatherJobBuilder>
            + + +

            +Command-line tool for running a KijiGatherer. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.mapreduce.tools.framework.KijiJobTool
            mLimitRowFlag, mStartRowFlag
            +  + + + + + + + +
            Fields inherited from class org.kiji.mapreduce.tools.framework.JobTool
            mInputFlag, mKvStoreFile, mLibDir, mOutputFlag
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiGather() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidconfigure(KijiGatherJobBuilder jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +protected  KijiGatherJobBuildercreateJobBuilder() + +
            +          Creates a new job builder.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  voidvalidateFlags() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.tools.framework.KijiJobTool
            getJobInputTable
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.tools.framework.JobTool
            getJobInput, getJobOutput, run
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, setup, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +KijiGather

            +
            +public KijiGather()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Description copied from class: KijiJobTool
            +
            +

            +

            +
            Overrides:
            validateFlags in class KijiJobTool<KijiGatherJobBuilder>
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +createJobBuilder

            +
            +protected KijiGatherJobBuilder createJobBuilder()
            +
            +
            Description copied from class: JobTool
            +
            Creates a new job builder. +

            +

            +
            Specified by:
            createJobBuilder in class JobTool<KijiGatherJobBuilder>
            +
            +
            + +
            Returns:
            A new job builder.
            +
            +
            +
            + +

            +configure

            +
            +protected void configure(KijiGatherJobBuilder jobBuilder)
+                  throws ClassNotFoundException,
+                         IOException,
+                         JobIOSpecParseException
            +
            +
            Description copied from class: KijiJobTool
            +
            Configures the job builder by applying the flags from the user. +

            +

            +
            Overrides:
            configure in class KijiJobTool<KijiGatherJobBuilder>
            +
            +
            +
            Parameters:
            jobBuilder - The job builder to configure. +
            Throws: +
            ClassNotFoundException - If a mapper, reducer, or other user class can not be loaded. +
            IOException - if there is an error reading configuration input data. +
            JobIOSpecParseException - If the input or output for the job can not configured.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiJobHistory.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiJobHistory.html new file mode 100644 index 00000000..e54d3cc1 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiJobHistory.html @@ -0,0 +1,430 @@ + + + + + + + +KijiJobHistory (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools +
            +Class KijiJobHistory

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.mapreduce.tools.KijiJobHistory
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.schema.tools.KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class KijiJobHistory
            extends org.kiji.schema.tools.BaseTool
            + + +

            +A tool that installs a job history table and lets you query individual jobs from it. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiJobHistory() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          
            +protected  voidvalidateFlags() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, setup, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +KijiJobHistory

            +
            +public KijiJobHistory()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            +

            +

            +
            Overrides:
            validateFlags in class org.kiji.schema.tools.BaseTool
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            +

            +

            +
            Specified by:
            run in class org.kiji.schema.tools.BaseTool
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiLaunchMapReduce.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiLaunchMapReduce.html new file mode 100644 index 00000000..793b6750 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiLaunchMapReduce.html @@ -0,0 +1,481 @@ + + + + + + + +KijiLaunchMapReduce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools +
            +Class KijiLaunchMapReduce

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.mapreduce.tools.framework.JobTool<KijiMapReduceJobBuilder>
+              extended by org.kiji.mapreduce.tools.KijiLaunchMapReduce
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.schema.tools.KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class KijiLaunchMapReduce
            extends JobTool<KijiMapReduceJobBuilder>
            + + +

            +Launch an arbitrary KijiMapReduceJob. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.mapreduce.tools.framework.JobTool
            mInputFlag, mKvStoreFile, mLibDir, mOutputFlag
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiLaunchMapReduce() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidconfigure(KijiMapReduceJobBuilder jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +protected  KijiMapReduceJobBuildercreateJobBuilder() + +
            +          Creates a new job builder.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  voidvalidateFlags() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.tools.framework.JobTool
            getJobInput, getJobOutput, run
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, setup, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +KijiLaunchMapReduce

            +
            +public KijiLaunchMapReduce()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Description copied from class: JobTool
            +
            +

            +

            +
            Overrides:
            validateFlags in class JobTool<KijiMapReduceJobBuilder>
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +createJobBuilder

            +
            +protected KijiMapReduceJobBuilder createJobBuilder()
            +
            +
            Description copied from class: JobTool
            +
            Creates a new job builder. +

            +

            +
            Specified by:
            createJobBuilder in class JobTool<KijiMapReduceJobBuilder>
            +
            +
            + +
            Returns:
            A new job builder.
            +
            +
            +
            + +

            +configure

            +
            +protected void configure(KijiMapReduceJobBuilder jobBuilder)
+                  throws ClassNotFoundException,
+                         IOException,
+                         JobIOSpecParseException
            +
            +
            Description copied from class: JobTool
            +
            Configures the job builder by applying the flags from the user. +

            +

            +
            Overrides:
            configure in class JobTool<KijiMapReduceJobBuilder>
            +
            +
            +
            Parameters:
            jobBuilder - The job builder to configure. +
            Throws: +
            ClassNotFoundException - If a mapper, reducer, or other user class can not be loaded. +
            IOException - if there is an error reading configuration input data. +
            JobIOSpecParseException - If the input or output for the job can not configured.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiProduce.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiProduce.html new file mode 100644 index 00000000..477d0740 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/KijiProduce.html @@ -0,0 +1,525 @@ + + + + + + + +KijiProduce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools +
            +Class KijiProduce

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.mapreduce.tools.framework.JobTool<B>
+              extended by org.kiji.mapreduce.tools.framework.KijiJobTool<KijiProduceJobBuilder>
+                  extended by org.kiji.mapreduce.tools.KijiProduce
+
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.schema.tools.KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class KijiProduce
            extends KijiJobTool<KijiProduceJobBuilder>
            + + +

            +Program for running a Kiji producer in a MapReduce job. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.mapreduce.tools.framework.KijiJobTool
            mLimitRowFlag, mStartRowFlag
            +  + + + + + + + +
            Fields inherited from class org.kiji.mapreduce.tools.framework.JobTool
            mInputFlag, mKvStoreFile, mLibDir, mOutputFlag
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiProduce() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidconfigure(KijiProduceJobBuilder jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +protected  KijiProduceJobBuildercreateJobBuilder() + +
            +          Creates a new job builder.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          
            +protected  voidvalidateFlags() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.tools.framework.KijiJobTool
            getJobInputTable
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.tools.framework.JobTool
            getJobInput, getJobOutput
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, setup, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +KijiProduce

            +
            +public KijiProduce()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            +
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Description copied from class: KijiJobTool
            +
            +

            +

            +
            Overrides:
            validateFlags in class KijiJobTool<KijiProduceJobBuilder>
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +createJobBuilder

            +
            +protected KijiProduceJobBuilder createJobBuilder()
            +
            +
            Creates a new job builder. +

            +

            +
            Specified by:
            createJobBuilder in class JobTool<KijiProduceJobBuilder>
            +
            +
            + +
            Returns:
            A new job builder.
            +
            +
            +
            + +

            +configure

            +
            +protected void configure(KijiProduceJobBuilder jobBuilder)
+                  throws ClassNotFoundException,
+                         IOException,
+                         JobIOSpecParseException
            +
            +
            Configures the job builder by applying the flags from the user. +

            +

            +
            Overrides:
            configure in class KijiJobTool<KijiProduceJobBuilder>
            +
            +
            +
            Parameters:
            jobBuilder - The job builder to configure. +
            Throws: +
            ClassNotFoundException - If a mapper, reducer, or other user class can not be loaded. +
            IOException - if there is an error reading configuration input data. +
            JobIOSpecParseException - If the input or output for the job can not configured.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            +

            +

            +
            Overrides:
            run in class JobTool<KijiProduceJobBuilder>
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiBulkImport.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiBulkImport.html new file mode 100644 index 00000000..19ca34fe --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiBulkImport.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.KijiBulkImport (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.KijiBulkImport

            +
            +No usage of org.kiji.mapreduce.tools.KijiBulkImport +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiBulkLoad.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiBulkLoad.html new file mode 100644 index 00000000..86af445e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiBulkLoad.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.KijiBulkLoad (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.KijiBulkLoad

            +
            +No usage of org.kiji.mapreduce.tools.KijiBulkLoad +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiGather.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiGather.html new file mode 100644 index 00000000..94427a52 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiGather.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.KijiGather (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.KijiGather

            +
            +No usage of org.kiji.mapreduce.tools.KijiGather +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiJobHistory.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiJobHistory.html new file mode 100644 index 00000000..498ba620 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiJobHistory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.KijiJobHistory (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.KijiJobHistory

            +
            +No usage of org.kiji.mapreduce.tools.KijiJobHistory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiLaunchMapReduce.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiLaunchMapReduce.html new file mode 100644 index 00000000..6241669b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiLaunchMapReduce.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.KijiLaunchMapReduce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.KijiLaunchMapReduce

            +
            +No usage of org.kiji.mapreduce.tools.KijiLaunchMapReduce +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiProduce.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiProduce.html new file mode 100644 index 00000000..5b215184 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/class-use/KijiProduce.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.KijiProduce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.KijiProduce

            +
            +No usage of org.kiji.mapreduce.tools.KijiProduce +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobIOConfKeys.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobIOConfKeys.html new file mode 100644 index 00000000..271efa36 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobIOConfKeys.html @@ -0,0 +1,319 @@ + + + + + + + +JobIOConfKeys (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools.framework +
            +Class JobIOConfKeys

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.tools.framework.JobIOConfKeys
+
            +
            +
            +
            public final class JobIOConfKeys
            extends Object
            + + +

            +Configuration keys for Job input and output specifications. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringFILE_PATH_KEY + +
            +          Input or output file path, usually an hdfs:// URI.
            +static StringFORMAT_KEY + +
            +          Format of the input or the ouptut.
            +static StringHTABLE_NAME_KEY + +
            +          Name of the input HTable, for HTableMapReduceJobInput.
            +static StringNSPLITS_KEY + +
            +          Number of splits for the output files.
            +static StringTABLE_KEY + +
            +          Input or output Kiji table, as a kiji:// URI.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +FORMAT_KEY

            +
            +public static final String FORMAT_KEY
            +
            +
            Format of the input or the ouptut. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +NSPLITS_KEY

            +
            +public static final String NSPLITS_KEY
            +
            +
            Number of splits for the output files. Zero means automatic. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +FILE_PATH_KEY

            +
            +public static final String FILE_PATH_KEY
            +
            +
            Input or output file path, usually an hdfs:// URI. + + As an output path, this must specify exactly one file. + As an input path, this may specify multiple files, separated by commas. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +TABLE_KEY

            +
            +public static final String TABLE_KEY
            +
            +
            Input or output Kiji table, as a kiji:// URI. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +HTABLE_NAME_KEY

            +
            +public static final String HTABLE_NAME_KEY
            +
            +
            Name of the input HTable, for HTableMapReduceJobInput. + + Actual HBase cluster address is pulled from the Job configuration. +

            +

            +
            See Also:
            Constant Field Values
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobIOSpecParseException.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobIOSpecParseException.html new file mode 100644 index 00000000..26426318 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobIOSpecParseException.html @@ -0,0 +1,250 @@ + + + + + + + +JobIOSpecParseException (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools.framework +
            +Class JobIOSpecParseException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.mapreduce.tools.framework.JobIOSpecParseException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class JobIOSpecParseException
            extends Exception
            + + +

            +Thrown when a JobInputSpec or JobOutputSpec cannot be parsed. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            JobIOSpecParseException(String message, + String spec) + +
            +           
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +JobIOSpecParseException

            +
            +public JobIOSpecParseException(String message,
+                               String spec)
            +
            +
            +
            Parameters:
            message - A message describing the problem with parsing.
            spec - The spec string that could not be parsed.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobInputSpec.Format.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobInputSpec.Format.html new file mode 100644 index 00000000..0ed8cd3c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobInputSpec.Format.html @@ -0,0 +1,475 @@ + + + + + + + +JobInputSpec.Format (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools.framework +
            +Enum JobInputSpec.Format

            +
            +java.lang.Object
+  extended by java.lang.Enum<JobInputSpec.Format>
+      extended by org.kiji.mapreduce.tools.framework.JobInputSpec.Format
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<JobInputSpec.Format>
            +
            +
            +
            Enclosing class:
            JobInputSpec
            +
            +
            +
            +
            public static enum JobInputSpec.Format
            extends Enum<JobInputSpec.Format>
            + + +

            +The Job input formats supported by Kiji. In the string representation of a + JobInputSpec, this is the part before the first colon, e.g. the "avro" in + "avro:/path/to/avro/container/file." +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            AVRO + +
            +          Avro container files from a file system.
            AVRO_KV + +
            +          Avro container files of key/value generic records.
            HTABLE + +
            +          An HBase table.
            KIJI + +
            +          A Kiji table.
            SEQUENCE + +
            +          Sequence files from a file system.
            SMALL_TEXT_FILES + +
            +          Single files in hdfs get read as one record per file.
            TEXT + +
            +          Text files from a file system.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetName() + +
            +          The short name of the format (used as the prefix in the string + representation of the JobInputSpec).
            +static JobInputSpec.Formatparse(String name) + +
            +          Return the format referred to by the name.
            +static JobInputSpec.FormatvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static JobInputSpec.Format[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +AVRO

            +
            +public static final JobInputSpec.Format AVRO
            +
            +
            Avro container files from a file system. +

            +

            +
            +
            +
            + +

            +AVRO_KV

            +
            +public static final JobInputSpec.Format AVRO_KV
            +
            +
            Avro container files of key/value generic records. +

            +

            +
            +
            +
            + +

            +HTABLE

            +
            +public static final JobInputSpec.Format HTABLE
            +
            +
            An HBase table. +

            +

            +
            +
            +
            + +

            +SEQUENCE

            +
            +public static final JobInputSpec.Format SEQUENCE
            +
            +
            Sequence files from a file system. +

            +

            +
            +
            +
            + +

            +SMALL_TEXT_FILES

            +
            +public static final JobInputSpec.Format SMALL_TEXT_FILES
            +
            +
            Single files in hdfs get read as one record per file. +

            +

            +
            +
            +
            + +

            +TEXT

            +
            +public static final JobInputSpec.Format TEXT
            +
            +
            Text files from a file system. +

            +

            +
            +
            +
            + +

            +KIJI

            +
            +public static final JobInputSpec.Format KIJI
            +
            +
            A Kiji table. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static JobInputSpec.Format[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (JobInputSpec.Format c : JobInputSpec.Format.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static JobInputSpec.Format valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            The short name of the format (used as the prefix in the string + representation of the JobInputSpec). +

            +

            + +
            Returns:
            The name of the format.
            +
            +
            +
            + +

            +parse

            +
            +public static JobInputSpec.Format parse(String name)
+                                 throws JobIOSpecParseException
            +
            +
            Return the format referred to by the name. +

            +

            +
            Parameters:
            name - The short name of the format. +
            Returns:
            the Format object. +
            Throws: +
            JobIOSpecParseException - If the name does not identify a valid format.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobInputSpec.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobInputSpec.html new file mode 100644 index 00000000..3ed67f93 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobInputSpec.html @@ -0,0 +1,372 @@ + + + + + + + +JobInputSpec (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools.framework +
            +Class JobInputSpec

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.tools.framework.JobInputSpec
+
            +
            +
            +
            @ApiAudience.Framework
+public final class JobInputSpec
            extends Object
            + + +

            +

            Describes the format and location of the input for a MapReduce job.

            + +

            The input for a MapReduce job can be described with two components: format and + location. The format determines how the input data should be read, e.g., is it a text + file or a sequence file? The location may depend on the format. For a file, it is + usually a URL or filesystem path. For a Kiji table, it is simply the name of the + table.

            + +

            JobInputSpecs can be constructed if you know the format and location, or they can be + parsed from a String using the parse(String) + method.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classJobInputSpec.Format + +
            +          The Job input formats supported by Kiji.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static JobInputSpeccreate(JobInputSpec.Format format, + String... locations) + +
            +          Creates a new job input specification.
            + JobInputSpec.FormatgetFormat() + +
            +           
            + StringgetLocation() + +
            +          Convenience method to return the location iff exactly one is specified.
            + String[]getLocations() + +
            +           
            +static JobInputSpecparse(String spec) + +
            +          Parses the string representation of a JobInputSpec.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static JobInputSpec create(JobInputSpec.Format format,
+                                  String... locations)
            +
            +
            Creates a new job input specification. When created with formats KIJI or HTABLE only one + input location may be specified. Otherwise multiple input locations may be given. +

            +

            +
            Parameters:
            format - is the format of the input data.
            locations - are the locations of the input data. +
            Returns:
            a new job input specification using the specified format and locations.
            +
            +
            +
            + +

            +getFormat

            +
            +public JobInputSpec.Format getFormat()
            +
            +
            + +
            Returns:
            The format of the input data.
            +
            +
            +
            + +

            +getLocation

            +
            +public String getLocation()
            +
            +
            Convenience method to return the location iff exactly one is specified. + Throws an IllegalStateException if not. +

            +

            + +
            Returns:
            The location of the input data.
            +
            +
            +
            + +

            +getLocations

            +
            +public String[] getLocations()
            +
            +
            + +
            Returns:
            The locations of the input data.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +parse

            +
            +public static JobInputSpec parse(String spec)
+                          throws JobIOSpecParseException
            +
            +

            Parses the string representation of a JobInputSpec.

            + +

            JobInputSpecs are of the form "<format>:<location>".

            +

            +

            +
            Parameters:
            spec - The input spec string to parse. +
            Returns:
            The parsed JobInputSpec. +
            Throws: +
            JobIOSpecParseException - If is unable to parse.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobOutputSpec.Format.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobOutputSpec.Format.html new file mode 100644 index 00000000..bd15590d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobOutputSpec.Format.html @@ -0,0 +1,473 @@ + + + + + + + +JobOutputSpec.Format (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools.framework +
            +Enum JobOutputSpec.Format

            +
            +java.lang.Object
+  extended by java.lang.Enum<JobOutputSpec.Format>
+      extended by org.kiji.mapreduce.tools.framework.JobOutputSpec.Format
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<JobOutputSpec.Format>
            +
            +
            +
            Enclosing class:
            JobOutputSpec
            +
            +
            +
            +
            public static enum JobOutputSpec.Format
            extends Enum<JobOutputSpec.Format>
            + + +

            +The job output formats supported by Kiji. In the string + representation of a JobOutputSpec, this is the part before the + first colon, e.g., the "avro" in "avro:/path/to/avro/container/file@8" +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            AVRO + +
            +          Avro container files in a file system.
            AVRO_KV + +
            +          Avro container files of key/value generic records.
            HFILE + +
            +          HFiles used in HBase for bulk loading into region servers.
            KIJI + +
            +          A Kiji table.
            MAP_FILE + +
            +          Map files in a file system.
            SEQUENCE_FILE + +
            +          Sequence files in a file system.
            TEXT + +
            +          Text files in a file system.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetName() + +
            +          Name of the format.
            +static JobOutputSpec.Formatparse(String name) + +
            +          Gets a Format object from its name.
            +static JobOutputSpec.FormatvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static JobOutputSpec.Format[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +KIJI

            +
            +public static final JobOutputSpec.Format KIJI
            +
            +
            A Kiji table. +

            +

            +
            +
            +
            + +

            +TEXT

            +
            +public static final JobOutputSpec.Format TEXT
            +
            +
            Text files in a file system. +

            +

            +
            +
            +
            + +

            +SEQUENCE_FILE

            +
            +public static final JobOutputSpec.Format SEQUENCE_FILE
            +
            +
            Sequence files in a file system. +

            +

            +
            +
            +
            + +

            +MAP_FILE

            +
            +public static final JobOutputSpec.Format MAP_FILE
            +
            +
            Map files in a file system. +

            +

            +
            +
            +
            + +

            +AVRO

            +
            +public static final JobOutputSpec.Format AVRO
            +
            +
            Avro container files in a file system. +

            +

            +
            +
            +
            + +

            +AVRO_KV

            +
            +public static final JobOutputSpec.Format AVRO_KV
            +
            +
            Avro container files of key/value generic records. +

            +

            +
            +
            +
            + +

            +HFILE

            +
            +public static final JobOutputSpec.Format HFILE
            +
            +
            HFiles used in HBase for bulk loading into region servers. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static JobOutputSpec.Format[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (JobOutputSpec.Format c : JobOutputSpec.Format.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static JobOutputSpec.Format valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Name of the format. +

            +

            + +
            Returns:
            the format name.
            +
            +
            +
            + +

            +parse

            +
            +public static JobOutputSpec.Format parse(String name)
+                                  throws JobIOSpecParseException
            +
            +
            Gets a Format object from its name. +

            +

            +
            Parameters:
            name - Name of the format. +
            Returns:
            the parsed format enum value. +
            Throws: +
            JobIOSpecParseException - If the name does not identify a valid format.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobOutputSpec.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobOutputSpec.html new file mode 100644 index 00000000..0f8b5799 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobOutputSpec.html @@ -0,0 +1,368 @@ + + + + + + + +JobOutputSpec (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools.framework +
            +Class JobOutputSpec

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.tools.framework.JobOutputSpec
+
            +
            +
            +
            @ApiAudience.Framework
+public final class JobOutputSpec
            extends Object
            + + +

            +Describes the format and location for the output of a MapReduce job. + +

            The output for a MapReduce job can be described with three components: format, + location, and a number of splits. The format determines how the output data should be + written, e.g., as a text file or sequence file? The location may depend on the + format. For a file, it is usually a URL or filesystem path. For a Kiji table, it is + simply the name of the table. Finally, the number of splits is used to determine the + number or reducers. When writing files, the number of sharded output files will + be equal to the number of reducers, since each reducer writes one shard.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classJobOutputSpec.Format + +
            +          The job output formats supported by Kiji.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static JobOutputSpeccreate(JobOutputSpec.Format format, + String location, + int splits) + +
            +          Creates a new job output specification.
            + JobOutputSpec.FormatgetFormat() + +
            +           
            + StringgetLocation() + +
            +           
            + intgetSplits() + +
            +           
            +static JobOutputSpecparse(String spec) + +
            +          Parses the string representation of a JobOutputSpec.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static JobOutputSpec create(JobOutputSpec.Format format,
+                                   String location,
+                                   int splits)
            +
            +
            Creates a new job output specification. +

            +

            +
            Parameters:
            format - is the format of the data output by the job.
            location - is the target location of the output data (or null if a location + is implied by the format).
            splits - is the number of desired output splits. +
            Returns:
            a new job output specification using the specified format, location, and splits.
            +
            +
            +
            + +

            +getFormat

            +
            +public JobOutputSpec.Format getFormat()
            +
            +
            + +
            Returns:
            The format of the output data.
            +
            +
            +
            + +

            +getLocation

            +
            +public String getLocation()
            +
            +
            + +
            Returns:
            The target location of the output data (may be null).
            +
            +
            +
            + +

            +getSplits

            +
            +public int getSplits()
            +
            +
            + +
            Returns:
            The number of splits in the output data.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +parse

            +
            +public static JobOutputSpec parse(String spec)
+                           throws JobIOSpecParseException
            +
            +
            Parses the string representation of a JobOutputSpec. The string + representation is of the format "<format>:<location>@<splits>". +

            +

            +
            Parameters:
            spec - The output spec string to parse. +
            Returns:
            The parsed JobOutputSpec. +
            Throws: +
            JobIOSpecParseException - If it is unable to parse.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobTool.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobTool.html new file mode 100644 index 00000000..7e443a44 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/JobTool.html @@ -0,0 +1,529 @@ + + + + + + + +JobTool (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools.framework +
            +Class JobTool<B extends MapReduceJobBuilder>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.mapreduce.tools.framework.JobTool<B>
+
            +
            +
            Type Parameters:
            B - The type of job builder to use.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.schema.tools.KijiTool
            +
            +
            +
            Direct Known Subclasses:
            KijiBulkImport, KijiJobTool, KijiLaunchMapReduce
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Extensible
+public abstract class JobTool<B extends MapReduceJobBuilder>
            extends org.kiji.schema.tools.BaseTool
            + + +

            +Base class for tools that run MapReduce jobs. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +protected  StringmInputFlag + +
            +           
            +protected  StringmKvStoreFile + +
            +           
            +protected  StringmLibDir + +
            +           
            +protected  StringmOutputFlag + +
            +           
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            JobTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidconfigure(B jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +protected abstract  BcreateJobBuilder() + +
            +          Creates a new job builder.
            +protected  MapReduceJobInputgetJobInput() + +
            +           
            +protected  MapReduceJobOutputgetJobOutput() + +
            +           
            +protected  intrun(List<String> nonFlagArgs) + +
            +          
            +protected  voidvalidateFlags() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, setup, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.tools.KijiTool
            getCategory, getDescription, getName
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +mInputFlag

            +
            +protected String mInputFlag
            +
            +
            +
            +
            +
            + +

            +mOutputFlag

            +
            +protected String mOutputFlag
            +
            +
            +
            +
            +
            + +

            +mLibDir

            +
            +protected String mLibDir
            +
            +
            +
            +
            +
            + +

            +mKvStoreFile

            +
            +protected String mKvStoreFile
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +JobTool

            +
            +public JobTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            +

            +

            +
            Overrides:
            validateFlags in class org.kiji.schema.tools.BaseTool
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +createJobBuilder

            +
            +protected abstract B createJobBuilder()
            +
            +
            Creates a new job builder. +

            +

            + +
            Returns:
            A new job builder.
            +
            +
            +
            + +

            +configure

            +
            +protected void configure(B jobBuilder)
+                  throws ClassNotFoundException,
+                         IOException,
+                         JobIOSpecParseException
            +
            +
            Configures the job builder by applying the flags from the user. +

            +

            +
            Parameters:
            jobBuilder - The job builder to configure. +
            Throws: +
            ClassNotFoundException - If a mapper, reducer, or other user class can not be loaded. +
            IOException - if there is an error reading configuration input data. +
            JobIOSpecParseException - If the input or output for the job can not configured.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            +

            +

            +
            Specified by:
            run in class org.kiji.schema.tools.BaseTool
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +getJobInput

            +
            +protected MapReduceJobInput getJobInput()
            +
            +
            + +
            Returns:
            the job input.
            +
            +
            +
            + +

            +getJobOutput

            +
            +protected MapReduceJobOutput getJobOutput()
            +
            +
            + +
            Returns:
            the job output.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/KijiJobTool.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/KijiJobTool.html new file mode 100644 index 00000000..74ef2d33 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/KijiJobTool.html @@ -0,0 +1,450 @@ + + + + + + + +KijiJobTool (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools.framework +
            +Class KijiJobTool<B extends KijiTableInputJobBuilder>

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.mapreduce.tools.framework.JobTool<B>
+              extended by org.kiji.mapreduce.tools.framework.KijiJobTool<B>
+
            +
            +
            Type Parameters:
            B - The type of job builder to use.
            +
            +
            All Implemented Interfaces:
            org.apache.hadoop.conf.Configurable, org.kiji.schema.tools.KijiTool
            +
            +
            +
            Direct Known Subclasses:
            KijiGather, KijiProduce
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Extensible
+public abstract class KijiJobTool<B extends KijiTableInputJobBuilder>
            extends JobTool<B>
            + + +

            +Base class for tools that run MapReduce jobs over kiji tables. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +protected  StringmLimitRowFlag + +
            +           
            +protected  StringmStartRowFlag + +
            +           
            +  + + + + + + + +
            Fields inherited from class org.kiji.mapreduce.tools.framework.JobTool
            mInputFlag, mKvStoreFile, mLibDir, mOutputFlag
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + + +
            +Constructor Summary
            +protected KijiJobTool() + +
            +          Creates a new KijiTool instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidconfigure(B jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +protected  KijiTableMapReduceJobInputgetJobInputTable() + +
            +           
            +protected  voidvalidateFlags() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.mapreduce.tools.framework.JobTool
            createJobBuilder, getJobInput, getJobOutput, run
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, setup, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.tools.KijiTool
            getCategory, getDescription, getName
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +mStartRowFlag

            +
            +protected String mStartRowFlag
            +
            +
            +
            +
            +
            + +

            +mLimitRowFlag

            +
            +protected String mLimitRowFlag
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +KijiJobTool

            +
            +protected KijiJobTool()
            +
            +
            Creates a new KijiTool instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            +

            +

            +
            Overrides:
            validateFlags in class JobTool<B extends KijiTableInputJobBuilder>
            +
            +
            + +
            Throws: +
            Exception
            +
            +
            +
            + +

            +configure

            +
            +protected void configure(B jobBuilder)
+                  throws ClassNotFoundException,
+                         IOException,
+                         JobIOSpecParseException
            +
            +
            Configures the job builder by applying the flags from the user. +

            +

            +
            Overrides:
            configure in class JobTool<B extends KijiTableInputJobBuilder>
            +
            +
            +
            Parameters:
            jobBuilder - The job builder to configure. +
            Throws: +
            ClassNotFoundException - If a mapper, reducer, or other user class can not be loaded. +
            IOException - if there is an error reading configuration input data. +
            JobIOSpecParseException - If the input or output for the job can not configured.
            +
            +
            +
            + +

            +getJobInputTable

            +
            +protected KijiTableMapReduceJobInput getJobInputTable()
            +
            +
            + +
            Returns:
            the input for this job, which must be a Kiji table.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/MapReduceJobInputFactory.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/MapReduceJobInputFactory.html new file mode 100644 index 00000000..5ac5d63e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/MapReduceJobInputFactory.html @@ -0,0 +1,255 @@ + + + + + + + +MapReduceJobInputFactory (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools.framework +
            +Class MapReduceJobInputFactory

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.tools.framework.MapReduceJobInputFactory
+
            +
            +
            +
            @ApiAudience.Framework
+public final class MapReduceJobInputFactory
            extends Object
            + + +

            +Constructs instances of MapReduceJobInput from a string specification. + + See JobInputSpec for the full inputspec specification. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static MapReduceJobInputFactorycreate() + +
            +          Creates a new factory for instances of MapReduceJobInput.
            + MapReduceJobInputfromSpaceSeparatedMap(String ssm) + +
            +          Creates a job input from a command-line flag space-separated parameters map.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static MapReduceJobInputFactory create()
            +
            +
            Creates a new factory for instances of MapReduceJobInput. +

            +

            + +
            Returns:
            a new factory for MapReduce job inputs.
            +
            +
            +
            + +

            +fromSpaceSeparatedMap

            +
            +public MapReduceJobInput fromSpaceSeparatedMap(String ssm)
+                                        throws IOException
            +
            +
            Creates a job input from a command-line flag space-separated parameters map. +

            +

            +
            Parameters:
            ssm - Space-separated parameters map from the command-line. +
            Returns:
            a job input configured from the command-line parameters. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/MapReduceJobOutputFactory.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/MapReduceJobOutputFactory.html new file mode 100644 index 00000000..a852bdc5 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/MapReduceJobOutputFactory.html @@ -0,0 +1,255 @@ + + + + + + + +MapReduceJobOutputFactory (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.tools.framework +
            +Class MapReduceJobOutputFactory

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.tools.framework.MapReduceJobOutputFactory
+
            +
            +
            +
            @ApiAudience.Framework
+public final class MapReduceJobOutputFactory
            extends Object
            + + +

            +A factory for creating MapReduceJobOutput objects from outputspecs. + + See JobOutputSpec for the full outputspec specification. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static MapReduceJobOutputFactorycreate() + +
            +          Creates a new factory for instances of MapReduceJobOutput.
            + MapReduceJobOutputfromSpaceSeparatedMap(String ssm) + +
            +          Creates a job output from a command-line flag space-separated parameters map.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static MapReduceJobOutputFactory create()
            +
            +
            Creates a new factory for instances of MapReduceJobOutput. +

            +

            + +
            Returns:
            a new factory for MapReduce job outputs.
            +
            +
            +
            + +

            +fromSpaceSeparatedMap

            +
            +public MapReduceJobOutput fromSpaceSeparatedMap(String ssm)
+                                         throws IOException
            +
            +
            Creates a job output from a command-line flag space-separated parameters map. +

            +

            +
            Parameters:
            ssm - Space-separated parameters map from the command-line. +
            Returns:
            a job output configured from the command-line parameters. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobIOConfKeys.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobIOConfKeys.html new file mode 100644 index 00000000..e9e83e94 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobIOConfKeys.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.framework.JobIOConfKeys (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.framework.JobIOConfKeys

            +
            +No usage of org.kiji.mapreduce.tools.framework.JobIOConfKeys +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobIOSpecParseException.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobIOSpecParseException.html new file mode 100644 index 00000000..e04ac603 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobIOSpecParseException.html @@ -0,0 +1,274 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.framework.JobIOSpecParseException (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.framework.JobIOSpecParseException

            +
            + + + + + + + + + + + + + +
            +Packages that use JobIOSpecParseException
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of JobIOSpecParseException in org.kiji.mapreduce.tools
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools that throw JobIOSpecParseException
            +protected  voidKijiBulkImport.configure(KijiBulkImportJobBuilder jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +protected  voidKijiGather.configure(KijiGatherJobBuilder jobBuilder) + +
            +           
            +protected  voidKijiLaunchMapReduce.configure(KijiMapReduceJobBuilder jobBuilder) + +
            +           
            +protected  voidKijiProduce.configure(KijiProduceJobBuilder jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +  +

            + + + + + +
            +Uses of JobIOSpecParseException in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework that throw JobIOSpecParseException
            +protected  voidJobTool.configure(B jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +protected  voidKijiJobTool.configure(B jobBuilder) + +
            +          Configures the job builder by applying the flags from the user.
            +static JobInputSpecJobInputSpec.parse(String spec) + +
            +          Parses the string representation of a JobInputSpec.
            +static JobInputSpec.FormatJobInputSpec.Format.parse(String name) + +
            +          Return the format referred to by the name.
            +static JobOutputSpecJobOutputSpec.parse(String spec) + +
            +          Parses the string representation of a JobOutputSpec.
            +static JobOutputSpec.FormatJobOutputSpec.Format.parse(String name) + +
            +          Gets a Format object from its name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobInputSpec.Format.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobInputSpec.Format.html new file mode 100644 index 00000000..e405c313 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobInputSpec.Format.html @@ -0,0 +1,223 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.framework.JobInputSpec.Format (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.framework.JobInputSpec.Format

            +
            + + + + + + + + + +
            +Packages that use JobInputSpec.Format
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of JobInputSpec.Format in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework that return JobInputSpec.Format
            + JobInputSpec.FormatJobInputSpec.getFormat() + +
            +           
            +static JobInputSpec.FormatJobInputSpec.Format.parse(String name) + +
            +          Return the format referred to by the name.
            +static JobInputSpec.FormatJobInputSpec.Format.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static JobInputSpec.Format[]JobInputSpec.Format.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework with parameters of type JobInputSpec.Format
            +static JobInputSpecJobInputSpec.create(JobInputSpec.Format format, + String... locations) + +
            +          Creates a new job input specification.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobInputSpec.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobInputSpec.html new file mode 100644 index 00000000..39805f0f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobInputSpec.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.framework.JobInputSpec (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.framework.JobInputSpec

            +
            + + + + + + + + + +
            +Packages that use JobInputSpec
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of JobInputSpec in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework that return JobInputSpec
            +static JobInputSpecJobInputSpec.create(JobInputSpec.Format format, + String... locations) + +
            +          Creates a new job input specification.
            +static JobInputSpecJobInputSpec.parse(String spec) + +
            +          Parses the string representation of a JobInputSpec.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobOutputSpec.Format.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobOutputSpec.Format.html new file mode 100644 index 00000000..14df0347 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobOutputSpec.Format.html @@ -0,0 +1,224 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.framework.JobOutputSpec.Format (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.framework.JobOutputSpec.Format

            +
            + + + + + + + + + +
            +Packages that use JobOutputSpec.Format
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of JobOutputSpec.Format in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework that return JobOutputSpec.Format
            + JobOutputSpec.FormatJobOutputSpec.getFormat() + +
            +           
            +static JobOutputSpec.FormatJobOutputSpec.Format.parse(String name) + +
            +          Gets a Format object from its name.
            +static JobOutputSpec.FormatJobOutputSpec.Format.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static JobOutputSpec.Format[]JobOutputSpec.Format.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework with parameters of type JobOutputSpec.Format
            +static JobOutputSpecJobOutputSpec.create(JobOutputSpec.Format format, + String location, + int splits) + +
            +          Creates a new job output specification.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobOutputSpec.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobOutputSpec.html new file mode 100644 index 00000000..2cf60ec3 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobOutputSpec.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.framework.JobOutputSpec (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.framework.JobOutputSpec

            +
            + + + + + + + + + +
            +Packages that use JobOutputSpec
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of JobOutputSpec in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework that return JobOutputSpec
            +static JobOutputSpecJobOutputSpec.create(JobOutputSpec.Format format, + String location, + int splits) + +
            +          Creates a new job output specification.
            +static JobOutputSpecJobOutputSpec.parse(String spec) + +
            +          Parses the string representation of a JobOutputSpec.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobTool.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobTool.html new file mode 100644 index 00000000..1ad1d228 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/JobTool.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.framework.JobTool (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.framework.JobTool

            +
            + + + + + + + + + + + + + +
            +Packages that use JobTool
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of JobTool in org.kiji.mapreduce.tools
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of JobTool in org.kiji.mapreduce.tools
            + classKijiBulkImport + +
            +          Bulk imports a file into a Kiji table.
            + classKijiGather + +
            +          Command-line tool for running a KijiGatherer.
            + classKijiLaunchMapReduce + +
            +          Launch an arbitrary KijiMapReduceJob.
            + classKijiProduce + +
            +          Program for running a Kiji producer in a MapReduce job.
            +  +

            + + + + + +
            +Uses of JobTool in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + +
            Subclasses of JobTool in org.kiji.mapreduce.tools.framework
            + classKijiJobTool<B extends KijiTableInputJobBuilder> + +
            +          Base class for tools that run MapReduce jobs over kiji tables.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/KijiJobTool.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/KijiJobTool.html new file mode 100644 index 00000000..a9641257 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/KijiJobTool.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.framework.KijiJobTool (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.framework.KijiJobTool

            +
            + + + + + + + + + +
            +Packages that use KijiJobTool
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            +  +

            + + + + + +
            +Uses of KijiJobTool in org.kiji.mapreduce.tools
            +  +

            + + + + + + + + + + + + + +
            Subclasses of KijiJobTool in org.kiji.mapreduce.tools
            + classKijiGather + +
            +          Command-line tool for running a KijiGatherer.
            + classKijiProduce + +
            +          Program for running a Kiji producer in a MapReduce job.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/MapReduceJobInputFactory.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/MapReduceJobInputFactory.html new file mode 100644 index 00000000..ff934d20 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/MapReduceJobInputFactory.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.framework.MapReduceJobInputFactory (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.framework.MapReduceJobInputFactory

            +
            + + + + + + + + + +
            +Packages that use MapReduceJobInputFactory
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of MapReduceJobInputFactory in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework that return MapReduceJobInputFactory
            +static MapReduceJobInputFactoryMapReduceJobInputFactory.create() + +
            +          Creates a new factory for instances of MapReduceJobInput.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/MapReduceJobOutputFactory.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/MapReduceJobOutputFactory.html new file mode 100644 index 00000000..e4516ae0 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/class-use/MapReduceJobOutputFactory.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.tools.framework.MapReduceJobOutputFactory (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.tools.framework.MapReduceJobOutputFactory

            +
            + + + + + + + + + +
            +Packages that use MapReduceJobOutputFactory
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + +
            +Uses of MapReduceJobOutputFactory in org.kiji.mapreduce.tools.framework
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.tools.framework that return MapReduceJobOutputFactory
            +static MapReduceJobOutputFactoryMapReduceJobOutputFactory.create() + +
            +          Creates a new factory for instances of MapReduceJobOutput.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-frame.html new file mode 100644 index 00000000..0bc5eeb1 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-frame.html @@ -0,0 +1,69 @@ + + + + + + + +org.kiji.mapreduce.tools.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.tools.framework + + + + +
            +Classes  + +
            +JobInputSpec +
            +JobIOConfKeys +
            +JobOutputSpec +
            +JobTool +
            +KijiJobTool +
            +MapReduceJobInputFactory +
            +MapReduceJobOutputFactory
            + + + + + + +
            +Enums  + +
            +JobInputSpec.Format +
            +JobOutputSpec.Format
            + + + + + + +
            +Exceptions  + +
            +JobIOSpecParseException
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-summary.html new file mode 100644 index 00000000..57555fb3 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-summary.html @@ -0,0 +1,230 @@ + + + + + + + +org.kiji.mapreduce.tools.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.tools.framework +

            +Framework-level classes supporting KijiMR command line tools. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            JobInputSpecDescribes the format and location of the input for a MapReduce job.
            JobIOConfKeysConfiguration keys for Job input and output specifications.
            JobOutputSpecDescribes the format and location for the output of a MapReduce job.
            JobTool<B extends MapReduceJobBuilder>Base class for tools that run MapReduce jobs.
            KijiJobTool<B extends KijiTableInputJobBuilder>Base class for tools that run MapReduce jobs over kiji tables.
            MapReduceJobInputFactoryConstructs instances of MapReduceJobInput from a string specification.
            MapReduceJobOutputFactoryA factory for creating MapReduceJobOutput objects from outputspecs.
            +  + +

            + + + + + + + + + + + + + +
            +Enum Summary
            JobInputSpec.FormatThe Job input formats supported by Kiji.
            JobOutputSpec.FormatThe job output formats supported by Kiji.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            JobIOSpecParseExceptionThrown when a JobInputSpec or JobOutputSpec cannot be parsed.
            +  + +

            +

            +Package org.kiji.mapreduce.tools.framework Description +

            + +

            +Framework-level classes supporting KijiMR command line tools. Applications + should not use these. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-tree.html new file mode 100644 index 00000000..51fa7a0a --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-tree.html @@ -0,0 +1,177 @@ + + + + + + + +org.kiji.mapreduce.tools.framework Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.tools.framework +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-use.html new file mode 100644 index 00000000..33487657 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/framework/package-use.html @@ -0,0 +1,244 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.tools.framework (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.tools.framework

            +
            + + + + + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.tools.framework
            org.kiji.mapreduce.toolsKijiMR commandline tools. 
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.tools.framework used by org.kiji.mapreduce.tools
            JobIOSpecParseException + +
            +          Thrown when a JobInputSpec or JobOutputSpec cannot be parsed.
            JobTool + +
            +          Base class for tools that run MapReduce jobs.
            KijiJobTool + +
            +          Base class for tools that run MapReduce jobs over kiji tables.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.tools.framework used by org.kiji.mapreduce.tools.framework
            JobInputSpec + +
            +          Describes the format and location of the input for a MapReduce job.
            JobInputSpec.Format + +
            +          The Job input formats supported by Kiji.
            JobIOSpecParseException + +
            +          Thrown when a JobInputSpec or JobOutputSpec cannot be parsed.
            JobOutputSpec + +
            +          Describes the format and location for the output of a MapReduce job.
            JobOutputSpec.Format + +
            +          The job output formats supported by Kiji.
            JobTool + +
            +          Base class for tools that run MapReduce jobs.
            MapReduceJobInputFactory + +
            +          Constructs instances of MapReduceJobInput from a string specification.
            MapReduceJobOutputFactory + +
            +          A factory for creating MapReduceJobOutput objects from outputspecs.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-frame.html new file mode 100644 index 00000000..44380a00 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-frame.html @@ -0,0 +1,43 @@ + + + + + + + +org.kiji.mapreduce.tools (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.tools + + + + +
            +Classes  + +
            +KijiBulkImport +
            +KijiBulkLoad +
            +KijiGather +
            +KijiJobHistory +
            +KijiLaunchMapReduce +
            +KijiProduce
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-summary.html new file mode 100644 index 00000000..8df5c8a0 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-summary.html @@ -0,0 +1,193 @@ + + + + + + + +org.kiji.mapreduce.tools (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.tools +

            +KijiMR commandline tools. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            KijiBulkImportBulk imports a file into a Kiji table.
            KijiBulkLoadBulk loads HFiles into a Kiji table.
            KijiGatherCommand-line tool for running a KijiGatherer.
            KijiJobHistoryA tool that installs a job history table and lets you query individual jobs from it.
            KijiLaunchMapReduceLaunch an arbitrary KijiMapReduceJob.
            KijiProduceProgram for running a Kiji producer in a MapReduce job.
            +  + +

            +

            +Package org.kiji.mapreduce.tools Description +

            + +

            +KijiMR commandline tools. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-tree.html new file mode 100644 index 00000000..c02e115b --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +org.kiji.mapreduce.tools Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.tools +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.hadoop.conf.Configured (implements org.apache.hadoop.conf.Configurable) + +
              +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-use.html new file mode 100644 index 00000000..ce61022c --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/tools/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.tools (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.tools

            +
            +No usage of org.kiji.mapreduce.tools +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/AvroMapReduce.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/AvroMapReduce.html new file mode 100644 index 00000000..80df6c30 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/AvroMapReduce.html @@ -0,0 +1,314 @@ + + + + + + + +AvroMapReduce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.util +
            +Class AvroMapReduce

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.util.AvroMapReduce
+
            +
            +
            +
            @ApiAudience.Private
+public final class AvroMapReduce
            extends Object
            + + +

            +A utility class for working with MapReduce jobs that use Avro for input or output data. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static org.apache.avro.SchemagetAvroKeyReaderSchema(Object obj) + +
            +          If the given object implements AvroKeyReader, return the reader schema for its + AvroKey; otherwise return null.
            +static org.apache.avro.SchemagetAvroKeyWriterSchema(Object obj) + +
            +          If the given object implements AvroKeyWriter, return the writer schema for its + AvroKey; otherwise return null.
            +static org.apache.avro.SchemagetAvroValueReaderSchema(Object obj) + +
            +          If the given object implements AvroValueReader, return the reader schema for its + AvroValue; otherwise return null.
            +static org.apache.avro.SchemagetAvroValueWriterSchema(Object obj) + +
            +          If the given object implements AvroValueWriter, return the writer schema for its + AvroValue; otherwise return null.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getAvroKeyReaderSchema

            +
            +public static org.apache.avro.Schema getAvroKeyReaderSchema(Object obj)
+                                                     throws IOException
            +
            +
            If the given object implements AvroKeyReader, return the reader schema for its + AvroKey; otherwise return null. +

            +

            +
            Parameters:
            obj - The target object. +
            Returns:
            The reader schema for the key Avro datum obj reads. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getAvroValueReaderSchema

            +
            +public static org.apache.avro.Schema getAvroValueReaderSchema(Object obj)
+                                                       throws IOException
            +
            +
            If the given object implements AvroValueReader, return the reader schema for its + AvroValue; otherwise return null. +

            +

            +
            Parameters:
            obj - The target object. +
            Returns:
            The reader schema for the value Avro datum obj reads. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getAvroKeyWriterSchema

            +
            +public static org.apache.avro.Schema getAvroKeyWriterSchema(Object obj)
+                                                     throws IOException
            +
            +
            If the given object implements AvroKeyWriter, return the writer schema for its + AvroKey; otherwise return null. +

            +

            +
            Parameters:
            obj - The target object. +
            Returns:
            The writer schema for the key Avro datum obj writes. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getAvroValueWriterSchema

            +
            +public static org.apache.avro.Schema getAvroValueWriterSchema(Object obj)
+                                                       throws IOException
            +
            +
            If the given object implements AvroValueWriter, return the writer schema for its + AvroValue; otherwise return null. +

            +

            +
            Parameters:
            obj - The target object. +
            Returns:
            The writer schema for the value Avro datum obj writes. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Jars.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Jars.html new file mode 100644 index 00000000..fc3cd706 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Jars.html @@ -0,0 +1,234 @@ + + + + + + + +Jars (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.util +
            +Class Jars

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.util.Jars
+
            +
            +
            +
            @ApiAudience.Private
+public final class Jars
            extends Object
            + + +

            +Utility class for dealing with Java Jar files and their contained classes. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static StringgetJarPathForClass(Class<? extends Object> classObj) + +
            +          Finds the file path to the jar that contains a particular class.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getJarPathForClass

            +
            +public static String getJarPathForClass(Class<? extends Object> classObj)
+                                 throws ClassNotFoundException,
+                                        IOException
            +
            +
            Finds the file path to the jar that contains a particular class. + Method mostly cloned from o.a.h.mapred.JobConf.findContainingJar(). +

            +

            +
            Parameters:
            classObj - The class of interest. +
            Returns:
            The path to the jar that contains classObj. +
            Throws: +
            ClassNotFoundException - If the class cannot be found in a jar. +
            IOException - If there is a problem reading jars from the file system.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.Aggregator.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.Aggregator.html new file mode 100644 index 00000000..3a1b79df --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.Aggregator.html @@ -0,0 +1,270 @@ + + + + + + + +Lists.Aggregator (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.util +
            +Class Lists.Aggregator<X,Y>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.util.Lists.Aggregator<X,Y>
+
            +
            +
            Type Parameters:
            X - the type of the elements of the input list.
            Y - the result type of the aggregation.
            +
            +
            Enclosing class:
            Lists
            +
            +
            +
            +
            public abstract static class Lists.Aggregator<X,Y>
            extends Object
            + + +

            +Aggregation function to apply over a list of elements of type X with foldLeft() + or foldRight(). The aggregation returns an element of type Y. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            Lists.Aggregator() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            +abstract  Yeval(X listElem, + Y intermediate) + +
            +          Perform an operation on the current list element and intermediate datum.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +Lists.Aggregator

            +
            +public Lists.Aggregator()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +eval

            +
            +public abstract Y eval(X listElem,
+                       Y intermediate)
            +
            +
            Perform an operation on the current list element and intermediate datum. + Returns a new intermediate datum, which is the final datum for the entire + computation if this is operating on the last element of the list. +

            +

            +
            Parameters:
            listElem - the list element being operated on.
            intermediate - an intermediate datum being operated on. +
            Returns:
            the next intermediate datum.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.Func.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.Func.html new file mode 100644 index 00000000..61f926b7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.Func.html @@ -0,0 +1,268 @@ + + + + + + + +Lists.Func (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.util +
            +Class Lists.Func<X,Y>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.util.Lists.Func<X,Y>
+
            +
            +
            Type Parameters:
            X - the type of the elements of the input list.
            Y - the result type of the function.
            +
            +
            Direct Known Subclasses:
            Lists.IsNullFn, Lists.ToStringFn
            +
            +
            +
            Enclosing class:
            Lists
            +
            +
            +
            +
            public abstract static class Lists.Func<X,Y>
            extends Object
            + + +

            +Generic function to apply to elements of a list. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            Lists.Func() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            +abstract  Yeval(X listElem) + +
            +          Perform an operation on the current list element and return an output value.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +Lists.Func

            +
            +public Lists.Func()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +eval

            +
            +public abstract Y eval(X listElem)
            +
            +
            Perform an operation on the current list element and return an output value. +

            +

            +
            Parameters:
            listElem - the input list element to consider. +
            Returns:
            an output value from some computation.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.IsNullFn.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.IsNullFn.html new file mode 100644 index 00000000..5bfe8f8d --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.IsNullFn.html @@ -0,0 +1,269 @@ + + + + + + + +Lists.IsNullFn (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.util +
            +Class Lists.IsNullFn<X>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.util.Lists.Func<X,Boolean>
+      extended by org.kiji.mapreduce.util.Lists.IsNullFn<X>
+
            +
            +
            Type Parameters:
            X - the input argument type.
            +
            +
            Enclosing class:
            Lists
            +
            +
            +
            +
            public static class Lists.IsNullFn<X>
            extends Lists.Func<X,Boolean>
            + + +

            +Evaluation function that returns True if it encounters a null input item. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            Lists.IsNullFn() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + Booleaneval(X listItem) + +
            +          Returns listItem == null.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +Lists.IsNullFn

            +
            +public Lists.IsNullFn()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +eval

            +
            +public Boolean eval(X listItem)
            +
            +
            Returns listItem == null. +

            +

            +
            Specified by:
            eval in class Lists.Func<X,Boolean>
            +
            +
            +
            Parameters:
            listItem - the list item to operate on. +
            Returns:
            true if listItem is null, false otherwise.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.ToStringFn.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.ToStringFn.html new file mode 100644 index 00000000..67aca3ec --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.ToStringFn.html @@ -0,0 +1,267 @@ + + + + + + + +Lists.ToStringFn (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.util +
            +Class Lists.ToStringFn<X>

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.util.Lists.Func<X,String>
+      extended by org.kiji.mapreduce.util.Lists.ToStringFn<X>
+
            +
            +
            Enclosing class:
            Lists
            +
            +
            +
            +
            public static class Lists.ToStringFn<X>
            extends Lists.Func<X,String>
            + + +

            +Evaluation function that returns the String representation of each input item. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            Lists.ToStringFn() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + Stringeval(X listItem) + +
            +          Returns listItem.toString().
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +Lists.ToStringFn

            +
            +public Lists.ToStringFn()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +eval

            +
            +public String eval(X listItem)
            +
            +
            Returns listItem.toString(). +

            +

            +
            Specified by:
            eval in class Lists.Func<X,String>
            +
            +
            +
            Parameters:
            listItem - the list item to operate on. +
            Returns:
            listItem.toString(), or null if listItem is null.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.html new file mode 100644 index 00000000..3a9a0e12 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/Lists.html @@ -0,0 +1,454 @@ + + + + + + + +Lists (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.util +
            +Class Lists

            +
            +java.lang.Object
+  extended by org.kiji.mapreduce.util.Lists
+
            +
            +
            +
            @ApiAudience.Private
+public final class Lists
            extends Object
            + + +

            +A library of static List manipulation functions. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Nested Class Summary
            +static classLists.Aggregator<X,Y> + +
            +          Aggregation function to apply over a list of elements of type X with foldLeft() + or foldRight().
            +static classLists.Func<X,Y> + +
            +          Generic function to apply to elements of a list.
            +static classLists.IsNullFn<X> + +
            +          Evaluation function that returns True if it encounters a null input item.
            +static classLists.ToStringFn<X> + +
            +          Evaluation function that returns the String representation of each input item.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<X> List<X>
            +            		distinct(List<X> inputs) + +
            +          Returns a list containing only the distinct elements of the input list.
            +static + + + + +
            +<X> boolean
            +            		exists(List<X> inputList, + Lists.Func<? super X,Boolean> predicate) + +
            +          Consider elements of a list, returning true if one of the elements of the list + satisfies the predicate function so that it returns True.
            +static + + + + +
            +<X,Y> Y
            +            		foldLeft(Y initial, + List<X> inputList, + Lists.Aggregator<? super X,Y> op) + +
            +          Operate element-wise on elements of a list in a left-to-right fashion, + computing an aggregated value.
            +static + + + + +
            +<X,Y> Y
            +            		foldRight(Y initial, + List<X> inputList, + Lists.Aggregator<? super X,Y> op) + +
            +          Operate element-wise on elements of a list in a right-to-left fashion, + computing an aggregated value.
            +static + + + + +
            +<X,Y> List<Y>
            +            		map(List<X> inputs, + Lists.Func<? super X,? extends Y> mapper) + +
            +          Applies the mapper function element-by-element, creating an output list of the same + length as the input list, with the transformation function applied to each.
            +static + + + + +
            +<X> X[]
            +            		toArray(List<X> inputs, + Class<X> klazz) + +
            +          Returns an array of the same length as the input list.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +foldLeft

            +
            +public static <X,Y> Y foldLeft(Y initial,
+                               List<X> inputList,
+                               Lists.Aggregator<? super X,Y> op)
            +
            +
            Operate element-wise on elements of a list in a left-to-right fashion, + computing an aggregated value. Returns the final aggregated value after + computing over all the elements of the list. +

            +

            +
            Type Parameters:
            X - the type of the input list elements.
            Y - the type of the aggregated return value.
            Parameters:
            initial - the initial value of the accumulator to apply with inputList[0].
            inputList - the input elements to compute over.
            op - the operation to perform on each (element, intermediateVal) pair. +
            Returns:
            initial if the list is null or empty, or the result of + op(lst[n], op(lst[n-1], ..., (op(lst[1], op(lst[0], initial))))).
            +
            +
            +
            + +

            +foldRight

            +
            +public static <X,Y> Y foldRight(Y initial,
+                                List<X> inputList,
+                                Lists.Aggregator<? super X,Y> op)
            +
            +
            Operate element-wise on elements of a list in a right-to-left fashion, + computing an aggregated value. Returns the final aggregated value after + computing over all the elements of the list. +

            +

            +
            Type Parameters:
            X - the type of the input list elements.
            Y - the type of the aggregated return value.
            Parameters:
            initial - the initial value of the accumulator to apply with inputList[len-1].
            inputList - the input elements to compute over.
            op - the operation to perform on each (element, intermediateVal) pair. +
            Returns:
            initial if the list is null or empty, or the result of + op(lst[0], op(lst[1], ..., (op(lst[n-2], op(lst[n-1], initial))))).
            +
            +
            +
            + +

            +exists

            +
            +public static <X> boolean exists(List<X> inputList,
+                                 Lists.Func<? super X,Boolean> predicate)
            +
            +
            Consider elements of a list, returning true if one of the elements of the list + satisfies the predicate function so that it returns True. This may short circuit + evaluation if an element of the list satisfies the predicate. +

            +

            +
            Type Parameters:
            X - the input array element type.
            Parameters:
            inputList - a list of elements to apply a truth predicate to.
            predicate - a function that returns True or False for each element of the input list. +
            Returns:
            true if predicate(inputList[i]) returns true for any index 'i'.
            +
            +
            +
            + +

            +map

            +
            +public static <X,Y> List<Y> map(List<X> inputs,
+                                Lists.Func<? super X,? extends Y> mapper)
            +
            +
            Applies the mapper function element-by-element, creating an output list of the same + length as the input list, with the transformation function applied to each. +

            +

            +
            Type Parameters:
            X - the input array element type.
            Y - the output array element type.
            Parameters:
            inputs - an input list of elements to transform.
            mapper - a function to apply to each element one-by-one +
            Returns:
            a list of the same length as the input list, containing + [mapper.eval(inputs[0]), mapper.eval(inputs[1]), ..., mapper.eval(inputs[n-1])].
            +
            +
            +
            + +

            +toArray

            +
            +public static <X> X[] toArray(List<X> inputs,
+                              Class<X> klazz)
            +
            +
            Returns an array of the same length as the input list. + If the input list is null, returns a zero-length array. +

            +

            +
            Type Parameters:
            X - the input array element type.
            Parameters:
            inputs - the input list to convert to an array.
            klazz - the Class associated with the array element type. +
            Returns:
            an array containing all the elements of the input list.
            +
            +
            +
            + +

            +distinct

            +
            +public static <X> List<X> distinct(List<X> inputs)
            +
            +
            Returns a list containing only the distinct elements of the input list. + The .equals() and .hashCode() methods must be implemented for the input + elements. (The 'null' value is also permitted.) +

            +

            +
            Type Parameters:
            X - the type of the input elements.
            Parameters:
            inputs - a list of input elements. +
            Returns:
            a list of the same values as 'inputs', but deduplicated. Elements + remain in the same order as they appeared in the input list.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/LruCache.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/LruCache.html new file mode 100644 index 00000000..09c535f3 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/LruCache.html @@ -0,0 +1,348 @@ + + + + + + + +LruCache (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.mapreduce.util +
            +Class LruCache<K,V>

            +
            +java.lang.Object
+  extended by java.util.AbstractMap<K,V>
+      extended by java.util.HashMap<K,V>
+          extended by java.util.LinkedHashMap<K,V>
+              extended by org.kiji.mapreduce.util.LruCache<K,V>
+
            +
            +
            Type Parameters:
            K - the key type in the map.
            V - the value type in the map.
            +
            +
            All Implemented Interfaces:
            Serializable, Cloneable, Map<K,V>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class LruCache<K,V>
            extends LinkedHashMap<K,V>
            + + +

            +LRU cache based on LinkedHashMap. + +

            This cache will retain 'maxSize' elements, based on the most recently-read + items. The get() operation is a structural modification to the underlying + data store.

            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class java.util.AbstractMap
            AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
            +  + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<K,V> LruCache<K,V>
            +            		create(int maxSize) + +
            +          Creates a new cache that holds a limited number of elements.
            + intgetMaxSize() + +
            +           
            +protected  booleanremoveEldestEntry(Map.Entry<K,V> eldest) + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.util.LinkedHashMap
            clear, containsValue, get
            +  + + + + + + + +
            Methods inherited from class java.util.HashMap
            clone, containsKey, entrySet, isEmpty, keySet, put, putAll, remove, size, values
            +  + + + + + + + +
            Methods inherited from class java.util.AbstractMap
            equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            finalize, getClass, notify, notifyAll, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Map
            containsKey, entrySet, equals, hashCode, isEmpty, keySet, put, putAll, remove, size, values
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static <K,V> LruCache<K,V> create(int maxSize)
            +
            +
            Creates a new cache that holds a limited number of elements. +

            +

            +
            Type Parameters:
            K - is the type of key stored in the new cache.
            V - is the type of value stored in the new cache.
            Parameters:
            maxSize - is the maximum number of elements the new cache can hold. +
            Returns:
            a new cache that can hold up to maxSize elements.
            +
            +
            +
            + +

            +removeEldestEntry

            +
            +protected boolean removeEldestEntry(Map.Entry<K,V> eldest)
            +
            +
            +

            +

            +
            Overrides:
            removeEldestEntry in class LinkedHashMap<K,V>
            +
            +
            +
            +
            +
            +
            + +

            +getMaxSize

            +
            +public int getMaxSize()
            +
            +
            + +
            Returns:
            the maximum number of objects to cache.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/AvroMapReduce.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/AvroMapReduce.html new file mode 100644 index 00000000..9c3d5b20 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/AvroMapReduce.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.util.AvroMapReduce (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.util.AvroMapReduce

            +
            +No usage of org.kiji.mapreduce.util.AvroMapReduce +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Jars.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Jars.html new file mode 100644 index 00000000..5c344e74 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Jars.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.util.Jars (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.util.Jars

            +
            +No usage of org.kiji.mapreduce.util.Jars +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.Aggregator.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.Aggregator.html new file mode 100644 index 00000000..742c4ad5 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.Aggregator.html @@ -0,0 +1,209 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.util.Lists.Aggregator (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.util.Lists.Aggregator

            +
            + + + + + + + + + +
            +Packages that use Lists.Aggregator
            org.kiji.mapreduce.utilKijiMR utilities. 
            +  +

            + + + + + +
            +Uses of Lists.Aggregator in org.kiji.mapreduce.util
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.util with parameters of type Lists.Aggregator
            +static + + + + +
            +<X,Y> Y
            +            		Lists.foldLeft(Y initial, + List<X> inputList, + Lists.Aggregator<? super X,Y> op) + +
            +          Operate element-wise on elements of a list in a left-to-right fashion, + computing an aggregated value.
            +static + + + + +
            +<X,Y> Y
            +            		Lists.foldRight(Y initial, + List<X> inputList, + Lists.Aggregator<? super X,Y> op) + +
            +          Operate element-wise on elements of a list in a right-to-left fashion, + computing an aggregated value.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.Func.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.Func.html new file mode 100644 index 00000000..a295ff46 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.Func.html @@ -0,0 +1,231 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.util.Lists.Func (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.util.Lists.Func

            +
            + + + + + + + + + +
            +Packages that use Lists.Func
            org.kiji.mapreduce.utilKijiMR utilities. 
            +  +

            + + + + + +
            +Uses of Lists.Func in org.kiji.mapreduce.util
            +  +

            + + + + + + + + + + + + + +
            Subclasses of Lists.Func in org.kiji.mapreduce.util
            +static classLists.IsNullFn<X> + +
            +          Evaluation function that returns True if it encounters a null input item.
            +static classLists.ToStringFn<X> + +
            +          Evaluation function that returns the String representation of each input item.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.mapreduce.util with parameters of type Lists.Func
            +static + + + + +
            +<X> boolean
            +            		Lists.exists(List<X> inputList, + Lists.Func<? super X,Boolean> predicate) + +
            +          Consider elements of a list, returning true if one of the elements of the list + satisfies the predicate function so that it returns True.
            +static + + + + +
            +<X,Y> List<Y>
            +            		Lists.map(List<X> inputs, + Lists.Func<? super X,? extends Y> mapper) + +
            +          Applies the mapper function element-by-element, creating an output list of the same + length as the input list, with the transformation function applied to each.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.IsNullFn.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.IsNullFn.html new file mode 100644 index 00000000..5a4c69d1 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.IsNullFn.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.util.Lists.IsNullFn (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.util.Lists.IsNullFn

            +
            +No usage of org.kiji.mapreduce.util.Lists.IsNullFn +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.ToStringFn.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.ToStringFn.html new file mode 100644 index 00000000..670c422e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.ToStringFn.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.util.Lists.ToStringFn (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.util.Lists.ToStringFn

            +
            +No usage of org.kiji.mapreduce.util.Lists.ToStringFn +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.html new file mode 100644 index 00000000..4907a23f --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/Lists.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.util.Lists (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.util.Lists

            +
            +No usage of org.kiji.mapreduce.util.Lists +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/LruCache.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/LruCache.html new file mode 100644 index 00000000..1fee913e --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/class-use/LruCache.html @@ -0,0 +1,188 @@ + + + + + + + +Uses of Class org.kiji.mapreduce.util.LruCache (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.mapreduce.util.LruCache

            +
            + + + + + + + + + +
            +Packages that use LruCache
            org.kiji.mapreduce.utilKijiMR utilities. 
            +  +

            + + + + + +
            +Uses of LruCache in org.kiji.mapreduce.util
            +  +

            + + + + + + + + + +
            Methods in org.kiji.mapreduce.util that return LruCache
            +static + + + + +
            +<K,V> LruCache<K,V>
            +            		LruCache.create(int maxSize) + +
            +          Creates a new cache that holds a limited number of elements.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-frame.html new file mode 100644 index 00000000..ee9b6ab5 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-frame.html @@ -0,0 +1,47 @@ + + + + + + + +org.kiji.mapreduce.util (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.mapreduce.util + + + + +
            +Classes  + +
            +AvroMapReduce +
            +Jars +
            +Lists +
            +Lists.Aggregator +
            +Lists.Func +
            +Lists.IsNullFn +
            +Lists.ToStringFn +
            +LruCache
            + + + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-summary.html new file mode 100644 index 00000000..b95565bc --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-summary.html @@ -0,0 +1,202 @@ + + + + + + + +org.kiji.mapreduce.util (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.mapreduce.util +

            +KijiMR utilities. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AvroMapReduceA utility class for working with MapReduce jobs that use Avro for input or output data.
            JarsUtility class for dealing with Java Jar files and their contained classes.
            ListsA library of static List manipulation functions.
            Lists.Aggregator<X,Y>Aggregation function to apply over a list of elements of type X with foldLeft() + or foldRight().
            Lists.Func<X,Y>Generic function to apply to elements of a list.
            Lists.IsNullFn<X>Evaluation function that returns True if it encounters a null input item.
            Lists.ToStringFn<X>Evaluation function that returns the String representation of each input item.
            LruCache<K,V>LRU cache based on LinkedHashMap.
            +  + +

            +

            +Package org.kiji.mapreduce.util Description +

            + +

            +KijiMR utilities. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-tree.html new file mode 100644 index 00000000..34a31bd0 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-tree.html @@ -0,0 +1,165 @@ + + + + + + + +org.kiji.mapreduce.util Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.mapreduce.util +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-use.html b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-use.html new file mode 100644 index 00000000..027ed5f7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce/util/package-use.html @@ -0,0 +1,184 @@ + + + + + + + +Uses of Package org.kiji.mapreduce.util (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.mapreduce.util

            +
            + + + + + + + + + +
            +Packages that use org.kiji.mapreduce.util
            org.kiji.mapreduce.utilKijiMR utilities. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.mapreduce.util used by org.kiji.mapreduce.util
            Lists.Aggregator + +
            +          Aggregation function to apply over a list of elements of type X with foldLeft() + or foldRight().
            Lists.Func + +
            +          Generic function to apply to elements of a list.
            LruCache + +
            +          LRU cache based on LinkedHashMap.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/overview-frame.html b/apidocs/kiji-mapreduce/1.0.0-rc4/overview-frame.html new file mode 100644 index 00000000..2057f833 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/overview-frame.html @@ -0,0 +1,93 @@ + + + + + + + +Overview List (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + + + + +
            +
            + + + + + +
            All Classes +

            + +Packages +
            +org.apache.hadoop.mapreduce.lib.input +
            +org.apache.hadoop.mapreduce.lib.map +
            +org.apache.hadoop.mapreduce.lib.output +
            +org.kiji.mapreduce +
            +org.kiji.mapreduce.avro +
            +org.kiji.mapreduce.bulkimport +
            +org.kiji.mapreduce.bulkimport.impl +
            +org.kiji.mapreduce.framework +
            +org.kiji.mapreduce.gather +
            +org.kiji.mapreduce.gather.impl +
            +org.kiji.mapreduce.impl +
            +org.kiji.mapreduce.input +
            +org.kiji.mapreduce.input.impl +
            +org.kiji.mapreduce.kvstore +
            +org.kiji.mapreduce.kvstore.framework +
            +org.kiji.mapreduce.kvstore.impl +
            +org.kiji.mapreduce.kvstore.lib +
            +org.kiji.mapreduce.output +
            +org.kiji.mapreduce.output.framework +
            +org.kiji.mapreduce.output.impl +
            +org.kiji.mapreduce.produce +
            +org.kiji.mapreduce.produce.impl +
            +org.kiji.mapreduce.reducer +
            +org.kiji.mapreduce.tools +
            +org.kiji.mapreduce.tools.framework +
            +org.kiji.mapreduce.util +
            +

            + +

            +  + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/overview-summary.html b/apidocs/kiji-mapreduce/1.0.0-rc4/overview-summary.html new file mode 100644 index 00000000..3d77f5a7 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/overview-summary.html @@ -0,0 +1,257 @@ + + + + + + + +Overview (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +KijiMR 1.0.0-rc4 API +

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages
            org.apache.hadoop.mapreduce.lib.input 
            org.apache.hadoop.mapreduce.lib.map 
            org.apache.hadoop.mapreduce.lib.output 
            org.kiji.mapreduceKijiMR utilities.
            org.kiji.mapreduce.avroAvro interfaces for KijiMR.
            org.kiji.mapreduce.bulkimportBulk importer classes for KijiMR clients.
            org.kiji.mapreduce.bulkimport.implInternal classes for KijiMR bulk importers.
            org.kiji.mapreduce.frameworkFramework-level classes supporting basic KijiMR classes.
            org.kiji.mapreduce.gatherGatherer classes for KijiMR clients.
            org.kiji.mapreduce.gather.implKiji gatherer implementation details.
            org.kiji.mapreduce.implInternal implementation details for KijiMR's top level classes.
            org.kiji.mapreduce.inputMapReduce job input types.
            org.kiji.mapreduce.input.implInternal implementation details for KijiMR's job input classes.
            org.kiji.mapreduce.kvstoreKey-value store APIs.
            org.kiji.mapreduce.kvstore.frameworkFramework-level classes supporting KijiMR key value stores.
            org.kiji.mapreduce.kvstore.implKey value store implementation details.
            org.kiji.mapreduce.kvstore.libKey-value store implementations.
            org.kiji.mapreduce.outputMapReduce job output types.
            org.kiji.mapreduce.output.frameworkFramework-level classes supporting KijiMR job output classes.
            org.kiji.mapreduce.output.implImplementation details for KijiMR's Hadoop output classes.
            org.kiji.mapreduce.produceProducer classes for KijiMR clients.
            org.kiji.mapreduce.produce.implKiji producer implementation details.
            org.kiji.mapreduce.reducerBasic identity reducer which is required for KijiMR jobs.
            org.kiji.mapreduce.toolsKijiMR commandline tools.
            org.kiji.mapreduce.tools.frameworkFramework-level classes supporting KijiMR command line tools.
            org.kiji.mapreduce.utilKijiMR utilities.
            + +

            + 

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/overview-tree.html b/apidocs/kiji-mapreduce/1.0.0-rc4/overview-tree.html new file mode 100644 index 00000000..70a6f964 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/overview-tree.html @@ -0,0 +1,314 @@ + + + + + + + +Class Hierarchy (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.apache.hadoop.mapreduce.lib.input, org.apache.hadoop.mapreduce.lib.map, org.apache.hadoop.mapreduce.lib.output, org.kiji.mapreduce, org.kiji.mapreduce.avro, org.kiji.mapreduce.bulkimport, org.kiji.mapreduce.bulkimport.impl, org.kiji.mapreduce.framework, org.kiji.mapreduce.gather, org.kiji.mapreduce.gather.impl, org.kiji.mapreduce.impl, org.kiji.mapreduce.input, org.kiji.mapreduce.input.impl, org.kiji.mapreduce.kvstore, org.kiji.mapreduce.kvstore.framework, org.kiji.mapreduce.kvstore.impl, org.kiji.mapreduce.kvstore.lib, org.kiji.mapreduce.output, org.kiji.mapreduce.output.framework, org.kiji.mapreduce.output.impl, org.kiji.mapreduce.produce, org.kiji.mapreduce.produce.impl, org.kiji.mapreduce.reducer, org.kiji.mapreduce.tools, org.kiji.mapreduce.tools.framework, org.kiji.mapreduce.util
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/package-list b/apidocs/kiji-mapreduce/1.0.0-rc4/package-list new file mode 100644 index 00000000..3e0a6098 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/package-list @@ -0,0 +1,26 @@ +org.apache.hadoop.mapreduce.lib.input +org.apache.hadoop.mapreduce.lib.map +org.apache.hadoop.mapreduce.lib.output +org.kiji.mapreduce +org.kiji.mapreduce.avro +org.kiji.mapreduce.bulkimport +org.kiji.mapreduce.bulkimport.impl +org.kiji.mapreduce.framework +org.kiji.mapreduce.gather +org.kiji.mapreduce.gather.impl +org.kiji.mapreduce.impl +org.kiji.mapreduce.input +org.kiji.mapreduce.input.impl +org.kiji.mapreduce.kvstore +org.kiji.mapreduce.kvstore.framework +org.kiji.mapreduce.kvstore.impl +org.kiji.mapreduce.kvstore.lib +org.kiji.mapreduce.output +org.kiji.mapreduce.output.framework +org.kiji.mapreduce.output.impl +org.kiji.mapreduce.produce +org.kiji.mapreduce.produce.impl +org.kiji.mapreduce.reducer +org.kiji.mapreduce.tools +org.kiji.mapreduce.tools.framework +org.kiji.mapreduce.util diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/resources/inherit.gif b/apidocs/kiji-mapreduce/1.0.0-rc4/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/kiji-mapreduce/1.0.0-rc4/resources/inherit.gif differ diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/serialized-form.html b/apidocs/kiji-mapreduce/1.0.0-rc4/serialized-form.html new file mode 100644 index 00000000..68eefda3 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/serialized-form.html @@ -0,0 +1,300 @@ + + + + + + + +Serialized Form (KijiMR 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Serialized Form

            +
            +
            + + + + + +
            +Package org.apache.hadoop.mapreduce.lib.input
            + +

            + + + + + +
            +Class org.apache.hadoop.mapreduce.lib.input.InvalidInputException extends IOException implements Serializable
            + +

            +serialVersionUID: -380668190578456802L + +

            + + + + + +
            +Serialized Fields
            + +

            +problems

            +
            +List<E> problems
            +
            +
            +
            +
            +
            + + + + + +
            +Package org.kiji.mapreduce
            + +

            + + + + + +
            +Class org.kiji.mapreduce.JobConfigurationException extends RuntimeException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.mapreduce.kvstore
            + +

            + + + + + +
            +Class org.kiji.mapreduce.kvstore.RequiredStores.StoreMap extends HashMap<String,KeyValueStore<?,?>> implements Serializable
            + +

            +serialVersionUID: 1L + +

            +

            + + + + + +
            +Package org.kiji.mapreduce.produce
            + +

            + + + + + +
            +Class org.kiji.mapreduce.produce.KijiProducerOutputException extends IOException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.mapreduce.tools.framework
            + +

            + + + + + +
            +Class org.kiji.mapreduce.tools.framework.JobIOSpecParseException extends Exception implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.mapreduce.util
            + +

            + + + + + +
            +Class org.kiji.mapreduce.util.LruCache extends LinkedHashMap<K,V> implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mMaxSize

            +
            +int mMaxSize
            +
            +
            +
            +
            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-mapreduce/1.0.0-rc4/stylesheet.css b/apidocs/kiji-mapreduce/1.0.0-rc4/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/kiji-mapreduce/1.0.0-rc4/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/allclasses-frame.html b/apidocs/kiji-schema/1.0.0-rc1/allclasses-frame.html similarity index 100% rename from apidocs/allclasses-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/allclasses-frame.html diff --git a/apidocs/allclasses-noframe.html b/apidocs/kiji-schema/1.0.0-rc1/allclasses-noframe.html similarity index 100% rename from apidocs/allclasses-noframe.html rename to apidocs/kiji-schema/1.0.0-rc1/allclasses-noframe.html diff --git a/apidocs/constant-values.html b/apidocs/kiji-schema/1.0.0-rc1/constant-values.html similarity index 100% rename from apidocs/constant-values.html rename to apidocs/kiji-schema/1.0.0-rc1/constant-values.html diff --git a/apidocs/deprecated-list.html b/apidocs/kiji-schema/1.0.0-rc1/deprecated-list.html similarity index 100% rename from apidocs/deprecated-list.html rename to apidocs/kiji-schema/1.0.0-rc1/deprecated-list.html diff --git a/apidocs/help-doc.html b/apidocs/kiji-schema/1.0.0-rc1/help-doc.html similarity index 100% rename from apidocs/help-doc.html rename to apidocs/kiji-schema/1.0.0-rc1/help-doc.html diff --git a/apidocs/index-all.html b/apidocs/kiji-schema/1.0.0-rc1/index-all.html similarity index 100% rename from apidocs/index-all.html rename to apidocs/kiji-schema/1.0.0-rc1/index-all.html diff --git a/apidocs/index.html b/apidocs/kiji-schema/1.0.0-rc1/index.html similarity index 100% rename from apidocs/index.html rename to apidocs/kiji-schema/1.0.0-rc1/index.html diff --git a/apidocs/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html b/apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html similarity index 100% rename from apidocs/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html rename to apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html diff --git a/apidocs/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html b/apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html similarity index 100% rename from apidocs/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html rename to apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html diff --git a/apidocs/org/apache/hadoop/hbase/mapreduce/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/package-frame.html similarity index 100% rename from apidocs/org/apache/hadoop/hbase/mapreduce/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/package-frame.html diff --git a/apidocs/org/apache/hadoop/hbase/mapreduce/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/package-summary.html similarity index 100% rename from apidocs/org/apache/hadoop/hbase/mapreduce/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/package-summary.html diff --git a/apidocs/org/apache/hadoop/hbase/mapreduce/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/package-tree.html similarity index 100% rename from apidocs/org/apache/hadoop/hbase/mapreduce/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/package-tree.html diff --git a/apidocs/org/apache/hadoop/hbase/mapreduce/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/package-use.html similarity index 100% rename from apidocs/org/apache/hadoop/hbase/mapreduce/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/apache/hadoop/hbase/mapreduce/package-use.html diff --git a/apidocs/org/kiji/schema/EntityId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/EntityId.html similarity index 100% rename from apidocs/org/kiji/schema/EntityId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/EntityId.html diff --git a/apidocs/org/kiji/schema/EntityIdFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/EntityIdFactory.html similarity index 100% rename from apidocs/org/kiji/schema/EntityIdFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/EntityIdFactory.html diff --git a/apidocs/org/kiji/schema/GenericCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/GenericCellDecoderFactory.html similarity index 100% rename from apidocs/org/kiji/schema/GenericCellDecoderFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/GenericCellDecoderFactory.html diff --git a/apidocs/org/kiji/schema/HBaseColumnName.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/HBaseColumnName.html similarity index 100% rename from apidocs/org/kiji/schema/HBaseColumnName.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/HBaseColumnName.html diff --git a/apidocs/org/kiji/schema/HBaseScanOptions.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/HBaseScanOptions.html similarity index 100% rename from apidocs/org/kiji/schema/HBaseScanOptions.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/HBaseScanOptions.html diff --git a/apidocs/org/kiji/schema/IncompatibleKijiVersionException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/IncompatibleKijiVersionException.html similarity index 100% rename from apidocs/org/kiji/schema/IncompatibleKijiVersionException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/IncompatibleKijiVersionException.html diff --git a/apidocs/org/kiji/schema/InternalKijiError.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/InternalKijiError.html similarity index 100% rename from apidocs/org/kiji/schema/InternalKijiError.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/InternalKijiError.html diff --git a/apidocs/org/kiji/schema/KeyValueBackedWrapper.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KeyValueBackedWrapper.html similarity index 100% rename from apidocs/org/kiji/schema/KeyValueBackedWrapper.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KeyValueBackedWrapper.html diff --git a/apidocs/org/kiji/schema/Kiji.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/Kiji.html similarity index 100% rename from apidocs/org/kiji/schema/Kiji.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/Kiji.html diff --git a/apidocs/org/kiji/schema/KijiAdmin.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiAdmin.html similarity index 100% rename from apidocs/org/kiji/schema/KijiAdmin.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiAdmin.html diff --git a/apidocs/org/kiji/schema/KijiCell.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCell.html similarity index 100% rename from apidocs/org/kiji/schema/KijiCell.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCell.html diff --git a/apidocs/org/kiji/schema/KijiCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCellDecoder.html similarity index 100% rename from apidocs/org/kiji/schema/KijiCellDecoder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCellDecoder.html diff --git a/apidocs/org/kiji/schema/KijiCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCellDecoderFactory.html similarity index 100% rename from apidocs/org/kiji/schema/KijiCellDecoderFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCellDecoderFactory.html diff --git a/apidocs/org/kiji/schema/KijiCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCellEncoder.html similarity index 100% rename from apidocs/org/kiji/schema/KijiCellEncoder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCellEncoder.html diff --git a/apidocs/org/kiji/schema/KijiCellFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCellFormat.html similarity index 100% rename from apidocs/org/kiji/schema/KijiCellFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCellFormat.html diff --git a/apidocs/org/kiji/schema/KijiColumnName.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiColumnName.html similarity index 100% rename from apidocs/org/kiji/schema/KijiColumnName.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiColumnName.html diff --git a/apidocs/org/kiji/schema/KijiColumnPager.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiColumnPager.html similarity index 100% rename from apidocs/org/kiji/schema/KijiColumnPager.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiColumnPager.html diff --git a/apidocs/org/kiji/schema/KijiColumnPagingNotEnabledException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiColumnPagingNotEnabledException.html similarity index 100% rename from apidocs/org/kiji/schema/KijiColumnPagingNotEnabledException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiColumnPagingNotEnabledException.html diff --git a/apidocs/org/kiji/schema/KijiConfiguration.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiConfiguration.html similarity index 100% rename from apidocs/org/kiji/schema/KijiConfiguration.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiConfiguration.html diff --git a/apidocs/org/kiji/schema/KijiCounter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCounter.html similarity index 100% rename from apidocs/org/kiji/schema/KijiCounter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiCounter.html diff --git a/apidocs/org/kiji/schema/KijiDataRequest.Column.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataRequest.Column.html similarity index 100% rename from apidocs/org/kiji/schema/KijiDataRequest.Column.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataRequest.Column.html diff --git a/apidocs/org/kiji/schema/KijiDataRequest.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataRequest.html similarity index 100% rename from apidocs/org/kiji/schema/KijiDataRequest.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataRequest.html diff --git a/apidocs/org/kiji/schema/KijiDataRequestException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataRequestException.html similarity index 100% rename from apidocs/org/kiji/schema/KijiDataRequestException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataRequestException.html diff --git a/apidocs/org/kiji/schema/KijiDataRequestValidator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataRequestValidator.html similarity index 100% rename from apidocs/org/kiji/schema/KijiDataRequestValidator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataRequestValidator.html diff --git a/apidocs/org/kiji/schema/KijiDataWrapper.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataWrapper.html similarity index 100% rename from apidocs/org/kiji/schema/KijiDataWrapper.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataWrapper.html diff --git a/apidocs/org/kiji/schema/KijiDataWriter.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataWriter.Options.html similarity index 100% rename from apidocs/org/kiji/schema/KijiDataWriter.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataWriter.Options.html diff --git a/apidocs/org/kiji/schema/KijiDataWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataWriter.html similarity index 100% rename from apidocs/org/kiji/schema/KijiDataWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiDataWriter.html diff --git a/apidocs/org/kiji/schema/KijiInstaller.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiInstaller.html similarity index 100% rename from apidocs/org/kiji/schema/KijiInstaller.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiInstaller.html diff --git a/apidocs/org/kiji/schema/KijiInvalidNameException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiInvalidNameException.html similarity index 100% rename from apidocs/org/kiji/schema/KijiInvalidNameException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiInvalidNameException.html diff --git a/apidocs/org/kiji/schema/KijiManagedHBaseTableName.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiManagedHBaseTableName.html similarity index 100% rename from apidocs/org/kiji/schema/KijiManagedHBaseTableName.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiManagedHBaseTableName.html diff --git a/apidocs/org/kiji/schema/KijiMetaTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiMetaTable.html similarity index 100% rename from apidocs/org/kiji/schema/KijiMetaTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiMetaTable.html diff --git a/apidocs/org/kiji/schema/KijiNotInstalledException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiNotInstalledException.html similarity index 100% rename from apidocs/org/kiji/schema/KijiNotInstalledException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiNotInstalledException.html diff --git a/apidocs/org/kiji/schema/KijiRowData.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiRowData.html similarity index 100% rename from apidocs/org/kiji/schema/KijiRowData.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiRowData.html diff --git a/apidocs/org/kiji/schema/KijiRowKeySplitter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiRowKeySplitter.html similarity index 100% rename from apidocs/org/kiji/schema/KijiRowKeySplitter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiRowKeySplitter.html diff --git a/apidocs/org/kiji/schema/KijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiRowScanner.html similarity index 100% rename from apidocs/org/kiji/schema/KijiRowScanner.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiRowScanner.html diff --git a/apidocs/org/kiji/schema/KijiSchemaTable.SchemaEntry.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiSchemaTable.SchemaEntry.html similarity index 100% rename from apidocs/org/kiji/schema/KijiSchemaTable.SchemaEntry.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiSchemaTable.SchemaEntry.html diff --git a/apidocs/org/kiji/schema/KijiSchemaTable.SchemaHashCache.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiSchemaTable.SchemaHashCache.html similarity index 100% rename from apidocs/org/kiji/schema/KijiSchemaTable.SchemaHashCache.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiSchemaTable.SchemaHashCache.html diff --git a/apidocs/org/kiji/schema/KijiSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiSchemaTable.html similarity index 100% rename from apidocs/org/kiji/schema/KijiSchemaTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiSchemaTable.html diff --git a/apidocs/org/kiji/schema/KijiSystemTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiSystemTable.html similarity index 100% rename from apidocs/org/kiji/schema/KijiSystemTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiSystemTable.html diff --git a/apidocs/org/kiji/schema/KijiTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTable.html similarity index 100% rename from apidocs/org/kiji/schema/KijiTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTable.html diff --git a/apidocs/org/kiji/schema/KijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTableFactory.html similarity index 100% rename from apidocs/org/kiji/schema/KijiTableFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTableFactory.html diff --git a/apidocs/org/kiji/schema/KijiTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTableKeyValueDatabase.html similarity index 100% rename from apidocs/org/kiji/schema/KijiTableKeyValueDatabase.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTableKeyValueDatabase.html diff --git a/apidocs/org/kiji/schema/KijiTableNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTableNotFoundException.html similarity index 100% rename from apidocs/org/kiji/schema/KijiTableNotFoundException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTableNotFoundException.html diff --git a/apidocs/org/kiji/schema/KijiTablePool.NoCapacityException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTablePool.NoCapacityException.html similarity index 100% rename from apidocs/org/kiji/schema/KijiTablePool.NoCapacityException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTablePool.NoCapacityException.html diff --git a/apidocs/org/kiji/schema/KijiTablePool.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTablePool.Options.html similarity index 100% rename from apidocs/org/kiji/schema/KijiTablePool.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTablePool.Options.html diff --git a/apidocs/org/kiji/schema/KijiTablePool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTablePool.html similarity index 100% rename from apidocs/org/kiji/schema/KijiTablePool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTablePool.html diff --git a/apidocs/org/kiji/schema/KijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTableReader.html similarity index 100% rename from apidocs/org/kiji/schema/KijiTableReader.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTableReader.html diff --git a/apidocs/org/kiji/schema/KijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTableWriter.html similarity index 100% rename from apidocs/org/kiji/schema/KijiTableWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiTableWriter.html diff --git a/apidocs/org/kiji/schema/KijiURI.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiURI.html similarity index 100% rename from apidocs/org/kiji/schema/KijiURI.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiURI.html diff --git a/apidocs/org/kiji/schema/KijiURIException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiURIException.html similarity index 100% rename from apidocs/org/kiji/schema/KijiURIException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/KijiURIException.html diff --git a/apidocs/org/kiji/schema/NoCellDataException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/NoCellDataException.html similarity index 100% rename from apidocs/org/kiji/schema/NoCellDataException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/NoCellDataException.html diff --git a/apidocs/org/kiji/schema/NoSuchColumnException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/NoSuchColumnException.html similarity index 100% rename from apidocs/org/kiji/schema/NoSuchColumnException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/NoSuchColumnException.html diff --git a/apidocs/org/kiji/schema/NotAKijiManagedTableException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/NotAKijiManagedTableException.html similarity index 100% rename from apidocs/org/kiji/schema/NotAKijiManagedTableException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/NotAKijiManagedTableException.html diff --git a/apidocs/org/kiji/schema/PutLocalApiWriter.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/PutLocalApiWriter.Options.html similarity index 100% rename from apidocs/org/kiji/schema/PutLocalApiWriter.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/PutLocalApiWriter.Options.html diff --git a/apidocs/org/kiji/schema/PutLocalApiWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/PutLocalApiWriter.html similarity index 100% rename from apidocs/org/kiji/schema/PutLocalApiWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/PutLocalApiWriter.html diff --git a/apidocs/org/kiji/schema/PutWrapper.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/PutWrapper.html similarity index 100% rename from apidocs/org/kiji/schema/PutWrapper.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/PutWrapper.html diff --git a/apidocs/org/kiji/schema/SpecificCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/SpecificCellDecoderFactory.html similarity index 100% rename from apidocs/org/kiji/schema/SpecificCellDecoderFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/SpecificCellDecoderFactory.html diff --git a/apidocs/org/kiji/schema/TableKeyNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/TableKeyNotFoundException.html similarity index 100% rename from apidocs/org/kiji/schema/TableKeyNotFoundException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/TableKeyNotFoundException.html diff --git a/apidocs/org/kiji/schema/WrappedDataWriter.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/WrappedDataWriter.Options.html similarity index 100% rename from apidocs/org/kiji/schema/WrappedDataWriter.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/WrappedDataWriter.Options.html diff --git a/apidocs/org/kiji/schema/WrappedDataWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/WrappedDataWriter.html similarity index 100% rename from apidocs/org/kiji/schema/WrappedDataWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/WrappedDataWriter.html diff --git a/apidocs/org/kiji/schema/avro/CellSchema.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/CellSchema.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/CellSchema.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/CellSchema.Builder.html diff --git a/apidocs/org/kiji/schema/avro/CellSchema.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/CellSchema.html similarity index 100% rename from apidocs/org/kiji/schema/avro/CellSchema.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/CellSchema.html diff --git a/apidocs/org/kiji/schema/avro/ColumnDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/ColumnDesc.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/ColumnDesc.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/ColumnDesc.Builder.html diff --git a/apidocs/org/kiji/schema/avro/ColumnDesc.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/ColumnDesc.html similarity index 100% rename from apidocs/org/kiji/schema/avro/ColumnDesc.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/ColumnDesc.html diff --git a/apidocs/org/kiji/schema/avro/CompressionType.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/CompressionType.html similarity index 100% rename from apidocs/org/kiji/schema/avro/CompressionType.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/CompressionType.html diff --git a/apidocs/org/kiji/schema/avro/FamilyDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/FamilyDesc.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/FamilyDesc.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/FamilyDesc.Builder.html diff --git a/apidocs/org/kiji/schema/avro/FamilyDesc.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/FamilyDesc.html similarity index 100% rename from apidocs/org/kiji/schema/avro/FamilyDesc.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/FamilyDesc.html diff --git a/apidocs/org/kiji/schema/avro/HashType.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/HashType.html similarity index 100% rename from apidocs/org/kiji/schema/avro/HashType.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/HashType.html diff --git a/apidocs/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html similarity index 100% rename from apidocs/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html diff --git a/apidocs/org/kiji/schema/avro/KijiTableLayoutRecords.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/KijiTableLayoutRecords.html similarity index 100% rename from apidocs/org/kiji/schema/avro/KijiTableLayoutRecords.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/KijiTableLayoutRecords.html diff --git a/apidocs/org/kiji/schema/avro/LocalityGroupDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/LocalityGroupDesc.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/LocalityGroupDesc.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/LocalityGroupDesc.Builder.html diff --git a/apidocs/org/kiji/schema/avro/LocalityGroupDesc.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/LocalityGroupDesc.html similarity index 100% rename from apidocs/org/kiji/schema/avro/LocalityGroupDesc.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/LocalityGroupDesc.html diff --git a/apidocs/org/kiji/schema/avro/MD5Hash.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/MD5Hash.html similarity index 100% rename from apidocs/org/kiji/schema/avro/MD5Hash.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/MD5Hash.html diff --git a/apidocs/org/kiji/schema/avro/MetadataBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/MetadataBackup.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/MetadataBackup.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/MetadataBackup.Builder.html diff --git a/apidocs/org/kiji/schema/avro/MetadataBackup.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/MetadataBackup.html similarity index 100% rename from apidocs/org/kiji/schema/avro/MetadataBackup.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/MetadataBackup.html diff --git a/apidocs/org/kiji/schema/avro/RowKeyEncoding.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/RowKeyEncoding.html similarity index 100% rename from apidocs/org/kiji/schema/avro/RowKeyEncoding.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/RowKeyEncoding.html diff --git a/apidocs/org/kiji/schema/avro/RowKeyFormat.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/RowKeyFormat.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/RowKeyFormat.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/RowKeyFormat.Builder.html diff --git a/apidocs/org/kiji/schema/avro/RowKeyFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/RowKeyFormat.html similarity index 100% rename from apidocs/org/kiji/schema/avro/RowKeyFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/RowKeyFormat.html diff --git a/apidocs/org/kiji/schema/avro/SchemaStorage.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/SchemaStorage.html similarity index 100% rename from apidocs/org/kiji/schema/avro/SchemaStorage.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/SchemaStorage.html diff --git a/apidocs/org/kiji/schema/avro/SchemaTableEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/SchemaTableEntry.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/SchemaTableEntry.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/SchemaTableEntry.Builder.html diff --git a/apidocs/org/kiji/schema/avro/SchemaTableEntry.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/SchemaTableEntry.html similarity index 100% rename from apidocs/org/kiji/schema/avro/SchemaTableEntry.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/SchemaTableEntry.html diff --git a/apidocs/org/kiji/schema/avro/SchemaType.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/SchemaType.html similarity index 100% rename from apidocs/org/kiji/schema/avro/SchemaType.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/SchemaType.html diff --git a/apidocs/org/kiji/schema/avro/TableBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableBackup.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/TableBackup.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableBackup.Builder.html diff --git a/apidocs/org/kiji/schema/avro/TableBackup.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableBackup.html similarity index 100% rename from apidocs/org/kiji/schema/avro/TableBackup.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableBackup.html diff --git a/apidocs/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html diff --git a/apidocs/org/kiji/schema/avro/TableLayoutBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableLayoutBackupEntry.html similarity index 100% rename from apidocs/org/kiji/schema/avro/TableLayoutBackupEntry.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableLayoutBackupEntry.html diff --git a/apidocs/org/kiji/schema/avro/TableLayoutDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableLayoutDesc.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/TableLayoutDesc.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableLayoutDesc.Builder.html diff --git a/apidocs/org/kiji/schema/avro/TableLayoutDesc.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableLayoutDesc.html similarity index 100% rename from apidocs/org/kiji/schema/avro/TableLayoutDesc.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/TableLayoutDesc.html diff --git a/apidocs/org/kiji/schema/avro/class-use/CellSchema.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/CellSchema.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/CellSchema.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/CellSchema.Builder.html diff --git a/apidocs/org/kiji/schema/avro/class-use/CellSchema.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/CellSchema.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/CellSchema.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/CellSchema.html diff --git a/apidocs/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html diff --git a/apidocs/org/kiji/schema/avro/class-use/ColumnDesc.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/ColumnDesc.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/ColumnDesc.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/ColumnDesc.html diff --git a/apidocs/org/kiji/schema/avro/class-use/CompressionType.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/CompressionType.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/CompressionType.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/CompressionType.html diff --git a/apidocs/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html diff --git a/apidocs/org/kiji/schema/avro/class-use/FamilyDesc.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/FamilyDesc.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/FamilyDesc.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/FamilyDesc.html diff --git a/apidocs/org/kiji/schema/avro/class-use/HashType.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/HashType.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/HashType.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/HashType.html diff --git a/apidocs/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html diff --git a/apidocs/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html diff --git a/apidocs/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html diff --git a/apidocs/org/kiji/schema/avro/class-use/LocalityGroupDesc.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/LocalityGroupDesc.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/LocalityGroupDesc.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/LocalityGroupDesc.html diff --git a/apidocs/org/kiji/schema/avro/class-use/MD5Hash.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/MD5Hash.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/MD5Hash.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/MD5Hash.html diff --git a/apidocs/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html diff --git a/apidocs/org/kiji/schema/avro/class-use/MetadataBackup.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/MetadataBackup.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/MetadataBackup.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/MetadataBackup.html diff --git a/apidocs/org/kiji/schema/avro/class-use/RowKeyEncoding.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/RowKeyEncoding.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/RowKeyEncoding.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/RowKeyEncoding.html diff --git a/apidocs/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html diff --git a/apidocs/org/kiji/schema/avro/class-use/RowKeyFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/RowKeyFormat.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/RowKeyFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/RowKeyFormat.html diff --git a/apidocs/org/kiji/schema/avro/class-use/SchemaStorage.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/SchemaStorage.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/SchemaStorage.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/SchemaStorage.html diff --git a/apidocs/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html diff --git a/apidocs/org/kiji/schema/avro/class-use/SchemaTableEntry.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/SchemaTableEntry.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/SchemaTableEntry.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/SchemaTableEntry.html diff --git a/apidocs/org/kiji/schema/avro/class-use/SchemaType.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/SchemaType.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/SchemaType.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/SchemaType.html diff --git a/apidocs/org/kiji/schema/avro/class-use/TableBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableBackup.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/TableBackup.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableBackup.Builder.html diff --git a/apidocs/org/kiji/schema/avro/class-use/TableBackup.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableBackup.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/TableBackup.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableBackup.html diff --git a/apidocs/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html diff --git a/apidocs/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html diff --git a/apidocs/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html diff --git a/apidocs/org/kiji/schema/avro/class-use/TableLayoutDesc.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableLayoutDesc.html similarity index 100% rename from apidocs/org/kiji/schema/avro/class-use/TableLayoutDesc.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/class-use/TableLayoutDesc.html diff --git a/apidocs/org/kiji/schema/avro/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/package-frame.html similarity index 100% rename from apidocs/org/kiji/schema/avro/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/package-frame.html diff --git a/apidocs/org/kiji/schema/avro/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/package-summary.html similarity index 100% rename from apidocs/org/kiji/schema/avro/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/package-summary.html diff --git a/apidocs/org/kiji/schema/avro/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/package-tree.html similarity index 100% rename from apidocs/org/kiji/schema/avro/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/package-tree.html diff --git a/apidocs/org/kiji/schema/avro/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/package-use.html similarity index 100% rename from apidocs/org/kiji/schema/avro/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/avro/package-use.html diff --git a/apidocs/org/kiji/schema/class-use/EntityId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/EntityId.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/EntityId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/EntityId.html diff --git a/apidocs/org/kiji/schema/class-use/EntityIdFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/EntityIdFactory.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/EntityIdFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/EntityIdFactory.html diff --git a/apidocs/org/kiji/schema/class-use/GenericCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/GenericCellDecoderFactory.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/GenericCellDecoderFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/GenericCellDecoderFactory.html diff --git a/apidocs/org/kiji/schema/class-use/HBaseColumnName.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/HBaseColumnName.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/HBaseColumnName.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/HBaseColumnName.html diff --git a/apidocs/org/kiji/schema/class-use/HBaseScanOptions.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/HBaseScanOptions.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/HBaseScanOptions.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/HBaseScanOptions.html diff --git a/apidocs/org/kiji/schema/class-use/IncompatibleKijiVersionException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/IncompatibleKijiVersionException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/IncompatibleKijiVersionException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/IncompatibleKijiVersionException.html diff --git a/apidocs/org/kiji/schema/class-use/InternalKijiError.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/InternalKijiError.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/InternalKijiError.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/InternalKijiError.html diff --git a/apidocs/org/kiji/schema/class-use/KeyValueBackedWrapper.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KeyValueBackedWrapper.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KeyValueBackedWrapper.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KeyValueBackedWrapper.html diff --git a/apidocs/org/kiji/schema/class-use/Kiji.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/Kiji.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/Kiji.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/Kiji.html diff --git a/apidocs/org/kiji/schema/class-use/KijiAdmin.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiAdmin.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiAdmin.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiAdmin.html diff --git a/apidocs/org/kiji/schema/class-use/KijiCell.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCell.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiCell.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCell.html diff --git a/apidocs/org/kiji/schema/class-use/KijiCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCellDecoder.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiCellDecoder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCellDecoder.html diff --git a/apidocs/org/kiji/schema/class-use/KijiCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCellDecoderFactory.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiCellDecoderFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCellDecoderFactory.html diff --git a/apidocs/org/kiji/schema/class-use/KijiCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCellEncoder.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiCellEncoder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCellEncoder.html diff --git a/apidocs/org/kiji/schema/class-use/KijiCellFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCellFormat.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiCellFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCellFormat.html diff --git a/apidocs/org/kiji/schema/class-use/KijiColumnName.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiColumnName.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiColumnName.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiColumnName.html diff --git a/apidocs/org/kiji/schema/class-use/KijiColumnPager.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiColumnPager.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiColumnPager.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiColumnPager.html diff --git a/apidocs/org/kiji/schema/class-use/KijiColumnPagingNotEnabledException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiColumnPagingNotEnabledException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiColumnPagingNotEnabledException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiColumnPagingNotEnabledException.html diff --git a/apidocs/org/kiji/schema/class-use/KijiConfiguration.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiConfiguration.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiConfiguration.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiConfiguration.html diff --git a/apidocs/org/kiji/schema/class-use/KijiCounter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCounter.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiCounter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiCounter.html diff --git a/apidocs/org/kiji/schema/class-use/KijiDataRequest.Column.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataRequest.Column.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiDataRequest.Column.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataRequest.Column.html diff --git a/apidocs/org/kiji/schema/class-use/KijiDataRequest.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataRequest.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiDataRequest.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataRequest.html diff --git a/apidocs/org/kiji/schema/class-use/KijiDataRequestException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataRequestException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiDataRequestException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataRequestException.html diff --git a/apidocs/org/kiji/schema/class-use/KijiDataRequestValidator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataRequestValidator.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiDataRequestValidator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataRequestValidator.html diff --git a/apidocs/org/kiji/schema/class-use/KijiDataWrapper.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataWrapper.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiDataWrapper.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataWrapper.html diff --git a/apidocs/org/kiji/schema/class-use/KijiDataWriter.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataWriter.Options.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiDataWriter.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataWriter.Options.html diff --git a/apidocs/org/kiji/schema/class-use/KijiDataWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataWriter.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiDataWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiDataWriter.html diff --git a/apidocs/org/kiji/schema/class-use/KijiInstaller.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiInstaller.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiInstaller.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiInstaller.html diff --git a/apidocs/org/kiji/schema/class-use/KijiInvalidNameException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiInvalidNameException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiInvalidNameException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiInvalidNameException.html diff --git a/apidocs/org/kiji/schema/class-use/KijiManagedHBaseTableName.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiManagedHBaseTableName.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiManagedHBaseTableName.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiManagedHBaseTableName.html diff --git a/apidocs/org/kiji/schema/class-use/KijiMetaTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiMetaTable.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiMetaTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiMetaTable.html diff --git a/apidocs/org/kiji/schema/class-use/KijiNotInstalledException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiNotInstalledException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiNotInstalledException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiNotInstalledException.html diff --git a/apidocs/org/kiji/schema/class-use/KijiRowData.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiRowData.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiRowData.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiRowData.html diff --git a/apidocs/org/kiji/schema/class-use/KijiRowKeySplitter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiRowKeySplitter.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiRowKeySplitter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiRowKeySplitter.html diff --git a/apidocs/org/kiji/schema/class-use/KijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiRowScanner.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiRowScanner.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiRowScanner.html diff --git a/apidocs/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html diff --git a/apidocs/org/kiji/schema/class-use/KijiSchemaTable.SchemaHashCache.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiSchemaTable.SchemaHashCache.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiSchemaTable.SchemaHashCache.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiSchemaTable.SchemaHashCache.html diff --git a/apidocs/org/kiji/schema/class-use/KijiSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiSchemaTable.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiSchemaTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiSchemaTable.html diff --git a/apidocs/org/kiji/schema/class-use/KijiSystemTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiSystemTable.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiSystemTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiSystemTable.html diff --git a/apidocs/org/kiji/schema/class-use/KijiTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTable.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTable.html diff --git a/apidocs/org/kiji/schema/class-use/KijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTableFactory.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiTableFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTableFactory.html diff --git a/apidocs/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html diff --git a/apidocs/org/kiji/schema/class-use/KijiTableNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTableNotFoundException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiTableNotFoundException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTableNotFoundException.html diff --git a/apidocs/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html diff --git a/apidocs/org/kiji/schema/class-use/KijiTablePool.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTablePool.Options.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiTablePool.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTablePool.Options.html diff --git a/apidocs/org/kiji/schema/class-use/KijiTablePool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTablePool.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiTablePool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTablePool.html diff --git a/apidocs/org/kiji/schema/class-use/KijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTableReader.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiTableReader.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTableReader.html diff --git a/apidocs/org/kiji/schema/class-use/KijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTableWriter.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiTableWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiTableWriter.html diff --git a/apidocs/org/kiji/schema/class-use/KijiURI.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiURI.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiURI.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiURI.html diff --git a/apidocs/org/kiji/schema/class-use/KijiURIException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiURIException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/KijiURIException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/KijiURIException.html diff --git a/apidocs/org/kiji/schema/class-use/NoCellDataException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/NoCellDataException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/NoCellDataException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/NoCellDataException.html diff --git a/apidocs/org/kiji/schema/class-use/NoSuchColumnException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/NoSuchColumnException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/NoSuchColumnException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/NoSuchColumnException.html diff --git a/apidocs/org/kiji/schema/class-use/NotAKijiManagedTableException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/NotAKijiManagedTableException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/NotAKijiManagedTableException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/NotAKijiManagedTableException.html diff --git a/apidocs/org/kiji/schema/class-use/PutLocalApiWriter.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/PutLocalApiWriter.Options.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/PutLocalApiWriter.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/PutLocalApiWriter.Options.html diff --git a/apidocs/org/kiji/schema/class-use/PutLocalApiWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/PutLocalApiWriter.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/PutLocalApiWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/PutLocalApiWriter.html diff --git a/apidocs/org/kiji/schema/class-use/PutWrapper.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/PutWrapper.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/PutWrapper.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/PutWrapper.html diff --git a/apidocs/org/kiji/schema/class-use/SpecificCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/SpecificCellDecoderFactory.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/SpecificCellDecoderFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/SpecificCellDecoderFactory.html diff --git a/apidocs/org/kiji/schema/class-use/TableKeyNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/TableKeyNotFoundException.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/TableKeyNotFoundException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/TableKeyNotFoundException.html diff --git a/apidocs/org/kiji/schema/class-use/WrappedDataWriter.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/WrappedDataWriter.Options.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/WrappedDataWriter.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/WrappedDataWriter.Options.html diff --git a/apidocs/org/kiji/schema/class-use/WrappedDataWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/WrappedDataWriter.html similarity index 100% rename from apidocs/org/kiji/schema/class-use/WrappedDataWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/class-use/WrappedDataWriter.html diff --git a/apidocs/org/kiji/schema/filter/AndRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/AndRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/AndRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/AndRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/HasColumnDataRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/HasColumnDataRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/HasColumnDataRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/HasColumnDataRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/KijiColumnFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/KijiColumnFilter.Context.html similarity index 100% rename from apidocs/org/kiji/schema/filter/KijiColumnFilter.Context.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/KijiColumnFilter.Context.html diff --git a/apidocs/org/kiji/schema/filter/KijiColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/KijiColumnFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/KijiColumnFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/KijiColumnFilter.html diff --git a/apidocs/org/kiji/schema/filter/KijiRowFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/KijiRowFilter.Context.html similarity index 100% rename from apidocs/org/kiji/schema/filter/KijiRowFilter.Context.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/KijiRowFilter.Context.html diff --git a/apidocs/org/kiji/schema/filter/KijiRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/KijiRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/KijiRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/KijiRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/KijiRowFilterApplicator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/KijiRowFilterApplicator.html similarity index 100% rename from apidocs/org/kiji/schema/filter/KijiRowFilterApplicator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/KijiRowFilterApplicator.html diff --git a/apidocs/org/kiji/schema/filter/OperatorRowFilter.Operator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/OperatorRowFilter.Operator.html similarity index 100% rename from apidocs/org/kiji/schema/filter/OperatorRowFilter.Operator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/OperatorRowFilter.Operator.html diff --git a/apidocs/org/kiji/schema/filter/OperatorRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/OperatorRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/OperatorRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/OperatorRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/OrRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/OrRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/OrRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/OrRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/RegexQualifierColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/RegexQualifierColumnFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/RegexQualifierColumnFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/RegexQualifierColumnFilter.html diff --git a/apidocs/org/kiji/schema/filter/StripValueRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/StripValueRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/StripValueRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/StripValueRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/class-use/AndRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/AndRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/AndRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/AndRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html diff --git a/apidocs/org/kiji/schema/filter/class-use/KijiColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/KijiColumnFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/KijiColumnFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/KijiColumnFilter.html diff --git a/apidocs/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html diff --git a/apidocs/org/kiji/schema/filter/class-use/KijiRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/KijiRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/KijiRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/KijiRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html diff --git a/apidocs/org/kiji/schema/filter/class-use/OperatorRowFilter.Operator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/OperatorRowFilter.Operator.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/OperatorRowFilter.Operator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/OperatorRowFilter.Operator.html diff --git a/apidocs/org/kiji/schema/filter/class-use/OperatorRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/OperatorRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/OperatorRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/OperatorRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/class-use/OrRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/OrRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/OrRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/OrRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html diff --git a/apidocs/org/kiji/schema/filter/class-use/StripValueRowFilter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/StripValueRowFilter.html similarity index 100% rename from apidocs/org/kiji/schema/filter/class-use/StripValueRowFilter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/class-use/StripValueRowFilter.html diff --git a/apidocs/org/kiji/schema/filter/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/package-frame.html similarity index 100% rename from apidocs/org/kiji/schema/filter/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/package-frame.html diff --git a/apidocs/org/kiji/schema/filter/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/package-summary.html similarity index 100% rename from apidocs/org/kiji/schema/filter/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/package-summary.html diff --git a/apidocs/org/kiji/schema/filter/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/package-tree.html similarity index 100% rename from apidocs/org/kiji/schema/filter/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/package-tree.html diff --git a/apidocs/org/kiji/schema/filter/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/package-use.html similarity index 100% rename from apidocs/org/kiji/schema/filter/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/filter/package-use.html diff --git a/apidocs/org/kiji/schema/impl/AbstractKijiRowData.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/AbstractKijiRowData.html similarity index 100% rename from apidocs/org/kiji/schema/impl/AbstractKijiRowData.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/AbstractKijiRowData.html diff --git a/apidocs/org/kiji/schema/impl/AbstractKijiTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/AbstractKijiTable.html similarity index 100% rename from apidocs/org/kiji/schema/impl/AbstractKijiTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/AbstractKijiTable.html diff --git a/apidocs/org/kiji/schema/impl/DefaultKijiCounter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/DefaultKijiCounter.html similarity index 100% rename from apidocs/org/kiji/schema/impl/DefaultKijiCounter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/DefaultKijiCounter.html diff --git a/apidocs/org/kiji/schema/impl/DefaultKijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/DefaultKijiTableFactory.html similarity index 100% rename from apidocs/org/kiji/schema/impl/DefaultKijiTableFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/DefaultKijiTableFactory.html diff --git a/apidocs/org/kiji/schema/impl/GenericCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/GenericCellDecoder.html similarity index 100% rename from apidocs/org/kiji/schema/impl/GenericCellDecoder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/GenericCellDecoder.html diff --git a/apidocs/org/kiji/schema/impl/HBaseDataRequestAdapter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseDataRequestAdapter.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseDataRequestAdapter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseDataRequestAdapter.html diff --git a/apidocs/org/kiji/schema/impl/HBaseEntityId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseEntityId.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseEntityId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseEntityId.html diff --git a/apidocs/org/kiji/schema/impl/HBaseKijiRowData.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiRowData.Options.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseKijiRowData.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiRowData.Options.html diff --git a/apidocs/org/kiji/schema/impl/HBaseKijiRowData.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiRowData.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseKijiRowData.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiRowData.html diff --git a/apidocs/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html diff --git a/apidocs/org/kiji/schema/impl/HBaseKijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiRowScanner.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseKijiRowScanner.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiRowScanner.html diff --git a/apidocs/org/kiji/schema/impl/HBaseKijiTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiTable.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseKijiTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiTable.html diff --git a/apidocs/org/kiji/schema/impl/HBaseKijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiTableReader.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseKijiTableReader.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiTableReader.html diff --git a/apidocs/org/kiji/schema/impl/HBaseKijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiTableWriter.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseKijiTableWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseKijiTableWriter.html diff --git a/apidocs/org/kiji/schema/impl/HBaseMetaTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseMetaTable.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseMetaTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseMetaTable.html diff --git a/apidocs/org/kiji/schema/impl/HBaseSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseSchemaTable.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseSchemaTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseSchemaTable.html diff --git a/apidocs/org/kiji/schema/impl/HBaseSystemTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseSystemTable.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseSystemTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseSystemTable.html diff --git a/apidocs/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html diff --git a/apidocs/org/kiji/schema/impl/HBaseTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseTableRecordReader.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HBaseTableRecordReader.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HBaseTableRecordReader.html diff --git a/apidocs/org/kiji/schema/impl/HColumnDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HColumnDescriptorComparator.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HColumnDescriptorComparator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HColumnDescriptorComparator.html diff --git a/apidocs/org/kiji/schema/impl/HTableDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HTableDescriptorComparator.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HTableDescriptorComparator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HTableDescriptorComparator.html diff --git a/apidocs/org/kiji/schema/impl/HTableFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HTableFactory.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HTableFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HTableFactory.html diff --git a/apidocs/org/kiji/schema/impl/HashPrefixedEntityId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HashPrefixedEntityId.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HashPrefixedEntityId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HashPrefixedEntityId.html diff --git a/apidocs/org/kiji/schema/impl/HashedEntityId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HashedEntityId.html similarity index 100% rename from apidocs/org/kiji/schema/impl/HashedEntityId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/HashedEntityId.html diff --git a/apidocs/org/kiji/schema/impl/InvalidColumnNameException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/InvalidColumnNameException.html similarity index 100% rename from apidocs/org/kiji/schema/impl/InvalidColumnNameException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/InvalidColumnNameException.html diff --git a/apidocs/org/kiji/schema/impl/KijiDataBuffer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/KijiDataBuffer.html similarity index 100% rename from apidocs/org/kiji/schema/impl/KijiDataBuffer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/KijiDataBuffer.html diff --git a/apidocs/org/kiji/schema/impl/LocalApiWriter.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/LocalApiWriter.Options.html similarity index 100% rename from apidocs/org/kiji/schema/impl/LocalApiWriter.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/LocalApiWriter.Options.html diff --git a/apidocs/org/kiji/schema/impl/LocalApiWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/LocalApiWriter.html similarity index 100% rename from apidocs/org/kiji/schema/impl/LocalApiWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/LocalApiWriter.html diff --git a/apidocs/org/kiji/schema/impl/RawEntityId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/RawEntityId.html similarity index 100% rename from apidocs/org/kiji/schema/impl/RawEntityId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/RawEntityId.html diff --git a/apidocs/org/kiji/schema/impl/SpecificCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/SpecificCellDecoder.html similarity index 100% rename from apidocs/org/kiji/schema/impl/SpecificCellDecoder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/SpecificCellDecoder.html diff --git a/apidocs/org/kiji/schema/impl/class-use/AbstractKijiRowData.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/AbstractKijiRowData.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/AbstractKijiRowData.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/AbstractKijiRowData.html diff --git a/apidocs/org/kiji/schema/impl/class-use/AbstractKijiTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/AbstractKijiTable.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/AbstractKijiTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/AbstractKijiTable.html diff --git a/apidocs/org/kiji/schema/impl/class-use/DefaultKijiCounter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/DefaultKijiCounter.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/DefaultKijiCounter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/DefaultKijiCounter.html diff --git a/apidocs/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html diff --git a/apidocs/org/kiji/schema/impl/class-use/GenericCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/GenericCellDecoder.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/GenericCellDecoder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/GenericCellDecoder.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseEntityId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseEntityId.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseEntityId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseEntityId.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseKijiRowData.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiRowData.Options.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseKijiRowData.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiRowData.Options.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseKijiRowData.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiRowData.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseKijiRowData.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiRowData.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseKijiTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiTable.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseKijiTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiTable.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseMetaTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseMetaTable.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseMetaTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseMetaTable.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseSchemaTable.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseSchemaTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseSchemaTable.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseSystemTable.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseSystemTable.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseSystemTable.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseSystemTable.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HBaseTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseTableRecordReader.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HBaseTableRecordReader.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HBaseTableRecordReader.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HTableFactory.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HTableFactory.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HTableFactory.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HTableFactory.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html diff --git a/apidocs/org/kiji/schema/impl/class-use/HashedEntityId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HashedEntityId.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/HashedEntityId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/HashedEntityId.html diff --git a/apidocs/org/kiji/schema/impl/class-use/InvalidColumnNameException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/InvalidColumnNameException.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/InvalidColumnNameException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/InvalidColumnNameException.html diff --git a/apidocs/org/kiji/schema/impl/class-use/KijiDataBuffer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/KijiDataBuffer.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/KijiDataBuffer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/KijiDataBuffer.html diff --git a/apidocs/org/kiji/schema/impl/class-use/LocalApiWriter.Options.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/LocalApiWriter.Options.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/LocalApiWriter.Options.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/LocalApiWriter.Options.html diff --git a/apidocs/org/kiji/schema/impl/class-use/LocalApiWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/LocalApiWriter.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/LocalApiWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/LocalApiWriter.html diff --git a/apidocs/org/kiji/schema/impl/class-use/RawEntityId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/RawEntityId.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/RawEntityId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/RawEntityId.html diff --git a/apidocs/org/kiji/schema/impl/class-use/SpecificCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/SpecificCellDecoder.html similarity index 100% rename from apidocs/org/kiji/schema/impl/class-use/SpecificCellDecoder.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/class-use/SpecificCellDecoder.html diff --git a/apidocs/org/kiji/schema/impl/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/package-frame.html similarity index 100% rename from apidocs/org/kiji/schema/impl/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/package-frame.html diff --git a/apidocs/org/kiji/schema/impl/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/package-summary.html similarity index 100% rename from apidocs/org/kiji/schema/impl/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/package-summary.html diff --git a/apidocs/org/kiji/schema/impl/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/package-tree.html similarity index 100% rename from apidocs/org/kiji/schema/impl/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/package-tree.html diff --git a/apidocs/org/kiji/schema/impl/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/package-use.html similarity index 100% rename from apidocs/org/kiji/schema/impl/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/impl/package-use.html diff --git a/apidocs/org/kiji/schema/layout/ColumnNameTranslator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/ColumnNameTranslator.html similarity index 100% rename from apidocs/org/kiji/schema/layout/ColumnNameTranslator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/ColumnNameTranslator.html diff --git a/apidocs/org/kiji/schema/layout/InvalidLayoutException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/InvalidLayoutException.html similarity index 100% rename from apidocs/org/kiji/schema/layout/InvalidLayoutException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/InvalidLayoutException.html diff --git a/apidocs/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html similarity index 100% rename from apidocs/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html diff --git a/apidocs/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html similarity index 100% rename from apidocs/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html diff --git a/apidocs/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html similarity index 100% rename from apidocs/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html diff --git a/apidocs/org/kiji/schema/layout/KijiTableLayout.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/KijiTableLayout.html similarity index 100% rename from apidocs/org/kiji/schema/layout/KijiTableLayout.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/KijiTableLayout.html diff --git a/apidocs/org/kiji/schema/layout/KijiTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/KijiTableLayoutDatabase.html similarity index 100% rename from apidocs/org/kiji/schema/layout/KijiTableLayoutDatabase.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/KijiTableLayoutDatabase.html diff --git a/apidocs/org/kiji/schema/layout/SchemaClassNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/SchemaClassNotFoundException.html similarity index 100% rename from apidocs/org/kiji/schema/layout/SchemaClassNotFoundException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/SchemaClassNotFoundException.html diff --git a/apidocs/org/kiji/schema/layout/TableLayoutSerializer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/TableLayoutSerializer.html similarity index 100% rename from apidocs/org/kiji/schema/layout/TableLayoutSerializer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/TableLayoutSerializer.html diff --git a/apidocs/org/kiji/schema/layout/class-use/ColumnNameTranslator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/ColumnNameTranslator.html similarity index 100% rename from apidocs/org/kiji/schema/layout/class-use/ColumnNameTranslator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/ColumnNameTranslator.html diff --git a/apidocs/org/kiji/schema/layout/class-use/InvalidLayoutException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/InvalidLayoutException.html similarity index 100% rename from apidocs/org/kiji/schema/layout/class-use/InvalidLayoutException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/InvalidLayoutException.html diff --git a/apidocs/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html similarity index 100% rename from apidocs/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html diff --git a/apidocs/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html similarity index 100% rename from apidocs/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html diff --git a/apidocs/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html similarity index 100% rename from apidocs/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html diff --git a/apidocs/org/kiji/schema/layout/class-use/KijiTableLayout.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/KijiTableLayout.html similarity index 100% rename from apidocs/org/kiji/schema/layout/class-use/KijiTableLayout.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/KijiTableLayout.html diff --git a/apidocs/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html similarity index 100% rename from apidocs/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html diff --git a/apidocs/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html similarity index 100% rename from apidocs/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html diff --git a/apidocs/org/kiji/schema/layout/class-use/TableLayoutSerializer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/TableLayoutSerializer.html similarity index 100% rename from apidocs/org/kiji/schema/layout/class-use/TableLayoutSerializer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/class-use/TableLayoutSerializer.html diff --git a/apidocs/org/kiji/schema/layout/impl/ColumnId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/ColumnId.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/ColumnId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/ColumnId.html diff --git a/apidocs/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html diff --git a/apidocs/org/kiji/schema/layout/impl/HTableSchemaTranslator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/HTableSchemaTranslator.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/HTableSchemaTranslator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/HTableSchemaTranslator.html diff --git a/apidocs/org/kiji/schema/layout/impl/InMemoryTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/InMemoryTableLayoutDatabase.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/InMemoryTableLayoutDatabase.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/InMemoryTableLayoutDatabase.html diff --git a/apidocs/org/kiji/schema/layout/impl/class-use/ColumnId.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/class-use/ColumnId.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/class-use/ColumnId.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/class-use/ColumnId.html diff --git a/apidocs/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html diff --git a/apidocs/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html diff --git a/apidocs/org/kiji/schema/layout/impl/class-use/InMemoryTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/class-use/InMemoryTableLayoutDatabase.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/class-use/InMemoryTableLayoutDatabase.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/class-use/InMemoryTableLayoutDatabase.html diff --git a/apidocs/org/kiji/schema/layout/impl/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/package-frame.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/package-frame.html diff --git a/apidocs/org/kiji/schema/layout/impl/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/package-summary.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/package-summary.html diff --git a/apidocs/org/kiji/schema/layout/impl/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/package-tree.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/package-tree.html diff --git a/apidocs/org/kiji/schema/layout/impl/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/package-use.html similarity index 100% rename from apidocs/org/kiji/schema/layout/impl/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/impl/package-use.html diff --git a/apidocs/org/kiji/schema/layout/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/package-frame.html similarity index 100% rename from apidocs/org/kiji/schema/layout/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/package-frame.html diff --git a/apidocs/org/kiji/schema/layout/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/package-summary.html similarity index 100% rename from apidocs/org/kiji/schema/layout/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/package-summary.html diff --git a/apidocs/org/kiji/schema/layout/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/package-tree.html similarity index 100% rename from apidocs/org/kiji/schema/layout/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/package-tree.html diff --git a/apidocs/org/kiji/schema/layout/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/package-use.html similarity index 100% rename from apidocs/org/kiji/schema/layout/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/layout/package-use.html diff --git a/apidocs/org/kiji/schema/mapreduce/ContextKijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/ContextKijiTableWriter.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/ContextKijiTableWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/ContextKijiTableWriter.html diff --git a/apidocs/org/kiji/schema/mapreduce/DistributedCacheJars.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/DistributedCacheJars.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/DistributedCacheJars.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/DistributedCacheJars.html diff --git a/apidocs/org/kiji/schema/mapreduce/HTableInputFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/HTableInputFormat.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/HTableInputFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/HTableInputFormat.html diff --git a/apidocs/org/kiji/schema/mapreduce/HTableOutputFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/HTableOutputFormat.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/HTableOutputFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/HTableOutputFormat.html diff --git a/apidocs/org/kiji/schema/mapreduce/KijiDelete.KijiDeleteScope.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiDelete.KijiDeleteScope.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/KijiDelete.KijiDeleteScope.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiDelete.KijiDeleteScope.html diff --git a/apidocs/org/kiji/schema/mapreduce/KijiDelete.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiDelete.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/KijiDelete.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiDelete.html diff --git a/apidocs/org/kiji/schema/mapreduce/KijiIncrement.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiIncrement.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/KijiIncrement.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiIncrement.html diff --git a/apidocs/org/kiji/schema/mapreduce/KijiMutation.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiMutation.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/KijiMutation.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiMutation.html diff --git a/apidocs/org/kiji/schema/mapreduce/KijiOutput.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiOutput.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/KijiOutput.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiOutput.html diff --git a/apidocs/org/kiji/schema/mapreduce/KijiPut.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiPut.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/KijiPut.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiPut.html diff --git a/apidocs/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html diff --git a/apidocs/org/kiji/schema/mapreduce/KijiTableInputFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiTableInputFormat.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/KijiTableInputFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiTableInputFormat.html diff --git a/apidocs/org/kiji/schema/mapreduce/KijiTableOutputFormat.KijiTableRecordWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiTableOutputFormat.KijiTableRecordWriter.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/KijiTableOutputFormat.KijiTableRecordWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiTableOutputFormat.KijiTableRecordWriter.html diff --git a/apidocs/org/kiji/schema/mapreduce/KijiTableOutputFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiTableOutputFormat.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/KijiTableOutputFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/KijiTableOutputFormat.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/ContextKijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/ContextKijiTableWriter.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/ContextKijiTableWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/ContextKijiTableWriter.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/HTableInputFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/HTableInputFormat.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/HTableInputFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/HTableInputFormat.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/HTableOutputFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/HTableOutputFormat.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/HTableOutputFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/HTableOutputFormat.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/KijiDelete.KijiDeleteScope.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiDelete.KijiDeleteScope.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/KijiDelete.KijiDeleteScope.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiDelete.KijiDeleteScope.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/KijiDelete.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiDelete.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/KijiDelete.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiDelete.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/KijiIncrement.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiIncrement.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/KijiIncrement.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiIncrement.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/KijiMutation.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiMutation.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/KijiMutation.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiMutation.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/KijiOutput.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiOutput.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/KijiOutput.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiOutput.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/KijiPut.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiPut.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/KijiPut.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiPut.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/KijiTableOutputFormat.KijiTableRecordWriter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiTableOutputFormat.KijiTableRecordWriter.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/KijiTableOutputFormat.KijiTableRecordWriter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiTableOutputFormat.KijiTableRecordWriter.html diff --git a/apidocs/org/kiji/schema/mapreduce/class-use/KijiTableOutputFormat.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiTableOutputFormat.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/class-use/KijiTableOutputFormat.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/class-use/KijiTableOutputFormat.html diff --git a/apidocs/org/kiji/schema/mapreduce/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/package-frame.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/package-frame.html diff --git a/apidocs/org/kiji/schema/mapreduce/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/package-summary.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/package-summary.html diff --git a/apidocs/org/kiji/schema/mapreduce/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/package-tree.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/package-tree.html diff --git a/apidocs/org/kiji/schema/mapreduce/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/package-use.html similarity index 100% rename from apidocs/org/kiji/schema/mapreduce/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/mapreduce/package-use.html diff --git a/apidocs/org/kiji/schema/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/package-frame.html similarity index 100% rename from apidocs/org/kiji/schema/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/package-frame.html diff --git a/apidocs/org/kiji/schema/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/package-summary.html similarity index 100% rename from apidocs/org/kiji/schema/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/package-summary.html diff --git a/apidocs/org/kiji/schema/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/package-tree.html similarity index 100% rename from apidocs/org/kiji/schema/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/package-tree.html diff --git a/apidocs/org/kiji/schema/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/package-use.html similarity index 100% rename from apidocs/org/kiji/schema/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/package-use.html diff --git a/apidocs/org/kiji/schema/tools/BaseTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/BaseTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/BaseTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/BaseTool.html diff --git a/apidocs/org/kiji/schema/tools/CreateTableTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/CreateTableTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/CreateTableTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/CreateTableTool.html diff --git a/apidocs/org/kiji/schema/tools/DeleteTableTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/DeleteTableTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/DeleteTableTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/DeleteTableTool.html diff --git a/apidocs/org/kiji/schema/tools/FlushTableTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/FlushTableTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/FlushTableTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/FlushTableTool.html diff --git a/apidocs/org/kiji/schema/tools/IncrementTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/IncrementTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/IncrementTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/IncrementTool.html diff --git a/apidocs/org/kiji/schema/tools/InstallTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/InstallTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/InstallTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/InstallTool.html diff --git a/apidocs/org/kiji/schema/tools/KijiTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/KijiTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/KijiTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/KijiTool.html diff --git a/apidocs/org/kiji/schema/tools/LayoutTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/LayoutTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/LayoutTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/LayoutTool.html diff --git a/apidocs/org/kiji/schema/tools/LsTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/LsTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/LsTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/LsTool.html diff --git a/apidocs/org/kiji/schema/tools/PutTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/PutTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/PutTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/PutTool.html diff --git a/apidocs/org/kiji/schema/tools/RequiredFlagException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/RequiredFlagException.html similarity index 100% rename from apidocs/org/kiji/schema/tools/RequiredFlagException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/RequiredFlagException.html diff --git a/apidocs/org/kiji/schema/tools/SynthesizeUserDataTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/SynthesizeUserDataTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/SynthesizeUserDataTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/SynthesizeUserDataTool.html diff --git a/apidocs/org/kiji/schema/tools/ToolUtils.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/ToolUtils.html similarity index 100% rename from apidocs/org/kiji/schema/tools/ToolUtils.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/ToolUtils.html diff --git a/apidocs/org/kiji/schema/tools/UninstallTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/UninstallTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/UninstallTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/UninstallTool.html diff --git a/apidocs/org/kiji/schema/tools/VersionTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/VersionTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/VersionTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/VersionTool.html diff --git a/apidocs/org/kiji/schema/tools/VersionValidatedTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/VersionValidatedTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/VersionValidatedTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/VersionValidatedTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/BaseTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/BaseTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/BaseTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/BaseTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/CreateTableTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/CreateTableTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/CreateTableTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/CreateTableTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/DeleteTableTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/DeleteTableTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/DeleteTableTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/DeleteTableTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/FlushTableTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/FlushTableTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/FlushTableTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/FlushTableTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/IncrementTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/IncrementTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/IncrementTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/IncrementTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/InstallTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/InstallTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/InstallTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/InstallTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/KijiTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/KijiTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/KijiTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/KijiTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/LayoutTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/LayoutTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/LayoutTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/LayoutTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/LsTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/LsTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/LsTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/LsTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/PutTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/PutTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/PutTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/PutTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/RequiredFlagException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/RequiredFlagException.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/RequiredFlagException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/RequiredFlagException.html diff --git a/apidocs/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/ToolUtils.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/ToolUtils.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/ToolUtils.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/ToolUtils.html diff --git a/apidocs/org/kiji/schema/tools/class-use/UninstallTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/UninstallTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/UninstallTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/UninstallTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/VersionTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/VersionTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/VersionTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/VersionTool.html diff --git a/apidocs/org/kiji/schema/tools/class-use/VersionValidatedTool.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/VersionValidatedTool.html similarity index 100% rename from apidocs/org/kiji/schema/tools/class-use/VersionValidatedTool.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/class-use/VersionValidatedTool.html diff --git a/apidocs/org/kiji/schema/tools/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/package-frame.html similarity index 100% rename from apidocs/org/kiji/schema/tools/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/package-frame.html diff --git a/apidocs/org/kiji/schema/tools/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/package-summary.html similarity index 100% rename from apidocs/org/kiji/schema/tools/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/package-summary.html diff --git a/apidocs/org/kiji/schema/tools/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/package-tree.html similarity index 100% rename from apidocs/org/kiji/schema/tools/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/package-tree.html diff --git a/apidocs/org/kiji/schema/tools/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/package-use.html similarity index 100% rename from apidocs/org/kiji/schema/tools/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/package-use.html diff --git a/apidocs/org/kiji/schema/tools/synth/DictionaryLoader.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/DictionaryLoader.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/DictionaryLoader.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/DictionaryLoader.html diff --git a/apidocs/org/kiji/schema/tools/synth/EmailSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/EmailSynthesizer.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/EmailSynthesizer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/EmailSynthesizer.html diff --git a/apidocs/org/kiji/schema/tools/synth/NGramSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/NGramSynthesizer.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/NGramSynthesizer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/NGramSynthesizer.html diff --git a/apidocs/org/kiji/schema/tools/synth/Synthesizer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/Synthesizer.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/Synthesizer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/Synthesizer.html diff --git a/apidocs/org/kiji/schema/tools/synth/WordSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/WordSynthesizer.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/WordSynthesizer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/WordSynthesizer.html diff --git a/apidocs/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html diff --git a/apidocs/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html diff --git a/apidocs/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html diff --git a/apidocs/org/kiji/schema/tools/synth/class-use/Synthesizer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/class-use/Synthesizer.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/class-use/Synthesizer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/class-use/Synthesizer.html diff --git a/apidocs/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html diff --git a/apidocs/org/kiji/schema/tools/synth/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/package-frame.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/package-frame.html diff --git a/apidocs/org/kiji/schema/tools/synth/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/package-summary.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/package-summary.html diff --git a/apidocs/org/kiji/schema/tools/synth/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/package-tree.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/package-tree.html diff --git a/apidocs/org/kiji/schema/tools/synth/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/package-use.html similarity index 100% rename from apidocs/org/kiji/schema/tools/synth/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/tools/synth/package-use.html diff --git a/apidocs/org/kiji/schema/util/AvroUtils.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/AvroUtils.html similarity index 100% rename from apidocs/org/kiji/schema/util/AvroUtils.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/AvroUtils.html diff --git a/apidocs/org/kiji/schema/util/ByteArrayFormatter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/ByteArrayFormatter.html similarity index 100% rename from apidocs/org/kiji/schema/util/ByteArrayFormatter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/ByteArrayFormatter.html diff --git a/apidocs/org/kiji/schema/util/ByteStreamArray.EncodingException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/ByteStreamArray.EncodingException.html similarity index 100% rename from apidocs/org/kiji/schema/util/ByteStreamArray.EncodingException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/ByteStreamArray.EncodingException.html diff --git a/apidocs/org/kiji/schema/util/ByteStreamArray.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/ByteStreamArray.html similarity index 100% rename from apidocs/org/kiji/schema/util/ByteStreamArray.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/ByteStreamArray.html diff --git a/apidocs/org/kiji/schema/util/BytesKey.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/BytesKey.html similarity index 100% rename from apidocs/org/kiji/schema/util/BytesKey.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/BytesKey.html diff --git a/apidocs/org/kiji/schema/util/Clock.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/Clock.html similarity index 100% rename from apidocs/org/kiji/schema/util/Clock.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/Clock.html diff --git a/apidocs/org/kiji/schema/util/CounterManager.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/CounterManager.html similarity index 100% rename from apidocs/org/kiji/schema/util/CounterManager.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/CounterManager.html diff --git a/apidocs/org/kiji/schema/util/DefaultClock.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/DefaultClock.html similarity index 100% rename from apidocs/org/kiji/schema/util/DefaultClock.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/DefaultClock.html diff --git a/apidocs/org/kiji/schema/util/FromJson.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/FromJson.html similarity index 100% rename from apidocs/org/kiji/schema/util/FromJson.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/FromJson.html diff --git a/apidocs/org/kiji/schema/util/Functions.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/Functions.html similarity index 100% rename from apidocs/org/kiji/schema/util/Functions.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/Functions.html diff --git a/apidocs/org/kiji/schema/util/Hasher.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/Hasher.html similarity index 100% rename from apidocs/org/kiji/schema/util/Hasher.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/Hasher.html diff --git a/apidocs/org/kiji/schema/util/JavaIdentifiers.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/JavaIdentifiers.html similarity index 100% rename from apidocs/org/kiji/schema/util/JavaIdentifiers.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/JavaIdentifiers.html diff --git a/apidocs/org/kiji/schema/util/KijiNameValidator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/KijiNameValidator.html similarity index 100% rename from apidocs/org/kiji/schema/util/KijiNameValidator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/KijiNameValidator.html diff --git a/apidocs/org/kiji/schema/util/NumberParser.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/NumberParser.html similarity index 100% rename from apidocs/org/kiji/schema/util/NumberParser.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/NumberParser.html diff --git a/apidocs/org/kiji/schema/util/Resources.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/Resources.html similarity index 100% rename from apidocs/org/kiji/schema/util/Resources.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/Resources.html diff --git a/apidocs/org/kiji/schema/util/SplitKeyFile.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/SplitKeyFile.html similarity index 100% rename from apidocs/org/kiji/schema/util/SplitKeyFile.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/SplitKeyFile.html diff --git a/apidocs/org/kiji/schema/util/TimestampComparator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/TimestampComparator.html similarity index 100% rename from apidocs/org/kiji/schema/util/TimestampComparator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/TimestampComparator.html diff --git a/apidocs/org/kiji/schema/util/ToJson.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/ToJson.html similarity index 100% rename from apidocs/org/kiji/schema/util/ToJson.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/ToJson.html diff --git a/apidocs/org/kiji/schema/util/VersionInfo.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/VersionInfo.html similarity index 100% rename from apidocs/org/kiji/schema/util/VersionInfo.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/VersionInfo.html diff --git a/apidocs/org/kiji/schema/util/ZooKeeperLock.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/ZooKeeperLock.html similarity index 100% rename from apidocs/org/kiji/schema/util/ZooKeeperLock.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/ZooKeeperLock.html diff --git a/apidocs/org/kiji/schema/util/class-use/AvroUtils.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/AvroUtils.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/AvroUtils.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/AvroUtils.html diff --git a/apidocs/org/kiji/schema/util/class-use/ByteArrayFormatter.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/ByteArrayFormatter.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/ByteArrayFormatter.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/ByteArrayFormatter.html diff --git a/apidocs/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html diff --git a/apidocs/org/kiji/schema/util/class-use/ByteStreamArray.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/ByteStreamArray.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/ByteStreamArray.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/ByteStreamArray.html diff --git a/apidocs/org/kiji/schema/util/class-use/BytesKey.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/BytesKey.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/BytesKey.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/BytesKey.html diff --git a/apidocs/org/kiji/schema/util/class-use/Clock.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/Clock.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/Clock.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/Clock.html diff --git a/apidocs/org/kiji/schema/util/class-use/CounterManager.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/CounterManager.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/CounterManager.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/CounterManager.html diff --git a/apidocs/org/kiji/schema/util/class-use/DefaultClock.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/DefaultClock.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/DefaultClock.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/DefaultClock.html diff --git a/apidocs/org/kiji/schema/util/class-use/FromJson.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/FromJson.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/FromJson.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/FromJson.html diff --git a/apidocs/org/kiji/schema/util/class-use/Functions.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/Functions.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/Functions.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/Functions.html diff --git a/apidocs/org/kiji/schema/util/class-use/Hasher.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/Hasher.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/Hasher.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/Hasher.html diff --git a/apidocs/org/kiji/schema/util/class-use/JavaIdentifiers.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/JavaIdentifiers.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/JavaIdentifiers.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/JavaIdentifiers.html diff --git a/apidocs/org/kiji/schema/util/class-use/KijiNameValidator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/KijiNameValidator.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/KijiNameValidator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/KijiNameValidator.html diff --git a/apidocs/org/kiji/schema/util/class-use/NumberParser.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/NumberParser.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/NumberParser.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/NumberParser.html diff --git a/apidocs/org/kiji/schema/util/class-use/Resources.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/Resources.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/Resources.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/Resources.html diff --git a/apidocs/org/kiji/schema/util/class-use/SplitKeyFile.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/SplitKeyFile.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/SplitKeyFile.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/SplitKeyFile.html diff --git a/apidocs/org/kiji/schema/util/class-use/TimestampComparator.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/TimestampComparator.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/TimestampComparator.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/TimestampComparator.html diff --git a/apidocs/org/kiji/schema/util/class-use/ToJson.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/ToJson.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/ToJson.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/ToJson.html diff --git a/apidocs/org/kiji/schema/util/class-use/VersionInfo.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/VersionInfo.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/VersionInfo.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/VersionInfo.html diff --git a/apidocs/org/kiji/schema/util/class-use/ZooKeeperLock.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/ZooKeeperLock.html similarity index 100% rename from apidocs/org/kiji/schema/util/class-use/ZooKeeperLock.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/class-use/ZooKeeperLock.html diff --git a/apidocs/org/kiji/schema/util/package-frame.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/package-frame.html similarity index 100% rename from apidocs/org/kiji/schema/util/package-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/package-frame.html diff --git a/apidocs/org/kiji/schema/util/package-summary.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/package-summary.html similarity index 100% rename from apidocs/org/kiji/schema/util/package-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/package-summary.html diff --git a/apidocs/org/kiji/schema/util/package-tree.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/package-tree.html similarity index 100% rename from apidocs/org/kiji/schema/util/package-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/package-tree.html diff --git a/apidocs/org/kiji/schema/util/package-use.html b/apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/package-use.html similarity index 100% rename from apidocs/org/kiji/schema/util/package-use.html rename to apidocs/kiji-schema/1.0.0-rc1/org/kiji/schema/util/package-use.html diff --git a/apidocs/overview-frame.html b/apidocs/kiji-schema/1.0.0-rc1/overview-frame.html similarity index 100% rename from apidocs/overview-frame.html rename to apidocs/kiji-schema/1.0.0-rc1/overview-frame.html diff --git a/apidocs/overview-summary.html b/apidocs/kiji-schema/1.0.0-rc1/overview-summary.html similarity index 100% rename from apidocs/overview-summary.html rename to apidocs/kiji-schema/1.0.0-rc1/overview-summary.html diff --git a/apidocs/overview-tree.html b/apidocs/kiji-schema/1.0.0-rc1/overview-tree.html similarity index 100% rename from apidocs/overview-tree.html rename to apidocs/kiji-schema/1.0.0-rc1/overview-tree.html diff --git a/apidocs/package-list b/apidocs/kiji-schema/1.0.0-rc1/package-list similarity index 100% rename from apidocs/package-list rename to apidocs/kiji-schema/1.0.0-rc1/package-list diff --git a/apidocs/kiji-schema/1.0.0-rc1/resources/inherit.gif b/apidocs/kiji-schema/1.0.0-rc1/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/kiji-schema/1.0.0-rc1/resources/inherit.gif differ diff --git a/apidocs/serialized-form.html b/apidocs/kiji-schema/1.0.0-rc1/serialized-form.html similarity index 100% rename from apidocs/serialized-form.html rename to apidocs/kiji-schema/1.0.0-rc1/serialized-form.html diff --git a/apidocs/kiji-schema/1.0.0-rc1/stylesheet.css b/apidocs/kiji-schema/1.0.0-rc1/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc1/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/kiji-schema/1.0.0-rc2/allclasses-frame.html b/apidocs/kiji-schema/1.0.0-rc2/allclasses-frame.html new file mode 100644 index 00000000..52dbc8cf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/allclasses-frame.html @@ -0,0 +1,420 @@ + + + + + + + +All Classes (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            AbstractKijiTable +
            +AndRowFilter +
            +AvroCellDecoder +
            +AvroCellEncoder +
            +AvroUtils +
            +BaseTool +
            +ByteArrayFormatter +
            +BytesKey +
            +ByteStreamArray +
            +ByteStreamArray.EncodingException +
            +CellSchema +
            +CellSchema.Builder +
            +CellSpec +
            +Clock +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +ColumnId +
            +ColumnNameTranslator +
            +ColumnValueEqualsRowFilter +
            +CompressionType +
            +CounterCellDecoder +
            +CounterCellEncoder +
            +CounterManager +
            +CreateTableTool +
            +DefaultHBaseAdminFactory +
            +DefaultHBaseFactory +
            +DefaultHTableInterfaceFactory +
            +DefaultKijiCellEncoderFactory +
            +DefaultKijiCounter +
            +DefaultKijiTableFactory +
            +DeleteTableTool +
            +DictionaryLoader +
            +DistributedCacheJars +
            +EmailSynthesizer +
            +EntityId +
            +EntityIdFactory +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +FlushTableTool +
            +FromJson +
            +Functions +
            +GenericCellDecoder +
            +GenericCellDecoderFactory +
            +GenericTableMapReduceUtil +
            +HasColumnDataRowFilter +
            +HashedEntityId +
            +Hasher +
            +HashPrefixedEntityId +
            +HashType +
            +HBaseAdminFactory +
            +HBaseColumnName +
            +HBaseDataRequestAdapter +
            +HBaseEntityId +
            +HBaseFactory +
            +HBaseFactory.Provider +
            +HBaseKijiRowData +
            +HBaseKijiRowScanner +
            +HBaseKijiRowScanner.Options +
            +HBaseKijiTable +
            +HBaseKijiTableReader +
            +HBaseKijiTableWriter +
            +HBaseMetaTable +
            +HBaseScanOptions +
            +HBaseSchemaTable +
            +HBaseSystemTable +
            +HBaseTableKeyValueDatabase +
            +HBaseTableLayoutDatabase +
            +HBaseTableRecordReader +
            +HColumnDescriptorComparator +
            +HelpTool +
            +HTableDescriptorComparator +
            +HTableInterfaceFactory +
            +HTableSchemaTranslator +
            +IncompatibleKijiVersionException +
            +IncrementTool +
            +InstallTool +
            +InternalKijiError +
            +InvalidColumnNameException +
            +InvalidLayoutException +
            +JavaIdentifiers +
            +KeyValueBackupEntry +
            +KeyValueBackupEntry.Builder +
            +Kiji +
            +KijiAdmin +
            +KijiCell +
            +KijiCellDecoder +
            +KijiCellDecoderFactory +
            +KijiCellEncoder +
            +KijiCellEncoderFactory +
            +KijiColumnFilter +
            +KijiColumnFilter.Context +
            +KijiColumnName +
            +KijiColumnPager +
            +KijiColumnPagingNotEnabledException +
            +KijiConfiguration +
            +KijiConfKeys +
            +KijiCounter +
            +KijiDataBuffer +
            +KijiDataRequest +
            +KijiDataRequest.Column +
            +KijiDataRequestException +
            +KijiDataRequestValidator +
            +KijiDeleter +
            +KijiIncrementer +
            +KijiInstaller +
            +KijiInvalidNameException +
            +KijiManagedHBaseTableName +
            +KijiMetaTable +
            +KijiNameValidator +
            +KijiNotInstalledException +
            +KijiPutter +
            +KijiRowData +
            +KijiRowFilter +
            +KijiRowFilter.Context +
            +KijiRowFilterApplicator +
            +KijiRowKeySplitter +
            +KijiRowScanner +
            +KijiSchemaTable +
            +KijiSchemaTable.SchemaEntry +
            +KijiSystemTable +
            +KijiTable +
            +KijiTableFactory +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader +
            +KijiTableKeyValueDatabase +
            +KijiTableLayout +
            +KijiTableLayoutDatabase +
            +KijiTableLayoutRecords +
            +KijiTableLayoutRecords.Callback +
            +KijiTableNotFoundException +
            +KijiTablePool +
            +KijiTablePool.NoCapacityException +
            +KijiTablePool.Options +
            +KijiTableReader +
            +KijiTableWriter +
            +KijiTool +
            +KijiToolLauncher +
            +KijiURI +
            +KijiURIException +
            +LayoutTool +
            +LocalityGroupDesc +
            +LocalityGroupDesc.Builder +
            +Lock +
            +LockFactory +
            +LsTool +
            +MD5Hash +
            +MetadataBackup +
            +MetadataBackup.Builder +
            +MetadataRestorer +
            +MetadataTool +
            +NGramSynthesizer +
            +NoCellDataException +
            +NoSuchColumnException +
            +NotAKijiManagedTableException +
            +NumberParser +
            +OperatorRowFilter +
            +OperatorRowFilter.Operator +
            +OrRowFilter +
            +PutTool +
            +RawEntityId +
            +RegexQualifierColumnFilter +
            +RequiredFlagException +
            +Resources +
            +RowKeyEncoding +
            +RowKeyFormat +
            +RowKeyFormat.Builder +
            +SchemaClassNotFoundException +
            +SchemaStorage +
            +SchemaTableEntry +
            +SchemaTableEntry.Builder +
            +SchemaType +
            +SpecificCellDecoder +
            +SpecificCellDecoderFactory +
            +SplitKeyFile +
            +StripValueRowFilter +
            +Synthesizer +
            +SynthesizeUserDataTool +
            +TableBackup +
            +TableBackup.Builder +
            +TableKeyNotFoundException +
            +TableLayoutBackupEntry +
            +TableLayoutBackupEntry.Builder +
            +TableLayoutDesc +
            +TableLayoutDesc.Builder +
            +TableLayoutSerializer +
            +TimestampComparator +
            +ToJson +
            +ToolUtils +
            +UninstallTool +
            +VersionInfo +
            +VersionTool +
            +VersionValidatedTool +
            +WordSynthesizer +
            +ZooKeeperLock +
            +ZooKeeperLockFactory +
            +
            + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/allclasses-noframe.html b/apidocs/kiji-schema/1.0.0-rc2/allclasses-noframe.html new file mode 100644 index 00000000..20a05b3a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/allclasses-noframe.html @@ -0,0 +1,420 @@ + + + + + + + +All Classes (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            AbstractKijiTable +
            +AndRowFilter +
            +AvroCellDecoder +
            +AvroCellEncoder +
            +AvroUtils +
            +BaseTool +
            +ByteArrayFormatter +
            +BytesKey +
            +ByteStreamArray +
            +ByteStreamArray.EncodingException +
            +CellSchema +
            +CellSchema.Builder +
            +CellSpec +
            +Clock +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +ColumnId +
            +ColumnNameTranslator +
            +ColumnValueEqualsRowFilter +
            +CompressionType +
            +CounterCellDecoder +
            +CounterCellEncoder +
            +CounterManager +
            +CreateTableTool +
            +DefaultHBaseAdminFactory +
            +DefaultHBaseFactory +
            +DefaultHTableInterfaceFactory +
            +DefaultKijiCellEncoderFactory +
            +DefaultKijiCounter +
            +DefaultKijiTableFactory +
            +DeleteTableTool +
            +DictionaryLoader +
            +DistributedCacheJars +
            +EmailSynthesizer +
            +EntityId +
            +EntityIdFactory +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +FlushTableTool +
            +FromJson +
            +Functions +
            +GenericCellDecoder +
            +GenericCellDecoderFactory +
            +GenericTableMapReduceUtil +
            +HasColumnDataRowFilter +
            +HashedEntityId +
            +Hasher +
            +HashPrefixedEntityId +
            +HashType +
            +HBaseAdminFactory +
            +HBaseColumnName +
            +HBaseDataRequestAdapter +
            +HBaseEntityId +
            +HBaseFactory +
            +HBaseFactory.Provider +
            +HBaseKijiRowData +
            +HBaseKijiRowScanner +
            +HBaseKijiRowScanner.Options +
            +HBaseKijiTable +
            +HBaseKijiTableReader +
            +HBaseKijiTableWriter +
            +HBaseMetaTable +
            +HBaseScanOptions +
            +HBaseSchemaTable +
            +HBaseSystemTable +
            +HBaseTableKeyValueDatabase +
            +HBaseTableLayoutDatabase +
            +HBaseTableRecordReader +
            +HColumnDescriptorComparator +
            +HelpTool +
            +HTableDescriptorComparator +
            +HTableInterfaceFactory +
            +HTableSchemaTranslator +
            +IncompatibleKijiVersionException +
            +IncrementTool +
            +InstallTool +
            +InternalKijiError +
            +InvalidColumnNameException +
            +InvalidLayoutException +
            +JavaIdentifiers +
            +KeyValueBackupEntry +
            +KeyValueBackupEntry.Builder +
            +Kiji +
            +KijiAdmin +
            +KijiCell +
            +KijiCellDecoder +
            +KijiCellDecoderFactory +
            +KijiCellEncoder +
            +KijiCellEncoderFactory +
            +KijiColumnFilter +
            +KijiColumnFilter.Context +
            +KijiColumnName +
            +KijiColumnPager +
            +KijiColumnPagingNotEnabledException +
            +KijiConfiguration +
            +KijiConfKeys +
            +KijiCounter +
            +KijiDataBuffer +
            +KijiDataRequest +
            +KijiDataRequest.Column +
            +KijiDataRequestException +
            +KijiDataRequestValidator +
            +KijiDeleter +
            +KijiIncrementer +
            +KijiInstaller +
            +KijiInvalidNameException +
            +KijiManagedHBaseTableName +
            +KijiMetaTable +
            +KijiNameValidator +
            +KijiNotInstalledException +
            +KijiPutter +
            +KijiRowData +
            +KijiRowFilter +
            +KijiRowFilter.Context +
            +KijiRowFilterApplicator +
            +KijiRowKeySplitter +
            +KijiRowScanner +
            +KijiSchemaTable +
            +KijiSchemaTable.SchemaEntry +
            +KijiSystemTable +
            +KijiTable +
            +KijiTableFactory +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader +
            +KijiTableKeyValueDatabase +
            +KijiTableLayout +
            +KijiTableLayoutDatabase +
            +KijiTableLayoutRecords +
            +KijiTableLayoutRecords.Callback +
            +KijiTableNotFoundException +
            +KijiTablePool +
            +KijiTablePool.NoCapacityException +
            +KijiTablePool.Options +
            +KijiTableReader +
            +KijiTableWriter +
            +KijiTool +
            +KijiToolLauncher +
            +KijiURI +
            +KijiURIException +
            +LayoutTool +
            +LocalityGroupDesc +
            +LocalityGroupDesc.Builder +
            +Lock +
            +LockFactory +
            +LsTool +
            +MD5Hash +
            +MetadataBackup +
            +MetadataBackup.Builder +
            +MetadataRestorer +
            +MetadataTool +
            +NGramSynthesizer +
            +NoCellDataException +
            +NoSuchColumnException +
            +NotAKijiManagedTableException +
            +NumberParser +
            +OperatorRowFilter +
            +OperatorRowFilter.Operator +
            +OrRowFilter +
            +PutTool +
            +RawEntityId +
            +RegexQualifierColumnFilter +
            +RequiredFlagException +
            +Resources +
            +RowKeyEncoding +
            +RowKeyFormat +
            +RowKeyFormat.Builder +
            +SchemaClassNotFoundException +
            +SchemaStorage +
            +SchemaTableEntry +
            +SchemaTableEntry.Builder +
            +SchemaType +
            +SpecificCellDecoder +
            +SpecificCellDecoderFactory +
            +SplitKeyFile +
            +StripValueRowFilter +
            +Synthesizer +
            +SynthesizeUserDataTool +
            +TableBackup +
            +TableBackup.Builder +
            +TableKeyNotFoundException +
            +TableLayoutBackupEntry +
            +TableLayoutBackupEntry.Builder +
            +TableLayoutDesc +
            +TableLayoutDesc.Builder +
            +TableLayoutSerializer +
            +TimestampComparator +
            +ToJson +
            +ToolUtils +
            +UninstallTool +
            +VersionInfo +
            +VersionTool +
            +VersionValidatedTool +
            +WordSynthesizer +
            +ZooKeeperLock +
            +ZooKeeperLockFactory +
            +
            + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/constant-values.html b/apidocs/kiji-schema/1.0.0-rc2/constant-values.html new file mode 100644 index 00000000..1533325c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/constant-values.html @@ -0,0 +1,493 @@ + + + + + + + +Constant Field Values (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents + + + + + + +
            +org.kiji.*
            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.KijiConfiguration
            +public static final StringCONF_KIJI_INSTANCE_NAME"kiji.instance.name"
            +public static final StringDEFAULT_CONF_FILE"/etc/kiji/kiji.conf"
            +public static final StringDEFAULT_INSTANCE_NAME"default"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.KijiManagedHBaseTableName
            +public static final StringKIJI_COMPONENT"kiji"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.KijiRowKeySplitter
            +public static final intHBASE_ROW_KEY_RESOLUTION16
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.KijiURI
            +public static final intDEFAULT_ZOOKEEPER_CLIENT_PORT2181
            +public static final StringENV_URI_STRING".env"
            +public static final StringKIJI_SCHEME"kiji"
            +public static final StringUNSET_URI_STRING".unset"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.impl.HBaseSchemaTable
            +public static final StringSCHEMA_COLUMN_FAMILY"schema"
            +public static final StringSCHEMA_COLUMN_QUALIFIER""
            +public static final StringSCHEMA_COUNTER_ROW_NAME"counter"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.impl.HBaseSystemTable
            +public static final StringDEFAULTS_PROPERTIES_FILE"org/kiji/schema/system-default.properties"
            +public static final StringKEY_DATA_VERSION"data-version"
            +public static final StringVALUE_COLUMN_FAMILY"value"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.layout.ColumnNameTranslator
            +public static final StringSEPARATOR":"
            + +

            + +

            + + + + + + + + + + + + + + + + + +
            org.kiji.schema.layout.TableLayoutSerializer
            +public static final StringCONF_INPUT_TABLE_LAYOUT"kiji.input.table.layout"
            +public static final StringCONF_OUTPUT_TABLE_LAYOUT"kiji.output.table.layout"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.layout.impl.ColumnId
            +public static final StringALPHABET"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
            +public static final intBITS_PER_DIGIT6
            +public static final intRADIX64
            +public static final intUNASSIGNED0
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.layout.impl.HBaseTableLayoutDatabase
            +public static final StringQUALIFIER_LAYOUT"layout"
            +public static final StringQUALIFIER_LAYOUT_ID"layout_id"
            +public static final StringQUALIFIER_UPDATE"update"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.mapreduce.KijiConfKeys
            +public static final StringINPUT_DATA_REQUEST"kiji.input.request"
            +public static final StringINPUT_TABLE_URI"kiji.input.table.uri"
            +public static final StringOUTPUT_KIJI_TABLE_URI"kiji.output.table.uri"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.util.Hasher
            +public static final intHASH_SIZE_BYTES16
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.util.VersionInfo
            +public static final StringDEFAULT_DEVELOPMENT_VERSION"development"
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/deprecated-list.html b/apidocs/kiji-schema/1.0.0-rc2/deprecated-list.html new file mode 100644 index 00000000..7191e106 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/deprecated-list.html @@ -0,0 +1,522 @@ + + + + + + + +Deprecated List (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents + + + + + + + + + +
            +Deprecated Interfaces
            org.kiji.schema.KijiCounter +
            +          KijiCounter will be merged into KijiCell. 
            +  +

            + + + + + + + + + + + + + + +
            +Deprecated Classes
            org.kiji.schema.mapreduce.DistributedCacheJars +
            +           
            org.kiji.schema.mapreduce.KijiConfKeys +
            +           
            org.kiji.schema.mapreduce.KijiTableInputFormat +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Deprecated Fields
            org.kiji.schema.avro.FamilyDesc.aliases +
            +           
            org.kiji.schema.avro.ColumnDesc.aliases +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.aliases +
            +           
            org.kiji.schema.avro.SchemaTableEntry.avro_schema +
            +           
            org.kiji.schema.avro.ColumnDesc.column_schema +
            +           
            org.kiji.schema.avro.FamilyDesc.columns +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.compression_type +
            +           
            org.kiji.schema.avro.FamilyDesc.delete +
            +           
            org.kiji.schema.avro.ColumnDesc.delete +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.delete +
            +           
            org.kiji.schema.avro.FamilyDesc.description +
            +           
            org.kiji.schema.avro.TableLayoutDesc.description +
            +           
            org.kiji.schema.avro.ColumnDesc.description +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.description +
            +           
            org.kiji.schema.avro.FamilyDesc.enabled +
            +           
            org.kiji.schema.avro.ColumnDesc.enabled +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.enabled +
            +           
            org.kiji.schema.avro.RowKeyFormat.encoding +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.families +
            +           
            org.kiji.schema.avro.SchemaTableEntry.hash +
            +           
            org.kiji.schema.avro.RowKeyFormat.hash_size +
            +           
            org.kiji.schema.avro.RowKeyFormat.hash_type +
            +           
            org.kiji.schema.avro.FamilyDesc.id +
            +           
            org.kiji.schema.avro.ColumnDesc.id +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.id +
            +           
            org.kiji.schema.avro.SchemaTableEntry.id +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.in_memory +
            +           
            org.kiji.schema.avro.KeyValueBackupEntry.key +
            +           
            org.kiji.schema.avro.TableBackup.key_values +
            +           
            org.kiji.schema.avro.TableLayoutDesc.keys_format +
            +           
            org.kiji.schema.avro.TableLayoutBackupEntry.layout +
            +           
            org.kiji.schema.avro.TableLayoutDesc.layout_id +
            +           
            org.kiji.schema.avro.MetadataBackup.layout_version +
            +           
            org.kiji.schema.avro.TableBackup.layouts +
            +           
            org.kiji.schema.avro.TableLayoutDesc.locality_groups +
            +           
            org.kiji.schema.avro.FamilyDesc.map_schema +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.max_versions +
            +           
            org.kiji.schema.avro.MetadataBackup.meta_table +
            +           
            org.kiji.schema.avro.FamilyDesc.name +
            +           
            org.kiji.schema.avro.TableBackup.name +
            +           
            org.kiji.schema.avro.TableLayoutDesc.name +
            +           
            org.kiji.schema.avro.ColumnDesc.name +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.name +
            +           
            org.kiji.schema.avro.TableLayoutDesc.reference_layout +
            +           
            org.kiji.schema.avro.FamilyDesc.renamed_from +
            +           
            org.kiji.schema.avro.ColumnDesc.renamed_from +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.renamed_from +
            +           
            org.kiji.schema.avro.MetadataBackup.schema_table +
            +           
            org.kiji.schema.avro.CellSchema.storage +
            +           
            org.kiji.schema.avro.TableLayoutBackupEntry.timestamp +
            +           
            org.kiji.schema.avro.KeyValueBackupEntry.timestamp +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.ttl_seconds +
            +           
            org.kiji.schema.avro.CellSchema.type +
            +           
            org.kiji.schema.avro.TableLayoutBackupEntry.update +
            +           
            org.kiji.schema.avro.CellSchema.value +
            +           
            org.kiji.schema.avro.KeyValueBackupEntry.value +
            +           
            org.kiji.schema.avro.TableLayoutDesc.version +
            +           
            +  +

            + + + + + + + + + + + +
            +Deprecated Methods
            org.kiji.schema.impl.HBaseKijiRowData.getCounter(String, String) +
            +           
            org.kiji.schema.impl.HBaseKijiRowData.getCounter(String, String, long) +
            +           
            +  +

            + + + + + + + + + + + +
            +Deprecated Constructors
            org.kiji.schema.impl.HBaseKijiRowData(EntityId, KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) +
            +           
            org.kiji.schema.impl.HBaseKijiRowData(KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/help-doc.html b/apidocs/kiji-schema/1.0.0-rc2/help-doc.html new file mode 100644 index 00000000..81f56663 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/help-doc.html @@ -0,0 +1,224 @@ + + + + + + + +API Help (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Overview

            +
            + +

            +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

            +

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/index-all.html b/apidocs/kiji-schema/1.0.0-rc2/index-all.html new file mode 100644 index 00000000..d8aece2d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/index-all.html @@ -0,0 +1,4716 @@ + + + + + + + +Index (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +A B C D E F G H I J K L M N O P Q R S T U V W Y Z
            +

            +A

            +
            +
            AbstractKijiTable - Class in org.kiji.schema.impl
            Main handle for a Kiji table with basic functionality.
            AbstractKijiTable(Kiji, String) - +Constructor for class org.kiji.schema.impl.AbstractKijiTable +
            Creates a new KijiTable instance. +
            add(EntityId, T) - +Method in class org.kiji.schema.impl.KijiDataBuffer +
            Adds a buffer element to the buffer and associates it with the specified entity. +
            addAllDependencyJars(Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            Like TableMapReduceUtil.addDependencyJars() but this catches some + missing ones like google's guava library. +
            addColumn(KijiDataRequest.Column) - +Method in class org.kiji.schema.KijiDataRequest +
            Add a request for a column to this data request. +
            addJarsToDistributedCache(Job, String) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Adds the jars from a directory into the distributed cache of a job. +
            addJarsToDistributedCache(Job, File) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Adds the jars from a directory into the distributed cache of a job. +
            aliases - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            aliases - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            aliases - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            ALPHABET - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The alphabet used to generate the short physical names. +
            AndRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter for a conjunction (AND operator) of other filters.
            AndRowFilter(List<? extends KijiRowFilter>) - +Constructor for class org.kiji.schema.filter.AndRowFilter +
            Creates a new AndRowFilter instance. +
            applyTo(Scan) - +Method in class org.kiji.schema.filter.KijiRowFilterApplicator +
            Applies the row filter to an HBase scan object. +
            applyToScan(Scan, KijiTableLayout) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one. +
            avro_schema - +Variable in class org.kiji.schema.avro.SchemaTableEntry +
            Deprecated.  +
            AvroCellDecoder<T> - Class in org.kiji.schema.impl
            Base class for decoders that read Kiji cells encoded using Avro.
            AvroCellDecoder(CellSpec) - +Constructor for class org.kiji.schema.impl.AvroCellDecoder +
            Initializes an abstract KijiAvroCellDecoder. +
            AvroCellEncoder - Class in org.kiji.schema.impl
            Serializes a KijiCell.
            AvroCellEncoder(CellSpec) - +Constructor for class org.kiji.schema.impl.AvroCellEncoder +
            Creates a new KijiCellEncoder instance. +
            AvroUtils - Class in org.kiji.schema.util
            General purpose Avro utilities.
            +
            +

            +B

            +
            +
            BaseTool - Class in org.kiji.schema.tools
            Base class for all command line tools.
            BaseTool() - +Constructor for class org.kiji.schema.tools.BaseTool +
              +
            BITS_PER_DIGIT - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The base 2 logarithm of the size of the alphabet (64), which is the number of bits + we can encode with a single digit. +
            build() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
              +
            bulkGet(List<EntityId>, KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Retrieves data from a list of rows in the kiji table. +
            bulkGet(List<EntityId>, KijiDataRequest) - +Method in class org.kiji.schema.KijiTableReader +
            Retrieves data from a list of rows in the kiji table. +
            ByteArrayFormatter - Class in org.kiji.schema.util
            Utility class to format byte arrays.
            BytesKey - Class in org.kiji.schema.util
            Wraps an array of bytes into an object that can be used as key in a hash map.
            BytesKey(byte[]) - +Constructor for class org.kiji.schema.util.BytesKey +
            Wraps the given byte array. +
            ByteStreamArray - Class in org.kiji.schema.util
            Wraps a byte array of binary-encoded data into a byte stream.
            ByteStreamArray(byte[], int) - +Constructor for class org.kiji.schema.util.ByteStreamArray +
            Constructs a new stream of byte. +
            ByteStreamArray(byte[]) - +Constructor for class org.kiji.schema.util.ByteStreamArray +
            Constructs a new stream of byte. +
            ByteStreamArray.EncodingException - Exception in org.kiji.schema.util
            Raised when decoding some data fails (eg.
            ByteStreamArray.EncodingException() - +Constructor for exception org.kiji.schema.util.ByteStreamArray.EncodingException +
              +
            +
            +

            +C

            +
            +
            CellSchema - Class in org.kiji.schema.avro
             
            CellSchema() - +Constructor for class org.kiji.schema.avro.CellSchema +
            Default constructor. +
            CellSchema(SchemaStorage, SchemaType, String) - +Constructor for class org.kiji.schema.avro.CellSchema +
            All-args constructor. +
            CellSchema.Builder - Class in org.kiji.schema.avro
            RecordBuilder for CellSchema instances.
            CellSpec - Class in org.kiji.schema.layout.impl
            Specification of a Kiji cell.
            CellSpec() - +Constructor for class org.kiji.schema.layout.impl.CellSpec +
            Initializes a new, unspecified CellSpec. +
            cleanup() - +Method in class org.kiji.schema.tools.BaseTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.CreateTableTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.DeleteTableTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.FlushTableTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.LayoutTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.LsTool +
            Cleans up any open file handles, connections, etc. +
            clear() - +Method in class org.kiji.schema.impl.KijiDataBuffer +
            Clears the buffer by removing all elements stored in it. +
            clearAliases() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'aliases' field +
            clearAliases() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'aliases' field +
            clearAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'aliases' field +
            clearAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Clears the value of the 'avro_schema' field +
            clearColumns() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'columns' field +
            clearColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'column_schema' field +
            clearCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'compression_type' field +
            clearDelete() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'delete' field +
            clearDelete() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'delete' field +
            clearDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'delete' field +
            clearDescription() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'description' field +
            clearDescription() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'description' field +
            clearDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'description' field +
            clearDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'description' field +
            clearEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'enabled' field +
            clearEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'enabled' field +
            clearEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'enabled' field +
            clearEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Clears the value of the 'encoding' field +
            clearFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'families' field +
            clearHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Clears the value of the 'hash' field +
            clearHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Clears the value of the 'hash_size' field +
            clearHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Clears the value of the 'hash_type' field +
            clearId() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'id' field +
            clearId() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'id' field +
            clearId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'id' field +
            clearId() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Clears the value of the 'id' field +
            clearInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'in_memory' field +
            clearKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Clears the value of the 'key' field +
            clearKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'keys_format' field +
            clearKeyValues() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Clears the value of the 'key_values' field +
            clearLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Clears the value of the 'layout' field +
            clearLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'layout_id' field +
            clearLayouts() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Clears the value of the 'layouts' field +
            clearLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Clears the value of the 'layout_version' field +
            clearLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'locality_groups' field +
            clearMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'map_schema' field +
            clearMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'max_versions' field +
            clearMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Clears the value of the 'meta_table' field +
            clearName() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'name' field +
            clearReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'reference_layout' field +
            clearRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'renamed_from' field +
            clearRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'renamed_from' field +
            clearRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'renamed_from' field +
            clearSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Clears the value of the 'schema_table' field +
            clearStorage() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Clears the value of the 'storage' field +
            clearTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Clears the value of the 'timestamp' field +
            clearTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Clears the value of the 'timestamp' field +
            clearTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'ttl_seconds' field +
            clearType() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Clears the value of the 'type' field +
            clearUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Clears the value of the 'update' field +
            clearValue() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Clears the value of the 'value' field +
            clearValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Clears the value of the 'value' field +
            clearVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'version' field +
            Clock - Class in org.kiji.schema.util
            An interface for a wall clock.
            close() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
              +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner +
            Closes this scanner and releases any system resources associated with it. +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
              +
            close() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Flushes and closes the KijiSchemaTable. +
            close() - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            +
            close() - +Method in class org.kiji.schema.Kiji +
            +
            close() - +Method in class org.kiji.schema.KijiMetaTable +
            +
            close() - +Method in interface org.kiji.schema.KijiRowScanner +
            Closes this scanner and releases any system resources associated with it. +
            close() - +Method in class org.kiji.schema.KijiSchemaTable +
            Flushes and closes the KijiSchemaTable. +
            close() - +Method in class org.kiji.schema.KijiTablePool +
            Closes the tables in the pool. +
            close() - +Method in class org.kiji.schema.KijiTableReader +
            +
            close() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            close() - +Method in class org.kiji.schema.util.ZooKeeperLock +
            +
            column_schema - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            ColumnDesc - Class in org.kiji.schema.avro
             
            ColumnDesc() - +Constructor for class org.kiji.schema.avro.ColumnDesc +
            Default constructor. +
            ColumnDesc(Integer, String, List<String>, Boolean, String, CellSchema, Boolean, String) - +Constructor for class org.kiji.schema.avro.ColumnDesc +
            All-args constructor. +
            ColumnDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for ColumnDesc instances.
            ColumnId - Class in org.kiji.schema.layout.impl
            A very short physical identifier for a column family or qualifier to be used in HBase.
            ColumnId(int) - +Constructor for class org.kiji.schema.layout.impl.ColumnId +
            Constructs a column id that encodes the given integer. +
            ColumnNameTranslator - Class in org.kiji.schema.layout
            Translates between HTable and Kiji table column names.
            ColumnNameTranslator(KijiTableLayout) - +Constructor for class org.kiji.schema.layout.ColumnNameTranslator +
            Creates a new ColumnNameTranslator instance. +
            columns - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            ColumnValueEqualsRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value.
            ColumnValueEqualsRowFilter(String, String, KijiCell<?>) - +Constructor for class org.kiji.schema.filter.ColumnValueEqualsRowFilter +
            Creates a new ColumnValueEqualsRowFilter instance. +
            compare(HColumnDescriptor, HColumnDescriptor) - +Method in class org.kiji.schema.impl.HColumnDescriptorComparator +
              +
            compare(HTableDescriptor, HTableDescriptor) - +Method in class org.kiji.schema.impl.HTableDescriptorComparator +
              +
            compare(Long, Long) - +Method in class org.kiji.schema.util.TimestampComparator +
              +
            compareTo(KijiColumnName) - +Method in class org.kiji.schema.KijiColumnName +
            +
            compression_type - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            CompressionType - Enum in org.kiji.schema.avro
             
            CONF_INPUT_TABLE_LAYOUT - +Static variable in class org.kiji.schema.layout.TableLayoutSerializer +
            The configuration variable that stores the avro json-encoded input table layout. +
            CONF_KIJI_INSTANCE_NAME - +Static variable in class org.kiji.schema.KijiConfiguration +
            The Configuration variable to store the kiji instance name. +
            CONF_OUTPUT_TABLE_LAYOUT - +Static variable in class org.kiji.schema.layout.TableLayoutSerializer +
            The configuration variable that stores output table layout. +
            configureJob(Job, KijiURI, KijiDataRequest, String, String) - +Static method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated. Configures a Hadoop M/R job to read from a given table. +
            containsColumn(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Determines whether a particular column has data in this row. +
            containsColumn(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Determines whether a particular column family has any data in this row. +
            containsColumn(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Determines whether a particular column has data in this row. +
            containsColumn(String) - +Method in interface org.kiji.schema.KijiRowData +
            Determines whether a particular column family has any data in this row. +
            convertStringToScan(String) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            This method is just like the package-private version in TableMapReduceUtil, + except that it disables block caching by default. +
            CounterCellDecoder - Class in org.kiji.schema.impl
            Cell decoder for counters.
            CounterCellEncoder - Class in org.kiji.schema.impl
            Encoder for Kiji counters.
            CounterManager - Interface in org.kiji.schema.util
            Interface for for objects that hold a collection of MapReduce counters.
            create(RowKeyFormat) - +Static method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID factory for the specified row key format. +
            create(CellSpec) - +Method in class org.kiji.schema.GenericCellDecoderFactory +
            Creates a new Kiji cell decoder. +
            create(Configuration) - +Method in class org.kiji.schema.impl.DefaultHBaseAdminFactory +
            Creates a new HBaseAdmin instance. +
            create(Configuration, String) - +Method in class org.kiji.schema.impl.DefaultHTableInterfaceFactory +
            Creates a new HTableInterface instance. +
            create(CellSpec) - +Method in class org.kiji.schema.impl.DefaultKijiCellEncoderFactory +
            Creates a new Kiji cell encoder. +
            create(Configuration) - +Method in interface org.kiji.schema.impl.HBaseAdminFactory +
            Creates a new HBaseAdmin instance. +
            create(Configuration, String) - +Method in interface org.kiji.schema.impl.HTableInterfaceFactory +
            Creates a new HTableInterface instance. +
            create(CellSpec) - +Method in interface org.kiji.schema.KijiCellDecoderFactory +
            Creates a new Kiji cell decoder. +
            create(CellSpec) - +Method in interface org.kiji.schema.KijiCellEncoderFactory +
            Creates a new Kiji cell encoder. +
            create(String, String) - +Static method in class org.kiji.schema.KijiConfiguration +
            Gets a handle to a Kiji instance. +
            create(String) - +Static method in class org.kiji.schema.KijiConfiguration +
            Gets a handle to a Kiji instance using the default Kiji configuration file. +
            create(CellSpec) - +Method in class org.kiji.schema.SpecificCellDecoderFactory +
            Creates a new Kiji cell decoder. +
            create(String) - +Method in interface org.kiji.schema.util.LockFactory +
            Creates a new lock with the specified name. +
            create(String) - +Method in class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a new lock with the specified name. +
            createDatumReader(Schema, Schema) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Factory for DatumReader instances. +
            createDatumReader(Schema, Schema) - +Method in class org.kiji.schema.impl.GenericCellDecoder +
            Factory for DatumReader instances. +
            createDatumReader(Schema, Schema) - +Method in class org.kiji.schema.impl.SpecificCellDecoder +
            Factory for DatumReader instances. +
            createEntityIdFromUserInputs(String, String, RowKeyFormat) - +Static method in class org.kiji.schema.tools.ToolUtils +
            Create an EntityId from the --entity-id and --entity-hash arguments to a kiji tool. +
            createFromEffectiveJson(InputStream) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Loads a table layout from the specified JSON text. +
            createFromEffectiveJsonResource(String) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Loads a table layout from the specified resource as JSON. +
            createRecordReader(InputSplit, TaskAttemptContext) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            createTable(String, KijiTableLayout, boolean) - +Method in class org.kiji.schema.KijiAdmin +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, boolean, int) - +Method in class org.kiji.schema.KijiAdmin +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, boolean, byte[][]) - +Method in class org.kiji.schema.KijiAdmin +
            Creates a Kiji table in an HBase instance. +
            CreateTableTool - Class in org.kiji.schema.tools
            Command-line tool for creating kiji tables in kiji instances.
            CreateTableTool() - +Constructor for class org.kiji.schema.tools.CreateTableTool +
              +
            +
            +

            +D

            +
            +
            decodeAvro(ByteBuffer, Schema, Schema, T) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Decodes the data payload given the reader and writer schema. +
            decodeCell(byte[]) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeCell(byte[]) - +Method in class org.kiji.schema.impl.CounterCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeCell(byte[]) - +Method in interface org.kiji.schema.KijiCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeRegionSplitList(InputStream) - +Static method in class org.kiji.schema.util.SplitKeyFile +
            Constructs a split key file from an input stream. +
            decodeRowKey(String) - +Static method in class org.kiji.schema.util.SplitKeyFile +
            Decodes a string encoded row key. +
            decodeSchemaEntry(byte[]) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Decodes a binary-encoded Avro schema entry. +
            decodeValue(byte[]) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeValue(byte[]) - +Method in class org.kiji.schema.impl.CounterCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeValue(byte[]) - +Method in interface org.kiji.schema.KijiCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            deDuplicateJarNames(List<String>) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Takes a list of paths and returns a list of paths with unique filenames. +
            DEFAULT_CONF_FILE - +Static variable in class org.kiji.schema.KijiConfiguration +
            The default Kiji configuration file. +
            DEFAULT_DEVELOPMENT_VERSION - +Static variable in class org.kiji.schema.util.VersionInfo +
            Fallback software version ID, in case the properties file is not generated/reachable. +
            DEFAULT_INSTANCE_NAME - +Static variable in class org.kiji.schema.KijiConfiguration +
            The default kiji instance name. +
            DEFAULT_ZOOKEEPER_CLIENT_PORT - +Static variable in class org.kiji.schema.KijiURI +
            Default Zookeeper port. +
            DefaultHBaseAdminFactory - Class in org.kiji.schema.impl
            Factory for HBaseAdmin that creates concrete HBaseAdmin instances.
            DefaultHBaseFactory - Class in org.kiji.schema.impl
            Factory for HBase instances based on URIs.
            DefaultHBaseFactory() - +Constructor for class org.kiji.schema.impl.DefaultHBaseFactory +
            Public constructor for use by the service loader. +
            DefaultHTableInterfaceFactory - Class in org.kiji.schema.impl
            Factory for HTableInterface that creates concrete HTable instances.
            DefaultKijiCellEncoderFactory - Class in org.kiji.schema.impl
            Factory for cell encoders.
            DefaultKijiCounter - Class in org.kiji.schema.impl
            The default implementation of a Kiji counter, which contains the data in a counter cell + of a column.
            DefaultKijiCounter(long, long) - +Constructor for class org.kiji.schema.impl.DefaultKijiCounter +
            Creates a new DefaultKijiCounter instance. +
            DefaultKijiTableFactory - Class in org.kiji.schema.impl
            The default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open().
            DefaultKijiTableFactory(Kiji) - +Constructor for class org.kiji.schema.impl.DefaultKijiTableFactory +
            Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance. +
            DEFAULTS_PROPERTIES_FILE - +Static variable in class org.kiji.schema.impl.HBaseSystemTable +
            The name of the file that stores the current system table defaults that are loaded + at installation time. +
            delete - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            delete - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            delete - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            deleteCell(EntityId, String, String) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes the most recent version of the cell in a column. +
            deleteCell(EntityId, String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes a single cell with a specified timestamp. +
            deleteCell(EntityId, String, String) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes the most recent version of the cell in a column. +
            deleteCell(EntityId, String, String, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes a single cell with a specified timestamp. +
            deleteColumn(EntityId, String, String) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all versions of all cells in a column. +
            deleteColumn(EntityId, String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +
            deleteColumn(EntityId, String, String) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all versions of all cells in a column. +
            deleteColumn(EntityId, String, String, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +
            deleteFamily(EntityId, String) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all versions of all cells in a family. +
            deleteFamily(EntityId, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +
            deleteFamily(EntityId, String) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all versions of all cells in a family. +
            deleteFamily(EntityId, String, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +
            deleteRow(EntityId) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes an entire row. +
            deleteRow(EntityId, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +
            deleteRow(EntityId) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes an entire row. +
            deleteRow(EntityId, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +
            deleteTable(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Remove all metadata, including layouts, for a particular table. +
            deleteTable(String) - +Method in class org.kiji.schema.KijiAdmin +
            Deletes a Kiji table. +
            deleteTable(String) - +Method in class org.kiji.schema.KijiMetaTable +
            Remove all metadata, including layouts, for a particular table. +
            DeleteTableTool - Class in org.kiji.schema.tools
            Command-line tool for deleting kiji tables from kiji instances.
            DeleteTableTool() - +Constructor for class org.kiji.schema.tools.DeleteTableTool +
              +
            description - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            description - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            description - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            description - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            DictionaryLoader - Class in org.kiji.schema.tools.synth
            Loads a dictionary file, which is simply a list of words, one per line.
            DictionaryLoader() - +Constructor for class org.kiji.schema.tools.synth.DictionaryLoader +
            Creates a new DictionaryLoader instance. +
            DistributedCacheJars - Class in org.kiji.schema.mapreduce
            Deprecated. 
            downcast(KijiTable) - +Static method in class org.kiji.schema.impl.HBaseKijiTable +
            We know that all KijiTables are really HBaseKijiTables + instances. +
            +
            +

            +E

            +
            +
            EmailSynthesizer - Class in org.kiji.schema.tools.synth
            Synthesizes a random email address.
            EmailSynthesizer(Random, List<String>) - +Constructor for class org.kiji.schema.tools.synth.EmailSynthesizer +
            Creates a new email synthesizer. +
            enabled - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            enabled - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            enabled - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            encode(KijiCell<?>) - +Method in class org.kiji.schema.impl.AvroCellEncoder +
            Encodes the specified Kiji cell. +
            encode(T) - +Method in class org.kiji.schema.impl.AvroCellEncoder +
            Encodes the specified value. +
            encode(KijiCell<?>) - +Method in class org.kiji.schema.impl.CounterCellEncoder +
            Encodes the specified Kiji cell. +
            encode(T) - +Method in class org.kiji.schema.impl.CounterCellEncoder +
            Encodes the specified value. +
            encode(KijiCell<?>) - +Method in interface org.kiji.schema.KijiCellEncoder +
            Encodes the specified Kiji cell. +
            encode(T) - +Method in interface org.kiji.schema.KijiCellEncoder +
            Encodes the specified value. +
            encodeSchemaEntry(SchemaTableEntry) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Encodes an Avro schema entry into binary. +
            encoding - +Variable in class org.kiji.schema.avro.RowKeyFormat +
            Deprecated.  +
            EntityId - Class in org.kiji.schema
            EntityId is used to identify a particular row in a Kiji table.
            EntityId() - +Constructor for class org.kiji.schema.EntityId +
              +
            EntityIdFactory - Class in org.kiji.schema
            Factory class for creating EntityIds.
            EntityIdFactory(RowKeyFormat) - +Constructor for class org.kiji.schema.EntityIdFactory +
            Creates an entity ID factory. +
            ENV_URI_STRING - +Static variable in class org.kiji.schema.KijiURI +
            String to specify a value through the local environment. +
            equals(Object) - +Method in class org.kiji.schema.EntityId +
            +
            equals(Object) - +Method in class org.kiji.schema.HBaseColumnName +
            +
            equals(Object) - +Method in class org.kiji.schema.impl.AbstractKijiTable +
              +
            equals(Object) - +Method in class org.kiji.schema.KijiCell +
            Determines whether this KijiCell is equivalent to another. +
            equals(Object) - +Method in class org.kiji.schema.KijiColumnName +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiDataRequest.Column +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiDataRequest +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
              +
            equals(Object) - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiURI +
            +
            equals(Object) - +Method in class org.kiji.schema.layout.impl.ColumnId +
            +
            equals(Object) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            +
            equals(Object) - +Method in class org.kiji.schema.util.BytesKey +
              +
            exists() - +Method in class org.kiji.schema.KijiConfiguration +
            Determines whether this named Kiji instance exists. +
            exists(HBaseAdmin) - +Method in class org.kiji.schema.KijiConfiguration +
            Determines whether the Kiji instance exists according to the + given HBase admin interface. +
            exists(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Reports whether a column exists. +
            exportMetadata(String, Kiji) - +Method in class org.kiji.schema.impl.MetadataRestorer +
            Exports all Kiji metadata to an Avro file with the specified filename. +
            +
            +

            +F

            +
            +
            families - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            FamilyDesc - Class in org.kiji.schema.avro
             
            FamilyDesc() - +Constructor for class org.kiji.schema.avro.FamilyDesc +
            Default constructor. +
            FamilyDesc(Integer, String, List<String>, Boolean, String, CellSchema, List<ColumnDesc>, Boolean, String) - +Constructor for class org.kiji.schema.avro.FamilyDesc +
            All-args constructor. +
            FamilyDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for FamilyDesc instances.
            fileSystemSpecified(Path) - +Static method in class org.kiji.schema.tools.LayoutTool +
            Determines whether a path has its filesystem explicitly specified. +
            finalize() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
              +
            finalize() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner +
            +
            finalize() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            +
            finalize() - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            +
            finalize() - +Method in class org.kiji.schema.Kiji +
              +
            finalize() - +Method in class org.kiji.schema.KijiMetaTable +
            +
            finalize() - +Method in class org.kiji.schema.KijiTablePool +
              +
            finalize() - +Method in class org.kiji.schema.KijiTableReader +
            +
            flush() - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
              +
            flush() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Commits any pending additions to the schema table. +
            flush() - +Method in class org.kiji.schema.KijiSchemaTable +
            Commits any pending additions to the schema table. +
            FlushTableTool - Class in org.kiji.schema.tools
            Command-line tool for flushing kiji meta and user tables in hbase.
            FlushTableTool() - +Constructor for class org.kiji.schema.tools.FlushTableTool +
              +
            formatEmail(String, String) - +Static method in class org.kiji.schema.tools.synth.EmailSynthesizer +
            Construct an email address string. +
            fromAvroEntry(SchemaTableEntry) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Converts an Avro SchemaTableEntry into a SchemaEntry. +
            fromAvroJsonString(String, Schema) - +Static method in class org.kiji.schema.util.FromJson +
            Standard Avro JSON decoder. +
            fromBackup(Map<String, TableBackup>) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Restores metadata from a backup record. +
            fromBackup(List<SchemaTableEntry>) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Restores the schema entries from the specified backup record. +
            fromBackup(Map<String, TableBackup>) - +Method in class org.kiji.schema.KijiMetaTable +
            Restores metadata from a backup record. +
            fromBackup(List<SchemaTableEntry>) - +Method in class org.kiji.schema.KijiSchemaTable +
            Restores the schema entries from the specified backup record. +
            fromByteArray(byte[]) - +Static method in class org.kiji.schema.layout.impl.ColumnId +
            Translates HBase column names to ColumnIds. +
            fromCellSchema(CellSchema, KijiSchemaTable) - +Static method in class org.kiji.schema.layout.impl.CellSpec +
              +
            fromCellSchema(CellSchema) - +Static method in class org.kiji.schema.layout.impl.CellSpec +
            Creates a CellSpec from a CellSchema record. +
            fromHBaseRowKey(byte[]) - +Method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID from an HBase row key. +
            fromHBaseRowKey(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashedEntityId +
            Creates a HashedEntityId from the specified HBase row key. +
            fromHBaseRowKey(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Creates a HashPrefixedEntityId from the specified HBase row key. +
            fromHBaseRowKey(byte[]) - +Static method in class org.kiji.schema.impl.RawEntityId +
            Creates a RawEntityId from the specified HBase row key. +
            FromJson - Class in org.kiji.schema.util
            Decode a JSON string into an Avro record.
            fromJsonNode(JsonNode, Schema) - +Static method in class org.kiji.schema.util.FromJson +
            Decodes a JSON node as an Avro value. +
            fromJsonString(String, Schema) - +Static method in class org.kiji.schema.util.FromJson +
            Decodes a JSON encoded record. +
            fromKijiRowKey(byte[]) - +Method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID from a Kiji row key. +
            fromKijiRowKey(String) - +Method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID from a UTF8 text Kiji row key. +
            fromKijiRowKey(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashedEntityId +
            Creates a HashedEntityId from the specified Kiji row key. +
            fromKijiRowKey(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Creates a HashPrefixedEntityId from the specified Kiji row key. +
            fromKijiRowKey(byte[]) - +Static method in class org.kiji.schema.impl.RawEntityId +
            Creates a RawEntityId from the specified Kiji row key. +
            fromString(String) - +Static method in class org.kiji.schema.layout.impl.ColumnId +
            Translates HBase column names to ColumnIds. +
            Functions - Class in org.kiji.schema.util
            A collection of useful functions.
            +
            +

            +G

            +
            +
            GenericCellDecoder<T> - Class in org.kiji.schema.impl
            Decodes cells encoded using Avro into generic types.
            GenericCellDecoder(CellSpec) - +Constructor for class org.kiji.schema.impl.GenericCellDecoder +
            Initializes a cell decoder that creates generic Avro types. +
            GenericCellDecoderFactory - Class in org.kiji.schema
            Factory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas.
            GenericTableMapReduceUtil - Class in org.apache.hadoop.hbase.mapreduce
            Just like TableMapReduceUtil but fixes some missing dependency jars.
            GenericTableMapReduceUtil() - +Constructor for class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
              +
            get(int) - +Method in class org.kiji.schema.avro.CellSchema +
              +
            get(int) - +Method in class org.kiji.schema.avro.ColumnDesc +
              +
            get(int) - +Method in class org.kiji.schema.avro.FamilyDesc +
              +
            get(int) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            get(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            get(int) - +Method in class org.kiji.schema.avro.MetadataBackup +
              +
            get(int) - +Method in class org.kiji.schema.avro.RowKeyFormat +
              +
            get(int) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
              +
            get(int) - +Method in class org.kiji.schema.avro.TableBackup +
              +
            get(int) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            get(int) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
              +
            get() - +Static method in class org.kiji.schema.GenericCellDecoderFactory +
              +
            get() - +Static method in class org.kiji.schema.HBaseFactory.Provider +
              +
            get() - +Static method in class org.kiji.schema.impl.CounterCellDecoder +
              +
            get() - +Static method in class org.kiji.schema.impl.CounterCellEncoder +
              +
            get() - +Static method in class org.kiji.schema.impl.DefaultHBaseAdminFactory +
              +
            get() - +Static method in class org.kiji.schema.impl.DefaultHTableInterfaceFactory +
              +
            get() - +Static method in class org.kiji.schema.impl.DefaultKijiCellEncoderFactory +
              +
            get(EntityId, KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Retrieve data from a single row in the Kiji table, with no post-processing. +
            get(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Constructs using an HBase HTable name. +
            get(String) - +Method in class org.kiji.schema.KijiTablePool +
            Gets a previously opened table from the pool, or open a new connection. +
            get(EntityId, KijiDataRequest) - +Method in class org.kiji.schema.KijiTableReader +
            Retrieves data from a single row in the kiji table. +
            get() - +Static method in class org.kiji.schema.SpecificCellDecoderFactory +
              +
            getAliases() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'aliases' field +
            getAliases() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'aliases' field. +
            getAliases() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'aliases' field +
            getAliases() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'aliases' field. +
            getAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'aliases' field +
            getAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'aliases' field. +
            getAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Gets the value of the 'avro_schema' field +
            getAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Gets the value of the 'avro_schema' field. +
            getAvroSchema() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            getBuffer(EntityId) - +Method in class org.kiji.schema.impl.KijiDataBuffer +
            Gets the list of buffer elements associated with the specified entity. +
            getBuffers() - +Method in class org.kiji.schema.impl.KijiDataBuffer +
              +
            getBytes() - +Method in class org.kiji.schema.util.BytesKey +
              +
            getBytes() - +Method in class org.kiji.schema.util.ByteStreamArray +
              +
            getCacheBlocks() - +Method in class org.kiji.schema.HBaseScanOptions +
            Returns whether requested rows are cached server-side, + or null if using the HBase default. +
            getCategory() - +Method in class org.kiji.schema.tools.CreateTableTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.DeleteTableTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.FlushTableTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.HelpTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.IncrementTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.InstallTool +
            +
            getCategory() - +Method in interface org.kiji.schema.tools.KijiTool +
              +
            getCategory() - +Method in class org.kiji.schema.tools.LayoutTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.LsTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.MetadataTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.PutTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.UninstallTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.VersionTool +
            +
            getCell(String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the specified cell. +
            getCell(String, String, long) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the specified cell. +
            getCellDecoderFactory() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the cell decoder factory. +
            getCellFormat(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Reports the cell format for the specified column. +
            getCells(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all the timestamp-cell pairs stored within the specified cell. +
            getCells(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all the timestamp-cell pairs stored within the specified family. +
            getCells(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all the timestamp-cell pairs stored within the specified family. +
            getCells(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all the timestamp-cell pairs stored within the specified cell. +
            getCellSchema() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            getCellSchema(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Gets the schema for a column. +
            getCellSpec(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getClientBufferSize() - +Method in class org.kiji.schema.HBaseScanOptions +
            Returns the number of rows to request with each RPC, + or null if using the HBase default. +
            getClientDataVersion() - +Static method in class org.kiji.schema.util.VersionInfo +
            Gets the version of the Kiji data format assumed by the client. +
            getClock() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets a clock. +
            getClusterDataVersion(Kiji) - +Static method in class org.kiji.schema.util.VersionInfo +
            Gets the version of the Kiji data format installed in the instance of the HBase cluster. +
            getColumn(String, String) - +Method in class org.kiji.schema.KijiDataRequest +
            Gets a Column requested named "family:key", or + null if none exists. +
            getColumn() - +Method in class org.kiji.schema.KijiURI +
              +
            getColumnIdNameMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getColumnMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getColumnName() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the column name. +
            getColumnNames() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getColumnOrdered() - +Method in class org.kiji.schema.KijiURI +
              +
            getColumns() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'columns' field +
            getColumns() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'columns' field. +
            getColumns() - +Method in class org.kiji.schema.KijiDataRequest +
            Gets the collection of requested columns. +
            getColumns() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'column_schema' field +
            getColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'column_schema' field. +
            getCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'compression_type' field +
            getCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'compression_type' field. +
            getConf() - +Method in class org.kiji.schema.Kiji +
            Gets the hadoop configuration. +
            getConf() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            getCounter(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Deprecated.  +
            getCounter(String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Deprecated.  +
            getCounter(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the most recent counter from a column. +
            getCounter(String, String, long) - +Method in interface org.kiji.schema.KijiRowData +
            Reads a counter as it was at a particular timestamp. +
            getCounter(Enum<?>) - +Method in interface org.kiji.schema.util.CounterManager +
            Gets a counter by name. +
            getCurrentKey() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            getCurrentValue() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            getData() - +Method in class org.kiji.schema.KijiCell +
            Gets the data in the cell. +
            getDataRequest() - +Method in class org.kiji.schema.filter.ColumnValueEqualsRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.HasColumnDataRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.KijiRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.OperatorRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.StripValueRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the data request. +
            getDataVersion() - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Gets the version of kiji installed. +
            getDataVersion() - +Method in class org.kiji.schema.KijiSystemTable +
            Gets the version of kiji installed. +
            getDefaultClock() - +Static method in class org.kiji.schema.util.Clock +
              +
            getDelete() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'delete' field +
            getDelete() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'delete' field. +
            getDelete() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'delete' field +
            getDelete() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'delete' field. +
            getDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'delete' field +
            getDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'delete' field. +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getDescription() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.tools.CreateTableTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.DeleteTableTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.FlushTableTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.HelpTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.IncrementTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.InstallTool +
            +
            getDescription() - +Method in interface org.kiji.schema.tools.KijiTool +
              +
            getDescription() - +Method in class org.kiji.schema.tools.LayoutTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.LsTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.MetadataTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.PutTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.UninstallTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.VersionTool +
            +
            getEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'enabled' field +
            getEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'enabled' field. +
            getEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'enabled' field +
            getEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'enabled' field. +
            getEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'enabled' field +
            getEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'enabled' field. +
            getEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Gets the value of the 'encoding' field +
            getEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Gets the value of the 'encoding' field. +
            getEntityId(String) - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            Creates an entity ID out of a UTF8 encoded Kiji row key. +
            getEntityId() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the entity id for this row of kiji data. +
            getEntityId() - +Method in interface org.kiji.schema.KijiRowData +
            Gets the entity id for this row of kiji data. +
            getEntityId(String) - +Method in interface org.kiji.schema.KijiTable +
            Creates an entity ID for the specified UTF8 encoded Kiji row key. +
            getEntityIdFactory() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            +
            getEntityIdFactory() - +Method in interface org.kiji.schema.KijiTable +
              +
            getEntries() - +Method in class org.kiji.schema.impl.KijiDataBuffer +
              +
            getFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'families' field +
            getFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'families' field. +
            getFamilies() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getFamilies() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getFamily() - +Method in class org.kiji.schema.HBaseColumnName +
            Gets the HBase column family. +
            getFamily() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column family. +
            getFamily() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the name of the requested column family. +
            getFamily() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getFamilyAsString() - +Method in class org.kiji.schema.HBaseColumnName +
            Gets the HBase column family as a string. +
            getFamilyBytes() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column family as a byte array. +
            getFamilyIdNameMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getFamilyMap() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getFamilyMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getFilter() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the column filter, or null if no filter was specified. +
            getFormat() - +Method in class org.kiji.schema.EntityId +
              +
            getFormat() - +Method in class org.kiji.schema.EntityIdFactory +
              +
            getFormat() - +Method in class org.kiji.schema.impl.HashedEntityId +
            +
            getFormat() - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
            +
            getFormat() - +Method in class org.kiji.schema.impl.HBaseEntityId +
            +
            getFormat() - +Method in class org.kiji.schema.impl.RawEntityId +
            +
            getHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Gets the value of the 'hash' field +
            getHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Gets the value of the 'hash' field. +
            getHash() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
              +
            getHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Gets the value of the 'hash_size' field +
            getHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Gets the value of the 'hash_size' field. +
            getHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Gets the value of the 'hash_type' field +
            getHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Gets the value of the 'hash_type' field. +
            getHBaseAdminFactory(KijiURI) - +Method in interface org.kiji.schema.HBaseFactory +
            Reports a factory for HBaseAdmin for a given HBase instance. +
            getHBaseAdminFactory(KijiURI) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            Reports a factory for HBaseAdmin for a given HBase instance. +
            getHBaseCellValue(KijiColumnName, KijiCell<?>) - +Method in class org.kiji.schema.filter.KijiRowFilter.Context +
            Converts a Kiji cell value into an HBase cell value. +
            getHBaseColumnName(KijiColumnName) - +Method in interface org.kiji.schema.filter.KijiColumnFilter.Context +
            Converts a Kiji column name to an HBase column name. +
            getHBaseColumnName(KijiColumnName) - +Method in class org.kiji.schema.filter.KijiRowFilter.Context +
            Converts a Kiji column name to an HBase column family name. +
            getHBaseResult() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the HBase result backing this KijiRowData. +
            getHBaseResultScanner() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the HBase result scanner. +
            getHBaseRowKey() - +Method in class org.kiji.schema.EntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey(String) - +Method in class org.kiji.schema.filter.KijiRowFilter.Context +
            Converts a Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.HashedEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.HBaseEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.RawEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseTableName() - +Method in exception org.kiji.schema.NotAKijiManagedTableException +
            Gets the name of the HBase table that is not managed by Kiji. +
            getHColumnDescriptor(String) - +Static method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets the description of an HColumn suitable for storing the table layout database. +
            getHTable() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
              +
            getHTableInterfaceFactory(KijiURI) - +Method in interface org.kiji.schema.HBaseFactory +
            Reports a factory for HTableInterface for a given HBase instance. +
            getHTableInterfaceFactory(KijiURI) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            Reports a factory for HTableInterface for a given HBase instance. +
            getId() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
              +
            getId() - +Method in class org.kiji.schema.layout.impl.ColumnId +
              +
            getId() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getId() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getId() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getIdlePollPeriod() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the amount of time between sweeps of the pool for removing idle connections. +
            getIdleTimeout() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the amount of time a connection may be idle before being removed from the pool. +
            getInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'in_memory' field +
            getInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'in_memory' field. +
            getInstance() - +Method in class org.kiji.schema.KijiURI +
              +
            getInstanceName() - +Method in exception org.kiji.schema.KijiNotInstalledException +
              +
            getInstanceNames() - +Method in class org.kiji.schema.tools.LsTool +
            Returns a set of instance names. +
            getJarsFromConfiguration(Configuration) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Lists all jars in the variable tmpjars of this Configuration. +
            getJarsFromDirectory(Configuration, File) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated.   +
            getKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Gets the value of the 'key' field +
            getKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Gets the value of the 'key' field. +
            getKey() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the name of the requested column qualifier, which may be null if any qualifier + should be included. +
            getKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'keys_format' field +
            getKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'keys_format' field. +
            getKeyValues() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Gets the value of the 'key_values' field +
            getKeyValues() - +Method in class org.kiji.schema.avro.TableBackup +
            Gets the value of the 'key_values' field. +
            getKiji() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            Gets the kiji instance this table lives in. +
            getKiji() - +Method in interface org.kiji.schema.KijiTable +
              +
            getKijiCellDecoderFactory() - +Method in class org.kiji.schema.KijiTableReader +
            Gets the KijiCellDecoderFactory to use for decoding KijiCells. +
            getKijiConf() - +Method in class org.kiji.schema.Kiji +
            Gets the kiji instance configuration. +
            getKijiInstanceName() - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets the name of the Kiji instance this named table belongs to. +
            getKijiRowKey() - +Method in class org.kiji.schema.EntityId +
              +
            getKijiRowKey() - +Method in class org.kiji.schema.impl.HashedEntityId +
            +
            getKijiRowKey() - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
            +
            getKijiRowKey() - +Method in class org.kiji.schema.impl.HBaseEntityId +
            +
            getKijiRowKey() - +Method in class org.kiji.schema.impl.RawEntityId +
            +
            getKijiTableName(String, String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table. +
            getKijiTableName() - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets the name of the Kiji table. +
            getLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Gets the value of the 'layout' field +
            getLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Gets the value of the 'layout' field. +
            getLayout() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            +
            getLayout() - +Method in interface org.kiji.schema.KijiTable +
              +
            getLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'layout_id' field +
            getLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'layout_id' field. +
            getLayouts() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Gets the value of the 'layouts' field +
            getLayouts() - +Method in class org.kiji.schema.avro.TableBackup +
            Gets the value of the 'layouts' field. +
            getLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Gets the value of the 'layout_version' field +
            getLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup +
            Gets the value of the 'layout_version' field. +
            getLocalityGroup() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getLocalityGroupIdNameMap() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getLocalityGroupMap() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'locality_groups' field +
            getLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'locality_groups' field. +
            getLocalityGroups() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getLockFactory(KijiURI, Configuration) - +Method in interface org.kiji.schema.HBaseFactory +
            Creates a lock factory for a given Kiji instance. +
            getLockFactory(KijiURI, Configuration) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            Creates a lock factory for a given Kiji instance. +
            getMap() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets a map from kiji family to qualifier to timestamp to raw kiji-encoded bytes of a cell. +
            getMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'map_schema' field +
            getMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'map_schema' field. +
            getMaxSize() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the maximum number of connections to keep per table. +
            getMaxTimestamp() - +Method in class org.kiji.schema.KijiDataRequest +
            Gets the maximum timestamp for versions in this request (exclusive). +
            getMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'max_versions' field +
            getMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'max_versions' field. +
            getMaxVersions() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the max number of most recent versions in this request. +
            getMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Gets the value of the 'meta_table' field +
            getMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup +
            Gets the value of the 'meta_table' field. +
            getMetaTable() - +Method in class org.kiji.schema.Kiji +
            Gets the meta table for this Kiji instance. +
            getMetaTableName(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table. +
            getMinTimestamp() - +Method in class org.kiji.schema.KijiDataRequest +
            Gets the minimum timestamp for versions in this request (inclusive). +
            getMostRecentCell(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the latest version of the specified cell. +
            getMostRecentCell(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the latest version of the specified cell. +
            getMostRecentCells(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the latest version of the specified cell. +
            getMostRecentCells(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the latest version of the specified cell. +
            getMostRecentValue(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the value with the latest timestamp stored within the specified cell. +
            getMostRecentValue(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the value with the latest timestamp stored within the specified cell. +
            getMostRecentValues(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the value with the latest timestamp stored within the specified cell. +
            getMostRecentValues(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the value with the latest timestamp stored within the specified cell. +
            getName() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.TableBackup +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            Gets the name of this kiji table. +
            getName() - +Method in class org.kiji.schema.Kiji +
            Gets the name of the kiji instance. +
            getName() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the full name of the column. +
            getName() - +Method in class org.kiji.schema.KijiConfiguration +
            Gets the name of this Kiji instance. +
            getName() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the full name of the requested column. +
            getName() - +Method in interface org.kiji.schema.KijiTable +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getName() - +Method in class org.kiji.schema.tools.CreateTableTool +
            +
            getName() - +Method in class org.kiji.schema.tools.DeleteTableTool +
            +
            getName() - +Method in class org.kiji.schema.tools.FlushTableTool +
            +
            getName() - +Method in class org.kiji.schema.tools.HelpTool +
            +
            getName() - +Method in class org.kiji.schema.tools.IncrementTool +
            +
            getName() - +Method in class org.kiji.schema.tools.InstallTool +
            +
            getName() - +Method in interface org.kiji.schema.tools.KijiTool +
              +
            getName() - +Method in class org.kiji.schema.tools.LayoutTool +
            +
            getName() - +Method in class org.kiji.schema.tools.LsTool +
            +
            getName() - +Method in class org.kiji.schema.tools.MetadataTool +
            +
            getName() - +Method in class org.kiji.schema.tools.PutTool +
            +
            getName() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            +
            getName() - +Method in class org.kiji.schema.tools.UninstallTool +
            +
            getName() - +Method in class org.kiji.schema.tools.VersionTool +
            +
            getNames() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getNames() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getNames() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getNextPage(String, String) - +Method in class org.kiji.schema.KijiColumnPager +
            Gets the next page of data in a column with paging enabled. +
            getNextPage(String) - +Method in class org.kiji.schema.KijiColumnPager +
            Gets the next page of data in a family with paging enabled. +
            getOffset() - +Method in class org.kiji.schema.util.ByteStreamArray +
              +
            getOptionalType(Schema) - +Static method in class org.kiji.schema.util.AvroUtils +
            Reports whether the given schema is an optional type (ie. +
            getOrCreateSchemaHash(Schema) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema hash given an Avro schema object. +
            getOrCreateSchemaHash(Schema) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema hash given an Avro schema object. +
            getOrCreateSchemaId(Schema) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema ID given an Avro schema object. +
            getOrCreateSchemaId(Schema) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema ID given an Avro schema object. +
            getPageSize() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the number of cells to return per page of results. +
            getPayload(byte[]) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Gets the portion of the encoded byte array from an HBase table cell that has the avro-encoded + data payload. +
            getPrintStream() - +Method in class org.kiji.schema.tools.BaseTool +
            The output print stream the tool should be writing to. +
            getPriority(Map<String, String>) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            +
            getProgress() - +Method in class org.kiji.schema.impl.HBaseTableRecordReader +
              +
            getProgress() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            getQualifier() - +Method in class org.kiji.schema.HBaseColumnName +
            Gets the HBase column qualifier. +
            getQualifier() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column qualifier, which may be null or empty. +
            getQualifierAsString() - +Method in class org.kiji.schema.HBaseColumnName +
            Gets the HBase column qualifier as a string. +
            getQualifierBytes() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column qualifier as a byte array. +
            getQualifiers(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the set of column qualifiers that exist in a family. +
            getQualifiers(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the set of column qualifiers that exist in a family. +
            getReaderSchema(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +
            getReaderSchema(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +
            getReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'reference_layout' field +
            getReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'reference_layout' field. +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'renamed_from' field +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'renamed_from' field. +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'renamed_from' field +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'renamed_from' field. +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'renamed_from' field +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'renamed_from' field. +
            getScanner(KijiDataRequest, EntityId, EntityId, KijiRowFilter, HBaseScanOptions) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions. +
            getScanner(KijiDataRequest, EntityId, EntityId) - +Method in class org.kiji.schema.KijiTableReader +
            Gets a KijiRowScanner using default options. +
            getScanner(KijiDataRequest, EntityId, EntityId, HBaseScanOptions) - +Method in class org.kiji.schema.KijiTableReader +
            Gets a KijiRowScanner using the specified HBaseScanOptions. +
            getScanner(KijiDataRequest, EntityId, EntityId, KijiRowFilter, HBaseScanOptions) - +Method in class org.kiji.schema.KijiTableReader +
            Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions. +
            getSchema() - +Method in class org.kiji.schema.avro.CellSchema +
              +
            getSchema() - +Method in class org.kiji.schema.avro.ColumnDesc +
              +
            getSchema() - +Method in class org.kiji.schema.avro.FamilyDesc +
              +
            getSchema() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            getSchema() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            getSchema() - +Method in class org.kiji.schema.avro.MetadataBackup +
              +
            getSchema() - +Method in class org.kiji.schema.avro.RowKeyFormat +
              +
            getSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
              +
            getSchema() - +Method in class org.kiji.schema.avro.TableBackup +
              +
            getSchema() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            getSchema() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
              +
            getSchema(long) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema given an ID. +
            getSchema(BytesKey) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema given a hash. +
            getSchema(long) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema given an ID. +
            getSchema(BytesKey) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema given a hash. +
            getSchema() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
              +
            getSchema(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Reports the schema of the specified column. +
            getSchemaHash(Schema) - +Method in class org.kiji.schema.KijiSchemaTable +
            Computes a schema hash. +
            getSchemaHashTableName(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table. +
            getSchemaIdTableName(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table. +
            getSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Gets the value of the 'schema_table' field +
            getSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup +
            Gets the value of the 'schema_table' field. +
            getSchemaTable() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the schema table this kiji row data uses for decoding. +
            getSchemaTable() - +Method in class org.kiji.schema.Kiji +
            Gets the schema table for this Kiji instance. +
            getSchemaTable() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            getSchemaV5TableName(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table. +
            getServerPrefetchSize() - +Method in class org.kiji.schema.HBaseScanOptions +
            Returns the number of rows for servers to prefetch, + or null if using the HBase default. +
            getSoftwareVersion() - +Static method in class org.kiji.schema.util.VersionInfo +
            Gets the version of the Kiji client software. +
            getSplitKeys(int) - +Static method in class org.kiji.schema.KijiRowKeySplitter +
            Returns the split keys for the given number of regions. +
            getSplits(JobContext) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            getStorage() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Gets the value of the 'storage' field +
            getStorage() - +Method in class org.kiji.schema.avro.CellSchema +
            Gets the value of the 'storage' field. +
            getSystemTable() - +Method in class org.kiji.schema.Kiji +
            Gets the system table for this Kiji instance. +
            getSystemTableName(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table. +
            getTable() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the table being scanned. +
            getTable() - +Method in class org.kiji.schema.KijiTableReader +
            Gets the table this reads from. +
            getTable() - +Method in class org.kiji.schema.KijiURI +
              +
            getTableLayout() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the layout of the table this row data belongs to. +
            getTableLayout(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets the most recent versions of the layout for a table. +
            getTableLayout() - +Method in class org.kiji.schema.layout.ColumnNameTranslator +
              +
            getTableLayout(String) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets the most recent versions of the layout for a table. +
            getTableLayout() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getTableLayout(String) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets the most recent versions of the layout for a table. +
            getTableLayoutVersions(String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the most recent specified number of versions of the table layout. +
            getTableLayoutVersions(String, int) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets a list of the most recent specified number of versions of the table layout. +
            getTableLayoutVersions(String, int) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets a list of the most recent specified number of versions of the table layout. +
            getTableNames() - +Method in class org.kiji.schema.KijiAdmin +
            Gets the list of Kiji table names. +
            getTime() - +Method in class org.kiji.schema.util.Clock +
            Gets the current time. +
            getTimedTableLayoutVersions(String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +
            getTimedTableLayoutVersions(String, int) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +
            getTimedTableLayoutVersions(String, int) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +
            getTimedValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns a map of values associated with the specified table and key. +
            getTimedValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns a map of values associated with the specified table and key. +
            getTimedValues(String, String, int) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns a map of values associated with the specified table and key. +
            getTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Gets the value of the 'timestamp' field +
            getTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Gets the value of the 'timestamp' field. +
            getTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Gets the value of the 'timestamp' field +
            getTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Gets the value of the 'timestamp' field. +
            getTimestamp() - +Method in class org.kiji.schema.impl.DefaultKijiCounter +
            Gets the timestamp at which the counter was incremented. +
            getTimestamp() - +Method in interface org.kiji.schema.KijiCounter +
            Deprecated. Gets the timestamp at which the counter was incremented. +
            getTimestamps(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the set of timestamps on cells that exist in a column. +
            getTimestamps(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the set of timestamps on cells that exist in a column. +
            getTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'ttl_seconds' field +
            getTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'ttl_seconds' field. +
            getType() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Gets the value of the 'type' field +
            getType() - +Method in class org.kiji.schema.avro.CellSchema +
            Gets the value of the 'type' field. +
            getUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Gets the value of the 'update' field +
            getUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Gets the value of the 'update' field. +
            getURI() - +Method in class org.kiji.schema.tools.BaseTool +
            Returns the kiji URI of the target this tool operates on. +
            getValue() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Gets the value of the 'value' field +
            getValue() - +Method in class org.kiji.schema.avro.CellSchema +
            Gets the value of the 'value' field. +
            getValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Gets the value of the 'value' field +
            getValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Gets the value of the 'value' field. +
            getValue() - +Method in class org.kiji.schema.impl.DefaultKijiCounter +
            Gets the value of the counter. +
            getValue(String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the value stored within the specified cell. +
            getValue(String, String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns the most recent value associated with the specified table and key. +
            getValue(String) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Gets the value associated with a property key. +
            getValue(String, String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns the most recent value associated with the specified table and key. +
            getValue() - +Method in interface org.kiji.schema.KijiCounter +
            Deprecated. Gets the value of the counter. +
            getValue(String, String, long) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the value stored within the specified cell. +
            getValue(String) - +Method in class org.kiji.schema.KijiSystemTable +
            Gets the value associated with a property key. +
            getValue(String, String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns the most recent value associated with the specified table and key. +
            getValues(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all the timestamp-value pairs stored within the specified cell. +
            getValues(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all the timestamp-value pairs stored within the specified family. +
            getValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +
            getValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +
            getValues(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all the timestamp-value pairs stored within the specified family. +
            getValues(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all the timestamp-value pairs stored within the specified cell. +
            getValues(String, String, int) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +
            getVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'version' field +
            getVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'version' field. +
            getWriterSchema() - +Method in class org.kiji.schema.KijiCell +
            Gets the schema used to write data in the cell. +
            getZookeeperClientPort() - +Method in class org.kiji.schema.KijiURI +
              +
            getZookeeperQuorum() - +Method in class org.kiji.schema.KijiURI +
              +
            getZookeeperQuorumOrdered() - +Method in class org.kiji.schema.KijiURI +
              +
            +
            +

            +H

            +
            +
            hasAliases() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'aliases' field has been set +
            hasAliases() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'aliases' field has been set +
            hasAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'aliases' field has been set +
            hasAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Checks whether the 'avro_schema' field has been set +
            HasColumnDataRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter that excludes rows that have no data for some column columnName.
            HasColumnDataRowFilter(String, String) - +Constructor for class org.kiji.schema.filter.HasColumnDataRowFilter +
            Constructs a row filter that excludes rows that have no data in columnName. +
            HasColumnDataRowFilter(String) - +Constructor for class org.kiji.schema.filter.HasColumnDataRowFilter +
            Constructs a row filter that excludes rows that have no data in columnName. +
            hasColumns() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'columns' field has been set +
            hasColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'column_schema' field has been set +
            hasCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'compression_type' field has been set +
            hasDelete() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'delete' field has been set +
            hasDelete() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'delete' field has been set +
            hasDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'delete' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'description' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'description' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'description' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'description' field has been set +
            hasEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'enabled' field has been set +
            hasEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'enabled' field has been set +
            hasEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'enabled' field has been set +
            hasEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Checks whether the 'encoding' field has been set +
            hasFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'families' field has been set +
            hash - +Variable in class org.kiji.schema.avro.SchemaTableEntry +
            Deprecated.  +
            hash(String) - +Static method in class org.kiji.schema.util.Hasher +
            Hashes the input string. +
            hash(byte[]) - +Static method in class org.kiji.schema.util.Hasher +
            Hashes the input byte array. +
            hash_size - +Variable in class org.kiji.schema.avro.RowKeyFormat +
            Deprecated.  +
            HASH_SIZE_BYTES - +Static variable in class org.kiji.schema.util.Hasher +
            The number of bytes in a hash. +
            hash_type - +Variable in class org.kiji.schema.avro.RowKeyFormat +
            Deprecated.  +
            hasHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Checks whether the 'hash' field has been set +
            hasHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Checks whether the 'hash_size' field has been set +
            hasHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Checks whether the 'hash_type' field has been set +
            hashCode() - +Method in class org.kiji.schema.EntityId +
            +
            hashCode() - +Method in class org.kiji.schema.HBaseColumnName +
            +
            hashCode() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
              +
            hashCode() - +Method in class org.kiji.schema.KijiCell +
            This operation is not supported. +
            hashCode() - +Method in class org.kiji.schema.KijiColumnName +
            +
            hashCode() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            +
            hashCode() - +Method in class org.kiji.schema.KijiDataRequest +
            +
            hashCode() - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
              +
            hashCode() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            +
            hashCode() - +Method in class org.kiji.schema.KijiURI +
            +
            hashCode() - +Method in class org.kiji.schema.layout.impl.ColumnId +
            +
            hashCode() - +Method in class org.kiji.schema.layout.KijiTableLayout +
            +
            hashCode() - +Method in class org.kiji.schema.util.BytesKey +
              +
            HashedEntityId - Class in org.kiji.schema.impl
            Implements the hashed row key format.
            Hasher - Class in org.kiji.schema.util
            A thread-safe utility for computing hashes of strings.
            hashKijiRowKey(RowKeyFormat, byte[]) - +Static method in class org.kiji.schema.impl.HashedEntityId +
            Hashes a Kiji row key. +
            hashKijiRowKey(RowKeyFormat, byte[]) - +Static method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Hashes a Kiji row key. +
            HashPrefixedEntityId - Class in org.kiji.schema.impl
            Implements the hash-prefixed row key format.
            hashSchema(Schema) - +Static method in class org.kiji.schema.KijiSchemaTable +
            Computes a hash of the specified Avro schema. +
            HashType - Enum in org.kiji.schema.avro
             
            hasId() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'id' field has been set +
            hasId() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'id' field has been set +
            hasId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'id' field has been set +
            hasId() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Checks whether the 'id' field has been set +
            hasInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'in_memory' field has been set +
            hasKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Checks whether the 'key' field has been set +
            hasKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'keys_format' field has been set +
            hasKeyValues() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Checks whether the 'key_values' field has been set +
            hasLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Checks whether the 'layout' field has been set +
            hasLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'layout_id' field has been set +
            hasLayouts() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Checks whether the 'layouts' field has been set +
            hasLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Checks whether the 'layout_version' field has been set +
            hasLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'locality_groups' field has been set +
            hasMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'map_schema' field has been set +
            hasMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'max_versions' field has been set +
            hasMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Checks whether the 'meta_table' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'name' field has been set +
            hasReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'reference_layout' field has been set +
            hasRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'renamed_from' field has been set +
            hasRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'renamed_from' field has been set +
            hasRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'renamed_from' field has been set +
            hasSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Checks whether the 'schema_table' field has been set +
            hasStorage() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Checks whether the 'storage' field has been set +
            hasTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Checks whether the 'timestamp' field has been set +
            hasTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Checks whether the 'timestamp' field has been set +
            hasTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'ttl_seconds' field has been set +
            hasType() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Checks whether the 'type' field has been set +
            hasUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Checks whether the 'update' field has been set +
            hasValue() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Checks whether the 'value' field has been set +
            hasValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Checks whether the 'value' field has been set +
            hasVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'version' field has been set +
            HBASE_ROW_KEY_RESOLUTION - +Static variable in class org.kiji.schema.KijiRowKeySplitter +
            Resolution (in number of bytes) when generating evenly spaced HBase row keys. +
            HBaseAdminFactory - Interface in org.kiji.schema.impl
            Factory for HBaseAdmin.
            HBaseColumnName - Class in org.kiji.schema
            An HBase column name.
            HBaseColumnName(byte[], byte[]) - +Constructor for class org.kiji.schema.HBaseColumnName +
            Creates a new HBaseColumnName instance. +
            HBaseDataRequestAdapter - Class in org.kiji.schema.impl
            Wraps a KijiDataRequest to expose methods that generate meaningful objects in HBase + land, like Puts and Gets.
            HBaseDataRequestAdapter(KijiDataRequest) - +Constructor for class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Wraps a KijiDataRequest. +
            HBaseEntityId - Class in org.kiji.schema.impl
            Entity ID encapsulating an HBase row key.
            HBaseEntityId(byte[]) - +Constructor for class org.kiji.schema.impl.HBaseEntityId +
            Creates an HBaseEntityId from the specified HBase row key. +
            HBaseFactory - Interface in org.kiji.schema
            Factory for HBase instances based on URIs.
            HBaseFactory.Provider - Class in org.kiji.schema
            Provider for the default HBaseFactory.
            HBaseKijiRowData - Class in org.kiji.schema.impl
            An implementation of KijiRowData that wraps an HBase Result object.
            HBaseKijiRowData(EntityId, KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Deprecated.  +
            HBaseKijiRowData(KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Deprecated.  +
            HBaseKijiRowData(EntityId, KijiDataRequest, HBaseKijiTable, Result) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Initializes a row data. +
            HBaseKijiRowData(KijiDataRequest, HBaseKijiTable, Result) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Initializes a row data. +
            HBaseKijiRowScanner - Class in org.kiji.schema.impl
            The internal implementation of KijiRowScanner that reads from HTables.
            HBaseKijiRowScanner(HBaseKijiRowScanner.Options) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowScanner +
            Creates a new KijiRowScanner instance. +
            HBaseKijiRowScanner.Options - Class in org.kiji.schema.impl
            A class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            HBaseKijiRowScanner.Options() - +Constructor for class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
              +
            HBaseKijiTable - Class in org.kiji.schema.impl
            A KijiTable that exposes the underlying HBase implementation.
            HBaseKijiTable(Kiji, String) - +Constructor for class org.kiji.schema.impl.HBaseKijiTable +
            Construct an opened Kiji table stored in HBase. +
            HBaseKijiTable(Kiji, String, HTableInterfaceFactory) - +Constructor for class org.kiji.schema.impl.HBaseKijiTable +
            Construct an opened Kiji table stored in HBase. +
            HBaseKijiTableReader - Class in org.kiji.schema.impl
            Reads from a kiji table by sending the requests directly to the HBase tables.
            HBaseKijiTableReader(KijiTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiTableReader +
            Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase. +
            HBaseKijiTableWriter - Class in org.kiji.schema.impl
            Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            HBaseKijiTableWriter(KijiTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiTableWriter +
            Creates a non-buffered kiji table writer that sends modifications directly to Kiji. +
            HBaseMetaTable - Class in org.kiji.schema.impl
            An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            HBaseMetaTable(KijiConfiguration, KijiSchemaTable, HTableInterfaceFactory) - +Constructor for class org.kiji.schema.impl.HBaseMetaTable +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +
            HBaseMetaTable(HTableInterface, KijiSchemaTable) - +Constructor for class org.kiji.schema.impl.HBaseMetaTable +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +
            HBaseMetaTable(HTableInterface, KijiTableLayoutDatabase, KijiTableKeyValueDatabase) - +Constructor for class org.kiji.schema.impl.HBaseMetaTable +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +
            HBaseScanOptions - Class in org.kiji.schema
            Customizable parameters for KijiRowScanners backed by an HBase scan.
            HBaseScanOptions() - +Constructor for class org.kiji.schema.HBaseScanOptions +
            Creates a new HBaseScanOptions where all parameters will default to HBase values. +
            HBaseSchemaTable - Class in org.kiji.schema.impl
            + Mapping between schema IDs, hashes and Avro schema objects.
            HBaseSchemaTable(KijiConfiguration, HTableInterfaceFactory, LockFactory) - +Constructor for class org.kiji.schema.impl.HBaseSchemaTable +
            Open a connection to the HBase schema table for a Kiji instance. +
            HBaseSchemaTable(HTableInterface, HTableInterface, Lock) - +Constructor for class org.kiji.schema.impl.HBaseSchemaTable +
            Wrap an existing HBase table assumed to be where the schema data is stored. +
            HBaseSystemTable - Class in org.kiji.schema.impl
            The Kiji system table that is stored in HBase.
            HBaseSystemTable(KijiConfiguration, HTableInterfaceFactory) - +Constructor for class org.kiji.schema.impl.HBaseSystemTable +
            Connect to the HBase system table inside a Kiji instance. +
            HBaseSystemTable(HTableInterface) - +Constructor for class org.kiji.schema.impl.HBaseSystemTable +
            Wrap an existing HTable connection that is assumed to be the table that stores the + Kiji instance properties. +
            HBaseTableKeyValueDatabase - Class in org.kiji.schema.impl
            Manages key-value pairs on a per table basis.
            HBaseTableKeyValueDatabase(HTableInterface, String) - +Constructor for class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            This class manages the storage and retrieval of key-value pairs on a per table basis. +
            HBaseTableLayoutDatabase - Class in org.kiji.schema.layout.impl
            Manages Kiji table layouts using a column family in an HBase table as a backing store.
            HBaseTableLayoutDatabase(HTableInterface, String, KijiSchemaTable) - +Constructor for class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Creates a new HBaseTableLayoutDatabase instance. +
            HBaseTableRecordReader - Class in org.kiji.schema.impl
            A record reader that reads from a HBase table that reports progress correctly.
            HBaseTableRecordReader(RowKeyFormat) - +Constructor for class org.kiji.schema.impl.HBaseTableRecordReader +
            Constructs a new record reader. +
            HColumnDescriptorComparator - Class in org.kiji.schema.impl
            Comparator for HColumnDescriptors.
            HColumnDescriptorComparator() - +Constructor for class org.kiji.schema.impl.HColumnDescriptorComparator +
              +
            HelpTool - Class in org.kiji.schema.tools
            Command-line tool for displaying help on available tools.
            HelpTool() - +Constructor for class org.kiji.schema.tools.HelpTool +
              +
            HTableDescriptorComparator - Class in org.kiji.schema.impl
            Compares HTableDescriptors.
            HTableDescriptorComparator() - +Constructor for class org.kiji.schema.impl.HTableDescriptorComparator +
              +
            HTableInterfaceFactory - Interface in org.kiji.schema.impl
            Factory for HTableInterface instances.
            HTableSchemaTranslator - Class in org.kiji.schema.layout.impl
            Translates between KijiTableLayouts and HTableDescriptors.
            HTableSchemaTranslator() - +Constructor for class org.kiji.schema.layout.impl.HTableSchemaTranslator +
            Creates a new HTableSchemaTranslator instance. +
            +
            +

            +I

            +
            +
            id - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            id - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            id - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            id - +Variable in class org.kiji.schema.avro.SchemaTableEntry +
            Deprecated.  +
            in_memory - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            IncompatibleKijiVersionException - Exception in org.kiji.schema
            Thrown when there is an attempt to operate on a Kiji instance whose data format version + is incompatible with the Kiji client version.
            IncompatibleKijiVersionException(String) - +Constructor for exception org.kiji.schema.IncompatibleKijiVersionException +
            Creates a new IncompatibleKijiVersionException with the specified + detail message. +
            increment(EntityId, String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Atomically increments a counter in a kiji table. +
            increment(EntityId, String, String, long) - +Method in interface org.kiji.schema.KijiIncrementer +
            Atomically increments a counter in a kiji table. +
            IncrementTool - Class in org.kiji.schema.tools
            Command-line tool to increment a counter in a cell of a kiji table.
            IncrementTool() - +Constructor for class org.kiji.schema.tools.IncrementTool +
              +
            initGenericTableMapperJob(String, Scan, Class<? extends TableMapper>, Class<?>, Class<?>, Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            This is just like the TableMapReduceUtil.initTableMapperJob but + it takes any classes for input and output keys instead of just + Writables. +
            initialize(InputSplit, TaskAttemptContext) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            initTableInput(String, Scan, Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            Configures the job with an HBase scan over a table as input. +
            initTableScan(Scan, Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            Configures the job with an HBase scan. +
            INPUT_DATA_REQUEST - +Static variable in class org.kiji.schema.mapreduce.KijiConfKeys +
            Deprecated. Serialized input data request. +
            INPUT_TABLE_URI - +Static variable in class org.kiji.schema.mapreduce.KijiConfKeys +
            Deprecated. URI of the input table to read from. +
            install(HBaseAdmin, KijiConfiguration) - +Static method in class org.kiji.schema.impl.HBaseMetaTable +
            Install the meta table into a Kiji instance. +
            install(HBaseAdmin, KijiConfiguration, HTableInterfaceFactory, LockFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Install the schema table into a Kiji instance. +
            install(HBaseAdmin, KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSystemTable +
            Installs a Kiji system table into a running HBase instance. +
            install(KijiURI, Configuration) - +Static method in class org.kiji.schema.KijiInstaller +
            Installs the specified Kiji instance. +
            install(KijiURI, HBaseFactory, Configuration) - +Static method in class org.kiji.schema.KijiInstaller +
            Installs a Kiji instance. +
            InstallTool - Class in org.kiji.schema.tools
            A command-line tool for installing kiji instances on hbase clusters.
            InstallTool() - +Constructor for class org.kiji.schema.tools.InstallTool +
              +
            INSTANCE - +Static variable in class org.kiji.schema.util.TimestampComparator +
            A singleton instance. +
            InternalKijiError - Error in org.kiji.schema
            Thrown when there is something wrong with the internal Kiji + implementation.
            InternalKijiError(Throwable) - +Constructor for error org.kiji.schema.InternalKijiError +
            Creates a new InternalKijiError with the specified cause. +
            InternalKijiError(String) - +Constructor for error org.kiji.schema.InternalKijiError +
            Creates a new InternalKijiError with the specified detail message. +
            InvalidColumnNameException - Exception in org.kiji.schema.impl
            Thrown when kiji encounters a column name that is not valid.
            InvalidColumnNameException(String) - +Constructor for exception org.kiji.schema.impl.InvalidColumnNameException +
            Creates a new InvalidColumnNameException with the specified detail message. +
            InvalidLayoutException - Exception in org.kiji.schema.layout
            Thrown when an invalid Kiji layout is encountered.
            InvalidLayoutException(String) - +Constructor for exception org.kiji.schema.layout.InvalidLayoutException +
            Creates a new InvalidLayoutException with the specified reason. +
            InvalidLayoutException(KijiTableLayout, String) - +Constructor for exception org.kiji.schema.layout.InvalidLayoutException +
            Constructs an exception indicated a table layout is invalid. +
            isAvro() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            isCounter() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            isEmpty() - +Method in class org.kiji.schema.KijiDataRequest +
            Determines whether this data request has any columns. +
            isFullyQualified() - +Method in class org.kiji.schema.KijiColumnName +
            Determines whether the name refers to a qualified family (vs. +
            isGroupType() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            isMapType() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            isPagingEnabled() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Determines whether paging is enabled for this column. +
            isPagingEnabled() - +Method in class org.kiji.schema.KijiDataRequest +
            Determines whether paging is enabled on any of the columns in this request. +
            isTimestampInRange(long) - +Method in class org.kiji.schema.KijiDataRequest +
            Determines whether a timestamp ts is within the time range for this + request. +
            isValidAlias(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
              +
            isValidClassName(String) - +Static method in class org.kiji.schema.util.JavaIdentifiers +
            Determines whether a string could be the name of a Java class. +
            isValidIdentifier(String) - +Static method in class org.kiji.schema.util.JavaIdentifiers +
            Determines whether a string is a valid Java identifier. +
            isValidKijiName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
              +
            isValidLayoutName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
              +
            iterator() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner +
            +
            +
            +

            +J

            +
            +
            JavaIdentifiers - Class in org.kiji.schema.util
            A utility class for dealing with identifiers in the Java language.
            +
            +

            +K

            +
            +
            key - +Variable in class org.kiji.schema.avro.KeyValueBackupEntry +
            Deprecated.  +
            KEY_DATA_VERSION - +Static variable in class org.kiji.schema.impl.HBaseSystemTable +
            The HBase row key that stores the installed Kiji data format version. +
            key_values - +Variable in class org.kiji.schema.avro.TableBackup +
            Deprecated.  +
            keys_format - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            keySet(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns a set view of keys contained in the map for the specified table. +
            keySet(String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns a set view of keys contained in the map for the specified table. +
            keySet(String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns a set view of keys contained in the map for the specified table. +
            KeyValueBackupEntry - Class in org.kiji.schema.avro
             
            KeyValueBackupEntry() - +Constructor for class org.kiji.schema.avro.KeyValueBackupEntry +
            Default constructor. +
            KeyValueBackupEntry(Long, String, ByteBuffer) - +Constructor for class org.kiji.schema.avro.KeyValueBackupEntry +
            All-args constructor. +
            KeyValueBackupEntry.Builder - Class in org.kiji.schema.avro
            RecordBuilder for KeyValueBackupEntry instances.
            keyValuesFromBackup(String, List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Restores all table's key value history from a backup. +
            keyValuesFromBackup(String, List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Restores all table's key value history from a backup. +
            keyValuesFromBackup(String, List<KeyValueBackupEntry>) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Restores all table's key value history from a backup. +
            keyValuesToBackup(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the TableKeyValueBackupEntries. +
            keyValuesToBackup(String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Gets a list of the TableKeyValueBackupEntries. +
            keyValuesToBackup(String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Gets a list of the TableKeyValueBackupEntries. +
            Kiji - Class in org.kiji.schema
            Kiji instance class that contains configuration and table + information.
            Kiji(KijiConfiguration) - +Constructor for class org.kiji.schema.Kiji +
            Creates a new Kiji instance. +
            Kiji(KijiConfiguration, boolean, HTableInterfaceFactory, LockFactory) - +Constructor for class org.kiji.schema.Kiji +
            Creates a new Kiji instance. +
            KIJI_COMPONENT - +Static variable in class org.kiji.schema.KijiManagedHBaseTableName +
            The first component of all HBase table names managed by Kiji. +
            KIJI_SCHEME - +Static variable in class org.kiji.schema.KijiURI +
            URI/URL scheme used to fully qualify a Kiji table. +
            KIJI_SYSTEM_TABLES_REGEX - +Static variable in class org.kiji.schema.KijiManagedHBaseTableName +
            Regexp matching Kiji system tables. +
            KijiAdmin - Class in org.kiji.schema
            Administration API for managing a Kiji instance.
            KijiAdmin(HBaseAdmin, Kiji) - +Constructor for class org.kiji.schema.KijiAdmin +
            Creates a Kiji admin. +
            KijiCell<T> - Class in org.kiji.schema
            The data held in one cell of a kiji table.
            KijiCell(Schema, T) - +Constructor for class org.kiji.schema.KijiCell +
            Constructs a single cell of kiji data. +
            KijiCellDecoder<T> - Interface in org.kiji.schema
            Interface for Kiji cell decoders.
            KijiCellDecoderFactory - Interface in org.kiji.schema
            Interface for factories of KijiCellDecoder instances.
            KijiCellEncoder - Interface in org.kiji.schema
            Interface for Kiji cell encoders.
            KijiCellEncoderFactory - Interface in org.kiji.schema
            Interface for factories of KijiCellEncoder instances.
            KijiColumnFilter - Class in org.kiji.schema.filter
            A column filter provides a means of filtering cells from a column on the server side.
            KijiColumnFilter() - +Constructor for class org.kiji.schema.filter.KijiColumnFilter +
              +
            KijiColumnFilter.Context - Interface in org.kiji.schema.filter
            An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            KijiColumnName - Class in org.kiji.schema
            A Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiColumnName(String) - +Constructor for class org.kiji.schema.KijiColumnName +
            Constructs a column name from a string "family" or "family:qualifier". +
            KijiColumnName(String, String) - +Constructor for class org.kiji.schema.KijiColumnName +
            Constructs a column name from the two-part family:qualifier. +
            KijiColumnPager - Class in org.kiji.schema
            Fetches new pages of column data in Kiji, and maintains state for which page each column is on.
            KijiColumnPager(EntityId, KijiDataRequest, KijiTableLayout, HTableInterface) - +Constructor for class org.kiji.schema.KijiColumnPager +
            Creates a new KijiColumnPager. +
            KijiColumnPagingNotEnabledException - Exception in org.kiji.schema
            Thrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column.
            KijiColumnPagingNotEnabledException(String) - +Constructor for exception org.kiji.schema.KijiColumnPagingNotEnabledException +
            Creates a new KijiColumnPagingNotEnabledException with the specified + detail message. +
            KijiConfiguration - Class in org.kiji.schema
            The configuration for a single instance of Kiji, as a cluster could + contain multiple instances.
            KijiConfiguration(Configuration, String) - +Constructor for class org.kiji.schema.KijiConfiguration +
            Constructs a handle to a Kiji instance. +
            KijiConfiguration(Configuration, KijiURI) - +Constructor for class org.kiji.schema.KijiConfiguration +
            Initializes a Kiji configuration from a Hadoop configuration and a Kiji URI. +
            KijiConfiguration(KijiConfiguration) - +Constructor for class org.kiji.schema.KijiConfiguration +
            Constructs a deep copy of an existing Kiji configuration. +
            KijiConfKeys - Class in org.kiji.schema.mapreduce
            Deprecated. 
            KijiCounter - Interface in org.kiji.schema
            Deprecated. KijiCounter will be merged into KijiCell.
            KijiDataBuffer<T> - Class in org.kiji.schema.impl
            A buffer used to hold data entries waiting to be written to a KijiTable.
            KijiDataBuffer() - +Constructor for class org.kiji.schema.impl.KijiDataBuffer +
            Creates an instance. +
            KijiDataRequest - Class in org.kiji.schema
            Describes a request for columns of data to read from a Kiji table.
            KijiDataRequest() - +Constructor for class org.kiji.schema.KijiDataRequest +
            Constructor. +
            KijiDataRequest(KijiDataRequest) - +Constructor for class org.kiji.schema.KijiDataRequest +
            Creates a new KijiDataRequest from a copy. +
            KijiDataRequest.Column - Class in org.kiji.schema
            Describes a request for a Kiji Table column.
            KijiDataRequest.Column(KijiColumnName) - +Constructor for class org.kiji.schema.KijiDataRequest.Column +
            Creates a new requested Column. +
            KijiDataRequest.Column(String) - +Constructor for class org.kiji.schema.KijiDataRequest.Column +
            Creates a new request for the latest version of the cells in family. +
            KijiDataRequest.Column(String, String) - +Constructor for class org.kiji.schema.KijiDataRequest.Column +
            Creates a new request for the latest version of the cell in family:key. +
            KijiDataRequest.Column(String, byte[]) - +Constructor for class org.kiji.schema.KijiDataRequest.Column +
            Creates a new request for the latest version of the cell in family:key. +
            KijiDataRequestException - Exception in org.kiji.schema
            Thrown when there is an error validating a KijiDataRequest against a Kiji table.
            KijiDataRequestException(String) - +Constructor for exception org.kiji.schema.KijiDataRequestException +
            Creates a new KijiDataRequestException with the specified detail message. +
            KijiDataRequestValidator - Class in org.kiji.schema
            This class validates a KijiDataRequest against the layout + of a Kiji table to make sure it contains all of the columns requested.
            KijiDataRequestValidator(KijiDataRequest) - +Constructor for class org.kiji.schema.KijiDataRequestValidator +
            Construct a validator for a data request. +
            KijiDeleter - Interface in org.kiji.schema
            Interface for performing deletes on a Kiji table.
            KijiIncrementer - Interface in org.kiji.schema
            Interface for performing increments on a Kiji table.
            KijiInstaller - Class in org.kiji.schema
            Installs or uninstalls Kiji instances from an HBase cluster.
            KijiInvalidNameException - Exception in org.kiji.schema
            Thrown when a Kiji instance or table layout name is invalid.
            KijiInvalidNameException(String) - +Constructor for exception org.kiji.schema.KijiInvalidNameException +
            Creates a new KijiInvalidNameException with the specified detail message. +
            KijiManagedHBaseTableName - Class in org.kiji.schema
            Multiple instances of Kiji can be installed on a single HBase + cluster.
            KijiMetaTable - Class in org.kiji.schema
            The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiMetaTable() - +Constructor for class org.kiji.schema.KijiMetaTable +
            Creates a new KijiMetaTable instance. +
            KijiNameValidator - Class in org.kiji.schema.util
            A utility class for validating layout names, + (including table names, locality group names, family names, and column names) + and Kiji instance names.
            KijiNotInstalledException - Exception in org.kiji.schema
            Thrown when attempting to open a non existing/not installed Kiji instance.
            KijiNotInstalledException(String, String) - +Constructor for exception org.kiji.schema.KijiNotInstalledException +
            Creates a new KijiNotInstalledException with the specified + detail message. +
            KijiPutter - Interface in org.kiji.schema
            Interface for performing puts on a Kiji table.
            KijiRowData - Interface in org.kiji.schema
            The input data for a single entity in Kiji.
            KijiRowFilter - Class in org.kiji.schema.filter
            The abstract base class for filters that exclude data from KijiRows.
            KijiRowFilter() - +Constructor for class org.kiji.schema.filter.KijiRowFilter +
              +
            KijiRowFilter.Context - Class in org.kiji.schema.filter
            A helper class for converting between Kiji objects and their HBase counterparts.
            KijiRowFilter.Context() - +Constructor for class org.kiji.schema.filter.KijiRowFilter.Context +
              +
            KijiRowFilterApplicator - Class in org.kiji.schema.filter
            Applies a KijiRowFilter to various row-savvy objects.
            KijiRowFilterApplicator(KijiRowFilter, KijiTableLayout, KijiSchemaTable) - +Constructor for class org.kiji.schema.filter.KijiRowFilterApplicator +
            Creates a new KijiRowFilterApplicator instance. +
            KijiRowKeySplitter - Class in org.kiji.schema
            Utility class for splitting the Kiji row key space.
            KijiRowScanner - Interface in org.kiji.schema
            Interface for scanning over rows read from a Kiji table.
            KijiSchemaTable - Class in org.kiji.schema
            The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSchemaTable() - +Constructor for class org.kiji.schema.KijiSchemaTable +
              +
            KijiSchemaTable.SchemaEntry - Class in org.kiji.schema
            Association between a schema and its ID.
            KijiSchemaTable.SchemaEntry(long, BytesKey, Schema) - +Constructor for class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            Creates a new schema entry. +
            KijiSystemTable - Class in org.kiji.schema
            The Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiSystemTable() - +Constructor for class org.kiji.schema.KijiSystemTable +
              +
            KijiTable - Interface in org.kiji.schema
            Interface for Kiji Tables.
            KijiTableFactory - Interface in org.kiji.schema
            Factory for KijiTable instances.
            KijiTableInputFormat - Class in org.kiji.schema.mapreduce
            Deprecated. 
            KijiTableInputFormat() - +Constructor for class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.   +
            KijiTableInputFormat.KijiTableRecordReader - Class in org.kiji.schema.mapreduce
            Deprecated. Hadoop record reader for Kiji table rows.
            KijiTableInputFormat.KijiTableRecordReader(Configuration) - +Constructor for class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated. Creates a new RecordReader for this input format. +
            KijiTableKeyValueDatabase - Interface in org.kiji.schema
            A database of per table key-value pairs.
            KijiTableLayout - Class in org.kiji.schema.layout
            Layout of a Kiji table.
            KijiTableLayout(TableLayoutDesc, KijiTableLayout) - +Constructor for class org.kiji.schema.layout.KijiTableLayout +
            Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout. +
            KijiTableLayout.LocalityGroupLayout - Class in org.kiji.schema.layout
            Concrete layout of a locality group.
            KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc, KijiTableLayout.LocalityGroupLayout) - +Constructor for class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
            Constructs a locality group layout. +
            KijiTableLayout.LocalityGroupLayout.FamilyLayout - Class in org.kiji.schema.layout
            Concrete layout of a family.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc, KijiTableLayout.LocalityGroupLayout.FamilyLayout) - +Constructor for class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
            Builds a new family layout instance. +
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout - Class in org.kiji.schema.layout
            Concrete layout of a column.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc, KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout) - +Constructor for class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
            Builds a new column layout instance from a descriptor. +
            KijiTableLayoutDatabase - Interface in org.kiji.schema.layout
            A database of Kiji table layouts.
            KijiTableLayoutRecords - Interface in org.kiji.schema.avro
             
            KijiTableLayoutRecords.Callback - Interface in org.kiji.schema.avro
             
            KijiTableNotFoundException - Exception in org.kiji.schema
            Thrown when an attempt to access a table fails because it does not exist.
            KijiTableNotFoundException(String) - +Constructor for exception org.kiji.schema.KijiTableNotFoundException +
            Creates a new KijiTableNotFoundException for the specified table. +
            KijiTablePool - Class in org.kiji.schema
            Maintains a pool of opened KijiTables.
            KijiTablePool(Kiji) - +Constructor for class org.kiji.schema.KijiTablePool +
            Constructs a new pool of Kiji tables. +
            KijiTablePool(KijiTableFactory) - +Constructor for class org.kiji.schema.KijiTablePool +
            Constructs a new pool of Kiji tables. +
            KijiTablePool(KijiTableFactory, KijiTablePool.Options) - +Constructor for class org.kiji.schema.KijiTablePool +
            Constructs a new pool of Kiji tables. +
            KijiTablePool.NoCapacityException - Exception in org.kiji.schema
            Thrown when an attempt to get a table connection fails because there is no room in the pool.
            KijiTablePool.NoCapacityException(String) - +Constructor for exception org.kiji.schema.KijiTablePool.NoCapacityException +
            Creates a new NoCapacityException with the specified detail message. +
            KijiTablePool.Options - Class in org.kiji.schema
            Describes the options that can be configured on the KijiTablePool.
            KijiTablePool.Options() - +Constructor for class org.kiji.schema.KijiTablePool.Options +
            Creates options with default values. +
            KijiTableReader - Class in org.kiji.schema
            Interface for reading data from a kiji table.
            KijiTableReader(KijiTable) - +Constructor for class org.kiji.schema.KijiTableReader +
            Creates a reader over a kiji table. +
            KijiTableWriter - Interface in org.kiji.schema
            Interface for modifying a Kiji table.
            KijiTool - Interface in org.kiji.schema.tools
            Base interface to be implemented by command-line tools that are launched through + the bin/kiji script.
            KijiToolLauncher - Class in org.kiji.schema.tools
            Main entry point to launch Kiji tools.
            KijiToolLauncher() - +Constructor for class org.kiji.schema.tools.KijiToolLauncher +
              +
            KijiURI - Class in org.kiji.schema
            URI that fully qualifies a Kiji instance/table/column.
            KijiURI(URI) - +Constructor for class org.kiji.schema.KijiURI +
            Constructs a URI that fully qualifies a Kiji table. +
            KijiURI(Iterable<String>, int, String, String, Iterable<KijiColumnName>) - +Constructor for class org.kiji.schema.KijiURI +
            Constructs a new KijiURI with the given parameters. +
            KijiURIException - Exception in org.kiji.schema
            Thrown when parsing a bogus Kiji table URI.
            KijiURIException(String) - +Constructor for exception org.kiji.schema.KijiURIException +
            Creates a new KijiURIException. +
            KijiURIException(String, String) - +Constructor for exception org.kiji.schema.KijiURIException +
            Creates a new KijiURIException for the specified uri and detail message. +
            +
            +

            +L

            +
            +
            layout - +Variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Deprecated.  +
            layout_id - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            layout_version - +Variable in class org.kiji.schema.avro.MetadataBackup +
            Deprecated.  +
            layouts - +Variable in class org.kiji.schema.avro.TableBackup +
            Deprecated.  +
            layoutsFromBackup(String, List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
              +
            layoutsFromBackup(String, List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Restores a table layout history from a backup. +
            layoutsFromBackup(String, List<TableLayoutBackupEntry>) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Restores a table layout history from a backup. +
            layoutsToBackup(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +
            layoutsToBackup(String) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +
            layoutsToBackup(String) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +
            LayoutTool - Class in org.kiji.schema.tools
            Command-line tool for interacting with table layouts.
            LayoutTool() - +Constructor for class org.kiji.schema.tools.LayoutTool +
              +
            listTables() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Lists the tables in this Kiji instance. +
            listTables() - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Lists the tables in this Kiji instance. +
            listTables() - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Lists the tables in this Kiji instance. +
            load(String) - +Method in class org.kiji.schema.tools.synth.DictionaryLoader +
            Loads the dictionary from a file. +
            load(InputStream) - +Method in class org.kiji.schema.tools.synth.DictionaryLoader +
            Loads the dictionary from an input stream. +
            loadDefaults(String) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Load the system table with the key/value pairs from the properties file named by resource. +
            locality_groups - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            LocalityGroupDesc - Class in org.kiji.schema.avro
             
            LocalityGroupDesc() - +Constructor for class org.kiji.schema.avro.LocalityGroupDesc +
            Default constructor. +
            LocalityGroupDesc(Integer, String, List<String>, Boolean, String, Boolean, Integer, Integer, CompressionType, List<FamilyDesc>, Boolean, String) - +Constructor for class org.kiji.schema.avro.LocalityGroupDesc +
            All-args constructor. +
            LocalityGroupDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for LocalityGroupDesc instances.
            Lock - Interface in org.kiji.schema.util
            Lock interface.
            lock() - +Method in interface org.kiji.schema.util.Lock +
            Unconditionally acquires the lock. +
            lock(double) - +Method in interface org.kiji.schema.util.Lock +
            Acquires the lock. +
            lock() - +Method in class org.kiji.schema.util.ZooKeeperLock +
            Unconditionally acquires the lock. +
            lock(double) - +Method in class org.kiji.schema.util.ZooKeeperLock +
            Acquires the lock. +
            LockFactory - Interface in org.kiji.schema.util
            Factory for Lock instances.
            LOG - +Static variable in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
              +
            longToVarInt64(long) - +Static method in class org.kiji.schema.util.ByteStreamArray +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +
            longToZigZagVarInt64(long) - +Static method in class org.kiji.schema.util.ByteStreamArray +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +
            LsTool - Class in org.kiji.schema.tools
            Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            LsTool() - +Constructor for class org.kiji.schema.tools.LsTool +
              +
            +
            +

            +M

            +
            +
            main(String[]) - +Static method in class org.kiji.schema.tools.CreateTableTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.DeleteTableTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.FlushTableTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.IncrementTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.InstallTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.KijiToolLauncher +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.LayoutTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.LsTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.MetadataTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.PutTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.UninstallTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.VersionTool +
            Program entry point. +
            makeEmptyTableDescriptor(KijiManagedHBaseTableName) - +Static method in class org.kiji.schema.impl.HTableDescriptorComparator +
            Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout(). +
            map_schema - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            max_versions - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            mConf - +Variable in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated. Hadoop Configuration object containing settings. +
            MD5Hash - Class in org.kiji.schema.avro
             
            MD5Hash() - +Constructor for class org.kiji.schema.avro.MD5Hash +
            Creates a new MD5Hash +
            MD5Hash(byte[]) - +Constructor for class org.kiji.schema.avro.MD5Hash +
            Creates a new MD5Hash with the given bytes +
            mDataRequest - +Variable in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated. Data request. +
            merge(HBaseKijiRowData) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Merges in the data from another HBaseKijiRowData instance. +
            merge(Put) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Merges in the data an HBase Put object. +
            merge(Collection<KeyValue>) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Merges in the data from a collection of KeyValues. +
            merge(KijiDataRequest) - +Method in class org.kiji.schema.KijiDataRequest +
            Merges the requested columns in other into this data request. +
            meta_table - +Variable in class org.kiji.schema.avro.MetadataBackup +
            Deprecated.  +
            MetadataBackup - Class in org.kiji.schema.avro
             
            MetadataBackup() - +Constructor for class org.kiji.schema.avro.MetadataBackup +
            Default constructor. +
            MetadataBackup(String, List<SchemaTableEntry>, Map<String, TableBackup>) - +Constructor for class org.kiji.schema.avro.MetadataBackup +
            All-args constructor. +
            MetadataBackup.Builder - Class in org.kiji.schema.avro
            RecordBuilder for MetadataBackup instances.
            MetadataRestorer - Class in org.kiji.schema.impl
            Metadata restorer backups up meta info to MetadataBackup records and can restore metadata to the + meta and schema tables.
            MetadataRestorer() - +Constructor for class org.kiji.schema.impl.MetadataRestorer +
              +
            MetadataTool - Class in org.kiji.schema.tools
            A tool to backup and restore Metadata.
            MetadataTool() - +Constructor for class org.kiji.schema.tools.MetadataTool +
              +
            +
            +

            +N

            +
            +
            name - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.TableBackup +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            newBuilder() - +Static method in class org.kiji.schema.avro.CellSchema +
            Creates a new CellSchema RecordBuilder +
            newBuilder(CellSchema.Builder) - +Static method in class org.kiji.schema.avro.CellSchema +
            Creates a new CellSchema RecordBuilder by copying an existing Builder +
            newBuilder(CellSchema) - +Static method in class org.kiji.schema.avro.CellSchema +
            Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder +
            newBuilder(ColumnDesc.Builder) - +Static method in class org.kiji.schema.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder by copying an existing Builder +
            newBuilder(ColumnDesc) - +Static method in class org.kiji.schema.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder +
            newBuilder(FamilyDesc.Builder) - +Static method in class org.kiji.schema.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder by copying an existing Builder +
            newBuilder(FamilyDesc) - +Static method in class org.kiji.schema.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Creates a new KeyValueBackupEntry RecordBuilder +
            newBuilder(KeyValueBackupEntry.Builder) - +Static method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder +
            newBuilder(KeyValueBackupEntry) - +Static method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.LocalityGroupDesc +
            Creates a new LocalityGroupDesc RecordBuilder +
            newBuilder(LocalityGroupDesc.Builder) - +Static method in class org.kiji.schema.avro.LocalityGroupDesc +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder +
            newBuilder(LocalityGroupDesc) - +Static method in class org.kiji.schema.avro.LocalityGroupDesc +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.MetadataBackup +
            Creates a new MetadataBackup RecordBuilder +
            newBuilder(MetadataBackup.Builder) - +Static method in class org.kiji.schema.avro.MetadataBackup +
            Creates a new MetadataBackup RecordBuilder by copying an existing Builder +
            newBuilder(MetadataBackup) - +Static method in class org.kiji.schema.avro.MetadataBackup +
            Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.RowKeyFormat +
            Creates a new RowKeyFormat RecordBuilder +
            newBuilder(RowKeyFormat.Builder) - +Static method in class org.kiji.schema.avro.RowKeyFormat +
            Creates a new RowKeyFormat RecordBuilder by copying an existing Builder +
            newBuilder(RowKeyFormat) - +Static method in class org.kiji.schema.avro.RowKeyFormat +
            Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.SchemaTableEntry +
            Creates a new SchemaTableEntry RecordBuilder +
            newBuilder(SchemaTableEntry.Builder) - +Static method in class org.kiji.schema.avro.SchemaTableEntry +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder +
            newBuilder(SchemaTableEntry) - +Static method in class org.kiji.schema.avro.SchemaTableEntry +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.TableBackup +
            Creates a new TableBackup RecordBuilder +
            newBuilder(TableBackup.Builder) - +Static method in class org.kiji.schema.avro.TableBackup +
            Creates a new TableBackup RecordBuilder by copying an existing Builder +
            newBuilder(TableBackup) - +Static method in class org.kiji.schema.avro.TableBackup +
            Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Creates a new TableLayoutBackupEntry RecordBuilder +
            newBuilder(TableLayoutBackupEntry.Builder) - +Static method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder +
            newBuilder(TableLayoutBackupEntry) - +Static method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.TableLayoutDesc +
            Creates a new TableLayoutDesc RecordBuilder +
            newBuilder(TableLayoutDesc.Builder) - +Static method in class org.kiji.schema.avro.TableLayoutDesc +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder +
            newBuilder(TableLayoutDesc) - +Static method in class org.kiji.schema.avro.TableLayoutDesc +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance +
            newCounter() - +Static method in class org.kiji.schema.layout.impl.CellSpec +
              +
            newLock(KijiConfiguration, LockFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates a lock for a given Kiji instance. +
            newMetaTable(KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseMetaTable +
            Creates an HTableInterface for the specified table. +
            newSchemaHashTable(KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates an HTable handle to the schema hash table. +
            newSchemaIdTable(KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates an HTable handle to the schema ID table. +
            newSchemaV5Table(KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates an HTable handle to the schema V5 table. +
            newSystemTable(KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSystemTable +
            Creates a new HTableInterface for the Kiji system table. +
            newZooKeeper(Configuration) - +Static method in class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a ZooKeeper client. +
            nextKeyValue() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            nextPage(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Populates the next page of cells for a column. +
            nextPage(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Populates the next page of cells for a requested column family. +
            nextPage(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Populates the next page of cells for a column. +
            nextPage(String) - +Method in interface org.kiji.schema.KijiRowData +
            Populates the next page of cells for a requested column family. +
            NGramSynthesizer - Class in org.kiji.schema.tools.synth
            Generates n-grams.
            NGramSynthesizer(WordSynthesizer, int) - +Constructor for class org.kiji.schema.tools.synth.NGramSynthesizer +
            Constructs a new n-gram synthesizer. +
            NoCellDataException - Exception in org.kiji.schema
            Thrown when attempting to read data from a cell that doesn't exist.
            NoCellDataException(String) - +Constructor for exception org.kiji.schema.NoCellDataException +
            Creates a new NoCellDataException with the specified detail message. +
            NoSuchColumnException - Exception in org.kiji.schema
            Thrown when attempting to access a column that does not exist.
            NoSuchColumnException(String) - +Constructor for exception org.kiji.schema.NoSuchColumnException +
            Creates a new NoSuchColumnException with the specified detail message. +
            NotAKijiManagedTableException - Exception in org.kiji.schema
            Thrown when Kiji encounters an HBase table that is not managed by Kiji.
            NotAKijiManagedTableException(String, String) - +Constructor for exception org.kiji.schema.NotAKijiManagedTableException +
            Creates a new NotAKijiManagedTableException for the specified + table with the specified detail message. +
            NumberParser - Class in org.kiji.schema.util
            Utility for parsing strings to numbers.
            +
            +

            +O

            +
            +
            open(Kiji, String) - +Static method in class org.kiji.schema.impl.AbstractKijiTable +
            Opens a kiji table with the default implementation. +
            open(KijiConfiguration) - +Static method in class org.kiji.schema.Kiji +
            Opens a Kiji instance. +
            open(KijiURI, Configuration) - +Static method in class org.kiji.schema.Kiji +
            Opens a Kiji instance by URI. +
            open(KijiURI) - +Static method in class org.kiji.schema.Kiji +
            Opens a Kiji instance by URI. +
            openKiji() - +Method in class org.kiji.schema.tools.VersionValidatedTool +
            Opens a kiji instance. +
            openSystemResource(String) - +Static method in class org.kiji.schema.util.Resources +
            Gets the named resource using the classloader, or null if it can not be found. +
            openSystemTextResource(String) - +Static method in class org.kiji.schema.util.Resources +
            Gets the named resource using the classloader, or null if it can not be found. +
            openTable(String) - +Method in class org.kiji.schema.impl.DefaultKijiTableFactory +
            Opens a KijiTable by name. +
            openTable(String) - +Method in class org.kiji.schema.Kiji +
            Opens a KijiTable by name. +
            openTable(String) - +Method in interface org.kiji.schema.KijiTableFactory +
            Opens a KijiTable by name. +
            openTableReader() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            Opens an appropriate implementation of KijiTableReader for this table. +
            openTableReader() - +Method in interface org.kiji.schema.KijiTable +
            Opens an appropriate implementation of KijiTableReader for this table. +
            openTableWriter() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            Opens an appropriate implementation of KijiTableWriter for this table. +
            openTableWriter() - +Method in interface org.kiji.schema.KijiTable +
            Opens an appropriate implementation of KijiTableWriter for this table. +
            OperatorRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter for a logical operator of composed of other filters.
            OperatorRowFilter.Operator - Enum in org.kiji.schema.filter
            Available logical operators.
            org.apache.hadoop.hbase.mapreduce - package org.apache.hadoop.hbase.mapreduce
             
            org.kiji.schema - package org.kiji.schema
            The main package for users of KijiSchema.
            org.kiji.schema.avro - package org.kiji.schema.avro
             
            org.kiji.schema.filter - package org.kiji.schema.filter
            Row level filters used when reading data from Kiji tables.
            org.kiji.schema.impl - package org.kiji.schema.impl
            Implementations for the main KijiSchema classes and interfaces.
            org.kiji.schema.layout - package org.kiji.schema.layout
            Kiji table layouts.
            org.kiji.schema.layout.impl - package org.kiji.schema.layout.impl
            Implementation for Kiji table layout management.
            org.kiji.schema.mapreduce - package org.kiji.schema.mapreduce
            Kiji map-reduce utilities.
            org.kiji.schema.tools - package org.kiji.schema.tools
            Package containing implementations, abstract base classes, + and exceptions for kiji command-line tools.
            org.kiji.schema.tools.synth - package org.kiji.schema.tools.synth
            Classes to assist when synthesizing sample data for use in kiji tables.
            org.kiji.schema.util - package org.kiji.schema.util
            Package containing utility classes used throughout Kiji.
            OrRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter for a disjunction (OR operator) of other filters.
            OrRowFilter(List<? extends KijiRowFilter>) - +Constructor for class org.kiji.schema.filter.OrRowFilter +
            Creates a new OrRowFilter instance. +
            OUTPUT_KIJI_TABLE_URI - +Static variable in class org.kiji.schema.mapreduce.KijiConfKeys +
            Deprecated. URI of the output Kiji table to write to. +
            +
            +

            +P

            +
            +
            parse(String) - +Static method in class org.kiji.schema.KijiURI +
            Constructs a fully qualified Kiji table URI from a string. +
            parseHex(String, char) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Parses a string hexadecimal representation of a byte array with separator. +
            parseHex(String) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Parses a string hexadecimal representation of a byte array. +
            parseInstanceName(String) - +Static method in class org.kiji.schema.tools.LsTool +
            Parses a table name for a kiji instance name. +
            parseInt(String) - +Static method in class org.kiji.schema.util.NumberParser +
            This parseInt allows Integer.MAX_VALUE to be written as a convenient string. +
            parseLong(String) - +Static method in class org.kiji.schema.util.NumberParser +
            This parseLong allows Long.MAX_VALUE to be written as a convenient string. +
            parseRowKeyFlag(String) - +Static method in class org.kiji.schema.tools.ToolUtils +
            Parses a flag describing a row key. +
            printInt(int) - +Static method in class org.kiji.schema.util.NumberParser +
            Converts an integer to a string that uses "infinity" as Integer.MAX_VALUE. +
            PROTOCOL - +Static variable in interface org.kiji.schema.avro.KijiTableLayoutRecords.Callback +
              +
            PROTOCOL - +Static variable in interface org.kiji.schema.avro.KijiTableLayoutRecords +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.CellSchema +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.ColumnDesc +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.FamilyDesc +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.MetadataBackup +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.RowKeyFormat +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.TableBackup +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
              +
            put(EntityId, String, String, T) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Puts data into a kiji table. +
            put(EntityId, String, String, long, T) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Puts data into a kiji table. +
            put(EntityId, String, String, T) - +Method in interface org.kiji.schema.KijiPutter +
            Puts data into a kiji table. +
            put(EntityId, String, String, long, T) - +Method in interface org.kiji.schema.KijiPutter +
            Puts data into a kiji table. +
            PutTool - Class in org.kiji.schema.tools
            Command-line tool for putting an Avro value into a kiji cell.
            PutTool() - +Constructor for class org.kiji.schema.tools.PutTool +
              +
            putValue(String, String, byte[]) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +
            putValue(String, byte[]) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Sets a value for a property key, which creates it if it doesn't exist. +
            putValue(String, String, byte[]) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +
            putValue(String, byte[]) - +Method in class org.kiji.schema.KijiSystemTable +
            Sets a value for a property key, which creates it if it doesn't exist. +
            putValue(String, String, byte[]) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +
            +
            +

            +Q

            +
            +
            QUALIFIER_LAYOUT - +Static variable in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            HBase column qualifier used to store absolute layouts. +
            QUALIFIER_LAYOUT_ID - +Static variable in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            HBase column qualifier used to store layout IDs. +
            QUALIFIER_UPDATE - +Static variable in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            HBase column qualifier used to store layout updates. +
            +
            +

            +R

            +
            +
            RADIX - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The size of the alphabet for a digit, which is the radix of our printed number. +
            RawEntityId - Class in org.kiji.schema.impl
            Implements the raw row key format.
            RawEntityId(byte[]) - +Constructor for class org.kiji.schema.impl.RawEntityId +
            Creates a raw entity ID. +
            RE_AUTHORITY_GROUP - +Static variable in class org.kiji.schema.KijiURI +
            Pattern matching "(host1,host2,host3):port". +
            readAvroSchema(CellSchema) - +Static method in class org.kiji.schema.layout.impl.CellSpec +
            Reads the Avro schema from the table layout. +
            readAvroSchema(CellSchema) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Reads the Avro schema from the table layout. +
            readBytes(int) - +Method in class org.kiji.schema.util.ByteStreamArray +
            Reads the specified number of bytes in the stream. +
            readInputTableLayout(Configuration) - +Static method in class org.kiji.schema.layout.TableLayoutSerializer +
            Reads an input table layout from the configuration. +
            readOutputTableLayout(Configuration) - +Static method in class org.kiji.schema.layout.TableLayoutSerializer +
            Reads an output table layout from the configuration. +
            readTableLayout(String, Configuration) - +Static method in class org.kiji.schema.layout.TableLayoutSerializer +
            Reads a table layout from the configuration. +
            readTableLayoutDescFromJSON(InputStream) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Reads a table layout descriptor from its JSON serialized form. +
            readVarInt64() - +Method in class org.kiji.schema.util.ByteStreamArray +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +
            readZigZagVarInt64() - +Method in class org.kiji.schema.util.ByteStreamArray +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +
            reference_layout - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            RegexQualifierColumnFilter - Class in org.kiji.schema.filter
            A KijiColumnFilter that only allows qualifiers that match a given regular expression.
            RegexQualifierColumnFilter(String) - +Constructor for class org.kiji.schema.filter.RegexQualifierColumnFilter +
            Constructor. +
            release(KijiTable) - +Method in class org.kiji.schema.KijiTablePool +
            Releases a table back to the pool. +
            removeAllTableLayoutVersions(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes all layout information for a particular table. +
            removeAllTableLayoutVersions(String) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Removes all layout information for a particular table. +
            removeAllTableLayoutVersions(String) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Removes all layout information for a particular table. +
            removeAllValues(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Deletes all key-value pairs associated with the specified table. +
            removeAllValues(String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Deletes all key-value pairs associated with the specified table. +
            removeAllValues(String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Deletes all key-value pairs associated with the specified table. +
            removeRecentTableLayoutVersions(String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes the most recent layout information for a given table. +
            removeRecentTableLayoutVersions(String, int) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Removes the most recent layout information for a given table. +
            removeRecentTableLayoutVersions(String, int) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Removes the most recent layout information for a given table. +
            removeValues(String, String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes all values associated with the specified table and key. +
            removeValues(String, String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Removes all values associated with the specified table and key. +
            removeValues(String, String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Removes all values associated with the specified table and key. +
            renamed_from - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            renamed_from - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            renamed_from - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            RequiredFlagException - Exception in org.kiji.schema.tools
            Thrown to indicate that a flag is required but not supplied.
            RequiredFlagException(String) - +Constructor for exception org.kiji.schema.tools.RequiredFlagException +
            Creates a new RequiredFlagException for the specified flag name. +
            resolve(String) - +Method in class org.kiji.schema.KijiURI +
            Resolve the path relative to this KijiURI. +
            Resources - Class in org.kiji.schema.util
            Utility for getting access to system resources.
            restoreSchemas(MetadataBackup, Kiji) - +Method in class org.kiji.schema.impl.MetadataRestorer +
            Restores all SchemaTable entries from the metadata backup. +
            restoreTables(MetadataBackup, Kiji) - +Method in class org.kiji.schema.impl.MetadataRestorer +
            Restores all tables from the metadata backup into the running Kiji instance. +
            RowKeyEncoding - Enum in org.kiji.schema.avro
             
            RowKeyFormat - Class in org.kiji.schema.avro
             
            RowKeyFormat() - +Constructor for class org.kiji.schema.avro.RowKeyFormat +
            Default constructor. +
            RowKeyFormat(RowKeyEncoding, HashType, Integer) - +Constructor for class org.kiji.schema.avro.RowKeyFormat +
            All-args constructor. +
            RowKeyFormat.Builder - Class in org.kiji.schema.avro
            RecordBuilder for RowKeyFormat instances.
            run(List<String>) - +Method in class org.kiji.schema.tools.BaseTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.CreateTableTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.DeleteTableTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.FlushTableTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.IncrementTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.InstallTool +
            Runs the tool. +
            run(String[]) - +Method in class org.kiji.schema.tools.KijiToolLauncher +
            Programmatic entry point to the tool launcher. +
            run(KijiTool, String[]) - +Method in class org.kiji.schema.tools.KijiToolLauncher +
            Programmatic entry point to the tool launcher if a tool is already selected. +
            run(List<String>) - +Method in class org.kiji.schema.tools.LayoutTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.LsTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.MetadataTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.PutTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.UninstallTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.VersionTool +
            Runs the tool. +
            +
            +

            +S

            +
            +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.CellSchema +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.ColumnDesc +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.CompressionType +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.FamilyDesc +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.HashType +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.MD5Hash +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.MetadataBackup +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.RowKeyEncoding +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.RowKeyFormat +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.SchemaStorage +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.SchemaTableEntry +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.SchemaType +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.TableBackup +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.TableLayoutDesc +
              +
            SCHEMA_COLUMN_FAMILY - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            The column family in HBase used to store schema entries. +
            SCHEMA_COLUMN_QUALIFIER - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            The column qualifier in HBase used to store schema entries. +
            SCHEMA_COUNTER_ROW_NAME - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            Schema IDs are generated using a counter. +
            schema_table - +Variable in class org.kiji.schema.avro.MetadataBackup +
            Deprecated.  +
            SchemaClassNotFoundException - Exception in org.kiji.schema.layout
            Thrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path).
            SchemaClassNotFoundException(String) - +Constructor for exception org.kiji.schema.layout.SchemaClassNotFoundException +
            Creates a new SchemaClassNotFoundException with the specified detail message.. +
            SchemaStorage - Enum in org.kiji.schema.avro
             
            SchemaTableEntry - Class in org.kiji.schema.avro
             
            SchemaTableEntry() - +Constructor for class org.kiji.schema.avro.SchemaTableEntry +
            Default constructor. +
            SchemaTableEntry(Long, MD5Hash, String) - +Constructor for class org.kiji.schema.avro.SchemaTableEntry +
            All-args constructor. +
            SchemaTableEntry.Builder - Class in org.kiji.schema.avro
            RecordBuilder for SchemaTableEntry instances.
            SchemaType - Enum in org.kiji.schema.avro
             
            SEPARATOR - +Static variable in class org.kiji.schema.layout.ColumnNameTranslator +
            Used to separate the Kiji family from the Kiji qualifier in an HBase qualifier. +
            serializeInputTableLayout(KijiTableLayout, Configuration) - +Static method in class org.kiji.schema.layout.TableLayoutSerializer +
            Serializes the table layout into a configuration object for input. +
            serializeOutputTableLayout(KijiTableLayout, Configuration) - +Static method in class org.kiji.schema.layout.TableLayoutSerializer +
            Serializes the table layout into a configuration object for output. +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'aliases' field +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'aliases' field. +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'aliases' field +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'aliases' field. +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'aliases' field +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'aliases' field. +
            setAvroSchema(String) - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Sets the value of the 'avro_schema' field +
            setAvroSchema(String) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Sets the value of the 'avro_schema' field. +
            setCacheBlocks(Boolean) - +Method in class org.kiji.schema.HBaseScanOptions +
            Sets whether rows requested are cached server-side for future use. +
            setCellSchema(CellSchema) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the cell schema. +
            setClientBufferSize(Integer) - +Method in class org.kiji.schema.HBaseScanOptions +
            Sets the number of rows that will be returned with each RPC when iterating + through a KijiRowScanner. +
            setColumnNames(Collection<String>) - +Method in class org.kiji.schema.KijiURI +
            Creates a KijiURI with these column names added. +
            setColumns(List<ColumnDesc>) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'columns' field +
            setColumns(List<ColumnDesc>) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'columns' field. +
            setColumnSchema(CellSchema) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'column_schema' field +
            setColumnSchema(CellSchema) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'column_schema' field. +
            setCompressionType(CompressionType) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'compression_type' field +
            setCompressionType(CompressionType) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'compression_type' field. +
            setConf(Configuration) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            setDataVersion(String) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Sets the version of kiji installed. +
            setDataVersion(String) - +Method in class org.kiji.schema.KijiSystemTable +
            Sets the version of kiji installed. +
            setDelete(boolean) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'delete' field +
            setDelete(Boolean) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'delete' field. +
            setDelete(boolean) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'delete' field +
            setDelete(Boolean) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'delete' field. +
            setDelete(boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'delete' field +
            setDelete(Boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'delete' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'description' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'description' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'description' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'description' field. +
            setEnabled(boolean) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'enabled' field +
            setEnabled(Boolean) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'enabled' field. +
            setEnabled(boolean) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'enabled' field +
            setEnabled(Boolean) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'enabled' field. +
            setEnabled(boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'enabled' field +
            setEnabled(Boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'enabled' field. +
            setEncoding(RowKeyEncoding) - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Sets the value of the 'encoding' field +
            setEncoding(RowKeyEncoding) - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Sets the value of the 'encoding' field. +
            setFamilies(List<FamilyDesc>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'families' field +
            setFamilies(List<FamilyDesc>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'families' field. +
            setHash(MD5Hash) - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Sets the value of the 'hash' field +
            setHash(MD5Hash) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Sets the value of the 'hash' field. +
            setHashSize(int) - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Sets the value of the 'hash_size' field +
            setHashSize(Integer) - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Sets the value of the 'hash_size' field. +
            setHashType(HashType) - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Sets the value of the 'hash_type' field +
            setHashType(HashType) - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Sets the value of the 'hash_type' field. +
            setId(int) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'id' field +
            setId(Integer) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'id' field. +
            setId(int) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'id' field +
            setId(Integer) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'id' field. +
            setId(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'id' field +
            setId(Integer) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'id' field. +
            setId(long) - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Sets the value of the 'id' field +
            setId(Long) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Sets the value of the 'id' field. +
            setInMemory(boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'in_memory' field +
            setInMemory(Boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'in_memory' field. +
            setInstanceName(String) - +Method in class org.kiji.schema.KijiURI +
            Creates a new KijiURI with this instance name added. +
            setKey(String) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Sets the value of the 'key' field +
            setKey(String) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Sets the value of the 'key' field. +
            setKeysFormat(RowKeyFormat) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'keys_format' field +
            setKeysFormat(RowKeyFormat) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'keys_format' field. +
            setKeyValues(List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Sets the value of the 'key_values' field +
            setKeyValues(List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup +
            Sets the value of the 'key_values' field. +
            setKijiCellDecoderFactory(KijiCellDecoderFactory) - +Method in class org.kiji.schema.KijiTableReader +
            Sets the KijiCellDecoderFactory to be used for retrieving a KijiCell. +
            setLayout(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Sets the value of the 'layout' field +
            setLayout(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Sets the value of the 'layout' field. +
            setLayoutId(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'layout_id' field +
            setLayoutId(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'layout_id' field. +
            setLayouts(List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Sets the value of the 'layouts' field +
            setLayouts(List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup +
            Sets the value of the 'layouts' field. +
            setLayoutVersion(String) - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Sets the value of the 'layout_version' field +
            setLayoutVersion(String) - +Method in class org.kiji.schema.avro.MetadataBackup +
            Sets the value of the 'layout_version' field. +
            setLocalityGroups(List<LocalityGroupDesc>) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'locality_groups' field +
            setLocalityGroups(List<LocalityGroupDesc>) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'locality_groups' field. +
            setMapSchema(CellSchema) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'map_schema' field +
            setMapSchema(CellSchema) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'map_schema' field. +
            setMaxVersions(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'max_versions' field +
            setMaxVersions(Integer) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'max_versions' field. +
            setMetaTable(Map<String, TableBackup>) - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Sets the value of the 'meta_table' field +
            setMetaTable(Map<String, TableBackup>) - +Method in class org.kiji.schema.avro.MetadataBackup +
            Sets the value of the 'meta_table' field. +
            setName(String) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.TableBackup +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'name' field. +
            setPrintStream(PrintStream) - +Method in class org.kiji.schema.tools.BaseTool +
            Set the output print stream the tool should write to. +
            setReaderSchema(Schema) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the Avro reader schema. +
            setReferenceLayout(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'reference_layout' field +
            setReferenceLayout(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'reference_layout' field. +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'renamed_from' field +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'renamed_from' field. +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'renamed_from' field +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'renamed_from' field. +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'renamed_from' field +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'renamed_from' field. +
            setScan(Scan) - +Method in class org.kiji.schema.impl.HBaseTableRecordReader +
              +
            setSchemaStorage(SchemaStorage) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the schema storage. +
            setSchemaTable(List<SchemaTableEntry>) - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Sets the value of the 'schema_table' field +
            setSchemaTable(List<SchemaTableEntry>) - +Method in class org.kiji.schema.avro.MetadataBackup +
            Sets the value of the 'schema_table' field. +
            setSchemaTable(KijiSchemaTable) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the schema table. +
            setServerPrefetchSize(Integer) - +Method in class org.kiji.schema.HBaseScanOptions +
            Sets the number of rows for servers to prefetch. +
            setStorage(SchemaStorage) - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Sets the value of the 'storage' field +
            setStorage(SchemaStorage) - +Method in class org.kiji.schema.avro.CellSchema +
            Sets the value of the 'storage' field. +
            setTableLayout(String, TableLayoutDesc) - +Method in class org.kiji.schema.KijiAdmin +
            Sets the layout of a table. +
            setTableLayout(String, TableLayoutDesc, boolean, PrintStream) - +Method in class org.kiji.schema.KijiAdmin +
            Sets the layout of a table, or print the results of setting the table layout if + dryRun is true. +
            setTableName(String) - +Method in class org.kiji.schema.KijiURI +
            Creates a KijiURI with this table name added. +
            setTimestamp(long) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Sets the value of the 'timestamp' field +
            setTimestamp(Long) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Sets the value of the 'timestamp' field. +
            setTimestamp(long) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Sets the value of the 'timestamp' field +
            setTimestamp(Long) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Sets the value of the 'timestamp' field. +
            setTtlSeconds(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'ttl_seconds' field +
            setTtlSeconds(Integer) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'ttl_seconds' field. +
            setType(SchemaType) - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Sets the value of the 'type' field +
            setType(SchemaType) - +Method in class org.kiji.schema.avro.CellSchema +
            Sets the value of the 'type' field. +
            setType(SchemaType) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the cell type. +
            setup() - +Method in class org.kiji.schema.tools.BaseTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.CreateTableTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.DeleteTableTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.FlushTableTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.LayoutTool +
            Called to initialize the tool just before running. +
            setUpdate(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Sets the value of the 'update' field +
            setUpdate(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Sets the value of the 'update' field. +
            setURI(KijiURI) - +Method in class org.kiji.schema.tools.BaseTool +
            Sets the kiji URI of the target this tool operates on. +
            setValue(String) - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Sets the value of the 'value' field +
            setValue(String) - +Method in class org.kiji.schema.avro.CellSchema +
            Sets the value of the 'value' field. +
            setValue(ByteBuffer) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Sets the value of the 'value' field +
            setValue(ByteBuffer) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Sets the value of the 'value' field. +
            setVersion(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'version' field +
            setVersion(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'version' field. +
            setZookeeperQuorum(String[]) - +Method in class org.kiji.schema.KijiURI +
            Creates a new KijiURI with this zookeeper quorum. +
            size() - +Method in class org.kiji.schema.impl.KijiDataBuffer +
              +
            sizeOfLongAsVarInt64(long) - +Static method in class org.kiji.schema.util.ByteStreamArray +
            Reports the size of the zig-zag encoding of the specified long integer. +
            skip(int) - +Method in class org.kiji.schema.util.ByteStreamArray +
            Skips some bytes. +
            SpecificCellDecoder<T> - Class in org.kiji.schema.impl
            Decodes cells encoded using Avro into specific types.
            SpecificCellDecoder(CellSpec) - +Constructor for class org.kiji.schema.impl.SpecificCellDecoder +
            Initializes a cell decoder that creates specific Avro types. +
            SpecificCellDecoderFactory - Class in org.kiji.schema
            Factory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas.
            SplitKeyFile - Class in org.kiji.schema.util
            Parses region boundaries split files.
            storage - +Variable in class org.kiji.schema.avro.CellSchema +
            Deprecated.  +
            StripValueRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest.
            StripValueRowFilter() - +Constructor for class org.kiji.schema.filter.StripValueRowFilter +
              +
            synthesize() - +Method in class org.kiji.schema.tools.synth.EmailSynthesizer +
              +
            synthesize() - +Method in class org.kiji.schema.tools.synth.NGramSynthesizer +
              +
            synthesize() - +Method in interface org.kiji.schema.tools.synth.Synthesizer +
            Synthesizes a piece of data. +
            synthesize() - +Method in class org.kiji.schema.tools.synth.WordSynthesizer +
              +
            synthesizeDomain() - +Method in class org.kiji.schema.tools.synth.EmailSynthesizer +
            Synthesize a random domain using the market share probabilities. +
            Synthesizer<T> - Interface in org.kiji.schema.tools.synth
            Synthesizers create objects from nothing.
            SynthesizeUserDataTool - Class in org.kiji.schema.tools
            Synthesize some user data into a kiji table.
            SynthesizeUserDataTool() - +Constructor for class org.kiji.schema.tools.SynthesizeUserDataTool +
              +
            +
            +

            +T

            +
            +
            TableBackup - Class in org.kiji.schema.avro
             
            TableBackup() - +Constructor for class org.kiji.schema.avro.TableBackup +
            Default constructor. +
            TableBackup(String, List<TableLayoutBackupEntry>, List<KeyValueBackupEntry>) - +Constructor for class org.kiji.schema.avro.TableBackup +
            All-args constructor. +
            TableBackup.Builder - Class in org.kiji.schema.avro
            RecordBuilder for TableBackup instances.
            TableKeyNotFoundException - Exception in org.kiji.schema
            Thrown when a key is not found in a map-like API implemented by one of the + Kiji tables, the system or meta table for example.
            TableKeyNotFoundException(String) - +Constructor for exception org.kiji.schema.TableKeyNotFoundException +
            Constructor. +
            TableLayoutBackupEntry - Class in org.kiji.schema.avro
             
            TableLayoutBackupEntry() - +Constructor for class org.kiji.schema.avro.TableLayoutBackupEntry +
            Default constructor. +
            TableLayoutBackupEntry(Long, TableLayoutDesc, TableLayoutDesc) - +Constructor for class org.kiji.schema.avro.TableLayoutBackupEntry +
            All-args constructor. +
            TableLayoutBackupEntry.Builder - Class in org.kiji.schema.avro
            RecordBuilder for TableLayoutBackupEntry instances.
            TableLayoutDesc - Class in org.kiji.schema.avro
             
            TableLayoutDesc() - +Constructor for class org.kiji.schema.avro.TableLayoutDesc +
            Default constructor. +
            TableLayoutDesc(String, String, RowKeyFormat, List<LocalityGroupDesc>, String, String, String) - +Constructor for class org.kiji.schema.avro.TableLayoutDesc +
            All-args constructor. +
            TableLayoutDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for TableLayoutDesc instances.
            TableLayoutSerializer - Class in org.kiji.schema.layout
            Serialize TableLayout instances into job configurations.
            tableSet() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns a set view of the tables that have key-value pairs defined. +
            tableSet() - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns a set view of the tables that have key-value pairs defined. +
            tableSet() - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns a set view of the tables that have key-value pairs defined. +
            timestamp - +Variable in class org.kiji.schema.avro.KeyValueBackupEntry +
            Deprecated.  +
            timestamp - +Variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Deprecated.  +
            TimestampComparator - Class in org.kiji.schema.util
            A comparator that sorts Longs in reverse chronological order.
            toAvroEntry(KijiSchemaTable.SchemaEntry) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Converts a SchemaEntry into an Avro SchemaTableEntry. +
            toAvroJsonString(Object, Schema) - +Static method in class org.kiji.schema.util.ToJson +
            Standard Avro/JSON encoder. +
            toAvroJsonString(IndexedRecord) - +Static method in class org.kiji.schema.util.ToJson +
            Standard Avro/JSON encoder. +
            toBackup() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. +
            toBackup() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. +
            toBackup() - +Method in class org.kiji.schema.KijiMetaTable +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. +
            toBackup() - +Method in class org.kiji.schema.KijiSchemaTable +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. +
            toByteArray() - +Method in class org.kiji.schema.layout.impl.ColumnId +
            Translates ColumnIds to HBase column names. +
            toBytes() - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets the name of the HBase table that stores the data for this Kiji table. +
            toGet(EntityId, KijiTableLayout) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row. +
            toGet(EntityId, KijiTableLayout, int) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row. +
            toHBaseColumnName(KijiColumnName) - +Method in class org.kiji.schema.layout.ColumnNameTranslator +
            Translates a Kiji column name into an HBase column name. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.ColumnValueEqualsRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.HasColumnDataRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiColumnName, KijiColumnFilter.Context) - +Method in class org.kiji.schema.filter.KijiColumnFilter +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +
            toHBaseFilter(KijiColumnName, ColumnNameTranslator) - +Method in class org.kiji.schema.filter.KijiColumnFilter +
            Expresses a KijiColumnFilter in terms of an equivalent HBase filter, translating the + KijiColumnNames to the corresponding HBaseColumnName. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.KijiRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.OperatorRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiColumnName, KijiColumnFilter.Context) - +Method in class org.kiji.schema.filter.RegexQualifierColumnFilter +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.StripValueRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHex(byte[]) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Formats a byte array as a sequence of hex-digits with no separator. +
            toHex(byte[], char) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Formats a byte array as a sequence of 2 hex-digits bytes with the specified separator. +
            toHTableDescriptor(String, KijiTableLayout) - +Method in class org.kiji.schema.layout.impl.HTableSchemaTranslator +
            Translates a Kiji table layout into an HColumnDescriptor. +
            ToJson - Class in org.kiji.schema.util
            Encode an Avro record into JSON.
            toJsonNode(Object, Schema) - +Static method in class org.kiji.schema.util.ToJson +
            Serializes a Java Avro value into JSON. +
            toJsonString(Object, Schema) - +Static method in class org.kiji.schema.util.ToJson +
            Encodes an Avro value into a JSON string. +
            toJsonString(IndexedRecord) - +Static method in class org.kiji.schema.util.ToJson +
            Encodes an Avro record into JSON. +
            toKijiColumnName(HBaseColumnName) - +Method in class org.kiji.schema.layout.ColumnNameTranslator +
            Translates an HBase column name to a Kiji column name. +
            toolMain(List<String>) - +Method in class org.kiji.schema.tools.BaseTool +
            Invoke the functionality of this tool, as supplied through its + implementation of the abstract methods of this class. +
            toolMain(List<String>) - +Method in class org.kiji.schema.tools.HelpTool +
            The main logic of your tool. +
            toolMain(List<String>) - +Method in interface org.kiji.schema.tools.KijiTool +
            The main logic of your tool. +
            ToolUtils - Class in org.kiji.schema.tools
            Utility class providing static methods used by command-line tools.
            toOrderedString() - +Method in class org.kiji.schema.KijiURI +
            Returns a string representation of this URI that preserves ordering of lists in fields, + such as the Zookeeper quorum and Kiji columns. +
            toScan(KijiTableLayout) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +
            toScan(KijiTableLayout, HBaseScanOptions) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +
            toString() - +Method in class org.kiji.schema.HBaseColumnName +
            +
            toString() - +Method in class org.kiji.schema.KijiColumnName +
            +
            toString() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            +
            toString() - +Method in class org.kiji.schema.KijiDataRequest +
            +
            toString() - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
              +
            toString() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            +
            toString() - +Method in class org.kiji.schema.KijiURI +
            +
            toString() - +Method in class org.kiji.schema.layout.impl.ColumnId +
            Gets the id as a string of digits from our alphabet. +
            toString() - +Method in class org.kiji.schema.layout.KijiTableLayout +
            +
            toString() - +Method in class org.kiji.schema.util.BytesKey +
              +
            toURL(byte[]) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Formats a byte array as a URL. +
            ttl_seconds - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            type - +Variable in class org.kiji.schema.avro.CellSchema +
            Deprecated.  +
            +
            +

            +U

            +
            +
            UNASSIGNED - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The special value reserved to mean that a symbolic name has not been assigned a column id. +
            uninstall(HBaseAdmin, KijiConfiguration) - +Static method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes the meta table from HBase. +
            uninstall(HBaseAdmin, KijiConfiguration) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Disables and removes the schema table from HBase. +
            uninstall(HBaseAdmin, KijiConfiguration) - +Static method in class org.kiji.schema.impl.HBaseSystemTable +
            Disables and delete the system table from HBase. +
            uninstall(KijiURI, Configuration) - +Static method in class org.kiji.schema.KijiInstaller +
            Uninstalls the specified Kiji instance. +
            uninstall(KijiURI, HBaseFactory, Configuration) - +Static method in class org.kiji.schema.KijiInstaller +
            Removes a kiji instance from the HBase cluster including any user tables. +
            UninstallTool - Class in org.kiji.schema.tools
            A command-line tool for uninstalling kiji instances from an hbase cluster.
            UninstallTool() - +Constructor for class org.kiji.schema.tools.UninstallTool +
              +
            unlock() - +Method in interface org.kiji.schema.util.Lock +
            Releases the lock. +
            unlock() - +Method in class org.kiji.schema.util.ZooKeeperLock +
            Releases the lock. +
            unmodifiableMap() - +Static method in class org.kiji.schema.util.Functions +
            Returns a function that makes a map immutable. +
            UNSET_URI_STRING - +Static variable in class org.kiji.schema.KijiURI +
            String to specify an unset KijiURI field. +
            update - +Variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Deprecated.  +
            updateTableLayout(String, TableLayoutDesc) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Sets a table's layout. +
            updateTableLayout(String, TableLayoutDesc) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Sets a table's layout. +
            updateTableLayout(String, TableLayoutDesc) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Sets a table's layout. +
            +
            +

            +V

            +
            +
            VALID_ALIAS_PATTERN - +Static variable in class org.kiji.schema.util.KijiNameValidator +
            Regular expression that defines a valid alias for a layout name. +
            VALID_INSTANCE_PATTERN - +Static variable in class org.kiji.schema.util.KijiNameValidator +
            Regular expression that defines a valid instance name. +
            VALID_LAYOUT_NAME_PATTERN - +Static variable in class org.kiji.schema.util.KijiNameValidator +
            Regular expression that defines a valid layout name (family, qualifier, table, etc). +
            validate(KijiTableLayout) - +Method in class org.kiji.schema.KijiDataRequestValidator +
            Validates the data request against the given table layout. +
            validateAlias(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
            Validates characters that may be used in an alias for a qualifier, family, or + locality group. +
            validateFlags() - +Method in class org.kiji.schema.tools.BaseTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.CreateTableTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.DeleteTableTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.FlushTableTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.IncrementTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.LayoutTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.LsTool +
              +
            validateFlags() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Validates the command-line flags. +
            validateKijiName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
            Determines whether a string is a valid Kiji instance name. +
            validateLayoutName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
            Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names. +
            validateVersion(Kiji) - +Static method in class org.kiji.schema.util.VersionInfo +
            Validates that the client data version matches the data version installed on a Kiji instance. +
            value - +Variable in class org.kiji.schema.avro.CellSchema +
            Deprecated.  +
            value - +Variable in class org.kiji.schema.avro.KeyValueBackupEntry +
            Deprecated.  +
            VALUE_COLUMN_FAMILY - +Static variable in class org.kiji.schema.impl.HBaseSystemTable +
            The HBase column family that stores the value of the properties. +
            VALUE_MAP - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            A map from characters in the alphabet to the integer it represents. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.CompressionType +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.HashType +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.RowKeyEncoding +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.SchemaStorage +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.SchemaType +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.filter.OperatorRowFilter.Operator +
            Returns the enum constant of this type with the specified name. +
            values() - +Static method in enum org.kiji.schema.avro.CompressionType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.HashType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.RowKeyEncoding +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.SchemaStorage +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.SchemaType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.filter.OperatorRowFilter.Operator +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            version - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            VersionInfo - Class in org.kiji.schema.util
            Reads the version info from the jar manifest for this version of Kiji.
            VersionTool - Class in org.kiji.schema.tools
            Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            VersionTool() - +Constructor for class org.kiji.schema.tools.VersionTool +
              +
            VersionValidatedTool - Class in org.kiji.schema.tools
            Base class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool.
            VersionValidatedTool() - +Constructor for class org.kiji.schema.tools.VersionValidatedTool +
            Constructor. +
            +
            +

            +W

            +
            +
            withCellDecoderFactory(KijiCellDecoderFactory) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the cell decoder factory to use when reading cells from the scanner. +
            withClock(Clock) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets a clock. +
            withDataRequest(KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the data request used to generate the KijiRowScanner. +
            withFilter(KijiColumnFilter) - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Sets a filter to use on the column. +
            withHBaseResultScanner(ResultScanner) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the HBase result scanner the KijiRowScanner will wrap. +
            withIdlePollPeriod(long) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the amount of time between sweeps of the pool for removing idle connections. +
            withIdleTimeout(long) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the amount of time a connection may be idle before being removed from the pool. +
            withMaxSize(int) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the maximum number of connections to keep per table. +
            withMaxVersions(int) - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Sets the maximum number of the most recent versions to return. +
            withPageSize(int) - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Sets the number of cells per page (defaults to zero, which means paging is disabled). +
            withTable(HBaseKijiTable) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the table being scanned. +
            withTimeRange(long, long) - +Method in class org.kiji.schema.KijiDataRequest +
            Sets the time range of cells to return: [minTimestamp, + maxTimestamp). +
            WordSynthesizer - Class in org.kiji.schema.tools.synth
            Synthesizes random words from a dictionary.
            WordSynthesizer(Random, List<String>) - +Constructor for class org.kiji.schema.tools.synth.WordSynthesizer +
            Constructs a word synthesizer. +
            +
            +

            +Y

            +
            +
            yesNoPrompt() - +Method in class org.kiji.schema.tools.BaseTool +
            Prompts the user for a yes or no answer until they provide a valid response + (y/n/yes/no case insensitive) and reports the result. +
            +
            +

            +Z

            +
            +
            ZooKeeperLock - Class in org.kiji.schema.util
            Distributed lock on top of ZooKeeper.
            ZooKeeperLock(ZooKeeper, File) - +Constructor for class org.kiji.schema.util.ZooKeeperLock +
            Constructs a ZooKeeper lock object. +
            ZooKeeperLockFactory - Class in org.kiji.schema.util
            Factory for ZooKeeperLock instances.
            ZooKeeperLockFactory(ZooKeeper) - +Constructor for class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a factory for ZooKeeperLock. +
            ZooKeeperLockFactory(Configuration) - +Constructor for class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a factory for ZooKeeperLock. +
            +
            +A B C D E F G H I J K L M N O P Q R S T U V W Y Z + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/index.html b/apidocs/kiji-schema/1.0.0-rc2/index.html new file mode 100644 index 00000000..0390da15 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/index.html @@ -0,0 +1,40 @@ + + + + + + + +kiji-schema 1.0.0-rc2 API + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html new file mode 100644 index 00000000..dadaf4b9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html @@ -0,0 +1,393 @@ + + + + + + + +GenericTableMapReduceUtil (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.hbase.mapreduce +
            +Class GenericTableMapReduceUtil

            +
            +java.lang.Object
+  extended by org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil
+      extended by org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil
+
            +
            +
            +
            public class GenericTableMapReduceUtil
            extends TableMapReduceUtil
            + + +

            +Just like TableMapReduceUtil but fixes some missing dependency jars. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            GenericTableMapReduceUtil() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidaddAllDependencyJars(Job job) + +
            +          Like TableMapReduceUtil.addDependencyJars() but this catches some + missing ones like google's guava library.
            +static ScanconvertStringToScan(String base64) + +
            +          This method is just like the package-private version in TableMapReduceUtil, + except that it disables block caching by default.
            +static voidinitGenericTableMapperJob(String table, + Scan scan, + Class<? extends TableMapper> mapper, + Class<?> outputKeyClass, + Class<?> outputValueClass, + Job job) + +
            +          This is just like the TableMapReduceUtil.initTableMapperJob but + it takes any classes for input and output keys instead of just + Writables.
            +static voidinitTableInput(String table, + Scan scan, + Job job) + +
            +          Configures the job with an HBase scan over a table as input.
            +static voidinitTableScan(Scan scan, + Job job) + +
            +          Configures the job with an HBase scan.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil
            addDependencyJars, addDependencyJars, initCredentials, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableReducerJob, initTableReducerJob, initTableReducerJob, initTableReducerJob, limitNumReduceTasks, setNumReduceTasks, setScannerCaching
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +GenericTableMapReduceUtil

            +
            +public GenericTableMapReduceUtil()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initTableScan

            +
            +public static void initTableScan(Scan scan,
+                                 Job job)
+                          throws IOException
            +
            +
            Configures the job with an HBase scan. +

            +

            +
            Parameters:
            scan - The scan to set in the job configuration.
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +initTableInput

            +
            +public static void initTableInput(String table,
+                                  Scan scan,
+                                  Job job)
+                           throws IOException
            +
            +
            Configures the job with an HBase scan over a table as input. +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +convertStringToScan

            +
            +public static Scan convertStringToScan(String base64)
+                                throws IOException
            +
            +
            This method is just like the package-private version in TableMapReduceUtil, + except that it disables block caching by default. +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +initGenericTableMapperJob

            +
            +public static void initGenericTableMapperJob(String table,
+                                             Scan scan,
+                                             Class<? extends TableMapper> mapper,
+                                             Class<?> outputKeyClass,
+                                             Class<?> outputValueClass,
+                                             Job job)
+                                      throws IOException
            +
            +
            This is just like the TableMapReduceUtil.initTableMapperJob but + it takes any classes for input and output keys instead of just + Writables. This way we can work with AvroSerialization instead + of just WritableSerialization. +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +addAllDependencyJars

            +
            +public static void addAllDependencyJars(Job job)
+                                 throws IOException
            +
            +
            Like TableMapReduceUtil.addDependencyJars() but this catches some + missing ones like google's guava library. +

            +

            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html new file mode 100644 index 00000000..f38c455b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil

            +
            +No usage of org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-frame.html new file mode 100644 index 00000000..9325e549 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.apache.hadoop.hbase.mapreduce (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.apache.hadoop.hbase.mapreduce + + + + +
            +Classes  + +
            +GenericTableMapReduceUtil
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-summary.html new file mode 100644 index 00000000..4b524f09 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +org.apache.hadoop.hbase.mapreduce (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.apache.hadoop.hbase.mapreduce +

            + + + + + + + + + +
            +Class Summary
            GenericTableMapReduceUtilJust like TableMapReduceUtil but fixes some missing dependency jars.
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-tree.html new file mode 100644 index 00000000..00e72f5c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-tree.html @@ -0,0 +1,156 @@ + + + + + + + +org.apache.hadoop.hbase.mapreduce Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.apache.hadoop.hbase.mapreduce +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-use.html new file mode 100644 index 00000000..ace6e353 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/apache/hadoop/hbase/mapreduce/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.apache.hadoop.hbase.mapreduce (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.apache.hadoop.hbase.mapreduce

            +
            +No usage of org.apache.hadoop.hbase.mapreduce +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/EntityId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/EntityId.html new file mode 100644 index 00000000..534fcdbd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/EntityId.html @@ -0,0 +1,369 @@ + + + + + + + +EntityId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class EntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+
            +
            +
            Direct Known Subclasses:
            HashedEntityId, HashPrefixedEntityId, HBaseEntityId, RawEntityId
            +
            +
            +
            +
            @ApiAudience.Public
+public abstract class EntityId
            extends Object
            + + +

            +EntityId is used to identify a particular row in a Kiji table. + + There are two name-spaces for rows: +

              +
            • Kiji rows are primarily indexed by Kiji row keys (arbitrary byte arrays). +
            • Under the hood, rows are indexed by HBase row keys (arbitrary byte arrays). +
            + + The translation between Kiji row keys and HBase row keys depends on the layout of the table + the row belongs to. + + There are multiple translation schemes: +
              +
            • Raw: Kiji row keys and HBase row keys are identical (identity translation). +
            • MD5: HBase row keys are MD5 hashes of the Kiji row key (non reversible transform). +
            • Hash-prefix: HBase row keys are Kiji row keys prefixed by a hash of the Kiji row key. +
            • Composite: to be determined. +
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EntityId() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object obj) + +
            +          
            +abstract  RowKeyFormatgetFormat() + +
            +           
            +abstract  byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            +abstract  byte[]getKijiRowKey() + +
            +           
            + inthashCode() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EntityId

            +
            +public EntityId()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getFormat

            +
            +public abstract RowKeyFormat getFormat()
            +
            +
            + +
            Returns:
            the format of this row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public abstract byte[] getKijiRowKey()
            +
            +
            + +
            Returns:
            the Kiji row key as a byte array.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public abstract byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            + +
            Returns:
            the HBase row key.
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object obj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/EntityIdFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/EntityIdFactory.html new file mode 100644 index 00000000..1cc41f79 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/EntityIdFactory.html @@ -0,0 +1,353 @@ + + + + + + + +EntityIdFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class EntityIdFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityIdFactory
+
            +
            +
            +
            @ApiAudience.Public
+public abstract class EntityIdFactory
            extends Object
            + + +

            +Factory class for creating EntityIds. + + Light-weight object, so as many can be created as needed. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EntityIdFactory(RowKeyFormat format) + +
            +          Creates an entity ID factory.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static EntityIdFactorycreate(RowKeyFormat format) + +
            +          Creates an entity ID factory for the specified row key format.
            +abstract  EntityIdfromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates an entity ID from an HBase row key.
            +abstract  EntityIdfromKijiRowKey(byte[] kijiRowKey) + +
            +          Creates an entity ID from a Kiji row key.
            + EntityIdfromKijiRowKey(String text) + +
            +          Creates an entity ID from a UTF8 text Kiji row key.
            + RowKeyFormatgetFormat() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EntityIdFactory

            +
            +public EntityIdFactory(RowKeyFormat format)
            +
            +
            Creates an entity ID factory. +

            +

            +
            Parameters:
            format - Format of the row keys.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static EntityIdFactory create(RowKeyFormat format)
            +
            +
            Creates an entity ID factory for the specified row key format. +

            +

            +
            Parameters:
            format - Row key format that determines the type of EntityIdFactory that's created +
            Returns:
            a new entity ID factory for the specified row key format.
            +
            +
            +
            + +

            +getFormat

            +
            +public RowKeyFormat getFormat()
            +
            +
            + +
            Returns:
            the format of the row keys generated by this factory.
            +
            +
            +
            + +

            +fromKijiRowKey

            +
            +public abstract EntityId fromKijiRowKey(byte[] kijiRowKey)
            +
            +
            Creates an entity ID from a Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key. +
            Returns:
            a new EntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromKijiRowKey

            +
            +public EntityId fromKijiRowKey(String text)
            +
            +
            Creates an entity ID from a UTF8 text Kiji row key. +

            +

            +
            Parameters:
            text - UTF8 encoded Kiji row key. +
            Returns:
            a new EntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public abstract EntityId fromHBaseRowKey(byte[] hbaseRowKey)
            +
            +
            Creates an entity ID from an HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key. +
            Returns:
            a new EntityId with the specified HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/GenericCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/GenericCellDecoderFactory.html new file mode 100644 index 00000000..e3e7e44b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/GenericCellDecoderFactory.html @@ -0,0 +1,260 @@ + + + + + + + +GenericCellDecoderFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class GenericCellDecoderFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.GenericCellDecoderFactory
+
            +
            +
            All Implemented Interfaces:
            KijiCellDecoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class GenericCellDecoderFactory
            extends Object
            implements KijiCellDecoderFactory
            + + +

            +Factory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellDecoder<?>create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +static KijiCellDecoderFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiCellDecoderFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            an instance of the GenericCellDecoderFactory.
            +
            +
            +
            + +

            +create

            +
            +public KijiCellDecoder<?> create(CellSpec cellSpec)
+                          throws IOException
            +
            +
            Creates a new Kiji cell decoder. +

            +

            +
            Specified by:
            create in interface KijiCellDecoderFactory
            +
            +
            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell decoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseColumnName.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseColumnName.html new file mode 100644 index 00000000..ea43ef50 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseColumnName.html @@ -0,0 +1,405 @@ + + + + + + + +HBaseColumnName (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class HBaseColumnName

            +
            +java.lang.Object
+  extended by org.kiji.schema.HBaseColumnName
+
            +
            +
            +
            @ApiAudience.Public
+public final class HBaseColumnName
            extends Object
            + + +

            +An HBase column name. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseColumnName(byte[] family, + byte[] qualifier) + +
            +          Creates a new HBaseColumnName instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            + byte[]getFamily() + +
            +          Gets the HBase column family.
            + StringgetFamilyAsString() + +
            +          Gets the HBase column family as a string.
            + byte[]getQualifier() + +
            +          Gets the HBase column qualifier.
            + StringgetQualifierAsString() + +
            +          Gets the HBase column qualifier as a string.
            + inthashCode() + +
            +          
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +HBaseColumnName

            +
            +public HBaseColumnName(byte[] family,
+                       byte[] qualifier)
            +
            +
            Creates a new HBaseColumnName instance. +

            +

            +
            Parameters:
            family - The column family.
            qualifier - The column qualifier.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getFamily

            +
            +public byte[] getFamily()
            +
            +
            Gets the HBase column family. +

            +

            + +
            Returns:
            The family.
            +
            +
            +
            + +

            +getFamilyAsString

            +
            +public String getFamilyAsString()
            +
            +
            Gets the HBase column family as a string. +

            +

            + +
            Returns:
            The family as a string.
            +
            +
            +
            + +

            +getQualifier

            +
            +public byte[] getQualifier()
            +
            +
            Gets the HBase column qualifier. +

            +

            + +
            Returns:
            The qualifier.
            +
            +
            +
            + +

            +getQualifierAsString

            +
            +public String getQualifierAsString()
            +
            +
            Gets the HBase column qualifier as a string. +

            +

            + +
            Returns:
            The qualifier as a string.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseFactory.Provider.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseFactory.Provider.html new file mode 100644 index 00000000..ba9ce6c0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseFactory.Provider.html @@ -0,0 +1,228 @@ + + + + + + + +HBaseFactory.Provider (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class HBaseFactory.Provider

            +
            +java.lang.Object
+  extended by org.kiji.schema.HBaseFactory.Provider
+
            +
            +
            Enclosing interface:
            HBaseFactory
            +
            +
            +
            +
            public static final class HBaseFactory.Provider
            extends Object
            + + +

            +Provider for the default HBaseFactory. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static HBaseFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static HBaseFactory get()
            +
            +
            + +
            Returns:
            the default HBaseFactory.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseFactory.html new file mode 100644 index 00000000..21f7604b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseFactory.html @@ -0,0 +1,305 @@ + + + + + + + +HBaseFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface HBaseFactory

            +
            +
            All Superinterfaces:
            org.kiji.delegation.PriorityProvider
            +
            +
            +
            All Known Implementing Classes:
            DefaultHBaseFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+public interface HBaseFactory
            extends org.kiji.delegation.PriorityProvider
            + + +

            +Factory for HBase instances based on URIs. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classHBaseFactory.Provider + +
            +          Provider for the default HBaseFactory.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdminFactorygetHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactorygetHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactorygetLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  + + + + + + + +
            Methods inherited from interface org.kiji.delegation.PriorityProvider
            getPriority
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getHTableInterfaceFactory

            +
            +HTableInterfaceFactory getHTableInterfaceFactory(KijiURI uri)
            +
            +
            Reports a factory for HTableInterface for a given HBase instance. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HTableInterface for the specified HBase instance.
            +
            +
            +
            + +

            +getHBaseAdminFactory

            +
            +HBaseAdminFactory getHBaseAdminFactory(KijiURI uri)
            +
            +
            Reports a factory for HBaseAdmin for a given HBase instance. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HBaseAdmin for the specified HBase instance.
            +
            +
            +
            + +

            +getLockFactory

            +
            +LockFactory getLockFactory(KijiURI uri,
+                           Configuration conf)
+                           throws IOException
            +
            +
            Creates a lock factory for a given Kiji instance. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI of the Kiji instance to create a lock factory for.
            conf - Hadoop configuration. +
            Returns:
            a factory for locks for the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseScanOptions.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseScanOptions.html new file mode 100644 index 00000000..8ea6319d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/HBaseScanOptions.html @@ -0,0 +1,382 @@ + + + + + + + +HBaseScanOptions (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class HBaseScanOptions

            +
            +java.lang.Object
+  extended by org.kiji.schema.HBaseScanOptions
+
            +
            +
            +
            @ApiAudience.Public
+public final class HBaseScanOptions
            extends Object
            + + +

            +Customizable parameters for KijiRowScanners backed by an HBase scan. + Any parameters that are not set will default to HBase values. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseScanOptions() + +
            +          Creates a new HBaseScanOptions where all parameters will default to HBase values.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + BooleangetCacheBlocks() + +
            +          Returns whether requested rows are cached server-side, + or null if using the HBase default.
            + IntegergetClientBufferSize() + +
            +          Returns the number of rows to request with each RPC, + or null if using the HBase default.
            + IntegergetServerPrefetchSize() + +
            +          Returns the number of rows for servers to prefetch, + or null if using the HBase default.
            + voidsetCacheBlocks(Boolean cacheBlocks) + +
            +          Sets whether rows requested are cached server-side for future use.
            + voidsetClientBufferSize(Integer bufferSize) + +
            +          Sets the number of rows that will be returned with each RPC when iterating + through a KijiRowScanner.
            + voidsetServerPrefetchSize(Integer prefetchSize) + +
            +          Sets the number of rows for servers to prefetch.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseScanOptions

            +
            +public HBaseScanOptions()
            +
            +
            Creates a new HBaseScanOptions where all parameters will default to HBase values. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +setClientBufferSize

            +
            +public void setClientBufferSize(Integer bufferSize)
            +
            +
            Sets the number of rows that will be returned with each RPC when iterating + through a KijiRowScanner. If null, uses HBase default. +

            +

            +
            Parameters:
            bufferSize - The number of rows to request with each RPC.
            +
            +
            +
            + +

            +getClientBufferSize

            +
            +public Integer getClientBufferSize()
            +
            +
            Returns the number of rows to request with each RPC, + or null if using the HBase default. +

            +

            + +
            Returns:
            The number of rows to request with each RPC.
            +
            +
            +
            + +

            +setServerPrefetchSize

            +
            +public void setServerPrefetchSize(Integer prefetchSize)
            +
            +
            Sets the number of rows for servers to prefetch. If null, use HBase default. + Increasing this number should improve amortized scan time, although individual requests + may take longer to complete while the server is prefetching the following rows. + It is important that the scanner timeout be long enough to allow these longer fetches. +

            +

            +
            Parameters:
            prefetchSize - The number of rows to read into memory at a time.
            +
            +
            +
            + +

            +getServerPrefetchSize

            +
            +public Integer getServerPrefetchSize()
            +
            +
            Returns the number of rows for servers to prefetch, + or null if using the HBase default. +

            +

            + +
            Returns:
            The number of rows for servers to prefetch.
            +
            +
            +
            + +

            +setCacheBlocks

            +
            +public void setCacheBlocks(Boolean cacheBlocks)
            +
            +
            Sets whether rows requested are cached server-side for future use. If null, use HBase default. +

            +

            +
            Parameters:
            cacheBlocks - Whether rows are cached server-side.
            +
            +
            +
            + +

            +getCacheBlocks

            +
            +public Boolean getCacheBlocks()
            +
            +
            Returns whether requested rows are cached server-side, + or null if using the HBase default. +

            +

            + +
            Returns:
            Whether requested rows are cached server-side.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/IncompatibleKijiVersionException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/IncompatibleKijiVersionException.html new file mode 100644 index 00000000..85f1eb8a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/IncompatibleKijiVersionException.html @@ -0,0 +1,254 @@ + + + + + + + +IncompatibleKijiVersionException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class IncompatibleKijiVersionException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.IncompatibleKijiVersionException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class IncompatibleKijiVersionException
            extends IOException
            + + +

            +Thrown when there is an attempt to operate on a Kiji instance whose data format version + is incompatible with the Kiji client version. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            IncompatibleKijiVersionException(String message) + +
            +          Creates a new IncompatibleKijiVersionException with the specified + detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +IncompatibleKijiVersionException

            +
            +public IncompatibleKijiVersionException(String message)
            +
            +
            Creates a new IncompatibleKijiVersionException with the specified + detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/InternalKijiError.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/InternalKijiError.html new file mode 100644 index 00000000..e489f4a0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/InternalKijiError.html @@ -0,0 +1,271 @@ + + + + + + + +InternalKijiError (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class InternalKijiError

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Error
+          extended by org.kiji.schema.InternalKijiError
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class InternalKijiError
            extends Error
            + + +

            +Thrown when there is something wrong with the internal Kiji + implementation. Clients should never catch one of these. Please + file a bug report if you ever see one at the + Kiji Issue tracker. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            InternalKijiError(String message) + +
            +          Creates a new InternalKijiError with the specified detail message.
            InternalKijiError(Throwable cause) + +
            +          Creates a new InternalKijiError with the specified cause.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +InternalKijiError

            +
            +public InternalKijiError(Throwable cause)
            +
            +
            Creates a new InternalKijiError with the specified cause. +

            +

            +
            Parameters:
            cause - A throwable cause.
            +
            +
            + +

            +InternalKijiError

            +
            +public InternalKijiError(String message)
            +
            +
            Creates a new InternalKijiError with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/Kiji.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/Kiji.html new file mode 100644 index 00000000..9032c091 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/Kiji.html @@ -0,0 +1,620 @@ + + + + + + + +Kiji (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class Kiji

            +
            +java.lang.Object
+  extended by org.kiji.schema.Kiji
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTableFactory
            +
            +
            +
            +
            @ApiAudience.Public
+public class Kiji
            extends Object
            implements KijiTableFactory, Closeable
            + + +

            +

            Kiji instance class that contains configuration and table + information. Multiple instances of Kiji can be installed onto a + single HBase cluster. This class represents a single one of those + instances.

            + +

            An installed Kiji instance contains several tables: +

              +
            • System table: Kiji system and version information.
              • +
            • Meta table: Metadata about the existing Kiji tables.
              • +
            • Schema table: Avro Schemas of the cells in Kiji tables.
              • +
            • User tables: The user-space Kiji tables that you create.
              • +
            +

            +

            The default Kiji instance name is default.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            Kiji(KijiConfiguration kijiConf) + +
            +          Creates a new Kiji instance.
            Kiji(KijiConfiguration kijiConf, + boolean validateVersion, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Creates a new Kiji instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +protected  voidfinalize() + +
            +           
            + ConfigurationgetConf() + +
            +          Gets the hadoop configuration.
            + KijiConfigurationgetKijiConf() + +
            +          Gets the kiji instance configuration.
            + KijiMetaTablegetMetaTable() + +
            +          Gets the meta table for this Kiji instance.
            + StringgetName() + +
            +          Gets the name of the kiji instance.
            + KijiSchemaTablegetSchemaTable() + +
            +          Gets the schema table for this Kiji instance.
            + KijiSystemTablegetSystemTable() + +
            +          Gets the system table for this Kiji instance.
            +static Kijiopen(KijiConfiguration kijiConf) + +
            +          Opens a Kiji instance.
            +static Kijiopen(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            +static Kijiopen(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            + KijiTableopenTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +Kiji

            +
            +public Kiji(KijiConfiguration kijiConf)
+     throws IOException
            +
            +
            Creates a new Kiji instance. + This should only be used by Kiji.open(); +

            +

            +
            Parameters:
            kijiConf - The kiji configuration. +
            Throws: +
            IOException - If there is an error.
            See Also:
            open(KijiConfiguration)
            +
            +
            + +

            +Kiji

            +
            +public Kiji(KijiConfiguration kijiConf,
+            boolean validateVersion,
+            HTableInterfaceFactory tableFactory,
+            LockFactory lockFactory)
+     throws IOException
            +
            +
            Creates a new Kiji instance. + + Should only be used by Kiji.open(). +

            +

            +
            Parameters:
            kijiConf - Kiji configuration.
            validateVersion - Validate that the installed version of kiji is compatible with + this client.
            tableFactory - HTableInterface factory.
            lockFactory - Factory for locks. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +open

            +
            +public static Kiji open(KijiConfiguration kijiConf)
+                 throws IOException
            +
            +
            Opens a Kiji instance. +

            +

            +
            +
            +
            +
            Parameters:
            kijiConf - The configuration. +
            Returns:
            An opened kiji instance. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +open

            +
            +public static Kiji open(KijiURI uri,
+                        Configuration conf)
+                 throws IOException
            +
            +
            Opens a Kiji instance by URI. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI specifying the Kiji instance to open.
            conf - Hadoop configuration. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +open

            +
            +public static Kiji open(KijiURI uri)
+                 throws IOException
            +
            +
            Opens a Kiji instance by URI. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI specifying the Kiji instance to open. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the name of the kiji instance. +

            +

            +
            +
            +
            + +
            Returns:
            The name of the kiji instance.
            +
            +
            +
            + +

            +getKijiConf

            +
            +public KijiConfiguration getKijiConf()
            +
            +
            Gets the kiji instance configuration. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji configuration.
            +
            +
            +
            + +

            +getConf

            +
            +public Configuration getConf()
            +
            +
            Gets the hadoop configuration. +

            +

            +
            +
            +
            + +
            Returns:
            The hadoop configuration.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public KijiSchemaTable getSchemaTable()
+                               throws IOException
            +
            +
            Gets the schema table for this Kiji instance. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji schema table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getSystemTable

            +
            +public KijiSystemTable getSystemTable()
+                               throws IOException
            +
            +
            Gets the system table for this Kiji instance. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji system table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMetaTable

            +
            +public KijiMetaTable getMetaTable()
+                           throws IOException
            +
            +
            Gets the meta table for this Kiji instance. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji meta table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +openTable

            +
            +public KijiTable openTable(String tableName)
+                    throws IOException
            +
            +
            Opens a KijiTable by name. + +

            Clients must take care to close the KijiTable instance when finished.

            +

            +

            +
            Specified by:
            openTable in interface KijiTableFactory
            +
            +
            +
            Parameters:
            tableName - Name of the table to open. +
            Returns:
            the opened Kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiAdmin.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiAdmin.html new file mode 100644 index 00000000..32ea1152 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiAdmin.html @@ -0,0 +1,450 @@ + + + + + + + +KijiAdmin (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiAdmin

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiAdmin
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiAdmin
            extends Object
            + + +

            +Administration API for managing a Kiji instance. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiAdmin(HBaseAdmin hbaseAdmin, + Kiji kiji) + +
            +          Creates a Kiji admin.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore) + +
            +          Creates a Kiji table in an HBase instance.
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + byte[][] splitKeys) + +
            +          Creates a Kiji table in an HBase instance.
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + int numRegions) + +
            +          Creates a Kiji table in an HBase instance.
            + voiddeleteTable(String tableName) + +
            +          Deletes a Kiji table.
            + List<String>getTableNames() + +
            +          Gets the list of Kiji table names.
            + KijiTableLayoutsetTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutsetTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiAdmin

            +
            +public KijiAdmin(HBaseAdmin hbaseAdmin,
+                 Kiji kiji)
            +
            +
            Creates a Kiji admin. + +

            The parameters passed to the KijiAdmin must remain valid and open during the + lifetime of the KijiAdmin. It is the responsibility of the caller to close them.

            +

            +

            +
            Parameters:
            hbaseAdmin - The HBaseAdmin for the HBase cluster to use Kiji in.
            kiji - The Kiji instance to administer.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createTable

            +
            +public void createTable(String tableName,
+                        KijiTableLayout tableLayout,
+                        boolean isRestore)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            isRestore - true if this is part of a metadata restore operation. + This should be set to false by all callers except KijiMetadataTool. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +createTable

            +
            +public void createTable(String tableName,
+                        KijiTableLayout tableLayout,
+                        boolean isRestore,
+                        int numRegions)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            isRestore - true if this is part of a metadata restore operation.
            numRegions - The initial number of regions to create. +
            Throws: +
            IllegalArgumentException - If numRegions is non-positive, or if numRegions is + more than 1 and row key hashing on the table layout is disabled. +
            IOException - If there is an error.
            +
            +
            +
            + +

            +createTable

            +
            +public void createTable(String tableName,
+                        KijiTableLayout tableLayout,
+                        boolean isRestore,
+                        byte[][] splitKeys)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            isRestore - true if this is part of a metadata restore operation.
            splitKeys - The initial key boundaries between regions. There will be splitKeys + + 1 regions created. Pass null to specify the default single region. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +setTableLayout

            +
            +public KijiTableLayout setTableLayout(String tableName,
+                                      TableLayoutDesc update)
+                               throws IOException
            +
            +
            Sets the layout of a table. +

            +

            +
            Parameters:
            tableName - The name of the Kiji table to affect.
            update - Layout update. +
            Returns:
            the updated layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +setTableLayout

            +
            +public KijiTableLayout setTableLayout(String tableName,
+                                      TableLayoutDesc update,
+                                      boolean dryRun,
+                                      PrintStream printStream)
+                               throws IOException
            +
            +
            Sets the layout of a table, or print the results of setting the table layout if + dryRun is true. +

            +

            +
            Parameters:
            tableName - The name of the Kiji table to affect.
            update - Layout update.
            dryRun - true if this is a 'dry run', false if changes should be made.
            printStream - the print stream to use for information if dryRun is true. + If null, stdout will be used. +
            Returns:
            the updated layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +deleteTable

            +
            +public void deleteTable(String tableName)
+                 throws IOException
            +
            +
            Deletes a Kiji table. Removes it from HBase. +

            +

            +
            Parameters:
            tableName - The name of the Kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableNames

            +
            +public List<String> getTableNames()
+                           throws IOException
            +
            +
            Gets the list of Kiji table names. +

            +

            + +
            Returns:
            A list of the names of Kiji tables installed in the Kiji instance. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCell.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCell.html new file mode 100644 index 00000000..2a442cfd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCell.html @@ -0,0 +1,363 @@ + + + + + + + +KijiCell (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiCell<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiCell<T>
+
            +
            +
            Type Parameters:
            T - The type of the data in the cell.
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiCell<T>
            extends Object
            + + +

            +

            The data held in one cell of a kiji table. A KijiCell is a single + unit of data in Kiji, addressed by a tuple of (table, row, family, + qualifier, timestamp).

            + +

            Use a AvroCellDecoder or a + AvroCellEncoder to serialize/deserialize this cell in and out of a + Kiji table.

            + +

            This class has a Java type parameter T, which should be the Java type + determined by the Avro Schema. The mapping between Avro Schemas and Java types are + documented in the Avro Java API documentation: + +

            +

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiCell(org.apache.avro.Schema writerSchema, + T data) + +
            +          Constructs a single cell of kiji data.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object obj) + +
            +          Determines whether this KijiCell is equivalent to another.
            + TgetData() + +
            +          Gets the data in the cell.
            + org.apache.avro.SchemagetWriterSchema() + +
            +          Gets the schema used to write data in the cell.
            + inthashCode() + +
            +          This operation is not supported.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiCell

            +
            +public KijiCell(org.apache.avro.Schema writerSchema,
+                T data)
            +
            +
            Constructs a single cell of kiji data. +

            +

            +
            Parameters:
            writerSchema - The schema used to the encode the data in the cell.
            data - The data in the cell (the payload).
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getWriterSchema

            +
            +public org.apache.avro.Schema getWriterSchema()
            +
            +
            Gets the schema used to write data in the cell. +

            +

            + +
            Returns:
            The avro schema used by the writer to encode the data payload.
            +
            +
            +
            + +

            +getData

            +
            +public T getData()
            +
            +
            Gets the data in the cell. +

            +

            + +
            Returns:
            The decoded original data payload.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object obj)
            +
            +
            Determines whether this KijiCell is equivalent to another. They are equivalent if + they are both KijiCell objects, they have the same writer schema, and they have the + same data. +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            Parameters:
            obj - The other object to compare to. +
            Returns:
            Whether they are equivalent.
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            This operation is not supported. +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            + +
            Returns:
            Nothing, since this operation is not supported.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellDecoder.html new file mode 100644 index 00000000..0c1e0b44 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellDecoder.html @@ -0,0 +1,251 @@ + + + + + + + +KijiCellDecoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellDecoder<T>

            +
            +
            Type Parameters:
            T - Type of the values being decoded.
            +
            +
            All Known Implementing Classes:
            AvroCellDecoder, CounterCellDecoder, GenericCellDecoder, SpecificCellDecoder
            +
            +
            +
            +
            @ApiAudience.Framework
+public interface KijiCellDecoder<T>
            + + +

            +Interface for Kiji cell decoders. + + A cell decoder is specific to one column and decodes only one type of value. + Cell decoders are instantiated via KijiCellDecoderFactory. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCell<T>decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + TdecodeValue(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +decodeCell

            +
            +KijiCell<T> decodeCell(byte[] bytes)
+                       throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Parameters:
            bytes - Binary encoded Kiji cell. +
            Returns:
            the decoded KijiCell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeValue

            +
            +T decodeValue(byte[] bytes)
+              throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Parameters:
            bytes - Binary encoded Kiji cell value. +
            Returns:
            the decoded cell value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellDecoderFactory.html new file mode 100644 index 00000000..3ca212f9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellDecoderFactory.html @@ -0,0 +1,228 @@ + + + + + + + +KijiCellDecoderFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellDecoderFactory

            +
            +
            All Known Implementing Classes:
            GenericCellDecoderFactory, SpecificCellDecoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+public interface KijiCellDecoderFactory
            + + +

            +Interface for factories of KijiCellDecoder instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<T> KijiCellDecoder<T>
            +            		create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +<T> KijiCellDecoder<T> create(CellSpec cellSpec)
+                          throws IOException
            +
            +
            Creates a new Kiji cell decoder. +

            +

            +
            Type Parameters:
            T - Type of the value to decode.
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell decoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellEncoder.html new file mode 100644 index 00000000..10ea7556 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellEncoder.html @@ -0,0 +1,260 @@ + + + + + + + +KijiCellEncoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellEncoder

            +
            +
            All Known Implementing Classes:
            AvroCellEncoder, CounterCellEncoder
            +
            +
            +
            +
            @ApiAudience.Framework
+public interface KijiCellEncoder
            + + +

            +Interface for Kiji cell encoders. + + A cell encoder is configured to encode precisely one specific column and knows exactly the type + of data it is supposed to encode. + + Cell encoders are instantiated via KijiCellEncoderFactory. + + Intended for framework developers only. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + + + + + +
            +<T> byte[]
            +            		encode(T cellValue) + +
            +          Encodes the specified value.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +encode

            +
            +byte[] encode(KijiCell<?> cell)
+              throws IOException
            +
            +
            Encodes the specified Kiji cell. +

            +

            +
            Parameters:
            cell - Kiji cell to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encode

            +
            +<T> byte[] encode(T cellValue)
+              throws IOException
            +
            +
            Encodes the specified value. +

            +

            +
            Type Parameters:
            T - type of the value to encode.
            Parameters:
            cellValue - value to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellEncoderFactory.html new file mode 100644 index 00000000..f1c0d544 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCellEncoderFactory.html @@ -0,0 +1,221 @@ + + + + + + + +KijiCellEncoderFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellEncoderFactory

            +
            +
            All Known Implementing Classes:
            DefaultKijiCellEncoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+public interface KijiCellEncoderFactory
            + + +

            +Interface for factories of KijiCellEncoder instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + KijiCellEncodercreate(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +KijiCellEncoder create(CellSpec cellSpec)
+                       throws IOException
            +
            +
            Creates a new Kiji cell encoder. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell encoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiColumnName.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiColumnName.html new file mode 100644 index 00000000..e1d274d1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiColumnName.html @@ -0,0 +1,519 @@ + + + + + + + +KijiColumnName (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiColumnName

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiColumnName
+
            +
            +
            All Implemented Interfaces:
            Comparable<KijiColumnName>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiColumnName
            extends Object
            implements Comparable<KijiColumnName>
            + + +

            +A Kiji column name is composed of one or two parts: a family and a qualifier. + The qualifier is sometimes also referred to as the key. + If the column is of type map, the qualifier is null. + If the column is of type group, then the qualifier is required but may be empty. +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiColumnName(String fullName) + +
            +          Constructs a column name from a string "family" or "family:qualifier".
            KijiColumnName(String family, + String qualifier) + +
            +          Constructs a column name from the two-part family:qualifier.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + intcompareTo(KijiColumnName o) + +
            +          
            + booleanequals(Object otherObj) + +
            +          
            + StringgetFamily() + +
            +          Gets the name of the column family.
            + byte[]getFamilyBytes() + +
            +          Gets the name of the column family as a byte array.
            + StringgetName() + +
            +          Gets the full name of the column.
            + StringgetQualifier() + +
            +          Gets the name of the column qualifier, which may be null or empty.
            + byte[]getQualifierBytes() + +
            +          Gets the name of the column qualifier as a byte array.
            + inthashCode() + +
            +          
            + booleanisFullyQualified() + +
            +          Determines whether the name refers to a qualified family (vs.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiColumnName

            +
            +public KijiColumnName(String fullName)
            +
            +
            Constructs a column name from a string "family" or "family:qualifier". +

            +

            +
            Parameters:
            fullName - The name of a kiji column "family:qualifier".
            +
            +
            + +

            +KijiColumnName

            +
            +public KijiColumnName(String family,
+                      String qualifier)
            +
            +
            Constructs a column name from the two-part family:qualifier. +

            +

            +
            Parameters:
            family - The kiji column family.
            qualifier - The kiji column qualifier: null means unqualified.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the full name of the column. +

            +

            +
            +
            +
            + +
            Returns:
            the full name of the column.
            +
            +
            +
            + +

            +getFamily

            +
            +public String getFamily()
            +
            +
            Gets the name of the column family. +

            +

            +
            +
            +
            + +
            Returns:
            the family component of the column name.
            +
            +
            +
            + +

            +getFamilyBytes

            +
            +public byte[] getFamilyBytes()
            +
            +
            Gets the name of the column family as a byte array. + Caches the result for subsequent calls. This method returns a shared + array instance for all calls; do not modify the returned byte array. +

            +

            +
            +
            +
            + +
            Returns:
            the family component of the column name.
            +
            +
            +
            + +

            +getQualifier

            +
            +public String getQualifier()
            +
            +
            Gets the name of the column qualifier, which may be null or empty. +

            +

            +
            +
            +
            + +
            Returns:
            the qualifier component of the column name.
            +
            +
            +
            + +

            +getQualifierBytes

            +
            +public byte[] getQualifierBytes()
            +
            +
            Gets the name of the column qualifier as a byte array. + Caches the result for subsequent calls. This method returns a shared + array instance for all calls; do not modify the returned byte array. +

            +

            +
            +
            +
            + +
            Returns:
            the qualifier component of the column name.
            +
            +
            +
            + +

            +isFullyQualified

            +
            +public boolean isFullyQualified()
            +
            +
            Determines whether the name refers to a qualified family (vs. an entire family). +

            +

            +
            +
            +
            + +
            Returns:
            whether the column refers to a fully qualified family.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object otherObj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +compareTo

            +
            +public int compareTo(KijiColumnName o)
            +
            +
            +

            +

            +
            Specified by:
            compareTo in interface Comparable<KijiColumnName>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiColumnPager.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiColumnPager.html new file mode 100644 index 00000000..f6b80104 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiColumnPager.html @@ -0,0 +1,303 @@ + + + + + + + +KijiColumnPager (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiColumnPager

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiColumnPager
+
            +
            +
            +
            @ApiAudience.Private
+public final class KijiColumnPager
            extends Object
            + + +

            +Fetches new pages of column data in Kiji, and maintains state for which page each column is on. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiColumnPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HTableInterface htable) + +
            +          Creates a new KijiColumnPager.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + NavigableMap<String,NavigableMap<Long,byte[]>>getNextPage(String family) + +
            +          Gets the next page of data in a family with paging enabled.
            + NavigableMap<Long,byte[]>getNextPage(String family, + String qualifier) + +
            +          Gets the next page of data in a column with paging enabled.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiColumnPager

            +
            +public KijiColumnPager(EntityId entityId,
+                       KijiDataRequest dataRequest,
+                       KijiTableLayout tableLayout,
+                       HTableInterface htable)
            +
            +
            Creates a new KijiColumnPager. +

            +

            +
            Parameters:
            entityId - The entity id of the row having columns paged.
            dataRequest - The data request that was used to fetch the row data.
            tableLayout - The layout of the Kiji table being read from.
            htable - An HTable connection for the table that stores the Kiji table data.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getNextPage

            +
            +public NavigableMap<Long,byte[]> getNextPage(String family,
+                                             String qualifier)
+                                      throws IOException
            +
            +
            Gets the next page of data in a column with paging enabled. +

            +

            +
            Parameters:
            family - A column family.
            qualifier - A column qualifier. +
            Returns:
            The next page of data (or null if there is no more data). +
            Throws: +
            KijiColumnPagingNotEnabledException - If paging is not enabled on the requested column. +
            IOException - If there is an I/O error.
            +
            +
            +
            + +

            +getNextPage

            +
            +public NavigableMap<String,NavigableMap<Long,byte[]>> getNextPage(String family)
+                                                           throws IOException
            +
            +
            Gets the next page of data in a family with paging enabled. +

            +

            +
            Parameters:
            family - A column family. +
            Returns:
            The next page of data (or null if there is no more data). +
            Throws: +
            KijiColumnPagingNotEnabledException - If paging is not enabled on the requested column. +
            IOException - If there is an I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiColumnPagingNotEnabledException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiColumnPagingNotEnabledException.html new file mode 100644 index 00000000..55e93e01 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiColumnPagingNotEnabledException.html @@ -0,0 +1,256 @@ + + + + + + + +KijiColumnPagingNotEnabledException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiColumnPagingNotEnabledException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.KijiColumnPagingNotEnabledException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiColumnPagingNotEnabledException
            extends IOException
            + + +

            +Thrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column. + +

            To enable paging on a column, use the KijiDataRequest.Column.withPageSize(int) method in your KijiDataRequest.

            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiColumnPagingNotEnabledException(String message) + +
            +          Creates a new KijiColumnPagingNotEnabledException with the specified + detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiColumnPagingNotEnabledException

            +
            +public KijiColumnPagingNotEnabledException(String message)
            +
            +
            Creates a new KijiColumnPagingNotEnabledException with the specified + detail message. +

            +

            +
            Parameters:
            message - An error message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiConfiguration.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiConfiguration.html new file mode 100644 index 00000000..973422fb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiConfiguration.html @@ -0,0 +1,517 @@ + + + + + + + +KijiConfiguration (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiConfiguration

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.KijiConfiguration
+
            +
            +
            All Implemented Interfaces:
            Configurable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiConfiguration
            extends Configured
            + + +

            +

            The configuration for a single instance of Kiji, as a cluster could + contain multiple instances.

            + +

            An installed Kiji instance contains several tables: +

              +
            • System table: Kiji system and version information.
              • +
            • Meta table: Metadata about the existing Kiji tables.
              • +
            • Schema table: Avro Schemas of the cells in Kiji tables.
              • +
            • User tables: The user-space Kiji tables that you create.
              • +
            +

            + +

            The default Kiji instance name is default.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_KIJI_INSTANCE_NAME + +
            +          The Configuration variable to store the kiji instance name.
            +static StringDEFAULT_CONF_FILE + +
            +          The default Kiji configuration file.
            +static StringDEFAULT_INSTANCE_NAME + +
            +          The default kiji instance name.
            +  + + + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiConfiguration(Configuration conf, + KijiURI uri) + +
            +          Initializes a Kiji configuration from a Hadoop configuration and a Kiji URI.
            KijiConfiguration(Configuration conf, + String instanceName) + +
            +          Constructs a handle to a Kiji instance.
            KijiConfiguration(KijiConfiguration kijiConf) + +
            +          Constructs a deep copy of an existing Kiji configuration.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiConfigurationcreate(String name) + +
            +          Gets a handle to a Kiji instance using the default Kiji configuration file.
            +static KijiConfigurationcreate(String confFile, + String name) + +
            +          Gets a handle to a Kiji instance.
            + booleanexists() + +
            +          Determines whether this named Kiji instance exists.
            +protected  booleanexists(HBaseAdmin hbaseAdmin) + +
            +          Determines whether the Kiji instance exists according to the + given HBase admin interface.
            + StringgetName() + +
            +          Gets the name of this Kiji instance.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +DEFAULT_CONF_FILE

            +
            +public static final String DEFAULT_CONF_FILE
            +
            +
            The default Kiji configuration file. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULT_INSTANCE_NAME

            +
            +public static final String DEFAULT_INSTANCE_NAME
            +
            +
            The default kiji instance name. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_KIJI_INSTANCE_NAME

            +
            +public static final String CONF_KIJI_INSTANCE_NAME
            +
            +
            The Configuration variable to store the kiji instance name. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +KijiConfiguration

            +
            +public KijiConfiguration(Configuration conf,
+                         String instanceName)
            +
            +
            Constructs a handle to a Kiji instance. +

            +

            +
            Parameters:
            conf - A Configuration object that specifies the HBase cluster.
            instanceName - The name of the Kiji instance.
            +
            +
            + +

            +KijiConfiguration

            +
            +public KijiConfiguration(Configuration conf,
+                         KijiURI uri)
            +
            +
            Initializes a Kiji configuration from a Hadoop configuration and a Kiji URI. +

            +

            +
            Parameters:
            conf - Hadoop configuration.
            uri - Kiji URI of the instance to initialize.
            +
            +
            + +

            +KijiConfiguration

            +
            +public KijiConfiguration(KijiConfiguration kijiConf)
            +
            +
            Constructs a deep copy of an existing Kiji configuration. +

            +

            +
            Parameters:
            kijiConf - The Kiji configuration to copy.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiConfiguration create(String confFile,
+                                       String name)
+                                throws IOException
            +
            +
            Gets a handle to a Kiji instance. + This method is useful if you cannot add the HBase configuration resources to the classpath of + your application (in an HTTP Servlet, for example). +

            +

            +
            Parameters:
            confFile - The path to a configuration file that specifies the location of HBase cluster + resources.
            name - The name of the Kiji instance. +
            Returns:
            A handle to a Kiji instance. +
            Throws: +
            IOException - If there is an error reading the configuration file.
            +
            +
            +
            + +

            +create

            +
            +public static KijiConfiguration create(String name)
+                                throws IOException
            +
            +
            Gets a handle to a Kiji instance using the default Kiji configuration file. + This method is useful if you cannot add the HBase configuration resources to the classpath of + your application (in an HTTP Servlet, for example). +

            +

            +
            Parameters:
            name - The name of the Kiji instance. +
            Returns:
            A handle to a Kiji instance. +
            Throws: +
            IOException - If there is an error reading the configuration file.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the name of this Kiji instance. +

            +

            + +
            Returns:
            The name of the Kiji instance.
            +
            +
            +
            + +

            +exists

            +
            +public boolean exists()
+               throws IOException
            +
            +
            Determines whether this named Kiji instance exists. +

            +

            + +
            Returns:
            Whether this Kiji instance exists in the HBase cluster. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +exists

            +
            +protected boolean exists(HBaseAdmin hbaseAdmin)
+                  throws IOException
            +
            +
            Determines whether the Kiji instance exists according to the + given HBase admin interface. +

            +

            +
            Parameters:
            hbaseAdmin - The HBase interface to use. +
            Returns:
            Whether the Kiji instance exists. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCounter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCounter.html new file mode 100644 index 00000000..2fa610e0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiCounter.html @@ -0,0 +1,247 @@ + + + + + + + +KijiCounter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCounter

            +
            +
            All Known Implementing Classes:
            DefaultKijiCounter
            +
            +
            +Deprecated. KijiCounter will be merged into KijiCell. +

            +

            +
            @ApiAudience.Public
+@Deprecated
+public interface KijiCounter
            + + +

            +A counter value stored in a column of a Kiji table. + +

            Use a KijiTableWriter to increment a counter value.

            +

            + +

            +

            +
            See Also:
            KijiIncrementer.increment(EntityId, String, String, long)
            +
            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + longgetTimestamp() + +
            +          Deprecated. Gets the timestamp at which the counter was incremented.
            + longgetValue() + +
            +          Deprecated. Gets the value of the counter.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTimestamp

            +
            +long getTimestamp()
            +
            +
            Deprecated. 
            Gets the timestamp at which the counter was incremented. +

            +

            + +
            Returns:
            A timestamp, in milliseconds since the epoch.
            +
            +
            +
            + +

            +getValue

            +
            +long getValue()
            +
            +
            Deprecated. 
            Gets the value of the counter. +

            +

            + +
            Returns:
            The value of the counter, which is zero if the counter has never been incremented.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequest.Column.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequest.Column.html new file mode 100644 index 00000000..27b84c2f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequest.Column.html @@ -0,0 +1,663 @@ + + + + + + + +KijiDataRequest.Column (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequest.Column

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequest.Column
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Enclosing class:
            KijiDataRequest
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiDataRequest.Column
            extends Object
            implements Serializable
            + + +

            +Describes a request for a Kiji Table column. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiDataRequest.Column(KijiColumnName name) + +
            +          Creates a new requested Column.
            KijiDataRequest.Column(String family) + +
            +          Creates a new request for the latest version of the cells in family.
            KijiDataRequest.Column(String family, + byte[] key) + +
            +          Creates a new request for the latest version of the cell in family:key.
            KijiDataRequest.Column(String family, + String key) + +
            +          Creates a new request for the latest version of the cell in family:key.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            + KijiColumnNamegetColumnName() + +
            +          Gets the column name.
            + StringgetFamily() + +
            +          Gets the name of the requested column family.
            + KijiColumnFiltergetFilter() + +
            +          Gets the column filter, or null if no filter was specified.
            + StringgetKey() + +
            +          Gets the name of the requested column qualifier, which may be null if any qualifier + should be included.
            + intgetMaxVersions() + +
            +          Gets the max number of most recent versions in this request.
            + StringgetName() + +
            +          Gets the full name of the requested column.
            + intgetPageSize() + +
            +          Gets the number of cells to return per page of results.
            + inthashCode() + +
            +          
            + booleanisPagingEnabled() + +
            +          Determines whether paging is enabled for this column.
            + StringtoString() + +
            +          
            + KijiDataRequest.ColumnwithFilter(KijiColumnFilter filter) + +
            +          Sets a filter to use on the column.
            + KijiDataRequest.ColumnwithMaxVersions(int num) + +
            +          Sets the maximum number of the most recent versions to return.
            + KijiDataRequest.ColumnwithPageSize(int cellsPerPage) + +
            +          Sets the number of cells per page (defaults to zero, which means paging is disabled).
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiDataRequest.Column

            +
            +public KijiDataRequest.Column(KijiColumnName name)
            +
            +
            Creates a new requested Column. +

            +

            +
            Parameters:
            name - The name of the column to request.
            +
            +
            + +

            +KijiDataRequest.Column

            +
            +public KijiDataRequest.Column(String family)
            +
            +
            Creates a new request for the latest version of the cells in family. +

            +

            +
            Parameters:
            family - The name of the column family to request.
            +
            +
            + +

            +KijiDataRequest.Column

            +
            +public KijiDataRequest.Column(String family,
+                              String key)
            +
            +
            Creates a new request for the latest version of the cell in family:key. +

            +

            +
            Parameters:
            family - The name of the column family to request.
            key - The name of the column qualifier to request.
            +
            +
            + +

            +KijiDataRequest.Column

            +
            +public KijiDataRequest.Column(String family,
+                              byte[] key)
            +
            +
            Creates a new request for the latest version of the cell in family:key. +

            +

            +
            Parameters:
            family - The name of the column family to request.
            key - The name of the column qualifier to request.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +withMaxVersions

            +
            +public KijiDataRequest.Column withMaxVersions(int num)
            +
            +
            Sets the maximum number of the most recent versions to return. +

            +

            +
            +
            +
            +
            Parameters:
            num - The maximum number of versions of the cell to read. +
            Returns:
            This column request instance.
            +
            +
            +
            + +

            +withFilter

            +
            +public KijiDataRequest.Column withFilter(KijiColumnFilter filter)
            +
            +
            Sets a filter to use on the column. +

            +

            +
            +
            +
            +
            Parameters:
            filter - The column filter; +
            Returns:
            This column request instance.
            +
            +
            +
            + +

            +withPageSize

            +
            +public KijiDataRequest.Column withPageSize(int cellsPerPage)
            +
            +
            Sets the number of cells per page (defaults to zero, which means paging is disabled). +

            +

            +
            +
            +
            +
            Parameters:
            cellsPerPage - The number of cells to return in each page of results. Use 0 to + disable paging and return all results at once. +
            Returns:
            This column request instance.
            +
            +
            +
            + +

            +getFamily

            +
            +public String getFamily()
            +
            +
            Gets the name of the requested column family. +

            +

            +
            +
            +
            + +
            Returns:
            A column family name.
            +
            +
            +
            + +

            +getKey

            +
            +public String getKey()
            +
            +
            Gets the name of the requested column qualifier, which may be null if any qualifier + should be included. +

            +

            +
            +
            +
            + +
            Returns:
            A column qualifier name (may be null or empty).
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +

            Gets the full name of the requested column.

            + +

            Note: A request for column "foo" means that all columns within the family "foo" + should be requested, whereas a request for column "foo:" means that the single + column with qualifier "" (empty) should be returned from the family "foo". +

            +

            +
            +
            +
            + +
            Returns:
            A column name.
            +
            +
            +
            + +

            +getColumnName

            +
            +public KijiColumnName getColumnName()
            +
            +
            Gets the column name. +

            +

            +
            +
            +
            + +
            Returns:
            The column name.
            +
            +
            +
            + +

            +getMaxVersions

            +
            +public int getMaxVersions()
            +
            +
            Gets the max number of most recent versions in this request. +

            +

            +
            +
            +
            + +
            Returns:
            A number of versions.
            +
            +
            +
            + +

            +getFilter

            +
            +public KijiColumnFilter getFilter()
            +
            +
            Gets the column filter, or null if no filter was specified. +

            +

            +
            +
            +
            + +
            Returns:
            The column filter, or null.
            +
            +
            +
            + +

            +getPageSize

            +
            +public int getPageSize()
            +
            +
            Gets the number of cells to return per page of results. +

            +

            +
            +
            +
            + +
            Returns:
            The page size (or 0 if paging is disabled).
            +
            +
            +
            + +

            +isPagingEnabled

            +
            +public boolean isPagingEnabled()
            +
            +
            Determines whether paging is enabled for this column. +

            +

            +
            +
            +
            + +
            Returns:
            Whether paging is enabled.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequest.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequest.html new file mode 100644 index 00000000..190201e7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequest.html @@ -0,0 +1,625 @@ + + + + + + + +KijiDataRequest (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequest

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequest
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiDataRequest
            extends Object
            implements Serializable
            + + +

            +

            Describes a request for columns of data to read from a Kiji table.

            + +

            To request the 3 most recent versions of cell data from a column bar from + the family foo within the time range (123, 456]: + + 

            + KijiDataRequest dataRequest = new KijiDataRequest()
+     .withTimeRange(123L, 456L)
+     .addColumn(new KijiDataRequest.Column("foo", "bar").withMaxVersions(3));
+
            + +

            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiDataRequest.Column + +
            +          Describes a request for a Kiji Table column.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            KijiDataRequest() + +
            +          Constructor.
            KijiDataRequest(KijiDataRequest copy) + +
            +          Creates a new KijiDataRequest from a copy.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestaddColumn(KijiDataRequest.Column column) + +
            +          Add a request for a column to this data request.
            + booleanequals(Object other) + +
            +          
            + KijiDataRequest.ColumngetColumn(String family, + String key) + +
            +          Gets a Column requested named "family:key", or + null if none exists.
            + Collection<KijiDataRequest.Column>getColumns() + +
            +          Gets the collection of requested columns.
            + longgetMaxTimestamp() + +
            +          Gets the maximum timestamp for versions in this request (exclusive).
            + longgetMinTimestamp() + +
            +          Gets the minimum timestamp for versions in this request (inclusive).
            + inthashCode() + +
            +          
            + booleanisEmpty() + +
            +          Determines whether this data request has any columns.
            + booleanisPagingEnabled() + +
            +          Determines whether paging is enabled on any of the columns in this request.
            + booleanisTimestampInRange(long ts) + +
            +          Determines whether a timestamp ts is within the time range for this + request.
            + KijiDataRequestmerge(KijiDataRequest other) + +
            +          Merges the requested columns in other into this data request.
            + StringtoString() + +
            +          
            + KijiDataRequestwithTimeRange(long minTimestamp, + long maxTimestamp) + +
            +          Sets the time range of cells to return: [minTimestamp, + maxTimestamp).
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiDataRequest

            +
            +public KijiDataRequest()
            +
            +
            Constructor. +

            +

            +
            + +

            +KijiDataRequest

            +
            +public KijiDataRequest(KijiDataRequest copy)
            +
            +
            Creates a new KijiDataRequest from a copy. +

            +

            +
            Parameters:
            copy - The KijiDataRequest to copy.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +addColumn

            +
            +public KijiDataRequest addColumn(KijiDataRequest.Column column)
            +
            +
            Add a request for a column to this data request. Only the most recent request for a + particular column is kept if multiple requests for the same column name are added. +

            +

            +
            +
            +
            +
            Parameters:
            column - The column request. +
            Returns:
            This KijiDataRequest instance.
            +
            +
            +
            + +

            +withTimeRange

            +
            +public KijiDataRequest withTimeRange(long minTimestamp,
+                                     long maxTimestamp)
            +
            +
            Sets the time range of cells to return: [minTimestamp, + maxTimestamp). +

            +

            +
            +
            +
            +
            Parameters:
            minTimestamp - Request cells with a timestamp at least minTimestamp.
            maxTimestamp - Request cells with a timestamp less than maxTimestamp. +
            Returns:
            This data request instance.
            +
            +
            +
            + +

            +merge

            +
            +public KijiDataRequest merge(KijiDataRequest other)
            +
            +
            Merges the requested columns in other into this data request. +

            +

            +
            +
            +
            +
            Parameters:
            other - Another data request to include as a part of this one. +
            Returns:
            This KijiDataRequest instance, mutated to include the other requested columns.
            +
            +
            +
            + +

            +getColumn

            +
            +public KijiDataRequest.Column getColumn(String family,
+                                        String key)
            +
            +
            Gets a Column requested named "family:key", or + null if none exists. +

            +

            +
            +
            +
            +
            Parameters:
            family - The requested column family name.
            key - The requested column qualifier name. +
            Returns:
            The requested column.
            +
            +
            +
            + +

            +isEmpty

            +
            +public boolean isEmpty()
            +
            +
            Determines whether this data request has any columns. +

            +

            +
            +
            +
            + +
            Returns:
            Whether any data has been requested.
            +
            +
            +
            + +

            +getColumns

            +
            +public Collection<KijiDataRequest.Column> getColumns()
            +
            +
            Gets the collection of requested columns. +

            +

            +
            +
            +
            + +
            Returns:
            All the requested column specs.
            +
            +
            +
            + +

            +getMinTimestamp

            +
            +public long getMinTimestamp()
            +
            +
            Gets the minimum timestamp for versions in this request (inclusive). +

            +

            +
            +
            +
            + +
            Returns:
            A minimum timestamp (milliseconds since the epoch).
            +
            +
            +
            + +

            +getMaxTimestamp

            +
            +public long getMaxTimestamp()
            +
            +
            Gets the maximum timestamp for versions in this request (exclusive). +

            +

            +
            +
            +
            + +
            Returns:
            A maximum timestamp (milliseconds since the epoch).
            +
            +
            +
            + +

            +isTimestampInRange

            +
            +public boolean isTimestampInRange(long ts)
            +
            +
            Determines whether a timestamp ts is within the time range for this + request. +

            +

            +
            +
            +
            +
            Parameters:
            ts - The timestamp to check. +
            Returns:
            Whether the timestamp is within the range of this request.
            +
            +
            +
            + +

            +isPagingEnabled

            +
            +public boolean isPagingEnabled()
            +
            +
            Determines whether paging is enabled on any of the columns in this request. +

            +

            +
            +
            +
            + +
            Returns:
            Whether paging is enabled.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequestException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequestException.html new file mode 100644 index 00000000..249ab1f3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequestException.html @@ -0,0 +1,251 @@ + + + + + + + +KijiDataRequestException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequestException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiDataRequestException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiDataRequestException
            extends RuntimeException
            + + +

            +Thrown when there is an error validating a KijiDataRequest against a Kiji table. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiDataRequestException(String message) + +
            +          Creates a new KijiDataRequestException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiDataRequestException

            +
            +public KijiDataRequestException(String message)
            +
            +
            Creates a new KijiDataRequestException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequestValidator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequestValidator.html new file mode 100644 index 00000000..756e43fd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDataRequestValidator.html @@ -0,0 +1,269 @@ + + + + + + + +KijiDataRequestValidator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequestValidator

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequestValidator
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiDataRequestValidator
            extends Object
            + + +

            +This class validates a KijiDataRequest against the layout + of a Kiji table to make sure it contains all of the columns requested. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiDataRequestValidator(KijiDataRequest dataRequest) + +
            +          Construct a validator for a data request.
            +  + + + + + + + + + + + +
            +Method Summary
            + voidvalidate(KijiTableLayout tableLayout) + +
            +          Validates the data request against the given table layout.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiDataRequestValidator

            +
            +public KijiDataRequestValidator(KijiDataRequest dataRequest)
            +
            +
            Construct a validator for a data request. +

            +

            +
            Parameters:
            dataRequest - The data request to validate.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +validate

            +
            +public void validate(KijiTableLayout tableLayout)
+              throws InvalidLayoutException
            +
            +
            Validates the data request against the given table layout. +

            +

            +
            Parameters:
            tableLayout - The Kiji table layout to validate against. +
            Throws: +
            InvalidLayoutException - If the table layout is invalid. +
            KijiDataRequestException - If the data request is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDeleter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDeleter.html new file mode 100644 index 00000000..f1625c79 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiDeleter.html @@ -0,0 +1,467 @@ + + + + + + + +KijiDeleter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiDeleter

            +
            +
            All Superinterfaces:
            Closeable, Flushable
            +
            +
            +
            All Known Subinterfaces:
            KijiTableWriter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Framework
+public interface KijiDeleter
            extends Closeable, Flushable
            + + +

            +Interface for performing deletes on a Kiji table. + + Instantiated via KijiTable.openTableWriter() +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voiddeleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voiddeleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voiddeleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voiddeleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +deleteRow

            +
            +void deleteRow(EntityId entityId)
+               throws IOException
            +
            +
            Deletes an entire row. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteRow

            +
            +void deleteRow(EntityId entityId,
+               long upToTimestamp)
+               throws IOException
            +
            +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +void deleteFamily(EntityId entityId,
+                  String family)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a family. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +void deleteFamily(EntityId entityId,
+                  String family,
+                  long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +void deleteColumn(EntityId entityId,
+                  String family,
+                  String qualifier)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a column. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +void deleteColumn(EntityId entityId,
+                  String family,
+                  String qualifier,
+                  long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +void deleteCell(EntityId entityId,
+                String family,
+                String qualifier)
+                throws IOException
            +
            +
            Deletes the most recent version of the cell in a column. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +void deleteCell(EntityId entityId,
+                String family,
+                String qualifier,
+                long timestamp)
+                throws IOException
            +
            +
            Deletes a single cell with a specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            timestamp - The timestamp of the cell to delete (use HConstants.LATEST_TIMESTAMP + to delete the most recent cell in the column). +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiIncrementer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiIncrementer.html new file mode 100644 index 00000000..1d039776 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiIncrementer.html @@ -0,0 +1,258 @@ + + + + + + + +KijiIncrementer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiIncrementer

            +
            +
            All Superinterfaces:
            Closeable, Flushable
            +
            +
            +
            All Known Subinterfaces:
            KijiTableWriter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Framework
+public interface KijiIncrementer
            extends Closeable, Flushable
            + + +

            +Interface for performing increments on a Kiji table. + + Instantiated via KijiTable.openTableWriter() +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + KijiCounterincrement(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +increment

            +
            +KijiCounter increment(EntityId entityId,
+                      String family,
+                      String qualifier,
+                      long amount)
+                      throws IOException
            +
            +
            Atomically increments a counter in a kiji table. + +

            Throws an exception if the specified column is not a counter.

            +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row containing the counter.
            family - Column family.
            qualifier - Column qualifier.
            amount - Amount to increment the counter (may be negative). +
            Returns:
            the new counter value, post increment. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiInstaller.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiInstaller.html new file mode 100644 index 00000000..322fffcb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiInstaller.html @@ -0,0 +1,318 @@ + + + + + + + +KijiInstaller (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiInstaller

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiInstaller
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiInstaller
            extends Object
            + + +

            +Installs or uninstalls Kiji instances from an HBase cluster. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidinstall(KijiURI uri, + Configuration conf) + +
            +          Installs the specified Kiji instance.
            +static voidinstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            +static voiduninstall(KijiURI uri, + Configuration conf) + +
            +          Uninstalls the specified Kiji instance.
            +static voiduninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +install

            +
            +public static void install(KijiURI uri,
+                           Configuration conf)
+                    throws IOException,
+                           KijiInvalidNameException
            +
            +
            Installs the specified Kiji instance. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to install.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error. +
            KijiInvalidNameException - if the Kiji instance name is invalid or already exists.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(KijiURI uri,
+                             Configuration conf)
+                      throws IOException
            +
            +
            Uninstalls the specified Kiji instance. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to uninstall.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +install

            +
            +public static void install(KijiURI uri,
+                           HBaseFactory hbaseFactory,
+                           Configuration conf)
+                    throws IOException,
+                           KijiInvalidNameException
            +
            +
            Installs a Kiji instance. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to install.
            hbaseFactory - Factory for HBase instances.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error. +
            KijiInvalidNameException - if the instance name is invalid or already exists.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(KijiURI uri,
+                             HBaseFactory hbaseFactory,
+                             Configuration conf)
+                      throws IOException
            +
            +
            Removes a kiji instance from the HBase cluster including any user tables. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to install.
            hbaseFactory - Factory for HBase instances.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiInvalidNameException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiInvalidNameException.html new file mode 100644 index 00000000..9062fe94 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiInvalidNameException.html @@ -0,0 +1,250 @@ + + + + + + + +KijiInvalidNameException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiInvalidNameException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.KijiInvalidNameException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiInvalidNameException
            extends Exception
            + + +

            +Thrown when a Kiji instance or table layout name is invalid. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiInvalidNameException(String message) + +
            +          Creates a new KijiInvalidNameException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiInvalidNameException

            +
            +public KijiInvalidNameException(String message)
            +
            +
            Creates a new KijiInvalidNameException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiManagedHBaseTableName.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiManagedHBaseTableName.html new file mode 100644 index 00000000..d8e8c9c6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiManagedHBaseTableName.html @@ -0,0 +1,608 @@ + + + + + + + +KijiManagedHBaseTableName (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiManagedHBaseTableName

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiManagedHBaseTableName
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiManagedHBaseTableName
            extends Object
            + + +

            +

            Multiple instances of Kiji can be installed on a single HBase + cluster. Within a Kiji instance, several HBase tables are created + to manage system, metadata, schemas, and user-space tables. This + class represents the name of one of those HBase tables that are + created and managed by Kiji.

            + +

            + The names of tables in HBase created and managed by Kiji are + made of a list of delimited components. There are at least 3 + components of a name: + +

              +
            1. + Prefix: a literal string "kiji" used to mark that this table + is managed by Kiji. +
              2. +
            2. + KijiInstance: the name of kiji instance managing this table. +
              3. +
            3. + Type: the type of table (system, schema, meta, table). +
              4. +
            + + If the type of the table is "table", then it's name (the name users + of Kiji would use to refer to it) is the fourth and final component. +

            + +

            + For example, an HBase cluster might have the following tables: + 

            + devices
+ kiji.default.meta
+ kiji.default.schema
+ kiji.default.schema_hash
+ kiji.default.schema_id
+ kiji.default.system
+ kiji.default.table.foo
+ kiji.default.table.bar
+ kiji.experimental.meta
+ kiji.experimental.schema
+ kiji.experimental.schema_hash
+ kiji.experimental.schema_id
+ kiji.experimental.system
+ kiji.experimental.table.baz
+
            + + In this example, there is an HBase table completely unrelated to + kiji called "devices." There are two kiji installations, once + called "default" and another called "experimental." Within the + "default" installation, there are two Kiji tables, "foo" and + "bar." Within the "experimental" installation, there is a single + Kiji table "baz." +

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringKIJI_COMPONENT + +
            +          The first component of all HBase table names managed by Kiji.
            +static PatternKIJI_SYSTEM_TABLES_REGEX + +
            +          Regexp matching Kiji system tables.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +           
            +static KijiManagedHBaseTableNameget(String hbaseTableName) + +
            +          Constructs using an HBase HTable name.
            + StringgetKijiInstanceName() + +
            +          Gets the name of the Kiji instance this named table belongs to.
            + StringgetKijiTableName() + +
            +          Gets the name of the Kiji table.
            +static KijiManagedHBaseTableNamegetKijiTableName(String kijiInstanceName, + String kijiTableName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table.
            +static KijiManagedHBaseTableNamegetMetaTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table.
            +static KijiManagedHBaseTableNamegetSchemaHashTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table.
            +static KijiManagedHBaseTableNamegetSchemaIdTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table.
            +static KijiManagedHBaseTableNamegetSchemaV5TableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table.
            +static KijiManagedHBaseTableNamegetSystemTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table.
            + inthashCode() + +
            +           
            + byte[]toBytes() + +
            +          Gets the name of the HBase table that stores the data for this Kiji table.
            + StringtoString() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +KIJI_COMPONENT

            +
            +public static final String KIJI_COMPONENT
            +
            +
            The first component of all HBase table names managed by Kiji. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_SYSTEM_TABLES_REGEX

            +
            +public static final Pattern KIJI_SYSTEM_TABLES_REGEX
            +
            +
            Regexp matching Kiji system tables. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiManagedHBaseTableName get(String hbaseTableName)
+                                     throws NotAKijiManagedTableException
            +
            +
            Constructs using an HBase HTable name. +

            +

            +
            Parameters:
            hbaseTableName - The HBase HTable name. +
            Returns:
            A new kiji-managed HBase table name. +
            Throws: +
            NotAKijiManagedTableException - If the HBase table is not managed by kiji.
            +
            +
            +
            + +

            +getMetaTableName

            +
            +public static KijiManagedHBaseTableName getMetaTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji meta table.
            +
            +
            +
            + +

            +getSchemaV5TableName

            +
            +public static KijiManagedHBaseTableName getSchemaV5TableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji schema table up until layout v5.
            +
            +
            +
            + +

            +getSchemaHashTableName

            +
            +public static KijiManagedHBaseTableName getSchemaHashTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji schema hash table.
            +
            +
            +
            + +

            +getSchemaIdTableName

            +
            +public static KijiManagedHBaseTableName getSchemaIdTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji schema IDs table.
            +
            +
            +
            + +

            +getSystemTableName

            +
            +public static KijiManagedHBaseTableName getSystemTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji system table.
            +
            +
            +
            + +

            +getKijiTableName

            +
            +public static KijiManagedHBaseTableName getKijiTableName(String kijiInstanceName,
+                                                         String kijiTableName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance.
            kijiTableName - The name of the user-space Kiji table. +
            Returns:
            The name of the HBase table used to store the user-space Kiji table.
            +
            +
            +
            + +

            +getKijiInstanceName

            +
            +public String getKijiInstanceName()
            +
            +
            Gets the name of the Kiji instance this named table belongs to. +

            +

            + +
            Returns:
            The name of the kiji instance.
            +
            +
            +
            + +

            +getKijiTableName

            +
            +public String getKijiTableName()
            +
            +
            Gets the name of the Kiji table. +

            +

            + +
            Returns:
            The name of the kiji table, or null if this is not a user-space Kiji table.
            +
            +
            +
            + +

            +toBytes

            +
            +public byte[] toBytes()
            +
            +
            Gets the name of the HBase table that stores the data for this Kiji table. +

            +

            + +
            Returns:
            The HBase table name as a UTF-8 encoded byte array.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiMetaTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiMetaTable.html new file mode 100644 index 00000000..2fb9ce6e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiMetaTable.html @@ -0,0 +1,411 @@ + + + + + + + +KijiMetaTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiMetaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiMetaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTableKeyValueDatabase, KijiTableLayoutDatabase
            +
            +
            +
            Direct Known Subclasses:
            HBaseMetaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+public abstract class KijiMetaTable
            extends Object
            implements Closeable, KijiTableLayoutDatabase, KijiTableKeyValueDatabase
            + + +

            +The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis. +

            + +

            +

            +
            See Also:
            KijiSchemaTable, +KijiSystemTable
            +
            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected KijiMetaTable() + +
            +          Creates a new KijiMetaTable instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +abstract  voiddeleteTable(String table) + +
            +          Remove all metadata, including layouts, for a particular table.
            +protected  voidfinalize() + +
            +          
            +abstract  voidfromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            +abstract  Map<String,TableBackup>toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.layout.KijiTableLayoutDatabase
            getTableLayout, getTableLayoutVersions, getTimedTableLayoutVersions, layoutsFromBackup, layoutsToBackup, listTables, removeAllTableLayoutVersions, removeRecentTableLayoutVersions, updateTableLayout
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiTableKeyValueDatabase
            getTimedValues, getValue, getValues, keySet, keyValuesFromBackup, keyValuesToBackup, putValue, removeAllValues, removeValues, tableSet
            +  +

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

            +KijiMetaTable

            +
            +protected KijiMetaTable()
            +
            +
            Creates a new KijiMetaTable instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +deleteTable

            +
            +public abstract void deleteTable(String table)
+                          throws IOException
            +
            +
            Remove all metadata, including layouts, for a particular table. +

            +

            +
            +
            +
            +
            Parameters:
            table - The name of the kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +toBackup

            +
            +public abstract Map<String,TableBackup> toBackup()
+                                          throws IOException
            +
            +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            +
            +
            + +
            Returns:
            A map from table names to TableBackup records. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public abstract void fromBackup(Map<String,TableBackup> backup)
+                         throws IOException
            +
            +
            Restores metadata from a backup record. This consists of table layouts, schemas, and user + defined key-value pairs. +

            +

            +
            +
            +
            +
            Parameters:
            backup - A map from table name to table backup record. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiNotInstalledException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiNotInstalledException.html new file mode 100644 index 00000000..ab3d3994 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiNotInstalledException.html @@ -0,0 +1,284 @@ + + + + + + + +KijiNotInstalledException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiNotInstalledException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiNotInstalledException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiNotInstalledException
            extends RuntimeException
            + + +

            +Thrown when attempting to open a non existing/not installed Kiji instance. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiNotInstalledException(String message, + String instanceName) + +
            +          Creates a new KijiNotInstalledException with the specified + detail message.
            +  + + + + + + + + + + + +
            +Method Summary
            + StringgetInstanceName() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiNotInstalledException

            +
            +public KijiNotInstalledException(String message,
+                                 String instanceName)
            +
            +
            Creates a new KijiNotInstalledException with the specified + detail message. +

            +

            +
            Parameters:
            message - The exception message.
            instanceName - the Kiji instance name that is not installed.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getInstanceName

            +
            +public String getInstanceName()
            +
            +
            + +
            Returns:
            the name of the missing Kiji instance.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiPutter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiPutter.html new file mode 100644 index 00000000..3cad3fbc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiPutter.html @@ -0,0 +1,304 @@ + + + + + + + +KijiPutter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiPutter

            +
            +
            All Superinterfaces:
            Closeable, Flushable
            +
            +
            +
            All Known Subinterfaces:
            KijiTableWriter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Framework
+public interface KijiPutter
            extends Closeable, Flushable
            + + +

            +Interface for performing puts on a Kiji table. + + Instantiated via KijiTable.openTableWriter() +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +put

            +
            +<T> void put(EntityId entityId,
+             String family,
+             String qualifier,
+             T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +put

            +
            +<T> void put(EntityId entityId,
+             String family,
+             String qualifier,
+             long timestamp,
+             T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            timestamp - Timestamp, in millisecond since the Epoch.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiRowData.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiRowData.html new file mode 100644 index 00000000..f8e90645 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiRowData.html @@ -0,0 +1,821 @@ + + + + + + + +KijiRowData (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiRowData

            +
            +
            All Known Implementing Classes:
            HBaseKijiRowData
            +
            +
            +
            +
            @ApiAudience.Public
+public interface KijiRowData
            + + +

            +The input data for a single entity in Kiji. Implementations should be thread-safe. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleancontainsColumn(String family) + +
            +          Determines whether a particular column family has any data in this row.
            + booleancontainsColumn(String family, + String qualifier) + +
            +          Determines whether a particular column has data in this row.
            + + + + + +
            +<T> KijiCell<T>
            +            		getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		getCells(String family) + +
            +          Gets all the timestamp-cell pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		getCells(String family, + String qualifier) + +
            +          Gets all the timestamp-cell pairs stored within the specified cell.
            + KijiCountergetCounter(String family, + String qualifier) + +
            +          Gets the most recent counter from a column.
            + KijiCountergetCounter(String family, + String qualifier, + long timestamp) + +
            +          Reads a counter as it was at a particular timestamp.
            + EntityIdgetEntityId() + +
            +          Gets the entity id for this row of kiji data.
            + + + + + +
            +<T> KijiCell<T>
            +            		getMostRecentCell(String family, + String qualifier) + +
            +          Gets the latest version of the specified cell.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		getMostRecentCells(String family) + +
            +          Gets the latest version of the specified cell.
            + + + + + +
            +<T> T
            +            		getMostRecentValue(String family, + String qualifier) + +
            +          Gets the value with the latest timestamp stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,T>
            +            		getMostRecentValues(String family) + +
            +          Gets the value with the latest timestamp stored within the specified cell.
            + NavigableSet<String>getQualifiers(String family) + +
            +          Gets the set of column qualifiers that exist in a family.
            + org.apache.avro.SchemagetReaderSchema(String family, + String qualifier) + +
            +          Gets the reader schema for a column as declared in the layout of the table this row + comes from.
            + NavigableSet<Long>getTimestamps(String family, + String qualifier) + +
            +          Gets the set of timestamps on cells that exist in a column.
            + + + + + +
            +<T> T
            +            		getValue(String family, + String qualifier, + long timestamp) + +
            +          Gets the value stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,T>>
            +            		getValues(String family) + +
            +          Gets all the timestamp-value pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,T>
            +            		getValues(String family, + String qualifier) + +
            +          Gets all the timestamp-value pairs stored within the specified cell.
            + booleannextPage(String family) + +
            +          Populates the next page of cells for a requested column family.
            + booleannextPage(String family, + String qualifier) + +
            +          Populates the next page of cells for a column.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEntityId

            +
            +EntityId getEntityId()
            +
            +
            Gets the entity id for this row of kiji data. +

            +

            + +
            Returns:
            The row key.
            +
            +
            +
            + +

            +containsColumn

            +
            +boolean containsColumn(String family,
+                       String qualifier)
            +
            +
            Determines whether a particular column has data in this row. +

            +

            +
            Parameters:
            family - A column family.
            qualifier - A column qualifier. +
            Returns:
            Whether the column has data in this row.
            +
            +
            +
            + +

            +containsColumn

            +
            +boolean containsColumn(String family)
            +
            +
            Determines whether a particular column family has any data in this row. +

            +

            +
            Parameters:
            family - A column family. +
            Returns:
            Whether the family has data in this row.
            +
            +
            +
            + +

            +getQualifiers

            +
            +NavigableSet<String> getQualifiers(String family)
            +
            +
            Gets the set of column qualifiers that exist in a family. +

            +

            +
            Parameters:
            family - A column family name. +
            Returns:
            The set of column qualifiers that exist in family.
            +
            +
            +
            + +

            +getTimestamps

            +
            +NavigableSet<Long> getTimestamps(String family,
+                                 String qualifier)
            +
            +
            Gets the set of timestamps on cells that exist in a column. + +

            If iterating over the set, you will get items in order of decreasing timestamp.

            +

            +

            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The set of all timestamps of cells in the family:qualifier column.
            +
            +
            +
            + +

            +getReaderSchema

            +
            +org.apache.avro.Schema getReaderSchema(String family,
+                                       String qualifier)
+                                       throws IOException
            +
            +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +

            +

            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The Avro reader schema for the column. +
            Throws: +
            IOException - If there is an error or the column does not exist.
            +
            +
            +
            + +

            +getCounter

            +
            +KijiCounter getCounter(String family,
+                       String qualifier)
+                       throws IOException
            +
            +
            Gets the most recent counter from a column. + +

            Only columns that have been declared with <schema type="counter"/> may be + read using this method, otherwise an exception is thrown.

            +

            +

            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The most recent counter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCounter

            +
            +KijiCounter getCounter(String family,
+                       String qualifier,
+                       long timestamp)
+                       throws IOException
            +
            +
            Reads a counter as it was at a particular timestamp. + +

            Only columns that have been declared with <schema type="counter"/> may be + read using this method, otherwise an exception is thrown.

            +

            +

            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            The counter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValue

            +
            +<T> T getValue(String family,
+               String qualifier,
+               long timestamp)
+           throws IOException
            +
            +
            Gets the value stored within the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. Use #containsColumn() to distinguish between this scenarios. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValue

            +
            +<T> T getMostRecentValue(String family,
+                         String qualifier)
+                     throws IOException
            +
            +
            Gets the value with the latest timestamp stored within the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValues

            +
            +<T> NavigableMap<String,T> getMostRecentValues(String family)
+                                           throws IOException
            +
            +
            Gets the value with the latest timestamp stored within the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +<T> NavigableMap<String,NavigableMap<Long,T>> getValues(String family)
+                                                    throws IOException
            +
            +
            Gets all the timestamp-value pairs stored within the specified family. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            A sorted map containing the values stored in the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +<T> NavigableMap<Long,T> getValues(String family,
+                                   String qualifier)
+                               throws IOException
            +
            +
            Gets all the timestamp-value pairs stored within the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            A sorted map containing the values stored in the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCell

            +
            +<T> KijiCell<T> getCell(String family,
+                        String qualifier,
+                        long timestamp)
+                    throws IOException
            +
            +
            Gets the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            the specified cell, or null if the cell does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCell

            +
            +<T> KijiCell<T> getMostRecentCell(String family,
+                                  String qualifier)
+                              throws IOException
            +
            +
            Gets the latest version of the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            the most recent version of the specified cell, or null if the cell does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCells

            +
            +<T> NavigableMap<String,KijiCell<T>> getMostRecentCells(String family)
+                                                    throws IOException
            +
            +
            Gets the latest version of the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            a map from qualifier to the most recent versions of the cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>> getCells(String family)
+                                                             throws IOException
            +
            +
            Gets all the timestamp-cell pairs stored within the specified family. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            A sorted map versions of the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +<T> NavigableMap<Long,KijiCell<T>> getCells(String family,
+                                            String qualifier)
+                                        throws IOException
            +
            +
            Gets all the timestamp-cell pairs stored within the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            A sorted map versions of the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +nextPage

            +
            +boolean nextPage(String family,
+                 String qualifier)
+                 throws IOException
            +
            +
            Populates the next page of cells for a column. + +

            If there are cells remaining, this KijiRowData object is populated with the next + page of cells for the requested column and the method returns true. Otherwise, data + from the column's previous page is removed, and this method returns false. This + method throws an IOException if the column does not have paging enabled in the + KijiDataRequest.

            +

            +

            +
            Parameters:
            family - A column family.
            qualifier - A column qualifier. +
            Returns:
            Whether a new page of cells has been fetched. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +nextPage

            +
            +boolean nextPage(String family)
+                 throws IOException
            +
            +
            Populates the next page of cells for a requested column family. + +

            If there are cells remaining, this KijiRowData object is populated with the next + page of cells for the requested family and the method returns true. Otherwise, data + from the family's previous page is removed, and this method returns false. This + method throws an IOException if the column does not have paging enabled in the + KijiDataRequest.

            + +

            An IOException is thrown if this method is called on a family that was not + requested explicitly in the KijiDataRequest. For example, consider the following: + + 

            +   new KijiDataRequest()
+       .addColumn(new KijiDataRequest.Column("foo").withPageSize(10))
+       .addColumn(new KijiDataRequest.Column("bar", "baz").withPageSize(10));
+
            + + It would be valid to call nextPage("foo"), but calling nextPage("bar") would throw an + IOException, since paging was not enabled on the entire "bar" family.

            +

            +

            +
            Parameters:
            family - A column family. +
            Returns:
            Whether a new page of cells has been fetched. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiRowKeySplitter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiRowKeySplitter.html new file mode 100644 index 00000000..f5009f68 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiRowKeySplitter.html @@ -0,0 +1,267 @@ + + + + + + + +KijiRowKeySplitter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiRowKeySplitter

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiRowKeySplitter
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiRowKeySplitter
            extends Object
            + + +

            +Utility class for splitting the Kiji row key space. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static intHBASE_ROW_KEY_RESOLUTION + +
            +          Resolution (in number of bytes) when generating evenly spaced HBase row keys.
            +  + + + + + + + + + + + +
            +Method Summary
            +static byte[][]getSplitKeys(int numRegions) + +
            +          Returns the split keys for the given number of regions.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +HBASE_ROW_KEY_RESOLUTION

            +
            +public static final int HBASE_ROW_KEY_RESOLUTION
            +
            +
            Resolution (in number of bytes) when generating evenly spaced HBase row keys. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getSplitKeys

            +
            +public static byte[][] getSplitKeys(int numRegions)
            +
            +
            Returns the split keys for the given number of regions. This assumes that the keys are + byte strings of size HBASE_ROW_KEY_RESOLUTION. +

            +

            +
            Parameters:
            numRegions - The number of desired regions. +
            Returns:
            The row keys that serve as the boundaries between the regions.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiRowScanner.html new file mode 100644 index 00000000..f8666cfe --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiRowScanner.html @@ -0,0 +1,253 @@ + + + + + + + +KijiRowScanner (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiRowScanner

            +
            +
            All Superinterfaces:
            Closeable, Iterable<KijiRowData>
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiRowScanner
            +
            +
            +
            +
            @ApiAudience.Public
+public interface KijiRowScanner
            extends Closeable, Iterable<KijiRowData>
            + + +

            +Interface for scanning over rows read from a Kiji table. + +

            Because this class implements the Iterable interface, you can write code like this: + + 

            +   KijiRowScanner scanner = tableReader.getScanner(...);
+   try {
+     for (KijiRowData row : scanner) {
+       process(row);
+     }
+   } finally {
+     // Don't forget to close it!
+     scanner.close();
+   }
+
            +

            +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Closes this scanner and releases any system resources associated with it.
            +  + + + + + + + +
            Methods inherited from interface java.lang.Iterable
            iterator
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +close

            +
            +void close()
+           throws IOException
            +
            +
            Closes this scanner and releases any system resources associated with it. + +

            Calling this method when you are finished with the scanner is important. + See http://hbase.apache.org/book.html#perf.hbase.client.scannerclose for details.

            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException - If an I/O error occurs.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiSchemaTable.SchemaEntry.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiSchemaTable.SchemaEntry.html new file mode 100644 index 00000000..201de114 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiSchemaTable.SchemaEntry.html @@ -0,0 +1,382 @@ + + + + + + + +KijiSchemaTable.SchemaEntry (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiSchemaTable.SchemaEntry

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSchemaTable.SchemaEntry
+
            +
            +
            Enclosing class:
            KijiSchemaTable
            +
            +
            +
            +
            public static class KijiSchemaTable.SchemaEntry
            extends Object
            + + +

            +Association between a schema and its ID. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiSchemaTable.SchemaEntry(long id, + BytesKey hash, + org.apache.avro.Schema schema) + +
            +          Creates a new schema entry.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            + BytesKeygetHash() + +
            +           
            + longgetId() + +
            +           
            + org.apache.avro.SchemagetSchema() + +
            +           
            + inthashCode() + +
            +          
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiSchemaTable.SchemaEntry

            +
            +@ApiAudience.Private
+public KijiSchemaTable.SchemaEntry(long id,
+                                                       BytesKey hash,
+                                                       org.apache.avro.Schema schema)
            +
            +
            Creates a new schema entry. +

            +

            +
            Parameters:
            id - the schema ID
            hash - the schema hash
            schema - the Avro schema object
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public long getId()
            +
            +
            + +
            Returns:
            the schema ID
            +
            +
            +
            + +

            +getHash

            +
            +public BytesKey getHash()
            +
            +
            + +
            Returns:
            the schema hash
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            + +
            Returns:
            the Avro schema object
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiSchemaTable.html new file mode 100644 index 00000000..09b58f88 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiSchemaTable.html @@ -0,0 +1,549 @@ + + + + + + + +KijiSchemaTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiSchemaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSchemaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Direct Known Subclasses:
            HBaseSchemaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+public abstract class KijiSchemaTable
            extends Object
            implements Closeable
            + + +

            +The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas. +

            + +

            +

            +
            See Also:
            KijiMetaTable, +KijiSystemTable
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiSchemaTable.SchemaEntry + +
            +          Association between a schema and its ID.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiSchemaTable() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  voidclose() + +
            +          Flushes and closes the KijiSchemaTable.
            + voidflush() + +
            +          Commits any pending additions to the schema table.
            +abstract  voidfromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            +abstract  BytesKeygetOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            +abstract  longgetOrCreateSchemaId(org.apache.avro.Schema schema) + +
            +          Looks up a schema ID given an Avro schema object.
            +abstract  org.apache.avro.SchemagetSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            +abstract  org.apache.avro.SchemagetSchema(long schemaId) + +
            +          Looks up a schema given an ID.
            + BytesKeygetSchemaHash(org.apache.avro.Schema schema) + +
            +          Computes a schema hash.
            +static byte[]hashSchema(org.apache.avro.Schema schema) + +
            +          Computes a hash of the specified Avro schema.
            +abstract  List<SchemaTableEntry>toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiSchemaTable

            +
            +public KijiSchemaTable()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getOrCreateSchemaId

            +
            +public abstract long getOrCreateSchemaId(org.apache.avro.Schema schema)
+                                  throws IOException
            +
            +
            Looks up a schema ID given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            +
            +
            +
            Parameters:
            schema - The full schema to store in the table. +
            Returns:
            The schema ID. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getOrCreateSchemaHash

            +
            +public abstract BytesKey getOrCreateSchemaHash(org.apache.avro.Schema schema)
+                                        throws IOException
            +
            +
            Looks up a schema hash given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            +
            +
            +
            Parameters:
            schema - Avro schema to look up. +
            Returns:
            The schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getSchemaHash

            +
            +public BytesKey getSchemaHash(org.apache.avro.Schema schema)
            +
            +
            Computes a schema hash. +

            +

            +
            +
            +
            +
            Parameters:
            schema - Avro schema to compute a hash for. +
            Returns:
            Schema hash.
            +
            +
            +
            + +

            +getSchema

            +
            +public abstract org.apache.avro.Schema getSchema(long schemaId)
+                                          throws IOException
            +
            +
            Looks up a schema given an ID. +

            +

            +
            +
            +
            +
            Parameters:
            schemaId - Schema ID to look up. +
            Returns:
            Avro schema, or null if the schema ID is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getSchema

            +
            +public abstract org.apache.avro.Schema getSchema(BytesKey schemaHash)
+                                          throws IOException
            +
            +
            Looks up a schema given a hash. +

            +

            +
            +
            +
            +
            Parameters:
            schemaHash - Schema hash to look up. +
            Returns:
            Avro schema, or null if the schema hash is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +hashSchema

            +
            +public static final byte[] hashSchema(org.apache.avro.Schema schema)
            +
            +
            Computes a hash of the specified Avro schema. + + Kiji currently uses MD5 sums (128 bits) of the schema JSON representation. +

            +

            +
            +
            +
            +
            Parameters:
            schema - Avro schema to compute a hash of. +
            Returns:
            Hash code as an array of bytes (16 bytes).
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            Commits any pending additions to the schema table. + + Default implementation is blank as flushing is not generally a vital operation +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +close

            +
            +public abstract void close()
+                    throws IOException
            +
            +
            Flushes and closes the KijiSchemaTable. No other methods may be called after this. +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +toBackup

            +
            +public abstract List<SchemaTableEntry> toBackup()
+                                         throws IOException
            +
            +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            +
            +
            + +
            Returns:
            A list of schema table entries. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public abstract void fromBackup(List<SchemaTableEntry> backup)
+                         throws IOException
            +
            +
            Restores the schema entries from the specified backup record. +

            +

            +
            +
            +
            +
            Parameters:
            backup - The schema entries from a MetadataBackup record. This consist of the schema + definition, schema id, and schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiSystemTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiSystemTable.html new file mode 100644 index 00000000..bee5e694 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiSystemTable.html @@ -0,0 +1,374 @@ + + + + + + + +KijiSystemTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiSystemTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSystemTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Direct Known Subclasses:
            HBaseSystemTable
            +
            +
            +
            +
            @ApiAudience.Framework
+public abstract class KijiSystemTable
            extends Object
            implements Closeable
            + + +

            +The Kiji system table, which stores system information such as the version, ready state, and + locks. +

            + +

            +

            +
            See Also:
            KijiMetaTable, +KijiSystemTable
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiSystemTable() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  StringgetDataVersion() + +
            +          Gets the version of kiji installed.
            +abstract  byte[]getValue(String key) + +
            +          Gets the value associated with a property key.
            +abstract  voidputValue(String key, + byte[] value) + +
            +          Sets a value for a property key, which creates it if it doesn't exist.
            +abstract  voidsetDataVersion(String version) + +
            +          Sets the version of kiji installed.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

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

            +KijiSystemTable

            +
            +public KijiSystemTable()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataVersion

            +
            +public abstract String getDataVersion()
+                               throws IOException
            +
            +
            Gets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            +
            +
            + +
            Returns:
            the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +setDataVersion

            +
            +public abstract void setDataVersion(String version)
+                             throws IOException
            +
            +
            Sets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            +
            +
            +
            Parameters:
            version - the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValue

            +
            +public abstract byte[] getValue(String key)
+                         throws IOException
            +
            +
            Gets the value associated with a property key. +

            +

            +
            +
            +
            +
            Parameters:
            key - The property key to look up. +
            Returns:
            The value in the system table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public abstract void putValue(String key,
+                              byte[] value)
+                       throws IOException
            +
            +
            Sets a value for a property key, which creates it if it doesn't exist. +

            +

            +
            +
            +
            +
            Parameters:
            key - The property key to set.
            value - The value of the property. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTable.html new file mode 100644 index 00000000..b5d4da33 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTable.html @@ -0,0 +1,385 @@ + + + + + + + +KijiTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTable

            +
            +
            All Superinterfaces:
            Closeable
            +
            +
            +
            All Known Implementing Classes:
            AbstractKijiTable, HBaseKijiTable
            +
            +
            +
            +
            @ApiAudience.Public
+public interface KijiTable
            extends Closeable
            + + +

            +Interface for Kiji Tables. + + Instantiated from KijiTableFactory.openTable(String) +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + EntityIdgetEntityId(String kijiRowKey) + +
            +          Creates an entity ID for the specified UTF8 encoded Kiji row key.
            + EntityIdFactorygetEntityIdFactory() + +
            +           
            + KijigetKiji() + +
            +           
            + KijiTableLayoutgetLayout() + +
            +           
            + StringgetName() + +
            +           
            + KijiTableReaderopenTableReader() + +
            +          Opens an appropriate implementation of KijiTableReader for this table.
            + KijiTableWriteropenTableWriter() + +
            +          Opens an appropriate implementation of KijiTableWriter for this table.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getKiji

            +
            +Kiji getKiji()
            +
            +
            +
            +
            +
            + +
            Returns:
            the Kiji instance this table belongs to.
            +
            +
            +
            + +

            +getName

            +
            +String getName()
            +
            +
            +
            +
            +
            + +
            Returns:
            the name of this table.
            +
            +
            +
            + +

            +getLayout

            +
            +KijiTableLayout getLayout()
            +
            +
            +
            +
            +
            + +
            Returns:
            the layout of this table.
            +
            +
            +
            + +

            +getEntityIdFactory

            +
            +EntityIdFactory getEntityIdFactory()
            +
            +
            +
            +
            +
            + +
            Returns:
            the entity ID factory for this table.
            +
            +
            +
            + +

            +getEntityId

            +
            +EntityId getEntityId(String kijiRowKey)
            +
            +
            Creates an entity ID for the specified UTF8 encoded Kiji row key. +

            +

            +
            +
            +
            +
            Parameters:
            kijiRowKey - UTF8 encoded Kiji row key. +
            Returns:
            a new entity ID for the specified Kiji row key.
            +
            +
            +
            + +

            +openTableReader

            +
            +KijiTableReader openTableReader()
+                                throws IOException
            +
            +
            Opens an appropriate implementation of KijiTableReader for this table. The caller is + responsible for closing this reader. +

            +

            +
            +
            +
            + +
            Returns:
            A KijiTableReader for this table. +
            Throws: +
            IOException - If there was an error opening the reader.
            +
            +
            +
            + +

            +openTableWriter

            +
            +KijiTableWriter openTableWriter()
+                                throws IOException
            +
            +
            Opens an appropriate implementation of KijiTableWriter for this table. The caller is + responsible for closing this writer. +

            +

            +
            +
            +
            + +
            Returns:
            A KijiTableWriter for this table. +
            Throws: +
            IOException - If there was an error opening the writer.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableFactory.html new file mode 100644 index 00000000..cf201e7d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableFactory.html @@ -0,0 +1,223 @@ + + + + + + + +KijiTableFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableFactory

            +
            +
            All Known Implementing Classes:
            DefaultKijiTableFactory, Kiji
            +
            +
            +
            +
            @ApiAudience.Public
+public interface KijiTableFactory
            + + +

            +Factory for KijiTable instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + KijiTableopenTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +openTable

            +
            +KijiTable openTable(String tableName)
+                    throws IOException
            +
            +
            Opens a KijiTable by name. + +

            Clients must take care to close the KijiTable instance when finished.

            +

            +

            +
            Parameters:
            tableName - Name of the table to open. +
            Returns:
            the opened Kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableKeyValueDatabase.html new file mode 100644 index 00000000..528cbf61 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableKeyValueDatabase.html @@ -0,0 +1,473 @@ + + + + + + + +KijiTableKeyValueDatabase (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableKeyValueDatabase

            +
            +
            All Known Implementing Classes:
            HBaseMetaTable, HBaseTableKeyValueDatabase, KijiMetaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+public interface KijiTableKeyValueDatabase
            + + +

            +A database of per table key-value pairs. This is used to store meta data (in the form of + key-value pairs) on a per table basis. +

            + +

            +

            +
            See Also:
            KijiMetaTable
            +
            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + NavigableMap<Long,byte[]>getTimedValues(String table, + String key, + int numVersions) + +
            +          Returns a map of values associated with the specified table and key.
            + byte[]getValue(String table, + String key) + +
            +          Returns the most recent value associated with the specified table and key.
            + List<byte[]>getValues(String table, + String key, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key.
            + Set<String>keySet(String table) + +
            +          Returns a set view of keys contained in the map for the specified table.
            + voidkeyValuesFromBackup(String table, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            + List<KeyValueBackupEntry>keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + KijiTableKeyValueDatabaseputValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + voidremoveAllValues(String table) + +
            +          Deletes all key-value pairs associated with the specified table.
            + voidremoveValues(String table, + String key) + +
            +          Removes all values associated with the specified table and key.
            + Set<String>tableSet() + +
            +          Returns a set view of the tables that have key-value pairs defined.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +putValue

            +
            +KijiTableKeyValueDatabase putValue(String table,
+                                   String key,
+                                   byte[] value)
+                                   throws IOException
            +
            +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +

            +

            +
            Parameters:
            table - The kiji table that this key-value pair will be set with.
            key - The key to associate with the specified value.
            value - The value to associate with the specified key. +
            Returns:
            The same KijiTableKeyValueDatabase. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValue

            +
            +byte[] getValue(String table,
+                String key)
+                throws IOException
            +
            +
            Returns the most recent value associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for. +
            Returns:
            The value in the meta table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +List<byte[]> getValues(String table,
+                       String key,
+                       int numVersions)
+                       throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +

            +

            +
            Parameters:
            table - The Kiji table.
            key - The key to look up associated values for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the values for the specified table and key, + sorted by most-recent-first. If there are no values, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedValues

            +
            +NavigableMap<Long,byte[]> getTimedValues(String table,
+                                         String key,
+                                         int numVersions)
+                                         throws IOException
            +
            +
            Returns a map of values associated with the specified table and key. The Map + is keyed by timestamp. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values that are the user defined values for the specified key + and table, and keys that correspond to timestamps, ordered from newest to oldest. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeValues

            +
            +void removeValues(String table,
+                  String key)
+                  throws IOException
            +
            +
            Removes all values associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table associated with the metadata.
            key - The metadata key to look up. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllValues

            +
            +void removeAllValues(String table)
+                     throws IOException
            +
            +
            Deletes all key-value pairs associated with the specified table. +

            +

            +
            Parameters:
            table - The table to delete remove key-value pairs for. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keySet

            +
            +Set<String> keySet(String table)
+                   throws IOException
            +
            +
            Returns a set view of keys contained in the map for the specified table. +

            +

            +
            Parameters:
            table - The table to look up in use keys for. +
            Returns:
            A navigable set of keys used to store meta information for a given table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +tableSet

            +
            +Set<String> tableSet()
+                     throws IOException
            +
            +
            Returns a set view of the tables that have key-value pairs defined. +

            +

            + +
            Returns:
            A set of tables that have key-value pairs defined. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesToBackup

            +
            +List<KeyValueBackupEntry> keyValuesToBackup(String table)
+                                            throws IOException
            +
            +
            Gets a list of the TableKeyValueBackupEntries. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableKeyValueBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesFromBackup

            +
            +void keyValuesFromBackup(String table,
+                         List<KeyValueBackupEntry> keyValues)
+                         throws IOException
            +
            +
            Restores all table's key value history from a backup. +

            +

            +
            Parameters:
            table - The name of the kiji table.
            keyValues - The key values associated with the table to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableNotFoundException.html new file mode 100644 index 00000000..9cae92d6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableNotFoundException.html @@ -0,0 +1,251 @@ + + + + + + + +KijiTableNotFoundException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTableNotFoundException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.KijiTableNotFoundException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableNotFoundException
            extends IOException
            + + +

            +Thrown when an attempt to access a table fails because it does not exist. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTableNotFoundException(String tableName) + +
            +          Creates a new KijiTableNotFoundException for the specified table.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiTableNotFoundException

            +
            +public KijiTableNotFoundException(String tableName)
            +
            +
            Creates a new KijiTableNotFoundException for the specified table. +

            +

            +
            Parameters:
            tableName - The name of the table that wasn't found.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTablePool.NoCapacityException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTablePool.NoCapacityException.html new file mode 100644 index 00000000..a68d4bee --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTablePool.NoCapacityException.html @@ -0,0 +1,254 @@ + + + + + + + +KijiTablePool.NoCapacityException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTablePool.NoCapacityException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.KijiTablePool.NoCapacityException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Enclosing class:
            KijiTablePool
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiTablePool.NoCapacityException
            extends IOException
            + + +

            +Thrown when an attempt to get a table connection fails because there is no room in the pool. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTablePool.NoCapacityException(String message) + +
            +          Creates a new NoCapacityException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiTablePool.NoCapacityException

            +
            +public KijiTablePool.NoCapacityException(String message)
            +
            +
            Creates a new NoCapacityException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTablePool.Options.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTablePool.Options.html new file mode 100644 index 00000000..60ddf68e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTablePool.Options.html @@ -0,0 +1,424 @@ + + + + + + + +KijiTablePool.Options (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTablePool.Options

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiTablePool.Options
+
            +
            +
            Enclosing class:
            KijiTablePool
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiTablePool.Options
            extends Object
            + + +

            +Describes the options that can be configured on the KijiTablePool. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTablePool.Options() + +
            +          Creates options with default values.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + ClockgetClock() + +
            +          Gets a clock.
            + longgetIdlePollPeriod() + +
            +          Gets the amount of time between sweeps of the pool for removing idle connections.
            + longgetIdleTimeout() + +
            +          Gets the amount of time a connection may be idle before being removed from the pool.
            + intgetMaxSize() + +
            +          Gets the maximum number of connections to keep per table.
            + KijiTablePool.OptionswithClock(Clock clock) + +
            +          Sets a clock.
            + KijiTablePool.OptionswithIdlePollPeriod(long periodMillis) + +
            +          Sets the amount of time between sweeps of the pool for removing idle connections.
            + KijiTablePool.OptionswithIdleTimeout(long timeoutMillis) + +
            +          Sets the amount of time a connection may be idle before being removed from the pool.
            + KijiTablePool.OptionswithMaxSize(int maxSize) + +
            +          Sets the maximum number of connections to keep per table.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTablePool.Options

            +
            +public KijiTablePool.Options()
            +
            +
            Creates options with default values. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +withMaxSize

            +
            +public KijiTablePool.Options withMaxSize(int maxSize)
            +
            +
            Sets the maximum number of connections to keep per table. + +

            Use zero(0) to indicate that the pool should be unbounded.

            +

            +

            +
            Parameters:
            maxSize - The max number of connections to keep per table. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getMaxSize

            +
            +public int getMaxSize()
            +
            +
            Gets the maximum number of connections to keep per table. +

            +

            + +
            Returns:
            The max number of connections to keep per table.
            +
            +
            +
            + +

            +withIdleTimeout

            +
            +public KijiTablePool.Options withIdleTimeout(long timeoutMillis)
            +
            +
            Sets the amount of time a connection may be idle before being removed from the pool. + +

            Use zero (0) to indicate that connections should never be removed.

            +

            +

            +
            Parameters:
            timeoutMillis - Timeout in milliseconds. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getIdleTimeout

            +
            +public long getIdleTimeout()
            +
            +
            Gets the amount of time a connection may be idle before being removed from the pool. +

            +

            + +
            Returns:
            The timeout in milliseconds.
            +
            +
            +
            + +

            +withIdlePollPeriod

            +
            +public KijiTablePool.Options withIdlePollPeriod(long periodMillis)
            +
            +
            Sets the amount of time between sweeps of the pool for removing idle connections. +

            +

            +
            Parameters:
            periodMillis - Number of milliseconds between sweeps. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getIdlePollPeriod

            +
            +public long getIdlePollPeriod()
            +
            +
            Gets the amount of time between sweeps of the pool for removing idle connections. +

            +

            + +
            Returns:
            Number of milliseconds between sweeps.
            +
            +
            +
            + +

            +withClock

            +
            +public KijiTablePool.Options withClock(Clock clock)
            +
            +
            Sets a clock. +

            +

            +
            Parameters:
            clock - A clock. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getClock

            +
            +public Clock getClock()
            +
            +
            Gets a clock. +

            +

            + +
            Returns:
            A clock.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTablePool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTablePool.html new file mode 100644 index 00000000..a6c5eecb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTablePool.html @@ -0,0 +1,427 @@ + + + + + + + +KijiTablePool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTablePool

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiTablePool
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTablePool
            extends Object
            implements Closeable
            + + +

            +Maintains a pool of opened KijiTables. + +

            Instead of creating a new KijiTable instance when needed, clients may use a + KijiTablePool to keep a pool of opened tables for reuse. When a client asks for a + KijiTable, the pool first checks the cache for an already opened and available + table. If available, the cached table will be returned. Otherwise, a new one will be + opened and returned. When the client is finished, it should call release() to allow + other clients or threads the option to reuse the opened table.

            + +

            This class is thread-safe.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTablePool.NoCapacityException + +
            +          Thrown when an attempt to get a table connection fails because there is no room in the pool.
            +static classKijiTablePool.Options + +
            +          Describes the options that can be configured on the KijiTablePool.
            +  + + + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiTablePool(Kiji kiji) + +
            +          Constructs a new pool of Kiji tables.
            KijiTablePool(KijiTableFactory tableFactory) + +
            +          Constructs a new pool of Kiji tables.
            KijiTablePool(KijiTableFactory tableFactory, + KijiTablePool.Options options) + +
            +          Constructs a new pool of Kiji tables.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Closes the tables in the pool.
            +protected  voidfinalize() + +
            +           
            + KijiTableget(String name) + +
            +          Gets a previously opened table from the pool, or open a new connection.
            + voidrelease(KijiTable table) + +
            +          Releases a table back to the pool.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTablePool

            +
            +public KijiTablePool(Kiji kiji)
            +
            +
            Constructs a new pool of Kiji tables. +

            +

            +
            Parameters:
            kiji - The kiji instance.
            +
            +
            + +

            +KijiTablePool

            +
            +public KijiTablePool(KijiTableFactory tableFactory)
            +
            +
            Constructs a new pool of Kiji tables. +

            +

            +
            Parameters:
            tableFactory - A KijiTable factory.
            +
            +
            + +

            +KijiTablePool

            +
            +public KijiTablePool(KijiTableFactory tableFactory,
+                     KijiTablePool.Options options)
            +
            +
            Constructs a new pool of Kiji tables. +

            +

            +
            Parameters:
            tableFactory - A KijiTable factory.
            options - Configurable options for the pool.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public KijiTable get(String name)
+              throws IOException
            +
            +
            Gets a previously opened table from the pool, or open a new connection. + Clients should not call close() on the returned table. Instead, they should release the + table back to the pool when finished by passing it in call to release(). +

            +

            +
            +
            +
            +
            Parameters:
            name - The name of the Kiji table. +
            Returns:
            An opened Kiji table. +
            Throws: +
            IOException - If there is an error. +
            KijiTablePool.NoCapacityException - If the table pool is at capacity.
            +
            +
            +
            + +

            +release

            +
            +public void release(KijiTable table)
            +
            +
            Releases a table back to the pool. + +

            Only open tables that were retrieved from this pool should be released.

            +

            +

            +
            +
            +
            +
            Parameters:
            table - The table to release to the pool. If null, will be a no-op.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            Closes the tables in the pool. +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException - If there is an error closing the pool.
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableReader.html new file mode 100644 index 00000000..42565247 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableReader.html @@ -0,0 +1,564 @@ + + + + + + + +KijiTableReader (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTableReader

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiTableReader
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Direct Known Subclasses:
            HBaseKijiTableReader
            +
            +
            +
            +
            @ApiAudience.Public
+public abstract class KijiTableReader
            extends Object
            implements Closeable
            + + +

            +Interface for reading data from a kiji table. + + Instantiated from KijiTable.openTableReader() +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected KijiTableReader(KijiTable table) + +
            +          Creates a reader over a kiji table.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  List<KijiRowData>bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + voidclose() + +
            +          
            +protected  voidfinalize() + +
            +          
            +abstract  KijiRowDataget(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiCellDecoderFactorygetKijiCellDecoderFactory() + +
            +          Gets the KijiCellDecoderFactory to use for decoding KijiCells.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow) + +
            +          Gets a KijiRowScanner using default options.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using the specified HBaseScanOptions.
            +abstract  KijiRowScannergetScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            + KijiTablegetTable() + +
            +          Gets the table this reads from.
            + voidsetKijiCellDecoderFactory(KijiCellDecoderFactory kijiCellDecoderFactory) + +
            +          Sets the KijiCellDecoderFactory to be used for retrieving a KijiCell.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableReader

            +
            +protected KijiTableReader(KijiTable table)
            +
            +
            Creates a reader over a kiji table. +

            +

            +
            Parameters:
            table - The kiji table to read from.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public abstract KijiRowData get(EntityId entityId,
+                                KijiDataRequest dataRequest)
+                         throws IOException
            +
            +
            Retrieves data from a single row in the kiji table. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - The entity id for the row to get data from.
            dataRequest - Specifies the columns of data to retrieve. +
            Returns:
            The requested data. If there is no row for the specified entityId, this + will return an empty KijiRowData. (containsColumn() will return false for all + columns.) +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +bulkGet

            +
            +public abstract List<KijiRowData> bulkGet(List<EntityId> entityIds,
+                                          KijiDataRequest dataRequest)
+                                   throws IOException
            +
            +
            Retrieves data from a list of rows in the kiji table. +

            +

            +
            +
            +
            +
            Parameters:
            entityIds - The list of entity ids to collect data for.
            dataRequest - Specifies constraints on the data to retrieve for each entity id. +
            Returns:
            The requested data. If an EntityId specified in entityIds + does not exist, then the corresponding KijiRowData will be empty. + If a get fails, then the corresponding KijiRowData will be null (instead of empty). +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +getTable

            +
            +public KijiTable getTable()
            +
            +
            Gets the table this reads from. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji table.
            +
            +
            +
            + +

            +getScanner

            +
            +public KijiRowScanner getScanner(KijiDataRequest dataRequest,
+                                 EntityId startRow,
+                                 EntityId stopRow)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner using default options. +

            +

            +
            +
            +
            +
            Parameters:
            dataRequest - Specifies the columns of data to retrieve.
            startRow - The entity id for the row to start the scan from. If null, the scanner + will read all rows up to the stopRow.
            stopRow - The entity id for the row to end the scan at. If null, the scanner will + read all rows after the startRow. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error. +
            KijiDataRequestException - If the data request is invalid.
            +
            +
            +
            + +

            +getScanner

            +
            +public KijiRowScanner getScanner(KijiDataRequest dataRequest,
+                                 EntityId startRow,
+                                 EntityId stopRow,
+                                 HBaseScanOptions scanOptions)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner using the specified HBaseScanOptions. +

            +

            +
            +
            +
            +
            Parameters:
            dataRequest - Specifies the columns of data to retrieve.
            startRow - The entity id for the row to start the scan from. If null, the scanner + will read all rows up to the stopRow.
            stopRow - The entity id for the row to end the scan at. If null, the scanner will + read all rows after the startRow.
            scanOptions - The custom scanner configuration to use. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error. +
            KijiDataRequestException - If the data request is invalid.
            +
            +
            +
            + +

            +getScanner

            +
            +public abstract KijiRowScanner getScanner(KijiDataRequest dataRequest,
+                                          EntityId startRow,
+                                          EntityId stopRow,
+                                          KijiRowFilter rowFilter,
+                                          HBaseScanOptions scanOptions)
+                                   throws IOException
            +
            +
            Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions. +

            +

            +
            +
            +
            +
            Parameters:
            dataRequest - Specifies the columns of data to retrieve.
            startRow - The entity id for the row to start the scan from. If null, the scanner + will read all rows up to the stopRow.
            stopRow - The entity id for the row to end the scan at. If null, the scanner will + read all rows after the startRow.
            rowFilter - The KijiRowFilter to filter these results on
            scanOptions - The custom scanner configuration to use. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error. +
            KijiDataRequestException - If the data request is invalid.
            +
            +
            +
            + +

            +getKijiCellDecoderFactory

            +
            +public KijiCellDecoderFactory getKijiCellDecoderFactory()
+                                                 throws IOException
            +
            +
            Gets the KijiCellDecoderFactory to use for decoding KijiCells. + + Defaults to SpecificCellDecoderFactory (creating it if necessary). + This behavior can be changed by calling + setKijiCellDecoderFactory(KijiCellDecoderFactory) + or overriding this method in a subclass. +

            +

            +
            +
            +
            + +
            Returns:
            The KijiCellDecoderFactory to be used when retrieving a KijiCell. +
            Throws: +
            IOException - if there is an error retrieving the KijiSchemaTable
            +
            +
            +
            + +

            +setKijiCellDecoderFactory

            +
            +public void setKijiCellDecoderFactory(KijiCellDecoderFactory kijiCellDecoderFactory)
            +
            +
            Sets the KijiCellDecoderFactory to be used for retrieving a KijiCell. +

            +

            +
            +
            +
            +
            Parameters:
            kijiCellDecoderFactory - the KijiCellDecoderFactory to use for decoding KijiCells.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableWriter.html new file mode 100644 index 00000000..44df52b6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiTableWriter.html @@ -0,0 +1,237 @@ + + + + + + + +KijiTableWriter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableWriter

            +
            +
            All Superinterfaces:
            Closeable, Flushable, KijiDeleter, KijiIncrementer, KijiPutter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Public
+public interface KijiTableWriter
            extends KijiPutter, KijiIncrementer, KijiDeleter
            + + +

            +Interface for modifying a Kiji table. + + Instantiated by calling KijiTable.openTableWriter() +

            + +

            +

            + +

            + + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiPutter
            put, put
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiIncrementer
            increment
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiDeleter
            deleteCell, deleteCell, deleteColumn, deleteColumn, deleteFamily, deleteFamily, deleteRow, deleteRow
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + +

            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiURI.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiURI.html new file mode 100644 index 00000000..af01290e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiURI.html @@ -0,0 +1,792 @@ + + + + + + + +KijiURI (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiURI

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiURI
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiURI
            extends Object
            + + +

            +URI that fully qualifies a Kiji instance/table/column. + Use "default" for the default Kiji instance. + + Valid URI forms look like: +

          • "kiji://zkHost" +
          • "kiji://zkHost/instance" +
          • "kiji://zkHost/instance/table" +
          • "kiji://zkHost:zkPort/instance/table" +
          • "kiji://zkHost1,zkHost2/instance/table" +
          • "kiji://(zkHost1,zkHost2):zkPort/instance/table" +
          • "kiji://zkHost/instance/table/col" +
          • "kiji://zkHost/instance/table/col1,col2" +
          • "kiji://.env/instance/table" +
          • "kiji://.unset/instance/table" +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static intDEFAULT_ZOOKEEPER_CLIENT_PORT + +
            +          Default Zookeeper port.
            +static StringENV_URI_STRING + +
            +          String to specify a value through the local environment.
            +static StringKIJI_SCHEME + +
            +          URI/URL scheme used to fully qualify a Kiji table.
            +static PatternRE_AUTHORITY_GROUP + +
            +          Pattern matching "(host1,host2,host3):port".
            +static StringUNSET_URI_STRING + +
            +          String to specify an unset KijiURI field.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            KijiURI(Iterable<String> zookeeperQuorum, + int zookeeperClientPort, + String instanceName, + String tableName, + Iterable<KijiColumnName> columnNames) + +
            +          Constructs a new KijiURI with the given parameters.
            KijiURI(URI uri) + +
            +          Constructs a URI that fully qualifies a Kiji table.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object object) + +
            +          
            + com.google.common.collect.ImmutableList<KijiColumnName>getColumn() + +
            +           
            + Collection<KijiColumnName>getColumnOrdered() + +
            +           
            + StringgetInstance() + +
            +           
            + StringgetTable() + +
            +           
            + intgetZookeeperClientPort() + +
            +           
            + com.google.common.collect.ImmutableList<String>getZookeeperQuorum() + +
            +           
            + com.google.common.collect.ImmutableList<String>getZookeeperQuorumOrdered() + +
            +           
            + inthashCode() + +
            +          
            +static KijiURIparse(String uri) + +
            +          Constructs a fully qualified Kiji table URI from a string.
            + KijiURIresolve(String path) + +
            +          Resolve the path relative to this KijiURI.
            + KijiURIsetColumnNames(Collection<String> columnNames) + +
            +          Creates a KijiURI with these column names added.
            + KijiURIsetInstanceName(String instanceName) + +
            +          Creates a new KijiURI with this instance name added.
            + KijiURIsetTableName(String tableName) + +
            +          Creates a KijiURI with this table name added.
            + KijiURIsetZookeeperQuorum(String[] quorum) + +
            +          Creates a new KijiURI with this zookeeper quorum.
            + StringtoOrderedString() + +
            +          Returns a string representation of this URI that preserves ordering of lists in fields, + such as the Zookeeper quorum and Kiji columns.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +KIJI_SCHEME

            +
            +public static final String KIJI_SCHEME
            +
            +
            URI/URL scheme used to fully qualify a Kiji table. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +UNSET_URI_STRING

            +
            +public static final String UNSET_URI_STRING
            +
            +
            String to specify an unset KijiURI field. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +ENV_URI_STRING

            +
            +public static final String ENV_URI_STRING
            +
            +
            String to specify a value through the local environment. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULT_ZOOKEEPER_CLIENT_PORT

            +
            +public static final int DEFAULT_ZOOKEEPER_CLIENT_PORT
            +
            +
            Default Zookeeper port. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +RE_AUTHORITY_GROUP

            +
            +public static final Pattern RE_AUTHORITY_GROUP
            +
            +
            Pattern matching "(host1,host2,host3):port". +

            +

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

            +KijiURI

            +
            +public KijiURI(URI uri)
+        throws KijiURIException
            +
            +
            Constructs a URI that fully qualifies a Kiji table. +

            +

            +
            Parameters:
            uri - Kiji URI +
            Throws: +
            KijiURIException - if the URI is invalid.
            +
            +
            + +

            +KijiURI

            +
            +public KijiURI(Iterable<String> zookeeperQuorum,
+               int zookeeperClientPort,
+               String instanceName,
+               String tableName,
+               Iterable<KijiColumnName> columnNames)
+        throws KijiURIException
            +
            +
            Constructs a new KijiURI with the given parameters. +

            +

            +
            Parameters:
            zookeeperQuorum - Zookeeper quorum.
            zookeeperClientPort - Zookeeper client port.
            instanceName - Instance name.
            tableName - Table name.
            columnNames - Column names. +
            Throws: +
            KijiURIException - If the parameters are invalid.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +parse

            +
            +public static KijiURI parse(String uri)
+                     throws KijiURIException
            +
            +
            Constructs a fully qualified Kiji table URI from a string. +

            +

            +
            Parameters:
            uri - Kiji URI +
            Returns:
            A KijiURI represented by uri. +
            Throws: +
            KijiURIException - if the URI is invalid.
            +
            +
            +
            + +

            +resolve

            +
            +public KijiURI resolve(String path)
+                throws KijiURIException
            +
            +
            Resolve the path relative to this KijiURI. Returns a new instance. +

            +

            +
            Parameters:
            path - The path to resolve. +
            Returns:
            The resolved KijiURI. +
            Throws: +
            KijiURIException - If this KijiURI is malformed.
            +
            +
            +
            + +

            +getZookeeperQuorum

            +
            +public com.google.common.collect.ImmutableList<String> getZookeeperQuorum()
            +
            +
            + +
            Returns:
            Zookeeper quorum (comma-separated list of host names or IPs), normalized.
            +
            +
            +
            + +

            +getZookeeperQuorumOrdered

            +
            +public com.google.common.collect.ImmutableList<String> getZookeeperQuorumOrdered()
            +
            +
            + +
            Returns:
            Zookeeper quorum (comma-separated list of host names or IPs), ordered.
            +
            +
            +
            + +

            +getZookeeperClientPort

            +
            +public int getZookeeperClientPort()
            +
            +
            + +
            Returns:
            Zookeeper client port.
            +
            +
            +
            + +

            +getInstance

            +
            +public String getInstance()
            +
            +
            + +
            Returns:
            Kiji instance name.
            +
            +
            +
            + +

            +getTable

            +
            +public String getTable()
            +
            +
            + +
            Returns:
            Kiji table name.
            +
            +
            +
            + +

            +getColumn

            +
            +public com.google.common.collect.ImmutableList<KijiColumnName> getColumn()
            +
            +
            + +
            Returns:
            Kiji columns (comma-separated list of Kiji column names), normalized.
            +
            +
            +
            + +

            +getColumnOrdered

            +
            +public Collection<KijiColumnName> getColumnOrdered()
            +
            +
            + +
            Returns:
            Kiji columns (comma-separated list of Kiji column names), ordered.
            +
            +
            +
            + +

            +setZookeeperQuorum

            +
            +public KijiURI setZookeeperQuorum(String[] quorum)
+                           throws KijiURIException
            +
            +
            Creates a new KijiURI with this zookeeper quorum. +

            +

            +
            Parameters:
            quorum - The value to set zookeeperQuorum to. +
            Returns:
            A copy of this KijiURI with the zookeeperQuorum set. +
            Throws: +
            KijiURIException - If the quorum is invalid.
            +
            +
            +
            + +

            +setInstanceName

            +
            +public KijiURI setInstanceName(String instanceName)
+                        throws KijiURIException
            +
            +
            Creates a new KijiURI with this instance name added. +

            +

            +
            Parameters:
            instanceName - The name to set the instance name to. +
            Returns:
            A copy of this KijiURI with the instance name set. +
            Throws: +
            KijiURIException - If instanceName is invalid.
            +
            +
            +
            + +

            +setTableName

            +
            +public KijiURI setTableName(String tableName)
+                     throws KijiURIException
            +
            +
            Creates a KijiURI with this table name added. +

            +

            +
            Parameters:
            tableName - The name to set the table name to. +
            Returns:
            A copy of this KijiURI with the table name set. +
            Throws: +
            KijiURIException - If tableName is invalid.
            +
            +
            +
            + +

            +setColumnNames

            +
            +public KijiURI setColumnNames(Collection<String> columnNames)
+                       throws KijiURIException
            +
            +
            Creates a KijiURI with these column names added. +

            +

            +
            Parameters:
            columnNames - The column names to set as (col1,col2). +
            Returns:
            A copy of this KijiURI with the column names set. +
            Throws: +
            KijiURIException - If columNames is invalid.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toOrderedString

            +
            +public String toOrderedString()
            +
            +
            Returns a string representation of this URI that preserves ordering of lists in fields, + such as the Zookeeper quorum and Kiji columns. +

            +

            + +
            Returns:
            An order-preserving string representation of this URI.
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object object)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiURIException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiURIException.html new file mode 100644 index 00000000..9102d51e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/KijiURIException.html @@ -0,0 +1,270 @@ + + + + + + + +KijiURIException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiURIException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.KijiURIException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiURIException
            extends Exception
            + + +

            +Thrown when parsing a bogus Kiji table URI. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiURIException(String uri) + +
            +          Creates a new KijiURIException.
            KijiURIException(String uri, + String message) + +
            +          Creates a new KijiURIException for the specified uri and detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiURIException

            +
            +public KijiURIException(String uri)
            +
            +
            Creates a new KijiURIException. +

            +

            +
            Parameters:
            uri - Bogus URI.
            +
            +
            + +

            +KijiURIException

            +
            +public KijiURIException(String uri,
+                        String message)
            +
            +
            Creates a new KijiURIException for the specified uri and detail message. +

            +

            +
            Parameters:
            uri - Bogus URI.
            message - Human readable explanation.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/NoCellDataException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/NoCellDataException.html new file mode 100644 index 00000000..14063a21 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/NoCellDataException.html @@ -0,0 +1,250 @@ + + + + + + + +NoCellDataException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class NoCellDataException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.NoCellDataException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NoCellDataException
            extends Exception
            + + +

            +Thrown when attempting to read data from a cell that doesn't exist. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NoCellDataException(String message) + +
            +          Creates a new NoCellDataException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +NoCellDataException

            +
            +public NoCellDataException(String message)
            +
            +
            Creates a new NoCellDataException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/NoSuchColumnException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/NoSuchColumnException.html new file mode 100644 index 00000000..e4a58a74 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/NoSuchColumnException.html @@ -0,0 +1,251 @@ + + + + + + + +NoSuchColumnException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class NoSuchColumnException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.NoSuchColumnException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NoSuchColumnException
            extends IOException
            + + +

            +Thrown when attempting to access a column that does not exist. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NoSuchColumnException(String message) + +
            +          Creates a new NoSuchColumnException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +NoSuchColumnException

            +
            +public NoSuchColumnException(String message)
            +
            +
            Creates a new NoSuchColumnException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/NotAKijiManagedTableException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/NotAKijiManagedTableException.html new file mode 100644 index 00000000..11764964 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/NotAKijiManagedTableException.html @@ -0,0 +1,285 @@ + + + + + + + +NotAKijiManagedTableException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class NotAKijiManagedTableException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.NotAKijiManagedTableException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NotAKijiManagedTableException
            extends Exception
            + + +

            +Thrown when Kiji encounters an HBase table that is not managed by Kiji. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NotAKijiManagedTableException(String hbaseTableName, + String message) + +
            +          Creates a new NotAKijiManagedTableException for the specified + table with the specified detail message.
            +  + + + + + + + + + + + +
            +Method Summary
            + StringgetHBaseTableName() + +
            +          Gets the name of the HBase table that is not managed by Kiji.
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +NotAKijiManagedTableException

            +
            +public NotAKijiManagedTableException(String hbaseTableName,
+                                     String message)
            +
            +
            Creates a new NotAKijiManagedTableException for the specified + table with the specified detail message. +

            +

            +
            Parameters:
            hbaseTableName - The name of an HBase table that is not managed by Kiji.
            message - Detail about the exception.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseTableName

            +
            +public String getHBaseTableName()
            +
            +
            Gets the name of the HBase table that is not managed by Kiji. +

            +

            + +
            Returns:
            The HBase table name.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/SpecificCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/SpecificCellDecoderFactory.html new file mode 100644 index 00000000..49b811dc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/SpecificCellDecoderFactory.html @@ -0,0 +1,260 @@ + + + + + + + +SpecificCellDecoderFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class SpecificCellDecoderFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.SpecificCellDecoderFactory
+
            +
            +
            All Implemented Interfaces:
            KijiCellDecoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class SpecificCellDecoderFactory
            extends Object
            implements KijiCellDecoderFactory
            + + +

            +Factory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellDecoder<?>create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +static KijiCellDecoderFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiCellDecoderFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            an instance of the SpecificCellDecoderFactory.
            +
            +
            +
            + +

            +create

            +
            +public KijiCellDecoder<?> create(CellSpec cellSpec)
+                          throws IOException
            +
            +
            Creates a new Kiji cell decoder. +

            +

            +
            Specified by:
            create in interface KijiCellDecoderFactory
            +
            +
            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell decoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/TableKeyNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/TableKeyNotFoundException.html new file mode 100644 index 00000000..3841971d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/TableKeyNotFoundException.html @@ -0,0 +1,252 @@ + + + + + + + +TableKeyNotFoundException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class TableKeyNotFoundException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.TableKeyNotFoundException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class TableKeyNotFoundException
            extends RuntimeException
            + + +

            +Thrown when a key is not found in a map-like API implemented by one of the + Kiji tables, the system or meta table for example. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            TableKeyNotFoundException(String message) + +
            +          Constructor.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +TableKeyNotFoundException

            +
            +public TableKeyNotFoundException(String message)
            +
            +
            Constructor. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/CellSchema.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/CellSchema.Builder.html new file mode 100644 index 00000000..dab3b49e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/CellSchema.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +CellSchema.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class CellSchema.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<CellSchema>
+          extended by org.kiji.schema.avro.CellSchema.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<CellSchema>
            +
            +
            +
            Enclosing class:
            CellSchema
            +
            +
            +
            +
            public static class CellSchema.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<CellSchema>
            implements org.apache.avro.data.RecordBuilder<CellSchema>
            + + +

            +RecordBuilder for CellSchema instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + CellSchemabuild() + +
            +           
            + CellSchema.BuilderclearStorage() + +
            +          Clears the value of the 'storage' field
            + CellSchema.BuilderclearType() + +
            +          Clears the value of the 'type' field
            + CellSchema.BuilderclearValue() + +
            +          Clears the value of the 'value' field
            + SchemaStoragegetStorage() + +
            +          Gets the value of the 'storage' field
            + SchemaTypegetType() + +
            +          Gets the value of the 'type' field
            + StringgetValue() + +
            +          Gets the value of the 'value' field
            + booleanhasStorage() + +
            +          Checks whether the 'storage' field has been set
            + booleanhasType() + +
            +          Checks whether the 'type' field has been set
            + booleanhasValue() + +
            +          Checks whether the 'value' field has been set
            + CellSchema.BuildersetStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field
            + CellSchema.BuildersetType(SchemaType value) + +
            +          Sets the value of the 'type' field
            + CellSchema.BuildersetValue(String value) + +
            +          Sets the value of the 'value' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getStorage

            +
            +public SchemaStorage getStorage()
            +
            +
            Gets the value of the 'storage' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setStorage

            +
            +public CellSchema.Builder setStorage(SchemaStorage value)
            +
            +
            Sets the value of the 'storage' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasStorage

            +
            +public boolean hasStorage()
            +
            +
            Checks whether the 'storage' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearStorage

            +
            +public CellSchema.Builder clearStorage()
            +
            +
            Clears the value of the 'storage' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getType

            +
            +public SchemaType getType()
            +
            +
            Gets the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setType

            +
            +public CellSchema.Builder setType(SchemaType value)
            +
            +
            Sets the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasType

            +
            +public boolean hasType()
            +
            +
            Checks whether the 'type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearType

            +
            +public CellSchema.Builder clearType()
            +
            +
            Clears the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public String getValue()
            +
            +
            Gets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public CellSchema.Builder setValue(String value)
            +
            +
            Sets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasValue

            +
            +public boolean hasValue()
            +
            +
            Checks whether the 'value' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearValue

            +
            +public CellSchema.Builder clearValue()
            +
            +
            Clears the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public CellSchema build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<CellSchema>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/CellSchema.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/CellSchema.html new file mode 100644 index 00000000..d73f022e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/CellSchema.html @@ -0,0 +1,684 @@ + + + + + + + +CellSchema (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class CellSchema

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.CellSchema
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class CellSchema
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classCellSchema.Builder + +
            +          RecordBuilder for CellSchema instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + SchemaStoragestorage + +
            +          Deprecated. 
            + SchemaTypetype + +
            +          Deprecated. 
            + Stringvalue + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            CellSchema() + +
            +          Default constructor.
            CellSchema(SchemaStorage storage, + SchemaType type, + String value) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + org.apache.avro.SchemagetSchema() + +
            +           
            + SchemaStoragegetStorage() + +
            +          Gets the value of the 'storage' field.
            + SchemaTypegetType() + +
            +          Gets the value of the 'type' field.
            + StringgetValue() + +
            +          Gets the value of the 'value' field.
            +static CellSchema.BuildernewBuilder() + +
            +          Creates a new CellSchema RecordBuilder
            +static CellSchema.BuildernewBuilder(CellSchema.Builder other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing Builder
            +static CellSchema.BuildernewBuilder(CellSchema other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field.
            + voidsetType(SchemaType value) + +
            +          Sets the value of the 'type' field.
            + voidsetValue(String value) + +
            +          Sets the value of the 'value' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +storage

            +
            +@Deprecated
+public SchemaStorage storage
            +
            +
            Deprecated. 
            Schema encoding in cells. Unused if type is COUNTER. +

            +

            +
            +
            +
            + +

            +type

            +
            +@Deprecated
+public SchemaType type
            +
            +
            Deprecated. 
            Type of schema. +

            +

            +
            +
            +
            + +

            +value

            +
            +@Deprecated
+public String value
            +
            +
            Deprecated. 
            Schema value, whose interpretation depends on the schema type: + - inline : immediate Avro schema description, eg. "string"; + - class : Avro schema class name, eg. "org.kiji.avro.Node"; + - counter : unused, must the empty. +

            +

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

            +CellSchema

            +
            +public CellSchema()
            +
            +
            Default constructor. +

            +

            +
            + +

            +CellSchema

            +
            +public CellSchema(SchemaStorage storage,
+                  SchemaType type,
+                  String value)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getStorage

            +
            +public SchemaStorage getStorage()
            +
            +
            Gets the value of the 'storage' field. + Schema encoding in cells. Unused if type is COUNTER. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setStorage

            +
            +public void setStorage(SchemaStorage value)
            +
            +
            Sets the value of the 'storage' field. + Schema encoding in cells. Unused if type is COUNTER. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getType

            +
            +public SchemaType getType()
            +
            +
            Gets the value of the 'type' field. + Type of schema. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setType

            +
            +public void setType(SchemaType value)
            +
            +
            Sets the value of the 'type' field. + Type of schema. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public String getValue()
            +
            +
            Gets the value of the 'value' field. + * Schema value, whose interpretation depends on the schema type: + - inline : immediate Avro schema description, eg. "string"; + - class : Avro schema class name, eg. "org.kiji.avro.Node"; + - counter : unused, must the empty. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public void setValue(String value)
            +
            +
            Sets the value of the 'value' field. + * Schema value, whose interpretation depends on the schema type: + - inline : immediate Avro schema description, eg. "string"; + - class : Avro schema class name, eg. "org.kiji.avro.Node"; + - counter : unused, must the empty. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static CellSchema.Builder newBuilder()
            +
            +
            Creates a new CellSchema RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static CellSchema.Builder newBuilder(CellSchema.Builder other)
            +
            +
            Creates a new CellSchema RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static CellSchema.Builder newBuilder(CellSchema other)
            +
            +
            Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/ColumnDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/ColumnDesc.Builder.html new file mode 100644 index 00000000..d9c54352 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/ColumnDesc.Builder.html @@ -0,0 +1,1012 @@ + + + + + + + +ColumnDesc.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class ColumnDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<ColumnDesc>
+          extended by org.kiji.schema.avro.ColumnDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<ColumnDesc>
            +
            +
            +
            Enclosing class:
            ColumnDesc
            +
            +
            +
            +
            public static class ColumnDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<ColumnDesc>
            implements org.apache.avro.data.RecordBuilder<ColumnDesc>
            + + +

            +RecordBuilder for ColumnDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + ColumnDescbuild() + +
            +           
            + ColumnDesc.BuilderclearAliases() + +
            +          Clears the value of the 'aliases' field
            + ColumnDesc.BuilderclearColumnSchema() + +
            +          Clears the value of the 'column_schema' field
            + ColumnDesc.BuilderclearDelete() + +
            +          Clears the value of the 'delete' field
            + ColumnDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + ColumnDesc.BuilderclearEnabled() + +
            +          Clears the value of the 'enabled' field
            + ColumnDesc.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + ColumnDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + ColumnDesc.BuilderclearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field
            + CellSchemagetColumnSchema() + +
            +          Gets the value of the 'column_schema' field
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field
            + IntegergetId() + +
            +          Gets the value of the 'id' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field
            + booleanhasAliases() + +
            +          Checks whether the 'aliases' field has been set
            + booleanhasColumnSchema() + +
            +          Checks whether the 'column_schema' field has been set
            + booleanhasDelete() + +
            +          Checks whether the 'delete' field has been set
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasEnabled() + +
            +          Checks whether the 'enabled' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasRenamedFrom() + +
            +          Checks whether the 'renamed_from' field has been set
            + ColumnDesc.BuildersetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + ColumnDesc.BuildersetColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field
            + ColumnDesc.BuildersetDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + ColumnDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + ColumnDesc.BuildersetEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + ColumnDesc.BuildersetId(int value) + +
            +          Sets the value of the 'id' field
            + ColumnDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + ColumnDesc.BuildersetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public ColumnDesc.Builder setId(int value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public ColumnDesc.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public ColumnDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public ColumnDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public ColumnDesc.Builder setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAliases

            +
            +public boolean hasAliases()
            +
            +
            Checks whether the 'aliases' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAliases

            +
            +public ColumnDesc.Builder clearAliases()
            +
            +
            Clears the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public ColumnDesc.Builder setEnabled(boolean value)
            +
            +
            Sets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEnabled

            +
            +public boolean hasEnabled()
            +
            +
            Checks whether the 'enabled' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEnabled

            +
            +public ColumnDesc.Builder clearEnabled()
            +
            +
            Clears the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public ColumnDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public ColumnDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumnSchema

            +
            +public CellSchema getColumnSchema()
            +
            +
            Gets the value of the 'column_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumnSchema

            +
            +public ColumnDesc.Builder setColumnSchema(CellSchema value)
            +
            +
            Sets the value of the 'column_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasColumnSchema

            +
            +public boolean hasColumnSchema()
            +
            +
            Checks whether the 'column_schema' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearColumnSchema

            +
            +public ColumnDesc.Builder clearColumnSchema()
            +
            +
            Clears the value of the 'column_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public ColumnDesc.Builder setDelete(boolean value)
            +
            +
            Sets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDelete

            +
            +public boolean hasDelete()
            +
            +
            Checks whether the 'delete' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDelete

            +
            +public ColumnDesc.Builder clearDelete()
            +
            +
            Clears the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public ColumnDesc.Builder setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasRenamedFrom

            +
            +public boolean hasRenamedFrom()
            +
            +
            Checks whether the 'renamed_from' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearRenamedFrom

            +
            +public ColumnDesc.Builder clearRenamedFrom()
            +
            +
            Clears the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public ColumnDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<ColumnDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/ColumnDesc.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/ColumnDesc.html new file mode 100644 index 00000000..7fb73dce --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/ColumnDesc.html @@ -0,0 +1,1040 @@ + + + + + + + +ColumnDesc (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class ColumnDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.ColumnDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class ColumnDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classColumnDesc.Builder + +
            +          RecordBuilder for ColumnDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<String>aliases + +
            +          Deprecated. 
            + CellSchemacolumn_schema + +
            +          Deprecated. 
            + booleandelete + +
            +          Deprecated. 
            + Stringdescription + +
            +          Deprecated. 
            + booleanenabled + +
            +          Deprecated. 
            + intid + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringrenamed_from + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            ColumnDesc() + +
            +          Default constructor.
            ColumnDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema column_schema, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field.
            + CellSchemagetColumnSchema() + +
            +          Gets the value of the 'column_schema' field.
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field.
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field.
            + IntegergetId() + +
            +          Gets the value of the 'id' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static ColumnDesc.BuildernewBuilder() + +
            +          Creates a new ColumnDesc RecordBuilder
            +static ColumnDesc.BuildernewBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +static ColumnDesc.BuildernewBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field.
            + voidsetColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field.
            + voidsetDelete(Boolean value) + +
            +          Sets the value of the 'delete' field.
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetEnabled(Boolean value) + +
            +          Sets the value of the 'enabled' field.
            + voidsetId(Integer value) + +
            +          Sets the value of the 'id' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public int id
            +
            +
            Deprecated. 
            Column ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +aliases

            +
            +@Deprecated
+public List<String> aliases
            +
            +
            Deprecated. 
            Column name aliases. +

            +

            +
            +
            +
            + +

            +enabled

            +
            +@Deprecated
+public boolean enabled
            +
            +
            Deprecated. 
            When false, the column is not visible or usable. +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the column. +

            +

            +
            +
            +
            + +

            +column_schema

            +
            +@Deprecated
+public CellSchema column_schema
            +
            +
            Deprecated. 
            Schema for the cell values. +

            +

            +
            +
            +
            + +

            +delete

            +
            +@Deprecated
+public boolean delete
            +
            +
            Deprecated. 
            When true, applying this layout deletes the column. +

            +

            +
            +
            +
            + +

            +renamed_from

            +
            +@Deprecated
+public String renamed_from
            +
            +
            Deprecated. 
            Reference primary name of the column, when renaming the column. +

            +

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

            +ColumnDesc

            +
            +public ColumnDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +ColumnDesc

            +
            +public ColumnDesc(Integer id,
+                  String name,
+                  List<String> aliases,
+                  Boolean enabled,
+                  String description,
+                  CellSchema column_schema,
+                  Boolean delete,
+                  String renamed_from)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field. + Column ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Integer value)
            +
            +
            Sets the value of the 'id' field. + Column ID. Not visible to the user. 0 means unset. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field. + Column name aliases. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public void setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field. + Column name aliases. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field. + When false, the column is not visible or usable. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public void setEnabled(Boolean value)
            +
            +
            Sets the value of the 'enabled' field. + When false, the column is not visible or usable. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the column. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the column. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumnSchema

            +
            +public CellSchema getColumnSchema()
            +
            +
            Gets the value of the 'column_schema' field. + Schema for the cell values. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumnSchema

            +
            +public void setColumnSchema(CellSchema value)
            +
            +
            Sets the value of the 'column_schema' field. + Schema for the cell values. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field. + When true, applying this layout deletes the column. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public void setDelete(Boolean value)
            +
            +
            Sets the value of the 'delete' field. + When true, applying this layout deletes the column. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field. + Reference primary name of the column, when renaming the column. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public void setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field. + Reference primary name of the column, when renaming the column. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder()
            +
            +
            Creates a new ColumnDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder(ColumnDesc.Builder other)
            +
            +
            Creates a new ColumnDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder(ColumnDesc other)
            +
            +
            Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/CompressionType.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/CompressionType.html new file mode 100644 index 00000000..e3fc373d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/CompressionType.html @@ -0,0 +1,391 @@ + + + + + + + +CompressionType (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum CompressionType

            +
            +java.lang.Object
+  extended by java.lang.Enum<CompressionType>
+      extended by org.kiji.schema.avro.CompressionType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<CompressionType>
            +
            +
            +
            +
            public enum CompressionType
            extends Enum<CompressionType>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            GZ + +
            +           
            LZO + +
            +           
            NONE + +
            +           
            SNAPPY + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static CompressionTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static CompressionType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +NONE

            +
            +public static final CompressionType NONE
            +
            +
            +
            +
            +
            + +

            +GZ

            +
            +public static final CompressionType GZ
            +
            +
            +
            +
            +
            + +

            +LZO

            +
            +public static final CompressionType LZO
            +
            +
            +
            +
            +
            + +

            +SNAPPY

            +
            +public static final CompressionType SNAPPY
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static CompressionType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (CompressionType c : CompressionType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static CompressionType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/FamilyDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/FamilyDesc.Builder.html new file mode 100644 index 00000000..2b85c3fb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/FamilyDesc.Builder.html @@ -0,0 +1,1108 @@ + + + + + + + +FamilyDesc.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class FamilyDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<FamilyDesc>
+          extended by org.kiji.schema.avro.FamilyDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<FamilyDesc>
            +
            +
            +
            Enclosing class:
            FamilyDesc
            +
            +
            +
            +
            public static class FamilyDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<FamilyDesc>
            implements org.apache.avro.data.RecordBuilder<FamilyDesc>
            + + +

            +RecordBuilder for FamilyDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + FamilyDescbuild() + +
            +           
            + FamilyDesc.BuilderclearAliases() + +
            +          Clears the value of the 'aliases' field
            + FamilyDesc.BuilderclearColumns() + +
            +          Clears the value of the 'columns' field
            + FamilyDesc.BuilderclearDelete() + +
            +          Clears the value of the 'delete' field
            + FamilyDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + FamilyDesc.BuilderclearEnabled() + +
            +          Clears the value of the 'enabled' field
            + FamilyDesc.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + FamilyDesc.BuilderclearMapSchema() + +
            +          Clears the value of the 'map_schema' field
            + FamilyDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + FamilyDesc.BuilderclearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field
            + List<ColumnDesc>getColumns() + +
            +          Gets the value of the 'columns' field
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field
            + IntegergetId() + +
            +          Gets the value of the 'id' field
            + CellSchemagetMapSchema() + +
            +          Gets the value of the 'map_schema' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field
            + booleanhasAliases() + +
            +          Checks whether the 'aliases' field has been set
            + booleanhasColumns() + +
            +          Checks whether the 'columns' field has been set
            + booleanhasDelete() + +
            +          Checks whether the 'delete' field has been set
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasEnabled() + +
            +          Checks whether the 'enabled' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + booleanhasMapSchema() + +
            +          Checks whether the 'map_schema' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasRenamedFrom() + +
            +          Checks whether the 'renamed_from' field has been set
            + FamilyDesc.BuildersetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + FamilyDesc.BuildersetColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            + FamilyDesc.BuildersetDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + FamilyDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + FamilyDesc.BuildersetEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + FamilyDesc.BuildersetId(int value) + +
            +          Sets the value of the 'id' field
            + FamilyDesc.BuildersetMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field
            + FamilyDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + FamilyDesc.BuildersetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public FamilyDesc.Builder setId(int value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public FamilyDesc.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public FamilyDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public FamilyDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public FamilyDesc.Builder setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAliases

            +
            +public boolean hasAliases()
            +
            +
            Checks whether the 'aliases' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAliases

            +
            +public FamilyDesc.Builder clearAliases()
            +
            +
            Clears the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public FamilyDesc.Builder setEnabled(boolean value)
            +
            +
            Sets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEnabled

            +
            +public boolean hasEnabled()
            +
            +
            Checks whether the 'enabled' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEnabled

            +
            +public FamilyDesc.Builder clearEnabled()
            +
            +
            Clears the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public FamilyDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public FamilyDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMapSchema

            +
            +public CellSchema getMapSchema()
            +
            +
            Gets the value of the 'map_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMapSchema

            +
            +public FamilyDesc.Builder setMapSchema(CellSchema value)
            +
            +
            Sets the value of the 'map_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasMapSchema

            +
            +public boolean hasMapSchema()
            +
            +
            Checks whether the 'map_schema' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearMapSchema

            +
            +public FamilyDesc.Builder clearMapSchema()
            +
            +
            Clears the value of the 'map_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumns

            +
            +public List<ColumnDesc> getColumns()
            +
            +
            Gets the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumns

            +
            +public FamilyDesc.Builder setColumns(List<ColumnDesc> value)
            +
            +
            Sets the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasColumns

            +
            +public boolean hasColumns()
            +
            +
            Checks whether the 'columns' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearColumns

            +
            +public FamilyDesc.Builder clearColumns()
            +
            +
            Clears the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public FamilyDesc.Builder setDelete(boolean value)
            +
            +
            Sets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDelete

            +
            +public boolean hasDelete()
            +
            +
            Checks whether the 'delete' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDelete

            +
            +public FamilyDesc.Builder clearDelete()
            +
            +
            Clears the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public FamilyDesc.Builder setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasRenamedFrom

            +
            +public boolean hasRenamedFrom()
            +
            +
            Checks whether the 'renamed_from' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearRenamedFrom

            +
            +public FamilyDesc.Builder clearRenamedFrom()
            +
            +
            Clears the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public FamilyDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<FamilyDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/FamilyDesc.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/FamilyDesc.html new file mode 100644 index 00000000..9396b8e7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/FamilyDesc.html @@ -0,0 +1,1113 @@ + + + + + + + +FamilyDesc (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class FamilyDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.FamilyDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class FamilyDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classFamilyDesc.Builder + +
            +          RecordBuilder for FamilyDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<String>aliases + +
            +          Deprecated. 
            + List<ColumnDesc>columns + +
            +          Deprecated. 
            + booleandelete + +
            +          Deprecated. 
            + Stringdescription + +
            +          Deprecated. 
            + booleanenabled + +
            +          Deprecated. 
            + intid + +
            +          Deprecated. 
            + CellSchemamap_schema + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringrenamed_from + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            FamilyDesc() + +
            +          Default constructor.
            FamilyDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema map_schema, + List<ColumnDesc> columns, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field.
            + List<ColumnDesc>getColumns() + +
            +          Gets the value of the 'columns' field.
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field.
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field.
            + IntegergetId() + +
            +          Gets the value of the 'id' field.
            + CellSchemagetMapSchema() + +
            +          Gets the value of the 'map_schema' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static FamilyDesc.BuildernewBuilder() + +
            +          Creates a new FamilyDesc RecordBuilder
            +static FamilyDesc.BuildernewBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +static FamilyDesc.BuildernewBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field.
            + voidsetColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field.
            + voidsetDelete(Boolean value) + +
            +          Sets the value of the 'delete' field.
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetEnabled(Boolean value) + +
            +          Sets the value of the 'enabled' field.
            + voidsetId(Integer value) + +
            +          Sets the value of the 'id' field.
            + voidsetMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public int id
            +
            +
            Deprecated. 
            Family ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +aliases

            +
            +@Deprecated
+public List<String> aliases
            +
            +
            Deprecated. 
            Column family name aliases. +

            +

            +
            +
            +
            + +

            +enabled

            +
            +@Deprecated
+public boolean enabled
            +
            +
            Deprecated. 
            When false, the family and its columns are not visible/usable. +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the column family. +

            +

            +
            +
            +
            + +

            +map_schema

            +
            +@Deprecated
+public CellSchema map_schema
            +
            +
            Deprecated. 
            Cell schema for map-type families. Null for group-type families. +

            +

            +
            +
            +
            + +

            +columns

            +
            +@Deprecated
+public List<ColumnDesc> columns
            +
            +
            Deprecated. 
            Columns, for group-type families only. Empty for map-type families. +

            +

            +
            +
            +
            + +

            +delete

            +
            +@Deprecated
+public boolean delete
            +
            +
            Deprecated. 
            When true, applying this layout deletes the family. +

            +

            +
            +
            +
            + +

            +renamed_from

            +
            +@Deprecated
+public String renamed_from
            +
            +
            Deprecated. 
            Reference primary name of the family, when renaming the family. +

            +

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

            +FamilyDesc

            +
            +public FamilyDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +FamilyDesc

            +
            +public FamilyDesc(Integer id,
+                  String name,
+                  List<String> aliases,
+                  Boolean enabled,
+                  String description,
+                  CellSchema map_schema,
+                  List<ColumnDesc> columns,
+                  Boolean delete,
+                  String renamed_from)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field. + Family ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Integer value)
            +
            +
            Sets the value of the 'id' field. + Family ID. Not visible to the user. 0 means unset. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field. + Column family name aliases. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public void setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field. + Column family name aliases. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field. + When false, the family and its columns are not visible/usable. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public void setEnabled(Boolean value)
            +
            +
            Sets the value of the 'enabled' field. + When false, the family and its columns are not visible/usable. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the column family. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the column family. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMapSchema

            +
            +public CellSchema getMapSchema()
            +
            +
            Gets the value of the 'map_schema' field. + Cell schema for map-type families. Null for group-type families. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMapSchema

            +
            +public void setMapSchema(CellSchema value)
            +
            +
            Sets the value of the 'map_schema' field. + Cell schema for map-type families. Null for group-type families. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumns

            +
            +public List<ColumnDesc> getColumns()
            +
            +
            Gets the value of the 'columns' field. + Columns, for group-type families only. Empty for map-type families. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumns

            +
            +public void setColumns(List<ColumnDesc> value)
            +
            +
            Sets the value of the 'columns' field. + Columns, for group-type families only. Empty for map-type families. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field. + When true, applying this layout deletes the family. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public void setDelete(Boolean value)
            +
            +
            Sets the value of the 'delete' field. + When true, applying this layout deletes the family. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field. + Reference primary name of the family, when renaming the family. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public void setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field. + Reference primary name of the family, when renaming the family. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder()
            +
            +
            Creates a new FamilyDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder(FamilyDesc.Builder other)
            +
            +
            Creates a new FamilyDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder(FamilyDesc other)
            +
            +
            Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/HashType.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/HashType.html new file mode 100644 index 00000000..7a586883 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/HashType.html @@ -0,0 +1,343 @@ + + + + + + + +HashType (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum HashType

            +
            +java.lang.Object
+  extended by java.lang.Enum<HashType>
+      extended by org.kiji.schema.avro.HashType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<HashType>
            +
            +
            +
            +
            public enum HashType
            extends Enum<HashType>
            + + +

            +

            + +

            + + + + + + + + + + +
            +Enum Constant Summary
            MD5 + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static HashTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static HashType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +MD5

            +
            +public static final HashType MD5
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static HashType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (HashType c : HashType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static HashType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KeyValueBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KeyValueBackupEntry.Builder.html new file mode 100644 index 00000000..51edb684 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KeyValueBackupEntry.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +KeyValueBackupEntry.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class KeyValueBackupEntry.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<KeyValueBackupEntry>
+          extended by org.kiji.schema.avro.KeyValueBackupEntry.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<KeyValueBackupEntry>
            +
            +
            +
            Enclosing class:
            KeyValueBackupEntry
            +
            +
            +
            +
            public static class KeyValueBackupEntry.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<KeyValueBackupEntry>
            implements org.apache.avro.data.RecordBuilder<KeyValueBackupEntry>
            + + +

            +RecordBuilder for KeyValueBackupEntry instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KeyValueBackupEntrybuild() + +
            +           
            + KeyValueBackupEntry.BuilderclearKey() + +
            +          Clears the value of the 'key' field
            + KeyValueBackupEntry.BuilderclearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + KeyValueBackupEntry.BuilderclearValue() + +
            +          Clears the value of the 'value' field
            + StringgetKey() + +
            +          Gets the value of the 'key' field
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field
            + ByteBuffergetValue() + +
            +          Gets the value of the 'value' field
            + booleanhasKey() + +
            +          Checks whether the 'key' field has been set
            + booleanhasTimestamp() + +
            +          Checks whether the 'timestamp' field has been set
            + booleanhasValue() + +
            +          Checks whether the 'value' field has been set
            + KeyValueBackupEntry.BuildersetKey(String value) + +
            +          Sets the value of the 'key' field
            + KeyValueBackupEntry.BuildersetTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + KeyValueBackupEntry.BuildersetValue(ByteBuffer value) + +
            +          Sets the value of the 'value' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public KeyValueBackupEntry.Builder setTimestamp(long value)
            +
            +
            Sets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasTimestamp

            +
            +public boolean hasTimestamp()
            +
            +
            Checks whether the 'timestamp' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearTimestamp

            +
            +public KeyValueBackupEntry.Builder clearTimestamp()
            +
            +
            Clears the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKey

            +
            +public String getKey()
            +
            +
            Gets the value of the 'key' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKey

            +
            +public KeyValueBackupEntry.Builder setKey(String value)
            +
            +
            Sets the value of the 'key' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasKey

            +
            +public boolean hasKey()
            +
            +
            Checks whether the 'key' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearKey

            +
            +public KeyValueBackupEntry.Builder clearKey()
            +
            +
            Clears the value of the 'key' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public ByteBuffer getValue()
            +
            +
            Gets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public KeyValueBackupEntry.Builder setValue(ByteBuffer value)
            +
            +
            Sets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasValue

            +
            +public boolean hasValue()
            +
            +
            Checks whether the 'value' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearValue

            +
            +public KeyValueBackupEntry.Builder clearValue()
            +
            +
            Clears the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public KeyValueBackupEntry build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<KeyValueBackupEntry>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KeyValueBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KeyValueBackupEntry.html new file mode 100644 index 00000000..782bd7f2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KeyValueBackupEntry.html @@ -0,0 +1,675 @@ + + + + + + + +KeyValueBackupEntry (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class KeyValueBackupEntry

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.KeyValueBackupEntry
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class KeyValueBackupEntry
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKeyValueBackupEntry.Builder + +
            +          RecordBuilder for KeyValueBackupEntry instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringkey + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + longtimestamp + +
            +          Deprecated. 
            + ByteBuffervalue + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            KeyValueBackupEntry() + +
            +          Default constructor.
            KeyValueBackupEntry(Long timestamp, + String key, + ByteBuffer value) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetKey() + +
            +          Gets the value of the 'key' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field.
            + ByteBuffergetValue() + +
            +          Gets the value of the 'value' field.
            +static KeyValueBackupEntry.BuildernewBuilder() + +
            +          Creates a new KeyValueBackupEntry RecordBuilder
            +static KeyValueBackupEntry.BuildernewBuilder(KeyValueBackupEntry.Builder other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder
            +static KeyValueBackupEntry.BuildernewBuilder(KeyValueBackupEntry other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetKey(String value) + +
            +          Sets the value of the 'key' field.
            + voidsetTimestamp(Long value) + +
            +          Sets the value of the 'timestamp' field.
            + voidsetValue(ByteBuffer value) + +
            +          Sets the value of the 'value' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +timestamp

            +
            +@Deprecated
+public long timestamp
            +
            +
            Deprecated. 
            Time Stamp. +

            +

            +
            +
            +
            + +

            +key

            +
            +@Deprecated
+public String key
            +
            +
            Deprecated. 
            Key. +

            +

            +
            +
            +
            + +

            +value

            +
            +@Deprecated
+public ByteBuffer value
            +
            +
            Deprecated. 
            Value. +

            +

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

            +KeyValueBackupEntry

            +
            +public KeyValueBackupEntry()
            +
            +
            Default constructor. +

            +

            +
            + +

            +KeyValueBackupEntry

            +
            +public KeyValueBackupEntry(Long timestamp,
+                           String key,
+                           ByteBuffer value)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field. + Time Stamp. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public void setTimestamp(Long value)
            +
            +
            Sets the value of the 'timestamp' field. + Time Stamp. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKey

            +
            +public String getKey()
            +
            +
            Gets the value of the 'key' field. + Key. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKey

            +
            +public void setKey(String value)
            +
            +
            Sets the value of the 'key' field. + Key. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public ByteBuffer getValue()
            +
            +
            Gets the value of the 'value' field. + Value. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public void setValue(ByteBuffer value)
            +
            +
            Sets the value of the 'value' field. + Value. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KeyValueBackupEntry.Builder newBuilder()
            +
            +
            Creates a new KeyValueBackupEntry RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KeyValueBackupEntry.Builder newBuilder(KeyValueBackupEntry.Builder other)
            +
            +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KeyValueBackupEntry.Builder newBuilder(KeyValueBackupEntry other)
            +
            +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html new file mode 100644 index 00000000..5303f83e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html @@ -0,0 +1,230 @@ + + + + + + + +KijiTableLayoutRecords.Callback (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Interface KijiTableLayoutRecords.Callback

            +
            +
            All Superinterfaces:
            KijiTableLayoutRecords
            +
            +
            +
            Enclosing interface:
            KijiTableLayoutRecords
            +
            +
            +
            +
            public static interface KijiTableLayoutRecords.Callback
            extends KijiTableLayoutRecords
            + + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.schema.avro.KijiTableLayoutRecords
            KijiTableLayoutRecords.Callback
            +  + + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.ProtocolPROTOCOL + +
            +           
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +PROTOCOL

            +
            +static final org.apache.avro.Protocol PROTOCOL
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KijiTableLayoutRecords.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KijiTableLayoutRecords.html new file mode 100644 index 00000000..8b965b50 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/KijiTableLayoutRecords.html @@ -0,0 +1,225 @@ + + + + + + + +KijiTableLayoutRecords (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Interface KijiTableLayoutRecords

            +
            +
            All Known Subinterfaces:
            KijiTableLayoutRecords.Callback
            +
            +
            +
            +
            public interface KijiTableLayoutRecords
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static interfaceKijiTableLayoutRecords.Callback + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.ProtocolPROTOCOL + +
            +           
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +PROTOCOL

            +
            +static final org.apache.avro.Protocol PROTOCOL
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/LocalityGroupDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/LocalityGroupDesc.Builder.html new file mode 100644 index 00000000..2c3bc5f8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/LocalityGroupDesc.Builder.html @@ -0,0 +1,1396 @@ + + + + + + + +LocalityGroupDesc.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class LocalityGroupDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<LocalityGroupDesc>
+          extended by org.kiji.schema.avro.LocalityGroupDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<LocalityGroupDesc>
            +
            +
            +
            Enclosing class:
            LocalityGroupDesc
            +
            +
            +
            +
            public static class LocalityGroupDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<LocalityGroupDesc>
            implements org.apache.avro.data.RecordBuilder<LocalityGroupDesc>
            + + +

            +RecordBuilder for LocalityGroupDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + LocalityGroupDescbuild() + +
            +           
            + LocalityGroupDesc.BuilderclearAliases() + +
            +          Clears the value of the 'aliases' field
            + LocalityGroupDesc.BuilderclearCompressionType() + +
            +          Clears the value of the 'compression_type' field
            + LocalityGroupDesc.BuilderclearDelete() + +
            +          Clears the value of the 'delete' field
            + LocalityGroupDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + LocalityGroupDesc.BuilderclearEnabled() + +
            +          Clears the value of the 'enabled' field
            + LocalityGroupDesc.BuilderclearFamilies() + +
            +          Clears the value of the 'families' field
            + LocalityGroupDesc.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + LocalityGroupDesc.BuilderclearInMemory() + +
            +          Clears the value of the 'in_memory' field
            + LocalityGroupDesc.BuilderclearMaxVersions() + +
            +          Clears the value of the 'max_versions' field
            + LocalityGroupDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + LocalityGroupDesc.BuilderclearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + LocalityGroupDesc.BuilderclearTtlSeconds() + +
            +          Clears the value of the 'ttl_seconds' field
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field
            + CompressionTypegetCompressionType() + +
            +          Gets the value of the 'compression_type' field
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field
            + List<FamilyDesc>getFamilies() + +
            +          Gets the value of the 'families' field
            + IntegergetId() + +
            +          Gets the value of the 'id' field
            + BooleangetInMemory() + +
            +          Gets the value of the 'in_memory' field
            + IntegergetMaxVersions() + +
            +          Gets the value of the 'max_versions' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field
            + IntegergetTtlSeconds() + +
            +          Gets the value of the 'ttl_seconds' field
            + booleanhasAliases() + +
            +          Checks whether the 'aliases' field has been set
            + booleanhasCompressionType() + +
            +          Checks whether the 'compression_type' field has been set
            + booleanhasDelete() + +
            +          Checks whether the 'delete' field has been set
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasEnabled() + +
            +          Checks whether the 'enabled' field has been set
            + booleanhasFamilies() + +
            +          Checks whether the 'families' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + booleanhasInMemory() + +
            +          Checks whether the 'in_memory' field has been set
            + booleanhasMaxVersions() + +
            +          Checks whether the 'max_versions' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasRenamedFrom() + +
            +          Checks whether the 'renamed_from' field has been set
            + booleanhasTtlSeconds() + +
            +          Checks whether the 'ttl_seconds' field has been set
            + LocalityGroupDesc.BuildersetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + LocalityGroupDesc.BuildersetCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field
            + LocalityGroupDesc.BuildersetDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + LocalityGroupDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + LocalityGroupDesc.BuildersetEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + LocalityGroupDesc.BuildersetFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            + LocalityGroupDesc.BuildersetId(int value) + +
            +          Sets the value of the 'id' field
            + LocalityGroupDesc.BuildersetInMemory(boolean value) + +
            +          Sets the value of the 'in_memory' field
            + LocalityGroupDesc.BuildersetMaxVersions(int value) + +
            +          Sets the value of the 'max_versions' field
            + LocalityGroupDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + LocalityGroupDesc.BuildersetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            + LocalityGroupDesc.BuildersetTtlSeconds(int value) + +
            +          Sets the value of the 'ttl_seconds' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public LocalityGroupDesc.Builder setId(int value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public LocalityGroupDesc.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public LocalityGroupDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public LocalityGroupDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public LocalityGroupDesc.Builder setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAliases

            +
            +public boolean hasAliases()
            +
            +
            Checks whether the 'aliases' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAliases

            +
            +public LocalityGroupDesc.Builder clearAliases()
            +
            +
            Clears the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public LocalityGroupDesc.Builder setEnabled(boolean value)
            +
            +
            Sets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEnabled

            +
            +public boolean hasEnabled()
            +
            +
            Checks whether the 'enabled' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEnabled

            +
            +public LocalityGroupDesc.Builder clearEnabled()
            +
            +
            Clears the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public LocalityGroupDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public LocalityGroupDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getInMemory

            +
            +public Boolean getInMemory()
            +
            +
            Gets the value of the 'in_memory' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setInMemory

            +
            +public LocalityGroupDesc.Builder setInMemory(boolean value)
            +
            +
            Sets the value of the 'in_memory' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasInMemory

            +
            +public boolean hasInMemory()
            +
            +
            Checks whether the 'in_memory' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearInMemory

            +
            +public LocalityGroupDesc.Builder clearInMemory()
            +
            +
            Clears the value of the 'in_memory' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMaxVersions

            +
            +public Integer getMaxVersions()
            +
            +
            Gets the value of the 'max_versions' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMaxVersions

            +
            +public LocalityGroupDesc.Builder setMaxVersions(int value)
            +
            +
            Sets the value of the 'max_versions' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasMaxVersions

            +
            +public boolean hasMaxVersions()
            +
            +
            Checks whether the 'max_versions' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearMaxVersions

            +
            +public LocalityGroupDesc.Builder clearMaxVersions()
            +
            +
            Clears the value of the 'max_versions' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getTtlSeconds

            +
            +public Integer getTtlSeconds()
            +
            +
            Gets the value of the 'ttl_seconds' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTtlSeconds

            +
            +public LocalityGroupDesc.Builder setTtlSeconds(int value)
            +
            +
            Sets the value of the 'ttl_seconds' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasTtlSeconds

            +
            +public boolean hasTtlSeconds()
            +
            +
            Checks whether the 'ttl_seconds' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearTtlSeconds

            +
            +public LocalityGroupDesc.Builder clearTtlSeconds()
            +
            +
            Clears the value of the 'ttl_seconds' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getCompressionType

            +
            +public CompressionType getCompressionType()
            +
            +
            Gets the value of the 'compression_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setCompressionType

            +
            +public LocalityGroupDesc.Builder setCompressionType(CompressionType value)
            +
            +
            Sets the value of the 'compression_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasCompressionType

            +
            +public boolean hasCompressionType()
            +
            +
            Checks whether the 'compression_type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearCompressionType

            +
            +public LocalityGroupDesc.Builder clearCompressionType()
            +
            +
            Clears the value of the 'compression_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getFamilies

            +
            +public List<FamilyDesc> getFamilies()
            +
            +
            Gets the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setFamilies

            +
            +public LocalityGroupDesc.Builder setFamilies(List<FamilyDesc> value)
            +
            +
            Sets the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasFamilies

            +
            +public boolean hasFamilies()
            +
            +
            Checks whether the 'families' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearFamilies

            +
            +public LocalityGroupDesc.Builder clearFamilies()
            +
            +
            Clears the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public LocalityGroupDesc.Builder setDelete(boolean value)
            +
            +
            Sets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDelete

            +
            +public boolean hasDelete()
            +
            +
            Checks whether the 'delete' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDelete

            +
            +public LocalityGroupDesc.Builder clearDelete()
            +
            +
            Clears the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public LocalityGroupDesc.Builder setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasRenamedFrom

            +
            +public boolean hasRenamedFrom()
            +
            +
            Checks whether the 'renamed_from' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearRenamedFrom

            +
            +public LocalityGroupDesc.Builder clearRenamedFrom()
            +
            +
            Clears the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public LocalityGroupDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<LocalityGroupDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/LocalityGroupDesc.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/LocalityGroupDesc.html new file mode 100644 index 00000000..3dc30fb3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/LocalityGroupDesc.html @@ -0,0 +1,1332 @@ + + + + + + + +LocalityGroupDesc (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class LocalityGroupDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.LocalityGroupDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class LocalityGroupDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classLocalityGroupDesc.Builder + +
            +          RecordBuilder for LocalityGroupDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<String>aliases + +
            +          Deprecated. 
            + CompressionTypecompression_type + +
            +          Deprecated. 
            + booleandelete + +
            +          Deprecated. 
            + Stringdescription + +
            +          Deprecated. 
            + booleanenabled + +
            +          Deprecated. 
            + List<FamilyDesc>families + +
            +          Deprecated. 
            + intid + +
            +          Deprecated. 
            + booleanin_memory + +
            +          Deprecated. 
            + intmax_versions + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringrenamed_from + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + intttl_seconds + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            LocalityGroupDesc() + +
            +          Default constructor.
            LocalityGroupDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + Boolean in_memory, + Integer max_versions, + Integer ttl_seconds, + CompressionType compression_type, + List<FamilyDesc> families, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field.
            + CompressionTypegetCompressionType() + +
            +          Gets the value of the 'compression_type' field.
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field.
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field.
            + List<FamilyDesc>getFamilies() + +
            +          Gets the value of the 'families' field.
            + IntegergetId() + +
            +          Gets the value of the 'id' field.
            + BooleangetInMemory() + +
            +          Gets the value of the 'in_memory' field.
            + IntegergetMaxVersions() + +
            +          Gets the value of the 'max_versions' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + IntegergetTtlSeconds() + +
            +          Gets the value of the 'ttl_seconds' field.
            +static LocalityGroupDesc.BuildernewBuilder() + +
            +          Creates a new LocalityGroupDesc RecordBuilder
            +static LocalityGroupDesc.BuildernewBuilder(LocalityGroupDesc.Builder other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder
            +static LocalityGroupDesc.BuildernewBuilder(LocalityGroupDesc other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field.
            + voidsetCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field.
            + voidsetDelete(Boolean value) + +
            +          Sets the value of the 'delete' field.
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetEnabled(Boolean value) + +
            +          Sets the value of the 'enabled' field.
            + voidsetFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field.
            + voidsetId(Integer value) + +
            +          Sets the value of the 'id' field.
            + voidsetInMemory(Boolean value) + +
            +          Sets the value of the 'in_memory' field.
            + voidsetMaxVersions(Integer value) + +
            +          Sets the value of the 'max_versions' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field.
            + voidsetTtlSeconds(Integer value) + +
            +          Sets the value of the 'ttl_seconds' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public int id
            +
            +
            Deprecated. 
            Locality group ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Locality group primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +aliases

            +
            +@Deprecated
+public List<String> aliases
            +
            +
            Deprecated. 
            Locality group name aliases. +

            +

            +
            +
            +
            + +

            +enabled

            +
            +@Deprecated
+public boolean enabled
            +
            +
            Deprecated. 
            When false, the locality group and its famillies are not visible. +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the locality group. +

            +

            +
            +
            +
            + +

            +in_memory

            +
            +@Deprecated
+public boolean in_memory
            +
            +
            Deprecated. 
            Reduce latency by forcing all data to be kept in memory. +

            +

            +
            +
            +
            + +

            +max_versions

            +
            +@Deprecated
+public int max_versions
            +
            +
            Deprecated. 
            Maximum number of the most recent cell versions to retain. +

            +

            +
            +
            +
            + +

            +ttl_seconds

            +
            +@Deprecated
+public int ttl_seconds
            +
            +
            Deprecated. 
            Length of time in seconds to retain cells. +

            +

            +
            +
            +
            + +

            +compression_type

            +
            +@Deprecated
+public CompressionType compression_type
            +
            +
            Deprecated. 
            Data compression type. +

            +

            +
            +
            +
            + +

            +families

            +
            +@Deprecated
+public List<FamilyDesc> families
            +
            +
            Deprecated. 
            Column family descriptors. +

            +

            +
            +
            +
            + +

            +delete

            +
            +@Deprecated
+public boolean delete
            +
            +
            Deprecated. 
            When true, applying this layout deletes the locality group. +

            +

            +
            +
            +
            + +

            +renamed_from

            +
            +@Deprecated
+public String renamed_from
            +
            +
            Deprecated. 
            Reference primary name of the locality group, when renaming. +

            +

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

            +LocalityGroupDesc

            +
            +public LocalityGroupDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +LocalityGroupDesc

            +
            +public LocalityGroupDesc(Integer id,
+                         String name,
+                         List<String> aliases,
+                         Boolean enabled,
+                         String description,
+                         Boolean in_memory,
+                         Integer max_versions,
+                         Integer ttl_seconds,
+                         CompressionType compression_type,
+                         List<FamilyDesc> families,
+                         Boolean delete,
+                         String renamed_from)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field. + Locality group ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Integer value)
            +
            +
            Sets the value of the 'id' field. + Locality group ID. Not visible to the user. 0 means unset. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Locality group primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Locality group primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field. + Locality group name aliases. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public void setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field. + Locality group name aliases. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field. + When false, the locality group and its famillies are not visible. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public void setEnabled(Boolean value)
            +
            +
            Sets the value of the 'enabled' field. + When false, the locality group and its famillies are not visible. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the locality group. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the locality group. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getInMemory

            +
            +public Boolean getInMemory()
            +
            +
            Gets the value of the 'in_memory' field. + Reduce latency by forcing all data to be kept in memory. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setInMemory

            +
            +public void setInMemory(Boolean value)
            +
            +
            Sets the value of the 'in_memory' field. + Reduce latency by forcing all data to be kept in memory. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMaxVersions

            +
            +public Integer getMaxVersions()
            +
            +
            Gets the value of the 'max_versions' field. + Maximum number of the most recent cell versions to retain. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMaxVersions

            +
            +public void setMaxVersions(Integer value)
            +
            +
            Sets the value of the 'max_versions' field. + Maximum number of the most recent cell versions to retain. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getTtlSeconds

            +
            +public Integer getTtlSeconds()
            +
            +
            Gets the value of the 'ttl_seconds' field. + Length of time in seconds to retain cells. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTtlSeconds

            +
            +public void setTtlSeconds(Integer value)
            +
            +
            Sets the value of the 'ttl_seconds' field. + Length of time in seconds to retain cells. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getCompressionType

            +
            +public CompressionType getCompressionType()
            +
            +
            Gets the value of the 'compression_type' field. + Data compression type. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setCompressionType

            +
            +public void setCompressionType(CompressionType value)
            +
            +
            Sets the value of the 'compression_type' field. + Data compression type. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getFamilies

            +
            +public List<FamilyDesc> getFamilies()
            +
            +
            Gets the value of the 'families' field. + Column family descriptors. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setFamilies

            +
            +public void setFamilies(List<FamilyDesc> value)
            +
            +
            Sets the value of the 'families' field. + Column family descriptors. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field. + When true, applying this layout deletes the locality group. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public void setDelete(Boolean value)
            +
            +
            Sets the value of the 'delete' field. + When true, applying this layout deletes the locality group. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field. + Reference primary name of the locality group, when renaming. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public void setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field. + Reference primary name of the locality group, when renaming. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static LocalityGroupDesc.Builder newBuilder()
            +
            +
            Creates a new LocalityGroupDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static LocalityGroupDesc.Builder newBuilder(LocalityGroupDesc.Builder other)
            +
            +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static LocalityGroupDesc.Builder newBuilder(LocalityGroupDesc other)
            +
            +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/MD5Hash.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/MD5Hash.html new file mode 100644 index 00000000..6a287dd5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/MD5Hash.html @@ -0,0 +1,294 @@ + + + + + + + +MD5Hash (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class MD5Hash

            +
            +java.lang.Object
+  extended by org.apache.avro.generic.GenericData.Fixed
+      extended by org.apache.avro.specific.SpecificFixed
+          extended by org.kiji.schema.avro.MD5Hash
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.generic.GenericData.Fixed>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.GenericFixed
            +
            +
            +
            +
            @FixedSize(value=16)
+public class MD5Hash
            extends org.apache.avro.specific.SpecificFixed
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            MD5Hash() + +
            +          Creates a new MD5Hash
            MD5Hash(byte[] bytes) + +
            +          Creates a new MD5Hash with the given bytes
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.generic.GenericData.Fixed
            bytes, bytes, compareTo, equals, getSchema, hashCode, setSchema, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +MD5Hash

            +
            +public MD5Hash()
            +
            +
            Creates a new MD5Hash +

            +

            +
            + +

            +MD5Hash

            +
            +public MD5Hash(byte[] bytes)
            +
            +
            Creates a new MD5Hash with the given bytes +

            +

            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/MetadataBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/MetadataBackup.Builder.html new file mode 100644 index 00000000..1c7fb530 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/MetadataBackup.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +MetadataBackup.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class MetadataBackup.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<MetadataBackup>
+          extended by org.kiji.schema.avro.MetadataBackup.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<MetadataBackup>
            +
            +
            +
            Enclosing class:
            MetadataBackup
            +
            +
            +
            +
            public static class MetadataBackup.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<MetadataBackup>
            implements org.apache.avro.data.RecordBuilder<MetadataBackup>
            + + +

            +RecordBuilder for MetadataBackup instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + MetadataBackupbuild() + +
            +           
            + MetadataBackup.BuilderclearLayoutVersion() + +
            +          Clears the value of the 'layout_version' field
            + MetadataBackup.BuilderclearMetaTable() + +
            +          Clears the value of the 'meta_table' field
            + MetadataBackup.BuilderclearSchemaTable() + +
            +          Clears the value of the 'schema_table' field
            + StringgetLayoutVersion() + +
            +          Gets the value of the 'layout_version' field
            + Map<String,TableBackup>getMetaTable() + +
            +          Gets the value of the 'meta_table' field
            + List<SchemaTableEntry>getSchemaTable() + +
            +          Gets the value of the 'schema_table' field
            + booleanhasLayoutVersion() + +
            +          Checks whether the 'layout_version' field has been set
            + booleanhasMetaTable() + +
            +          Checks whether the 'meta_table' field has been set
            + booleanhasSchemaTable() + +
            +          Checks whether the 'schema_table' field has been set
            + MetadataBackup.BuildersetLayoutVersion(String value) + +
            +          Sets the value of the 'layout_version' field
            + MetadataBackup.BuildersetMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field
            + MetadataBackup.BuildersetSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getLayoutVersion

            +
            +public String getLayoutVersion()
            +
            +
            Gets the value of the 'layout_version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutVersion

            +
            +public MetadataBackup.Builder setLayoutVersion(String value)
            +
            +
            Sets the value of the 'layout_version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayoutVersion

            +
            +public boolean hasLayoutVersion()
            +
            +
            Checks whether the 'layout_version' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayoutVersion

            +
            +public MetadataBackup.Builder clearLayoutVersion()
            +
            +
            Clears the value of the 'layout_version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public List<SchemaTableEntry> getSchemaTable()
            +
            +
            Gets the value of the 'schema_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSchemaTable

            +
            +public MetadataBackup.Builder setSchemaTable(List<SchemaTableEntry> value)
            +
            +
            Sets the value of the 'schema_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasSchemaTable

            +
            +public boolean hasSchemaTable()
            +
            +
            Checks whether the 'schema_table' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearSchemaTable

            +
            +public MetadataBackup.Builder clearSchemaTable()
            +
            +
            Clears the value of the 'schema_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMetaTable

            +
            +public Map<String,TableBackup> getMetaTable()
            +
            +
            Gets the value of the 'meta_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMetaTable

            +
            +public MetadataBackup.Builder setMetaTable(Map<String,TableBackup> value)
            +
            +
            Sets the value of the 'meta_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasMetaTable

            +
            +public boolean hasMetaTable()
            +
            +
            Checks whether the 'meta_table' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearMetaTable

            +
            +public MetadataBackup.Builder clearMetaTable()
            +
            +
            Clears the value of the 'meta_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public MetadataBackup build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<MetadataBackup>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/MetadataBackup.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/MetadataBackup.html new file mode 100644 index 00000000..2c41a9d9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/MetadataBackup.html @@ -0,0 +1,675 @@ + + + + + + + +MetadataBackup (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class MetadataBackup

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.MetadataBackup
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class MetadataBackup
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classMetadataBackup.Builder + +
            +          RecordBuilder for MetadataBackup instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringlayout_version + +
            +          Deprecated. 
            + Map<String,TableBackup>meta_table + +
            +          Deprecated. 
            + List<SchemaTableEntry>schema_table + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            MetadataBackup() + +
            +          Default constructor.
            MetadataBackup(String layout_version, + List<SchemaTableEntry> schema_table, + Map<String,TableBackup> meta_table) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetLayoutVersion() + +
            +          Gets the value of the 'layout_version' field.
            + Map<String,TableBackup>getMetaTable() + +
            +          Gets the value of the 'meta_table' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + List<SchemaTableEntry>getSchemaTable() + +
            +          Gets the value of the 'schema_table' field.
            +static MetadataBackup.BuildernewBuilder() + +
            +          Creates a new MetadataBackup RecordBuilder
            +static MetadataBackup.BuildernewBuilder(MetadataBackup.Builder other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing Builder
            +static MetadataBackup.BuildernewBuilder(MetadataBackup other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetLayoutVersion(String value) + +
            +          Sets the value of the 'layout_version' field.
            + voidsetMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field.
            + voidsetSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +layout_version

            +
            +@Deprecated
+public String layout_version
            +
            +
            Deprecated. 
            Layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            + +

            +schema_table

            +
            +@Deprecated
+public List<SchemaTableEntry> schema_table
            +
            +
            Deprecated. 
            Schema entries. +

            +

            +
            +
            +
            + +

            +meta_table

            +
            +@Deprecated
+public Map<String,TableBackup> meta_table
            +
            +
            Deprecated. 
            Map from table names to table backup records. +

            +

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

            +MetadataBackup

            +
            +public MetadataBackup()
            +
            +
            Default constructor. +

            +

            +
            + +

            +MetadataBackup

            +
            +public MetadataBackup(String layout_version,
+                      List<SchemaTableEntry> schema_table,
+                      Map<String,TableBackup> meta_table)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getLayoutVersion

            +
            +public String getLayoutVersion()
            +
            +
            Gets the value of the 'layout_version' field. + Layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutVersion

            +
            +public void setLayoutVersion(String value)
            +
            +
            Sets the value of the 'layout_version' field. + Layout version (eg. "kiji-1.0"). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public List<SchemaTableEntry> getSchemaTable()
            +
            +
            Gets the value of the 'schema_table' field. + Schema entries. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSchemaTable

            +
            +public void setSchemaTable(List<SchemaTableEntry> value)
            +
            +
            Sets the value of the 'schema_table' field. + Schema entries. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMetaTable

            +
            +public Map<String,TableBackup> getMetaTable()
            +
            +
            Gets the value of the 'meta_table' field. + Map from table names to table backup records. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMetaTable

            +
            +public void setMetaTable(Map<String,TableBackup> value)
            +
            +
            Sets the value of the 'meta_table' field. + Map from table names to table backup records. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static MetadataBackup.Builder newBuilder()
            +
            +
            Creates a new MetadataBackup RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static MetadataBackup.Builder newBuilder(MetadataBackup.Builder other)
            +
            +
            Creates a new MetadataBackup RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static MetadataBackup.Builder newBuilder(MetadataBackup other)
            +
            +
            Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/RowKeyEncoding.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/RowKeyEncoding.html new file mode 100644 index 00000000..2f0bc507 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/RowKeyEncoding.html @@ -0,0 +1,375 @@ + + + + + + + +RowKeyEncoding (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum RowKeyEncoding

            +
            +java.lang.Object
+  extended by java.lang.Enum<RowKeyEncoding>
+      extended by org.kiji.schema.avro.RowKeyEncoding
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<RowKeyEncoding>
            +
            +
            +
            +
            public enum RowKeyEncoding
            extends Enum<RowKeyEncoding>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            HASH + +
            +           
            HASH_PREFIX + +
            +           
            RAW + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static RowKeyEncodingvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static RowKeyEncoding[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +RAW

            +
            +public static final RowKeyEncoding RAW
            +
            +
            +
            +
            +
            + +

            +HASH

            +
            +public static final RowKeyEncoding HASH
            +
            +
            +
            +
            +
            + +

            +HASH_PREFIX

            +
            +public static final RowKeyEncoding HASH_PREFIX
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static RowKeyEncoding[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (RowKeyEncoding c : RowKeyEncoding.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static RowKeyEncoding valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/RowKeyFormat.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/RowKeyFormat.Builder.html new file mode 100644 index 00000000..5eee947e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/RowKeyFormat.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +RowKeyFormat.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class RowKeyFormat.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<RowKeyFormat>
+          extended by org.kiji.schema.avro.RowKeyFormat.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<RowKeyFormat>
            +
            +
            +
            Enclosing class:
            RowKeyFormat
            +
            +
            +
            +
            public static class RowKeyFormat.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<RowKeyFormat>
            implements org.apache.avro.data.RecordBuilder<RowKeyFormat>
            + + +

            +RecordBuilder for RowKeyFormat instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + RowKeyFormatbuild() + +
            +           
            + RowKeyFormat.BuilderclearEncoding() + +
            +          Clears the value of the 'encoding' field
            + RowKeyFormat.BuilderclearHashSize() + +
            +          Clears the value of the 'hash_size' field
            + RowKeyFormat.BuilderclearHashType() + +
            +          Clears the value of the 'hash_type' field
            + RowKeyEncodinggetEncoding() + +
            +          Gets the value of the 'encoding' field
            + IntegergetHashSize() + +
            +          Gets the value of the 'hash_size' field
            + HashTypegetHashType() + +
            +          Gets the value of the 'hash_type' field
            + booleanhasEncoding() + +
            +          Checks whether the 'encoding' field has been set
            + booleanhasHashSize() + +
            +          Checks whether the 'hash_size' field has been set
            + booleanhasHashType() + +
            +          Checks whether the 'hash_type' field has been set
            + RowKeyFormat.BuildersetEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            + RowKeyFormat.BuildersetHashSize(int value) + +
            +          Sets the value of the 'hash_size' field
            + RowKeyFormat.BuildersetHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEncoding

            +
            +public RowKeyEncoding getEncoding()
            +
            +
            Gets the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEncoding

            +
            +public RowKeyFormat.Builder setEncoding(RowKeyEncoding value)
            +
            +
            Sets the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEncoding

            +
            +public boolean hasEncoding()
            +
            +
            Checks whether the 'encoding' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEncoding

            +
            +public RowKeyFormat.Builder clearEncoding()
            +
            +
            Clears the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashType

            +
            +public HashType getHashType()
            +
            +
            Gets the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashType

            +
            +public RowKeyFormat.Builder setHashType(HashType value)
            +
            +
            Sets the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHashType

            +
            +public boolean hasHashType()
            +
            +
            Checks whether the 'hash_type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHashType

            +
            +public RowKeyFormat.Builder clearHashType()
            +
            +
            Clears the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashSize

            +
            +public Integer getHashSize()
            +
            +
            Gets the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashSize

            +
            +public RowKeyFormat.Builder setHashSize(int value)
            +
            +
            Sets the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHashSize

            +
            +public boolean hasHashSize()
            +
            +
            Checks whether the 'hash_size' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHashSize

            +
            +public RowKeyFormat.Builder clearHashSize()
            +
            +
            Clears the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public RowKeyFormat build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<RowKeyFormat>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/RowKeyFormat.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/RowKeyFormat.html new file mode 100644 index 00000000..c529892d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/RowKeyFormat.html @@ -0,0 +1,681 @@ + + + + + + + +RowKeyFormat (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class RowKeyFormat

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.RowKeyFormat
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class RowKeyFormat
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classRowKeyFormat.Builder + +
            +          RecordBuilder for RowKeyFormat instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + RowKeyEncodingencoding + +
            +          Deprecated. 
            + inthash_size + +
            +          Deprecated. 
            + HashTypehash_type + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            RowKeyFormat() + +
            +          Default constructor.
            RowKeyFormat(RowKeyEncoding encoding, + HashType hash_type, + Integer hash_size) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + RowKeyEncodinggetEncoding() + +
            +          Gets the value of the 'encoding' field.
            + IntegergetHashSize() + +
            +          Gets the value of the 'hash_size' field.
            + HashTypegetHashType() + +
            +          Gets the value of the 'hash_type' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static RowKeyFormat.BuildernewBuilder() + +
            +          Creates a new RowKeyFormat RecordBuilder
            +static RowKeyFormat.BuildernewBuilder(RowKeyFormat.Builder other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing Builder
            +static RowKeyFormat.BuildernewBuilder(RowKeyFormat other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field.
            + voidsetHashSize(Integer value) + +
            +          Sets the value of the 'hash_size' field.
            + voidsetHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +encoding

            +
            +@Deprecated
+public RowKeyEncoding encoding
            +
            +
            Deprecated. 
            Encoding of the row key. +

            +

            +
            +
            +
            + +

            +hash_type

            +
            +@Deprecated
+public HashType hash_type
            +
            +
            Deprecated. 
            Type of hashing used, if any. +

            +

            +
            +
            +
            + +

            +hash_size

            +
            +@Deprecated
+public int hash_size
            +
            +
            Deprecated. 
            Size of the hash, in bytes. + - unused when encoding is RAW. + - smaller than the hash size used for HASH or HASH_PREFIX. +

            +

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

            +RowKeyFormat

            +
            +public RowKeyFormat()
            +
            +
            Default constructor. +

            +

            +
            + +

            +RowKeyFormat

            +
            +public RowKeyFormat(RowKeyEncoding encoding,
+                    HashType hash_type,
+                    Integer hash_size)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getEncoding

            +
            +public RowKeyEncoding getEncoding()
            +
            +
            Gets the value of the 'encoding' field. + Encoding of the row key. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEncoding

            +
            +public void setEncoding(RowKeyEncoding value)
            +
            +
            Sets the value of the 'encoding' field. + Encoding of the row key. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashType

            +
            +public HashType getHashType()
            +
            +
            Gets the value of the 'hash_type' field. + Type of hashing used, if any. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashType

            +
            +public void setHashType(HashType value)
            +
            +
            Sets the value of the 'hash_type' field. + Type of hashing used, if any. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashSize

            +
            +public Integer getHashSize()
            +
            +
            Gets the value of the 'hash_size' field. + * Size of the hash, in bytes. + - unused when encoding is RAW. + - smaller than the hash size used for HASH or HASH_PREFIX. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashSize

            +
            +public void setHashSize(Integer value)
            +
            +
            Sets the value of the 'hash_size' field. + * Size of the hash, in bytes. + - unused when encoding is RAW. + - smaller than the hash size used for HASH or HASH_PREFIX. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat.Builder newBuilder()
            +
            +
            Creates a new RowKeyFormat RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat.Builder newBuilder(RowKeyFormat.Builder other)
            +
            +
            Creates a new RowKeyFormat RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat.Builder newBuilder(RowKeyFormat other)
            +
            +
            Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaStorage.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaStorage.html new file mode 100644 index 00000000..95c8e5a8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaStorage.html @@ -0,0 +1,375 @@ + + + + + + + +SchemaStorage (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum SchemaStorage

            +
            +java.lang.Object
+  extended by java.lang.Enum<SchemaStorage>
+      extended by org.kiji.schema.avro.SchemaStorage
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<SchemaStorage>
            +
            +
            +
            +
            public enum SchemaStorage
            extends Enum<SchemaStorage>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            FINAL + +
            +           
            HASH + +
            +           
            UID + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static SchemaStoragevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaStorage[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +HASH

            +
            +public static final SchemaStorage HASH
            +
            +
            +
            +
            +
            + +

            +UID

            +
            +public static final SchemaStorage UID
            +
            +
            +
            +
            +
            + +

            +FINAL

            +
            +public static final SchemaStorage FINAL
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static SchemaStorage[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (SchemaStorage c : SchemaStorage.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static SchemaStorage valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaTableEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaTableEntry.Builder.html new file mode 100644 index 00000000..c661aaa5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaTableEntry.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +SchemaTableEntry.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class SchemaTableEntry.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<SchemaTableEntry>
+          extended by org.kiji.schema.avro.SchemaTableEntry.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<SchemaTableEntry>
            +
            +
            +
            Enclosing class:
            SchemaTableEntry
            +
            +
            +
            +
            public static class SchemaTableEntry.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<SchemaTableEntry>
            implements org.apache.avro.data.RecordBuilder<SchemaTableEntry>
            + + +

            +RecordBuilder for SchemaTableEntry instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + SchemaTableEntrybuild() + +
            +           
            + SchemaTableEntry.BuilderclearAvroSchema() + +
            +          Clears the value of the 'avro_schema' field
            + SchemaTableEntry.BuilderclearHash() + +
            +          Clears the value of the 'hash' field
            + SchemaTableEntry.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + StringgetAvroSchema() + +
            +          Gets the value of the 'avro_schema' field
            + MD5HashgetHash() + +
            +          Gets the value of the 'hash' field
            + LonggetId() + +
            +          Gets the value of the 'id' field
            + booleanhasAvroSchema() + +
            +          Checks whether the 'avro_schema' field has been set
            + booleanhasHash() + +
            +          Checks whether the 'hash' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + SchemaTableEntry.BuildersetAvroSchema(String value) + +
            +          Sets the value of the 'avro_schema' field
            + SchemaTableEntry.BuildersetHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field
            + SchemaTableEntry.BuildersetId(long value) + +
            +          Sets the value of the 'id' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Long getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public SchemaTableEntry.Builder setId(long value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public SchemaTableEntry.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHash

            +
            +public MD5Hash getHash()
            +
            +
            Gets the value of the 'hash' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHash

            +
            +public SchemaTableEntry.Builder setHash(MD5Hash value)
            +
            +
            Sets the value of the 'hash' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHash

            +
            +public boolean hasHash()
            +
            +
            Checks whether the 'hash' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHash

            +
            +public SchemaTableEntry.Builder clearHash()
            +
            +
            Clears the value of the 'hash' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAvroSchema

            +
            +public String getAvroSchema()
            +
            +
            Gets the value of the 'avro_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAvroSchema

            +
            +public SchemaTableEntry.Builder setAvroSchema(String value)
            +
            +
            Sets the value of the 'avro_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAvroSchema

            +
            +public boolean hasAvroSchema()
            +
            +
            Checks whether the 'avro_schema' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAvroSchema

            +
            +public SchemaTableEntry.Builder clearAvroSchema()
            +
            +
            Clears the value of the 'avro_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public SchemaTableEntry build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<SchemaTableEntry>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaTableEntry.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaTableEntry.html new file mode 100644 index 00000000..6c3b870d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaTableEntry.html @@ -0,0 +1,675 @@ + + + + + + + +SchemaTableEntry (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class SchemaTableEntry

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.SchemaTableEntry
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class SchemaTableEntry
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classSchemaTableEntry.Builder + +
            +          RecordBuilder for SchemaTableEntry instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringavro_schema + +
            +          Deprecated. 
            + MD5Hashhash + +
            +          Deprecated. 
            + longid + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            SchemaTableEntry() + +
            +          Default constructor.
            SchemaTableEntry(Long id, + MD5Hash hash, + String avro_schema) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetAvroSchema() + +
            +          Gets the value of the 'avro_schema' field.
            + MD5HashgetHash() + +
            +          Gets the value of the 'hash' field.
            + LonggetId() + +
            +          Gets the value of the 'id' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static SchemaTableEntry.BuildernewBuilder() + +
            +          Creates a new SchemaTableEntry RecordBuilder
            +static SchemaTableEntry.BuildernewBuilder(SchemaTableEntry.Builder other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder
            +static SchemaTableEntry.BuildernewBuilder(SchemaTableEntry other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAvroSchema(String value) + +
            +          Sets the value of the 'avro_schema' field.
            + voidsetHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field.
            + voidsetId(Long value) + +
            +          Sets the value of the 'id' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public long id
            +
            +
            Deprecated. 
            Schema ID: positive integers only. +

            +

            +
            +
            +
            + +

            +hash

            +
            +@Deprecated
+public MD5Hash hash
            +
            +
            Deprecated. 
            128 bits (16 bytes) hash of the schema JSON representation. +

            +

            +
            +
            +
            + +

            +avro_schema

            +
            +@Deprecated
+public String avro_schema
            +
            +
            Deprecated. 
            JSON representation of the schema. +

            +

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

            +SchemaTableEntry

            +
            +public SchemaTableEntry()
            +
            +
            Default constructor. +

            +

            +
            + +

            +SchemaTableEntry

            +
            +public SchemaTableEntry(Long id,
+                        MD5Hash hash,
+                        String avro_schema)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Long getId()
            +
            +
            Gets the value of the 'id' field. + Schema ID: positive integers only. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Long value)
            +
            +
            Sets the value of the 'id' field. + Schema ID: positive integers only. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHash

            +
            +public MD5Hash getHash()
            +
            +
            Gets the value of the 'hash' field. + 128 bits (16 bytes) hash of the schema JSON representation. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHash

            +
            +public void setHash(MD5Hash value)
            +
            +
            Sets the value of the 'hash' field. + 128 bits (16 bytes) hash of the schema JSON representation. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAvroSchema

            +
            +public String getAvroSchema()
            +
            +
            Gets the value of the 'avro_schema' field. + JSON representation of the schema. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAvroSchema

            +
            +public void setAvroSchema(String value)
            +
            +
            Sets the value of the 'avro_schema' field. + JSON representation of the schema. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static SchemaTableEntry.Builder newBuilder()
            +
            +
            Creates a new SchemaTableEntry RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static SchemaTableEntry.Builder newBuilder(SchemaTableEntry.Builder other)
            +
            +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static SchemaTableEntry.Builder newBuilder(SchemaTableEntry other)
            +
            +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaType.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaType.html new file mode 100644 index 00000000..a401d09b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/SchemaType.html @@ -0,0 +1,375 @@ + + + + + + + +SchemaType (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum SchemaType

            +
            +java.lang.Object
+  extended by java.lang.Enum<SchemaType>
+      extended by org.kiji.schema.avro.SchemaType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<SchemaType>
            +
            +
            +
            +
            public enum SchemaType
            extends Enum<SchemaType>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            CLASS + +
            +           
            COUNTER + +
            +           
            INLINE + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static SchemaTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +INLINE

            +
            +public static final SchemaType INLINE
            +
            +
            +
            +
            +
            + +

            +CLASS

            +
            +public static final SchemaType CLASS
            +
            +
            +
            +
            +
            + +

            +COUNTER

            +
            +public static final SchemaType COUNTER
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static SchemaType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (SchemaType c : SchemaType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static SchemaType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableBackup.Builder.html new file mode 100644 index 00000000..105deac6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableBackup.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +TableBackup.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableBackup.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<TableBackup>
+          extended by org.kiji.schema.avro.TableBackup.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<TableBackup>
            +
            +
            +
            Enclosing class:
            TableBackup
            +
            +
            +
            +
            public static class TableBackup.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<TableBackup>
            implements org.apache.avro.data.RecordBuilder<TableBackup>
            + + +

            +RecordBuilder for TableBackup instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TableBackupbuild() + +
            +           
            + TableBackup.BuilderclearKeyValues() + +
            +          Clears the value of the 'key_values' field
            + TableBackup.BuilderclearLayouts() + +
            +          Clears the value of the 'layouts' field
            + TableBackup.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + List<KeyValueBackupEntry>getKeyValues() + +
            +          Gets the value of the 'key_values' field
            + List<TableLayoutBackupEntry>getLayouts() + +
            +          Gets the value of the 'layouts' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + booleanhasKeyValues() + +
            +          Checks whether the 'key_values' field has been set
            + booleanhasLayouts() + +
            +          Checks whether the 'layouts' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + TableBackup.BuildersetKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field
            + TableBackup.BuildersetLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field
            + TableBackup.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public TableBackup.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public TableBackup.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayouts

            +
            +public List<TableLayoutBackupEntry> getLayouts()
            +
            +
            Gets the value of the 'layouts' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayouts

            +
            +public TableBackup.Builder setLayouts(List<TableLayoutBackupEntry> value)
            +
            +
            Sets the value of the 'layouts' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayouts

            +
            +public boolean hasLayouts()
            +
            +
            Checks whether the 'layouts' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayouts

            +
            +public TableBackup.Builder clearLayouts()
            +
            +
            Clears the value of the 'layouts' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeyValues

            +
            +public List<KeyValueBackupEntry> getKeyValues()
            +
            +
            Gets the value of the 'key_values' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeyValues

            +
            +public TableBackup.Builder setKeyValues(List<KeyValueBackupEntry> value)
            +
            +
            Sets the value of the 'key_values' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasKeyValues

            +
            +public boolean hasKeyValues()
            +
            +
            Checks whether the 'key_values' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearKeyValues

            +
            +public TableBackup.Builder clearKeyValues()
            +
            +
            Clears the value of the 'key_values' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public TableBackup build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<TableBackup>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableBackup.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableBackup.html new file mode 100644 index 00000000..651e07d9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableBackup.html @@ -0,0 +1,675 @@ + + + + + + + +TableBackup (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableBackup

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.TableBackup
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class TableBackup
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTableBackup.Builder + +
            +          RecordBuilder for TableBackup instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<KeyValueBackupEntry>key_values + +
            +          Deprecated. 
            + List<TableLayoutBackupEntry>layouts + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            TableBackup() + +
            +          Default constructor.
            TableBackup(String name, + List<TableLayoutBackupEntry> layouts, + List<KeyValueBackupEntry> key_values) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<KeyValueBackupEntry>getKeyValues() + +
            +          Gets the value of the 'key_values' field.
            + List<TableLayoutBackupEntry>getLayouts() + +
            +          Gets the value of the 'layouts' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static TableBackup.BuildernewBuilder() + +
            +          Creates a new TableBackup RecordBuilder
            +static TableBackup.BuildernewBuilder(TableBackup.Builder other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing Builder
            +static TableBackup.BuildernewBuilder(TableBackup other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field.
            + voidsetLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Table name. +

            +

            +
            +
            +
            + +

            +layouts

            +
            +@Deprecated
+public List<TableLayoutBackupEntry> layouts
            +
            +
            Deprecated. 
            Sequence of layouts for the specified table, in order +

            +

            +
            +
            +
            + +

            +key_values

            +
            +@Deprecated
+public List<KeyValueBackupEntry> key_values
            +
            +
            Deprecated. 
            Sequence of user defined key-value pairs for the specified table, in order. +

            +

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

            +TableBackup

            +
            +public TableBackup()
            +
            +
            Default constructor. +

            +

            +
            + +

            +TableBackup

            +
            +public TableBackup(String name,
+                   List<TableLayoutBackupEntry> layouts,
+                   List<KeyValueBackupEntry> key_values)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Table name. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Table name. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayouts

            +
            +public List<TableLayoutBackupEntry> getLayouts()
            +
            +
            Gets the value of the 'layouts' field. + Sequence of layouts for the specified table, in order +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayouts

            +
            +public void setLayouts(List<TableLayoutBackupEntry> value)
            +
            +
            Sets the value of the 'layouts' field. + Sequence of layouts for the specified table, in order * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeyValues

            +
            +public List<KeyValueBackupEntry> getKeyValues()
            +
            +
            Gets the value of the 'key_values' field. + Sequence of user defined key-value pairs for the specified table, in order. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeyValues

            +
            +public void setKeyValues(List<KeyValueBackupEntry> value)
            +
            +
            Sets the value of the 'key_values' field. + Sequence of user defined key-value pairs for the specified table, in order. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableBackup.Builder newBuilder()
            +
            +
            Creates a new TableBackup RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableBackup.Builder newBuilder(TableBackup.Builder other)
            +
            +
            Creates a new TableBackup RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableBackup.Builder newBuilder(TableBackup other)
            +
            +
            Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html new file mode 100644 index 00000000..f3ba77ce --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +TableLayoutBackupEntry.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutBackupEntry.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutBackupEntry>
+          extended by org.kiji.schema.avro.TableLayoutBackupEntry.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<TableLayoutBackupEntry>
            +
            +
            +
            Enclosing class:
            TableLayoutBackupEntry
            +
            +
            +
            +
            public static class TableLayoutBackupEntry.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutBackupEntry>
            implements org.apache.avro.data.RecordBuilder<TableLayoutBackupEntry>
            + + +

            +RecordBuilder for TableLayoutBackupEntry instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TableLayoutBackupEntrybuild() + +
            +           
            + TableLayoutBackupEntry.BuilderclearLayout() + +
            +          Clears the value of the 'layout' field
            + TableLayoutBackupEntry.BuilderclearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuilderclearUpdate() + +
            +          Clears the value of the 'update' field
            + TableLayoutDescgetLayout() + +
            +          Gets the value of the 'layout' field
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field
            + TableLayoutDescgetUpdate() + +
            +          Gets the value of the 'update' field
            + booleanhasLayout() + +
            +          Checks whether the 'layout' field has been set
            + booleanhasTimestamp() + +
            +          Checks whether the 'timestamp' field has been set
            + booleanhasUpdate() + +
            +          Checks whether the 'update' field has been set
            + TableLayoutBackupEntry.BuildersetLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field
            + TableLayoutBackupEntry.BuildersetTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuildersetUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public TableLayoutBackupEntry.Builder setTimestamp(long value)
            +
            +
            Sets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasTimestamp

            +
            +public boolean hasTimestamp()
            +
            +
            Checks whether the 'timestamp' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearTimestamp

            +
            +public TableLayoutBackupEntry.Builder clearTimestamp()
            +
            +
            Clears the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getUpdate

            +
            +public TableLayoutDesc getUpdate()
            +
            +
            Gets the value of the 'update' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setUpdate

            +
            +public TableLayoutBackupEntry.Builder setUpdate(TableLayoutDesc value)
            +
            +
            Sets the value of the 'update' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasUpdate

            +
            +public boolean hasUpdate()
            +
            +
            Checks whether the 'update' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearUpdate

            +
            +public TableLayoutBackupEntry.Builder clearUpdate()
            +
            +
            Clears the value of the 'update' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayout

            +
            +public TableLayoutDesc getLayout()
            +
            +
            Gets the value of the 'layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayout

            +
            +public TableLayoutBackupEntry.Builder setLayout(TableLayoutDesc value)
            +
            +
            Sets the value of the 'layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayout

            +
            +public boolean hasLayout()
            +
            +
            Checks whether the 'layout' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayout

            +
            +public TableLayoutBackupEntry.Builder clearLayout()
            +
            +
            Clears the value of the 'layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public TableLayoutBackupEntry build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<TableLayoutBackupEntry>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutBackupEntry.html new file mode 100644 index 00000000..3017a9ce --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutBackupEntry.html @@ -0,0 +1,678 @@ + + + + + + + +TableLayoutBackupEntry (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutBackupEntry

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.TableLayoutBackupEntry
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class TableLayoutBackupEntry
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTableLayoutBackupEntry.Builder + +
            +          RecordBuilder for TableLayoutBackupEntry instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + TableLayoutDesclayout + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + longtimestamp + +
            +          Deprecated. 
            + TableLayoutDescupdate + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            TableLayoutBackupEntry() + +
            +          Default constructor.
            TableLayoutBackupEntry(Long timestamp, + TableLayoutDesc update, + TableLayoutDesc layout) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + TableLayoutDescgetLayout() + +
            +          Gets the value of the 'layout' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field.
            + TableLayoutDescgetUpdate() + +
            +          Gets the value of the 'update' field.
            +static TableLayoutBackupEntry.BuildernewBuilder() + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder
            +static TableLayoutBackupEntry.BuildernewBuilder(TableLayoutBackupEntry.Builder other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder
            +static TableLayoutBackupEntry.BuildernewBuilder(TableLayoutBackupEntry other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field.
            + voidsetTimestamp(Long value) + +
            +          Sets the value of the 'timestamp' field.
            + voidsetUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +timestamp

            +
            +@Deprecated
+public long timestamp
            +
            +
            Deprecated. 
            Time Stamp. +

            +

            +
            +
            +
            + +

            +update

            +
            +@Deprecated
+public TableLayoutDesc update
            +
            +
            Deprecated. 
            Table layout update, as specified by the submitter/user. + Except for the first one, the update builds on the previous layout. +

            +

            +
            +
            +
            + +

            +layout

            +
            +@Deprecated
+public TableLayoutDesc layout
            +
            +
            Deprecated. 
            Effective table layout, after applying the update. +

            +

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

            +TableLayoutBackupEntry

            +
            +public TableLayoutBackupEntry()
            +
            +
            Default constructor. +

            +

            +
            + +

            +TableLayoutBackupEntry

            +
            +public TableLayoutBackupEntry(Long timestamp,
+                              TableLayoutDesc update,
+                              TableLayoutDesc layout)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field. + Time Stamp. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public void setTimestamp(Long value)
            +
            +
            Sets the value of the 'timestamp' field. + Time Stamp. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getUpdate

            +
            +public TableLayoutDesc getUpdate()
            +
            +
            Gets the value of the 'update' field. + * Table layout update, as specified by the submitter/user. + Except for the first one, the update builds on the previous layout. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setUpdate

            +
            +public void setUpdate(TableLayoutDesc value)
            +
            +
            Sets the value of the 'update' field. + * Table layout update, as specified by the submitter/user. + Except for the first one, the update builds on the previous layout. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayout

            +
            +public TableLayoutDesc getLayout()
            +
            +
            Gets the value of the 'layout' field. + Effective table layout, after applying the update. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayout

            +
            +public void setLayout(TableLayoutDesc value)
            +
            +
            Sets the value of the 'layout' field. + Effective table layout, after applying the update. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutBackupEntry.Builder newBuilder()
            +
            +
            Creates a new TableLayoutBackupEntry RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutBackupEntry.Builder newBuilder(TableLayoutBackupEntry.Builder other)
            +
            +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutBackupEntry.Builder newBuilder(TableLayoutBackupEntry other)
            +
            +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutDesc.Builder.html new file mode 100644 index 00000000..3b4d8f88 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutDesc.Builder.html @@ -0,0 +1,916 @@ + + + + + + + +TableLayoutDesc.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutDesc>
+          extended by org.kiji.schema.avro.TableLayoutDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<TableLayoutDesc>
            +
            +
            +
            Enclosing class:
            TableLayoutDesc
            +
            +
            +
            +
            public static class TableLayoutDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutDesc>
            implements org.apache.avro.data.RecordBuilder<TableLayoutDesc>
            + + +

            +RecordBuilder for TableLayoutDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TableLayoutDescbuild() + +
            +           
            + TableLayoutDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + TableLayoutDesc.BuilderclearKeysFormat() + +
            +          Clears the value of the 'keys_format' field
            + TableLayoutDesc.BuilderclearLayoutId() + +
            +          Clears the value of the 'layout_id' field
            + TableLayoutDesc.BuilderclearLocalityGroups() + +
            +          Clears the value of the 'locality_groups' field
            + TableLayoutDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + TableLayoutDesc.BuilderclearReferenceLayout() + +
            +          Clears the value of the 'reference_layout' field
            + TableLayoutDesc.BuilderclearVersion() + +
            +          Clears the value of the 'version' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + RowKeyFormatgetKeysFormat() + +
            +          Gets the value of the 'keys_format' field
            + StringgetLayoutId() + +
            +          Gets the value of the 'layout_id' field
            + List<LocalityGroupDesc>getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetReferenceLayout() + +
            +          Gets the value of the 'reference_layout' field
            + StringgetVersion() + +
            +          Gets the value of the 'version' field
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasKeysFormat() + +
            +          Checks whether the 'keys_format' field has been set
            + booleanhasLayoutId() + +
            +          Checks whether the 'layout_id' field has been set
            + booleanhasLocalityGroups() + +
            +          Checks whether the 'locality_groups' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasReferenceLayout() + +
            +          Checks whether the 'reference_layout' field has been set
            + booleanhasVersion() + +
            +          Checks whether the 'version' field has been set
            + TableLayoutDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + TableLayoutDesc.BuildersetKeysFormat(RowKeyFormat value) + +
            +          Sets the value of the 'keys_format' field
            + TableLayoutDesc.BuildersetLayoutId(String value) + +
            +          Sets the value of the 'layout_id' field
            + TableLayoutDesc.BuildersetLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field
            + TableLayoutDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + TableLayoutDesc.BuildersetReferenceLayout(String value) + +
            +          Sets the value of the 'reference_layout' field
            + TableLayoutDesc.BuildersetVersion(String value) + +
            +          Sets the value of the 'version' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public TableLayoutDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public TableLayoutDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public TableLayoutDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public TableLayoutDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeysFormat

            +
            +public RowKeyFormat getKeysFormat()
            +
            +
            Gets the value of the 'keys_format' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeysFormat

            +
            +public TableLayoutDesc.Builder setKeysFormat(RowKeyFormat value)
            +
            +
            Sets the value of the 'keys_format' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasKeysFormat

            +
            +public boolean hasKeysFormat()
            +
            +
            Checks whether the 'keys_format' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearKeysFormat

            +
            +public TableLayoutDesc.Builder clearKeysFormat()
            +
            +
            Clears the value of the 'keys_format' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLocalityGroups

            +
            +public List<LocalityGroupDesc> getLocalityGroups()
            +
            +
            Gets the value of the 'locality_groups' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLocalityGroups

            +
            +public TableLayoutDesc.Builder setLocalityGroups(List<LocalityGroupDesc> value)
            +
            +
            Sets the value of the 'locality_groups' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLocalityGroups

            +
            +public boolean hasLocalityGroups()
            +
            +
            Checks whether the 'locality_groups' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLocalityGroups

            +
            +public TableLayoutDesc.Builder clearLocalityGroups()
            +
            +
            Clears the value of the 'locality_groups' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getVersion

            +
            +public String getVersion()
            +
            +
            Gets the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setVersion

            +
            +public TableLayoutDesc.Builder setVersion(String value)
            +
            +
            Sets the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasVersion

            +
            +public boolean hasVersion()
            +
            +
            Checks whether the 'version' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearVersion

            +
            +public TableLayoutDesc.Builder clearVersion()
            +
            +
            Clears the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayoutId

            +
            +public String getLayoutId()
            +
            +
            Gets the value of the 'layout_id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutId

            +
            +public TableLayoutDesc.Builder setLayoutId(String value)
            +
            +
            Sets the value of the 'layout_id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayoutId

            +
            +public boolean hasLayoutId()
            +
            +
            Checks whether the 'layout_id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayoutId

            +
            +public TableLayoutDesc.Builder clearLayoutId()
            +
            +
            Clears the value of the 'layout_id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getReferenceLayout

            +
            +public String getReferenceLayout()
            +
            +
            Gets the value of the 'reference_layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setReferenceLayout

            +
            +public TableLayoutDesc.Builder setReferenceLayout(String value)
            +
            +
            Sets the value of the 'reference_layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasReferenceLayout

            +
            +public boolean hasReferenceLayout()
            +
            +
            Checks whether the 'reference_layout' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearReferenceLayout

            +
            +public TableLayoutDesc.Builder clearReferenceLayout()
            +
            +
            Clears the value of the 'reference_layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public TableLayoutDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<TableLayoutDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutDesc.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutDesc.html new file mode 100644 index 00000000..0cd54e72 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/TableLayoutDesc.html @@ -0,0 +1,967 @@ + + + + + + + +TableLayoutDesc (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.TableLayoutDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class TableLayoutDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTableLayoutDesc.Builder + +
            +          RecordBuilder for TableLayoutDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringdescription + +
            +          Deprecated. 
            + RowKeyFormatkeys_format + +
            +          Deprecated. 
            + Stringlayout_id + +
            +          Deprecated. 
            + List<LocalityGroupDesc>locality_groups + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringreference_layout + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + Stringversion + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            TableLayoutDesc() + +
            +          Default constructor.
            TableLayoutDesc(String name, + String description, + RowKeyFormat keys_format, + List<LocalityGroupDesc> locality_groups, + String version, + String layout_id, + String reference_layout) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + RowKeyFormatgetKeysFormat() + +
            +          Gets the value of the 'keys_format' field.
            + StringgetLayoutId() + +
            +          Gets the value of the 'layout_id' field.
            + List<LocalityGroupDesc>getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetReferenceLayout() + +
            +          Gets the value of the 'reference_layout' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + StringgetVersion() + +
            +          Gets the value of the 'version' field.
            +static TableLayoutDesc.BuildernewBuilder() + +
            +          Creates a new TableLayoutDesc RecordBuilder
            +static TableLayoutDesc.BuildernewBuilder(TableLayoutDesc.Builder other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder
            +static TableLayoutDesc.BuildernewBuilder(TableLayoutDesc other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetKeysFormat(RowKeyFormat value) + +
            +          Sets the value of the 'keys_format' field.
            + voidsetLayoutId(String value) + +
            +          Sets the value of the 'layout_id' field.
            + voidsetLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetReferenceLayout(String value) + +
            +          Sets the value of the 'reference_layout' field.
            + voidsetVersion(String value) + +
            +          Sets the value of the 'version' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Name of the table ([a-zA-Z0-9_]+). +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the table. +

            +

            +
            +
            +
            + +

            +keys_format

            +
            +@Deprecated
+public RowKeyFormat keys_format
            +
            +
            Deprecated. 
            Whether row key hashing should be managed by Kiji. +

            +

            +
            +
            +
            + +

            +locality_groups

            +
            +@Deprecated
+public List<LocalityGroupDesc> locality_groups
            +
            +
            Deprecated. 
            Locality groups in the table. +

            +

            +
            +
            +
            + +

            +version

            +
            +@Deprecated
+public String version
            +
            +
            Deprecated. 
            Data layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            + +

            +layout_id

            +
            +@Deprecated
+public String layout_id
            +
            +
            Deprecated. 
            ID of the layout. +

            +

            +
            +
            +
            + +

            +reference_layout

            +
            +@Deprecated
+public String reference_layout
            +
            +
            Deprecated. 
            Reference to the base layout this descriptor builds on. +

            +

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

            +TableLayoutDesc

            +
            +public TableLayoutDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +TableLayoutDesc

            +
            +public TableLayoutDesc(String name,
+                       String description,
+                       RowKeyFormat keys_format,
+                       List<LocalityGroupDesc> locality_groups,
+                       String version,
+                       String layout_id,
+                       String reference_layout)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Name of the table ([a-zA-Z0-9_]+). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Name of the table ([a-zA-Z0-9_]+). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the table. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the table. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeysFormat

            +
            +public RowKeyFormat getKeysFormat()
            +
            +
            Gets the value of the 'keys_format' field. + Whether row key hashing should be managed by Kiji. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeysFormat

            +
            +public void setKeysFormat(RowKeyFormat value)
            +
            +
            Sets the value of the 'keys_format' field. + Whether row key hashing should be managed by Kiji. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLocalityGroups

            +
            +public List<LocalityGroupDesc> getLocalityGroups()
            +
            +
            Gets the value of the 'locality_groups' field. + Locality groups in the table. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLocalityGroups

            +
            +public void setLocalityGroups(List<LocalityGroupDesc> value)
            +
            +
            Sets the value of the 'locality_groups' field. + Locality groups in the table. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getVersion

            +
            +public String getVersion()
            +
            +
            Gets the value of the 'version' field. + Data layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setVersion

            +
            +public void setVersion(String value)
            +
            +
            Sets the value of the 'version' field. + Data layout version (eg. "kiji-1.0"). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayoutId

            +
            +public String getLayoutId()
            +
            +
            Gets the value of the 'layout_id' field. + ID of the layout. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutId

            +
            +public void setLayoutId(String value)
            +
            +
            Sets the value of the 'layout_id' field. + ID of the layout. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getReferenceLayout

            +
            +public String getReferenceLayout()
            +
            +
            Gets the value of the 'reference_layout' field. + Reference to the base layout this descriptor builds on. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setReferenceLayout

            +
            +public void setReferenceLayout(String value)
            +
            +
            Sets the value of the 'reference_layout' field. + Reference to the base layout this descriptor builds on. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutDesc.Builder newBuilder()
            +
            +
            Creates a new TableLayoutDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutDesc.Builder newBuilder(TableLayoutDesc.Builder other)
            +
            +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutDesc.Builder newBuilder(TableLayoutDesc other)
            +
            +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/CellSchema.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/CellSchema.Builder.html new file mode 100644 index 00000000..86abb87c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/CellSchema.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.CellSchema.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.CellSchema.Builder

            +
            + + + + + + + + + +
            +Packages that use CellSchema.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of CellSchema.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return CellSchema.Builder
            + CellSchema.BuilderCellSchema.Builder.clearStorage() + +
            +          Clears the value of the 'storage' field
            + CellSchema.BuilderCellSchema.Builder.clearType() + +
            +          Clears the value of the 'type' field
            + CellSchema.BuilderCellSchema.Builder.clearValue() + +
            +          Clears the value of the 'value' field
            +static CellSchema.BuilderCellSchema.newBuilder() + +
            +          Creates a new CellSchema RecordBuilder
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema.Builder other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing Builder
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance
            + CellSchema.BuilderCellSchema.Builder.setStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field
            + CellSchema.BuilderCellSchema.Builder.setType(SchemaType value) + +
            +          Sets the value of the 'type' field
            + CellSchema.BuilderCellSchema.Builder.setValue(String value) + +
            +          Sets the value of the 'value' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type CellSchema.Builder
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema.Builder other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/CellSchema.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/CellSchema.html new file mode 100644 index 00000000..f1228fdf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/CellSchema.html @@ -0,0 +1,435 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.CellSchema (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.CellSchema

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use CellSchema
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of CellSchema in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as CellSchema
            + CellSchemaColumnDesc.column_schema + +
            +          Deprecated. 
            + CellSchemaFamilyDesc.map_schema + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return CellSchema
            + CellSchemaCellSchema.Builder.build() + +
            +           
            + CellSchemaColumnDesc.getColumnSchema() + +
            +          Gets the value of the 'column_schema' field.
            + CellSchemaColumnDesc.Builder.getColumnSchema() + +
            +          Gets the value of the 'column_schema' field
            + CellSchemaFamilyDesc.getMapSchema() + +
            +          Gets the value of the 'map_schema' field.
            + CellSchemaFamilyDesc.Builder.getMapSchema() + +
            +          Gets the value of the 'map_schema' field
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type CellSchema
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance
            + voidColumnDesc.setColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field.
            + ColumnDesc.BuilderColumnDesc.Builder.setColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field
            + voidFamilyDesc.setMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field.
            + FamilyDesc.BuilderFamilyDesc.Builder.setMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type CellSchema
            ColumnDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema column_schema, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            FamilyDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema map_schema, + List<ColumnDesc> columns, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of CellSchema in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return CellSchema
            + CellSchemaKijiTableLayout.getCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type CellSchema
            +static org.apache.avro.SchemaKijiTableLayout.readAvroSchema(CellSchema avro) + +
            +          Reads the Avro schema from the table layout.
            +  +

            + + + + + +
            +Uses of CellSchema in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return CellSchema
            + CellSchemaCellSpec.getCellSchema() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type CellSchema
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            +static org.apache.avro.SchemaCellSpec.readAvroSchema(CellSchema cellSchema) + +
            +          Reads the Avro schema from the table layout.
            + CellSpecCellSpec.setCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html new file mode 100644 index 00000000..ed94e099 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html @@ -0,0 +1,341 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.ColumnDesc.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.ColumnDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use ColumnDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of ColumnDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return ColumnDesc.Builder
            + ColumnDesc.BuilderColumnDesc.Builder.clearAliases() + +
            +          Clears the value of the 'aliases' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearColumnSchema() + +
            +          Clears the value of the 'column_schema' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearDelete() + +
            +          Clears the value of the 'delete' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearEnabled() + +
            +          Clears the value of the 'enabled' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearId() + +
            +          Clears the value of the 'id' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            +static ColumnDesc.BuilderColumnDesc.newBuilder() + +
            +          Creates a new ColumnDesc RecordBuilder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            + ColumnDesc.BuilderColumnDesc.Builder.setAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + ColumnDesc.BuilderColumnDesc.Builder.setColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field
            + ColumnDesc.BuilderColumnDesc.Builder.setDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + ColumnDesc.BuilderColumnDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + ColumnDesc.BuilderColumnDesc.Builder.setEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + ColumnDesc.BuilderColumnDesc.Builder.setId(int value) + +
            +          Sets the value of the 'id' field
            + ColumnDesc.BuilderColumnDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + ColumnDesc.BuilderColumnDesc.Builder.setRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type ColumnDesc.Builder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/ColumnDesc.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/ColumnDesc.html new file mode 100644 index 00000000..249d0ed6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/ColumnDesc.html @@ -0,0 +1,327 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.ColumnDesc (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.ColumnDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use ColumnDesc
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of ColumnDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type ColumnDesc
            + List<ColumnDesc>FamilyDesc.columns + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return ColumnDesc
            + ColumnDescColumnDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type ColumnDesc
            + List<ColumnDesc>FamilyDesc.getColumns() + +
            +          Gets the value of the 'columns' field.
            + List<ColumnDesc>FamilyDesc.Builder.getColumns() + +
            +          Gets the value of the 'columns' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type ColumnDesc
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type ColumnDesc
            + voidFamilyDesc.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field.
            + FamilyDesc.BuilderFamilyDesc.Builder.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type ColumnDesc
            FamilyDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema map_schema, + List<ColumnDesc> columns, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of ColumnDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return ColumnDesc
            + ColumnDescKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.getDesc() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type ColumnDesc
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc desc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout reference) + +
            +          Builds a new column layout instance from a descriptor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/CompressionType.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/CompressionType.html new file mode 100644 index 00000000..38b563a2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/CompressionType.html @@ -0,0 +1,271 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.CompressionType (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.CompressionType

            +
            + + + + + + + + + +
            +Packages that use CompressionType
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of CompressionType in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as CompressionType
            + CompressionTypeLocalityGroupDesc.compression_type + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return CompressionType
            + CompressionTypeLocalityGroupDesc.getCompressionType() + +
            +          Gets the value of the 'compression_type' field.
            + CompressionTypeLocalityGroupDesc.Builder.getCompressionType() + +
            +          Gets the value of the 'compression_type' field
            +static CompressionTypeCompressionType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static CompressionType[]CompressionType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type CompressionType
            + voidLocalityGroupDesc.setCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field.
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type CompressionType
            LocalityGroupDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + Boolean in_memory, + Integer max_versions, + Integer ttl_seconds, + CompressionType compression_type, + List<FamilyDesc> families, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html new file mode 100644 index 00000000..a7f64d3d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html @@ -0,0 +1,357 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.FamilyDesc.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.FamilyDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use FamilyDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of FamilyDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return FamilyDesc.Builder
            + FamilyDesc.BuilderFamilyDesc.Builder.clearAliases() + +
            +          Clears the value of the 'aliases' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearColumns() + +
            +          Clears the value of the 'columns' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearDelete() + +
            +          Clears the value of the 'delete' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearEnabled() + +
            +          Clears the value of the 'enabled' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearId() + +
            +          Clears the value of the 'id' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearMapSchema() + +
            +          Clears the value of the 'map_schema' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            +static FamilyDesc.BuilderFamilyDesc.newBuilder() + +
            +          Creates a new FamilyDesc RecordBuilder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            + FamilyDesc.BuilderFamilyDesc.Builder.setAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setId(int value) + +
            +          Sets the value of the 'id' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type FamilyDesc.Builder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/FamilyDesc.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/FamilyDesc.html new file mode 100644 index 00000000..5d0fca75 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/FamilyDesc.html @@ -0,0 +1,330 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.FamilyDesc (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.FamilyDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use FamilyDesc
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of FamilyDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type FamilyDesc
            + List<FamilyDesc>LocalityGroupDesc.families + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return FamilyDesc
            + FamilyDescFamilyDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type FamilyDesc
            + List<FamilyDesc>LocalityGroupDesc.getFamilies() + +
            +          Gets the value of the 'families' field.
            + List<FamilyDesc>LocalityGroupDesc.Builder.getFamilies() + +
            +          Gets the value of the 'families' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type FamilyDesc
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type FamilyDesc
            + voidLocalityGroupDesc.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field.
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type FamilyDesc
            LocalityGroupDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + Boolean in_memory, + Integer max_versions, + Integer ttl_seconds, + CompressionType compression_type, + List<FamilyDesc> families, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of FamilyDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return FamilyDesc
            + FamilyDescKijiTableLayout.LocalityGroupLayout.FamilyLayout.getDesc() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type FamilyDesc
            KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc familyDesc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout reference) + +
            +          Builds a new family layout instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/HashType.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/HashType.html new file mode 100644 index 00000000..5957ba1b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/HashType.html @@ -0,0 +1,262 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.HashType (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.HashType

            +
            + + + + + + + + + +
            +Packages that use HashType
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of HashType in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as HashType
            + HashTypeRowKeyFormat.hash_type + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return HashType
            + HashTypeRowKeyFormat.getHashType() + +
            +          Gets the value of the 'hash_type' field.
            + HashTypeRowKeyFormat.Builder.getHashType() + +
            +          Gets the value of the 'hash_type' field
            +static HashTypeHashType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static HashType[]HashType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type HashType
            + voidRowKeyFormat.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field.
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type HashType
            RowKeyFormat(RowKeyEncoding encoding, + HashType hash_type, + Integer hash_size) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KeyValueBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KeyValueBackupEntry.Builder.html new file mode 100644 index 00000000..aed8fbef --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KeyValueBackupEntry.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.KeyValueBackupEntry.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.KeyValueBackupEntry.Builder

            +
            + + + + + + + + + +
            +Packages that use KeyValueBackupEntry.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return KeyValueBackupEntry.Builder
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.clearKey() + +
            +          Clears the value of the 'key' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.clearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.clearValue() + +
            +          Clears the value of the 'value' field
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder() + +
            +          Creates a new KeyValueBackupEntry RecordBuilder
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry.Builder other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.setKey(String value) + +
            +          Sets the value of the 'key' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.setTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.setValue(ByteBuffer value) + +
            +          Sets the value of the 'value' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type KeyValueBackupEntry.Builder
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry.Builder other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KeyValueBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KeyValueBackupEntry.html new file mode 100644 index 00000000..5c627f37 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KeyValueBackupEntry.html @@ -0,0 +1,386 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.KeyValueBackupEntry (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.KeyValueBackupEntry

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KeyValueBackupEntry
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>KijiTableKeyValueDatabase.keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type KeyValueBackupEntry
            + voidKijiTableKeyValueDatabase.keyValuesFromBackup(String table, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>TableBackup.key_values + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return KeyValueBackupEntry
            + KeyValueBackupEntryKeyValueBackupEntry.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>TableBackup.getKeyValues() + +
            +          Gets the value of the 'key_values' field.
            + List<KeyValueBackupEntry>TableBackup.Builder.getKeyValues() + +
            +          Gets the value of the 'key_values' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type KeyValueBackupEntry
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type KeyValueBackupEntry
            + voidTableBackup.setKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field.
            + TableBackup.BuilderTableBackup.Builder.setKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type KeyValueBackupEntry
            TableBackup(String name, + List<TableLayoutBackupEntry> layouts, + List<KeyValueBackupEntry> key_values) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>HBaseMetaTable.keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + List<KeyValueBackupEntry>HBaseTableKeyValueDatabase.keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type KeyValueBackupEntry
            + voidHBaseMetaTable.keyValuesFromBackup(String table, + List<KeyValueBackupEntry> tableBackup) + +
            +          Restores all table's key value history from a backup.
            + voidHBaseTableKeyValueDatabase.keyValuesFromBackup(String tableName, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html new file mode 100644 index 00000000..da120baf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface org.kiji.schema.avro.KijiTableLayoutRecords.Callback (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.avro.KijiTableLayoutRecords.Callback

            +
            +No usage of org.kiji.schema.avro.KijiTableLayoutRecords.Callback +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html new file mode 100644 index 00000000..9cf1cfde --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface org.kiji.schema.avro.KijiTableLayoutRecords (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.avro.KijiTableLayoutRecords

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayoutRecords
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of KijiTableLayoutRecords in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiTableLayoutRecords in org.kiji.schema.avro
            +static interfaceKijiTableLayoutRecords.Callback + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html new file mode 100644 index 00000000..65bb84fb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html @@ -0,0 +1,405 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.LocalityGroupDesc.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.LocalityGroupDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use LocalityGroupDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of LocalityGroupDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return LocalityGroupDesc.Builder
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearAliases() + +
            +          Clears the value of the 'aliases' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearCompressionType() + +
            +          Clears the value of the 'compression_type' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearDelete() + +
            +          Clears the value of the 'delete' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearEnabled() + +
            +          Clears the value of the 'enabled' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearFamilies() + +
            +          Clears the value of the 'families' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearId() + +
            +          Clears the value of the 'id' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearInMemory() + +
            +          Clears the value of the 'in_memory' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearMaxVersions() + +
            +          Clears the value of the 'max_versions' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearTtlSeconds() + +
            +          Clears the value of the 'ttl_seconds' field
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder() + +
            +          Creates a new LocalityGroupDesc RecordBuilder
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc.Builder other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setId(int value) + +
            +          Sets the value of the 'id' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setInMemory(boolean value) + +
            +          Sets the value of the 'in_memory' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setMaxVersions(int value) + +
            +          Sets the value of the 'max_versions' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setTtlSeconds(int value) + +
            +          Sets the value of the 'ttl_seconds' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type LocalityGroupDesc.Builder
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc.Builder other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/LocalityGroupDesc.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/LocalityGroupDesc.html new file mode 100644 index 00000000..68e8387a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/LocalityGroupDesc.html @@ -0,0 +1,325 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.LocalityGroupDesc (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.LocalityGroupDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use LocalityGroupDesc
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of LocalityGroupDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type LocalityGroupDesc
            + List<LocalityGroupDesc>TableLayoutDesc.locality_groups + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return LocalityGroupDesc
            + LocalityGroupDescLocalityGroupDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type LocalityGroupDesc
            + List<LocalityGroupDesc>TableLayoutDesc.getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field.
            + List<LocalityGroupDesc>TableLayoutDesc.Builder.getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type LocalityGroupDesc
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type LocalityGroupDesc
            + voidTableLayoutDesc.setLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field.
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type LocalityGroupDesc
            TableLayoutDesc(String name, + String description, + RowKeyFormat keys_format, + List<LocalityGroupDesc> locality_groups, + String version, + String layout_id, + String reference_layout) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of LocalityGroupDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return LocalityGroupDesc
            + LocalityGroupDescKijiTableLayout.LocalityGroupLayout.getDesc() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type LocalityGroupDesc
            KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc lgDesc, + KijiTableLayout.LocalityGroupLayout reference) + +
            +          Constructs a locality group layout.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/MD5Hash.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/MD5Hash.html new file mode 100644 index 00000000..870f9e9a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/MD5Hash.html @@ -0,0 +1,245 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.MD5Hash (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.MD5Hash

            +
            + + + + + + + + + +
            +Packages that use MD5Hash
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of MD5Hash in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as MD5Hash
            + MD5HashSchemaTableEntry.hash + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return MD5Hash
            + MD5HashSchemaTableEntry.getHash() + +
            +          Gets the value of the 'hash' field.
            + MD5HashSchemaTableEntry.Builder.getHash() + +
            +          Gets the value of the 'hash' field
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type MD5Hash
            + voidSchemaTableEntry.setHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field.
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type MD5Hash
            SchemaTableEntry(Long id, + MD5Hash hash, + String avro_schema) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html new file mode 100644 index 00000000..27799158 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.MetadataBackup.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.MetadataBackup.Builder

            +
            + + + + + + + + + +
            +Packages that use MetadataBackup.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of MetadataBackup.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return MetadataBackup.Builder
            + MetadataBackup.BuilderMetadataBackup.Builder.clearLayoutVersion() + +
            +          Clears the value of the 'layout_version' field
            + MetadataBackup.BuilderMetadataBackup.Builder.clearMetaTable() + +
            +          Clears the value of the 'meta_table' field
            + MetadataBackup.BuilderMetadataBackup.Builder.clearSchemaTable() + +
            +          Clears the value of the 'schema_table' field
            +static MetadataBackup.BuilderMetadataBackup.newBuilder() + +
            +          Creates a new MetadataBackup RecordBuilder
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup.Builder other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing Builder
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance
            + MetadataBackup.BuilderMetadataBackup.Builder.setLayoutVersion(String value) + +
            +          Sets the value of the 'layout_version' field
            + MetadataBackup.BuilderMetadataBackup.Builder.setMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field
            + MetadataBackup.BuilderMetadataBackup.Builder.setSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type MetadataBackup.Builder
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup.Builder other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/MetadataBackup.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/MetadataBackup.html new file mode 100644 index 00000000..d6654e48 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/MetadataBackup.html @@ -0,0 +1,236 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.MetadataBackup (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.MetadataBackup

            +
            + + + + + + + + + + + + + +
            +Packages that use MetadataBackup
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of MetadataBackup in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return MetadataBackup
            + MetadataBackupMetadataBackup.Builder.build() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type MetadataBackup
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance
            +  +

            + + + + + +
            +Uses of MetadataBackup in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type MetadataBackup
            + voidMetadataRestorer.restoreSchemas(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all SchemaTable entries from the metadata backup.
            + voidMetadataRestorer.restoreTables(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all tables from the metadata backup into the running Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/RowKeyEncoding.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/RowKeyEncoding.html new file mode 100644 index 00000000..c6dd0a78 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/RowKeyEncoding.html @@ -0,0 +1,262 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyEncoding (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyEncoding

            +
            + + + + + + + + + +
            +Packages that use RowKeyEncoding
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of RowKeyEncoding in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as RowKeyEncoding
            + RowKeyEncodingRowKeyFormat.encoding + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyEncoding
            + RowKeyEncodingRowKeyFormat.getEncoding() + +
            +          Gets the value of the 'encoding' field.
            + RowKeyEncodingRowKeyFormat.Builder.getEncoding() + +
            +          Gets the value of the 'encoding' field
            +static RowKeyEncodingRowKeyEncoding.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static RowKeyEncoding[]RowKeyEncoding.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyEncoding
            + voidRowKeyFormat.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field.
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type RowKeyEncoding
            RowKeyFormat(RowKeyEncoding encoding, + HashType hash_type, + Integer hash_size) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html new file mode 100644 index 00000000..04dc4a23 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyFormat.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyFormat.Builder

            +
            + + + + + + + + + +
            +Packages that use RowKeyFormat.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of RowKeyFormat.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyFormat.Builder
            + RowKeyFormat.BuilderRowKeyFormat.Builder.clearEncoding() + +
            +          Clears the value of the 'encoding' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.clearHashSize() + +
            +          Clears the value of the 'hash_size' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.clearHashType() + +
            +          Clears the value of the 'hash_type' field
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder() + +
            +          Creates a new RowKeyFormat RecordBuilder
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat.Builder other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing Builder
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setHashSize(int value) + +
            +          Sets the value of the 'hash_size' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyFormat.Builder
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat.Builder other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/RowKeyFormat.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/RowKeyFormat.html new file mode 100644 index 00000000..ba5676ab --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/RowKeyFormat.html @@ -0,0 +1,493 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyFormat (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyFormat

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use RowKeyFormat
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return RowKeyFormat
            + RowKeyFormatEntityIdFactory.getFormat() + +
            +           
            +abstract  RowKeyFormatEntityId.getFormat() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type RowKeyFormat
            +static EntityIdFactoryEntityIdFactory.create(RowKeyFormat format) + +
            +          Creates an entity ID factory for the specified row key format.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type RowKeyFormat
            EntityIdFactory(RowKeyFormat format) + +
            +          Creates an entity ID factory.
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as RowKeyFormat
            + RowKeyFormatTableLayoutDesc.keys_format + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyFormat
            + RowKeyFormatRowKeyFormat.Builder.build() + +
            +           
            + RowKeyFormatTableLayoutDesc.getKeysFormat() + +
            +          Gets the value of the 'keys_format' field.
            + RowKeyFormatTableLayoutDesc.Builder.getKeysFormat() + +
            +          Gets the value of the 'keys_format' field
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyFormat
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance
            + voidTableLayoutDesc.setKeysFormat(RowKeyFormat value) + +
            +          Sets the value of the 'keys_format' field.
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setKeysFormat(RowKeyFormat value) + +
            +          Sets the value of the 'keys_format' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type RowKeyFormat
            TableLayoutDesc(String name, + String description, + RowKeyFormat keys_format, + List<LocalityGroupDesc> locality_groups, + String version, + String layout_id, + String reference_layout) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return RowKeyFormat
            + RowKeyFormatHBaseEntityId.getFormat() + +
            +          
            + RowKeyFormatRawEntityId.getFormat() + +
            +          
            + RowKeyFormatHashPrefixedEntityId.getFormat() + +
            +          
            + RowKeyFormatHashedEntityId.getFormat() + +
            +          
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type RowKeyFormat
            +static HashPrefixedEntityIdHashPrefixedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified HBase row key.
            +static HashedEntityIdHashedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified HBase row key.
            +static HashPrefixedEntityIdHashPrefixedEntityId.fromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified Kiji row key.
            +static HashedEntityIdHashedEntityId.fromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified Kiji row key.
            +static byte[]HashPrefixedEntityId.hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            +static byte[]HashedEntityId.hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type RowKeyFormat
            HBaseTableRecordReader(RowKeyFormat rowKeyFormat) + +
            +          Constructs a new record reader.
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type RowKeyFormat
            +static EntityIdToolUtils.createEntityIdFromUserInputs(String entityId, + String entityHash, + RowKeyFormat format) + +
            +          Create an EntityId from the --entity-id and --entity-hash arguments to a kiji tool.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaStorage.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaStorage.html new file mode 100644 index 00000000..64afb25f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaStorage.html @@ -0,0 +1,320 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaStorage (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaStorage

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use SchemaStorage
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of SchemaStorage in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as SchemaStorage
            + SchemaStorageCellSchema.storage + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaStorage
            + SchemaStorageCellSchema.getStorage() + +
            +          Gets the value of the 'storage' field.
            + SchemaStorageCellSchema.Builder.getStorage() + +
            +          Gets the value of the 'storage' field
            +static SchemaStorageSchemaStorage.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaStorage[]SchemaStorage.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaStorage
            + voidCellSchema.setStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field.
            + CellSchema.BuilderCellSchema.Builder.setStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type SchemaStorage
            CellSchema(SchemaStorage storage, + SchemaType type, + String value) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of SchemaStorage in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return SchemaStorage
            + SchemaStorageKijiTableLayout.getCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            +  +

            + + + + + +
            +Uses of SchemaStorage in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type SchemaStorage
            + CellSpecCellSpec.setSchemaStorage(SchemaStorage schemaStorage) + +
            +          Sets the schema storage.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html new file mode 100644 index 00000000..c5ffad82 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaTableEntry.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaTableEntry.Builder

            +
            + + + + + + + + + +
            +Packages that use SchemaTableEntry.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of SchemaTableEntry.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaTableEntry.Builder
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.clearAvroSchema() + +
            +          Clears the value of the 'avro_schema' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.clearHash() + +
            +          Clears the value of the 'hash' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.clearId() + +
            +          Clears the value of the 'id' field
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder() + +
            +          Creates a new SchemaTableEntry RecordBuilder
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry.Builder other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setAvroSchema(String value) + +
            +          Sets the value of the 'avro_schema' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setId(long value) + +
            +          Sets the value of the 'id' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaTableEntry.Builder
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry.Builder other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaTableEntry.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaTableEntry.html new file mode 100644 index 00000000..f709b19e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaTableEntry.html @@ -0,0 +1,417 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaTableEntry (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaTableEntry

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use SchemaTableEntry
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of SchemaTableEntry in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type SchemaTableEntry
            +abstract  List<SchemaTableEntry>KijiSchemaTable.toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type SchemaTableEntry
            +abstract  voidKijiSchemaTable.fromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            +  +

            + + + + + +
            +Uses of SchemaTableEntry in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type SchemaTableEntry
            + List<SchemaTableEntry>MetadataBackup.schema_table + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaTableEntry
            + SchemaTableEntrySchemaTableEntry.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type SchemaTableEntry
            + List<SchemaTableEntry>MetadataBackup.getSchemaTable() + +
            +          Gets the value of the 'schema_table' field.
            + List<SchemaTableEntry>MetadataBackup.Builder.getSchemaTable() + +
            +          Gets the value of the 'schema_table' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaTableEntry
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type SchemaTableEntry
            + voidMetadataBackup.setSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field.
            + MetadataBackup.BuilderMetadataBackup.Builder.setSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type SchemaTableEntry
            MetadataBackup(String layout_version, + List<SchemaTableEntry> schema_table, + Map<String,TableBackup> meta_table) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of SchemaTableEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return SchemaTableEntry
            +static SchemaTableEntryHBaseSchemaTable.decodeSchemaEntry(byte[] bytes) + +
            +          Decodes a binary-encoded Avro schema entry.
            +static SchemaTableEntryHBaseSchemaTable.toAvroEntry(KijiSchemaTable.SchemaEntry entry) + +
            +          Converts a SchemaEntry into an Avro SchemaTableEntry.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type SchemaTableEntry
            + List<SchemaTableEntry>HBaseSchemaTable.toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type SchemaTableEntry
            +static byte[]HBaseSchemaTable.encodeSchemaEntry(SchemaTableEntry avroEntry) + +
            +          Encodes an Avro schema entry into binary.
            +static KijiSchemaTable.SchemaEntryHBaseSchemaTable.fromAvroEntry(SchemaTableEntry avroEntry) + +
            +          Converts an Avro SchemaTableEntry into a SchemaEntry.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type SchemaTableEntry
            + voidHBaseSchemaTable.fromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaType.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaType.html new file mode 100644 index 00000000..b4f5c107 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/SchemaType.html @@ -0,0 +1,291 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaType (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaType

            +
            + + + + + + + + + + + + + +
            +Packages that use SchemaType
            org.kiji.schema.avro  
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of SchemaType in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as SchemaType
            + SchemaTypeCellSchema.type + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaType
            + SchemaTypeCellSchema.getType() + +
            +          Gets the value of the 'type' field.
            + SchemaTypeCellSchema.Builder.getType() + +
            +          Gets the value of the 'type' field
            +static SchemaTypeSchemaType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaType[]SchemaType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaType
            + voidCellSchema.setType(SchemaType value) + +
            +          Sets the value of the 'type' field.
            + CellSchema.BuilderCellSchema.Builder.setType(SchemaType value) + +
            +          Sets the value of the 'type' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type SchemaType
            CellSchema(SchemaStorage storage, + SchemaType type, + String value) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of SchemaType in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type SchemaType
            + CellSpecCellSpec.setType(SchemaType schemaType) + +
            +          Sets the cell type.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableBackup.Builder.html new file mode 100644 index 00000000..21aad2d2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableBackup.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableBackup.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableBackup.Builder

            +
            + + + + + + + + + +
            +Packages that use TableBackup.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of TableBackup.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableBackup.Builder
            + TableBackup.BuilderTableBackup.Builder.clearKeyValues() + +
            +          Clears the value of the 'key_values' field
            + TableBackup.BuilderTableBackup.Builder.clearLayouts() + +
            +          Clears the value of the 'layouts' field
            + TableBackup.BuilderTableBackup.Builder.clearName() + +
            +          Clears the value of the 'name' field
            +static TableBackup.BuilderTableBackup.newBuilder() + +
            +          Creates a new TableBackup RecordBuilder
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup.Builder other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing Builder
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance
            + TableBackup.BuilderTableBackup.Builder.setKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field
            + TableBackup.BuilderTableBackup.Builder.setLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field
            + TableBackup.BuilderTableBackup.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableBackup.Builder
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup.Builder other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableBackup.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableBackup.html new file mode 100644 index 00000000..9c629acc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableBackup.html @@ -0,0 +1,369 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableBackup (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableBackup

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use TableBackup
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of TableBackup in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type TableBackup
            +abstract  Map<String,TableBackup>KijiMetaTable.toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type TableBackup
            +abstract  voidKijiMetaTable.fromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            +  +

            + + + + + +
            +Uses of TableBackup in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type TableBackup
            + Map<String,TableBackup>MetadataBackup.meta_table + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableBackup
            + TableBackupTableBackup.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type TableBackup
            + Map<String,TableBackup>MetadataBackup.getMetaTable() + +
            +          Gets the value of the 'meta_table' field.
            + Map<String,TableBackup>MetadataBackup.Builder.getMetaTable() + +
            +          Gets the value of the 'meta_table' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableBackup
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type TableBackup
            + voidMetadataBackup.setMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field.
            + MetadataBackup.BuilderMetadataBackup.Builder.setMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type TableBackup
            MetadataBackup(String layout_version, + List<SchemaTableEntry> schema_table, + Map<String,TableBackup> meta_table) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of TableBackup in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type TableBackup
            + Map<String,TableBackup>HBaseMetaTable.toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type TableBackup
            + voidHBaseMetaTable.fromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html new file mode 100644 index 00000000..e4537892 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutBackupEntry.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutBackupEntry.Builder

            +
            + + + + + + + + + +
            +Packages that use TableLayoutBackupEntry.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutBackupEntry.Builder
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.clearLayout() + +
            +          Clears the value of the 'layout' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.clearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.clearUpdate() + +
            +          Clears the value of the 'update' field
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder() + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry.Builder other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutBackupEntry.Builder
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry.Builder other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html new file mode 100644 index 00000000..05048a79 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html @@ -0,0 +1,415 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutBackupEntry (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutBackupEntry

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use TableLayoutBackupEntry
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>TableBackup.layouts + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutBackupEntry
            + TableLayoutBackupEntryTableLayoutBackupEntry.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>TableBackup.getLayouts() + +
            +          Gets the value of the 'layouts' field.
            + List<TableLayoutBackupEntry>TableBackup.Builder.getLayouts() + +
            +          Gets the value of the 'layouts' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutBackupEntry
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type TableLayoutBackupEntry
            + voidTableBackup.setLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field.
            + TableBackup.BuilderTableBackup.Builder.setLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type TableLayoutBackupEntry
            TableBackup(String name, + List<TableLayoutBackupEntry> layouts, + List<KeyValueBackupEntry> key_values) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>HBaseMetaTable.layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type TableLayoutBackupEntry
            + voidHBaseMetaTable.layoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +           
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>KijiTableLayoutDatabase.layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.layout with type arguments of type TableLayoutBackupEntry
            + voidKijiTableLayoutDatabase.layoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +          Restores a table layout history from a backup.
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>HBaseTableLayoutDatabase.layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.layout.impl with type arguments of type TableLayoutBackupEntry
            + voidHBaseTableLayoutDatabase.layoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> layoutBackup) + +
            +          Restores a table layout history from a backup.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html new file mode 100644 index 00000000..802fa1e5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html @@ -0,0 +1,325 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutDesc.Builder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use TableLayoutDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of TableLayoutDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutDesc.Builder
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearKeysFormat() + +
            +          Clears the value of the 'keys_format' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearLayoutId() + +
            +          Clears the value of the 'layout_id' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearLocalityGroups() + +
            +          Clears the value of the 'locality_groups' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearReferenceLayout() + +
            +          Clears the value of the 'reference_layout' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearVersion() + +
            +          Clears the value of the 'version' field
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder() + +
            +          Creates a new TableLayoutDesc RecordBuilder
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc.Builder other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setKeysFormat(RowKeyFormat value) + +
            +          Sets the value of the 'keys_format' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setLayoutId(String value) + +
            +          Sets the value of the 'layout_id' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setReferenceLayout(String value) + +
            +          Sets the value of the 'reference_layout' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setVersion(String value) + +
            +          Sets the value of the 'version' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutDesc.Builder
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc.Builder other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutDesc.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutDesc.html new file mode 100644 index 00000000..a28c03a1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/class-use/TableLayoutDesc.html @@ -0,0 +1,472 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutDesc (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutDesc

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use TableLayoutDesc
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type TableLayoutDesc
            + KijiTableLayoutKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as TableLayoutDesc
            + TableLayoutDescTableLayoutBackupEntry.layout + +
            +          Deprecated. 
            + TableLayoutDescTableLayoutBackupEntry.update + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutDesc
            + TableLayoutDescTableLayoutDesc.Builder.build() + +
            +           
            + TableLayoutDescTableLayoutBackupEntry.getLayout() + +
            +          Gets the value of the 'layout' field.
            + TableLayoutDescTableLayoutBackupEntry.Builder.getLayout() + +
            +          Gets the value of the 'layout' field
            + TableLayoutDescTableLayoutBackupEntry.getUpdate() + +
            +          Gets the value of the 'update' field.
            + TableLayoutDescTableLayoutBackupEntry.Builder.getUpdate() + +
            +          Gets the value of the 'update' field
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutDesc
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance
            + voidTableLayoutBackupEntry.setLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field.
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field
            + voidTableLayoutBackupEntry.setUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field.
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type TableLayoutDesc
            TableLayoutBackupEntry(Long timestamp, + TableLayoutDesc update, + TableLayoutDesc layout) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type TableLayoutDesc
            + KijiTableLayoutHBaseMetaTable.updateTableLayout(String table, + TableLayoutDesc layoutUpdate) + +
            +          Sets a table's layout.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return TableLayoutDesc
            + TableLayoutDescKijiTableLayout.getDesc() + +
            +           
            +static TableLayoutDescKijiTableLayout.readTableLayoutDescFromJSON(InputStream istream) + +
            +          Reads a table layout descriptor from its JSON serialized form.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type TableLayoutDesc
            + KijiTableLayoutKijiTableLayoutDatabase.updateTableLayout(String table, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type TableLayoutDesc
            KijiTableLayout(TableLayoutDesc desc, + KijiTableLayout reference) + +
            +          Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type TableLayoutDesc
            + KijiTableLayoutHBaseTableLayoutDatabase.updateTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-frame.html new file mode 100644 index 00000000..59d68e94 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-frame.html @@ -0,0 +1,109 @@ + + + + + + + +org.kiji.schema.avro (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.schema.avro + + + + +
            +Interfaces  + +
            +KijiTableLayoutRecords +
            +KijiTableLayoutRecords.Callback
            + + + + + + +
            +Classes  + +
            +CellSchema +
            +CellSchema.Builder +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +KeyValueBackupEntry +
            +KeyValueBackupEntry.Builder +
            +LocalityGroupDesc +
            +LocalityGroupDesc.Builder +
            +MD5Hash +
            +MetadataBackup +
            +MetadataBackup.Builder +
            +RowKeyFormat +
            +RowKeyFormat.Builder +
            +SchemaTableEntry +
            +SchemaTableEntry.Builder +
            +TableBackup +
            +TableBackup.Builder +
            +TableLayoutBackupEntry +
            +TableLayoutBackupEntry.Builder +
            +TableLayoutDesc +
            +TableLayoutDesc.Builder
            + + + + + + +
            +Enums  + +
            +CompressionType +
            +HashType +
            +RowKeyEncoding +
            +SchemaStorage +
            +SchemaType
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-summary.html new file mode 100644 index 00000000..671ced70 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-summary.html @@ -0,0 +1,294 @@ + + + + + + + +org.kiji.schema.avro (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.avro +

            + + + + + + + + + + + + + +
            +Interface Summary
            KijiTableLayoutRecords 
            KijiTableLayoutRecords.Callback 
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            CellSchema 
            CellSchema.BuilderRecordBuilder for CellSchema instances.
            ColumnDesc 
            ColumnDesc.BuilderRecordBuilder for ColumnDesc instances.
            FamilyDesc 
            FamilyDesc.BuilderRecordBuilder for FamilyDesc instances.
            KeyValueBackupEntry 
            KeyValueBackupEntry.BuilderRecordBuilder for KeyValueBackupEntry instances.
            LocalityGroupDesc 
            LocalityGroupDesc.BuilderRecordBuilder for LocalityGroupDesc instances.
            MD5Hash 
            MetadataBackup 
            MetadataBackup.BuilderRecordBuilder for MetadataBackup instances.
            RowKeyFormat 
            RowKeyFormat.BuilderRecordBuilder for RowKeyFormat instances.
            SchemaTableEntry 
            SchemaTableEntry.BuilderRecordBuilder for SchemaTableEntry instances.
            TableBackup 
            TableBackup.BuilderRecordBuilder for TableBackup instances.
            TableLayoutBackupEntry 
            TableLayoutBackupEntry.BuilderRecordBuilder for TableLayoutBackupEntry instances.
            TableLayoutDesc 
            TableLayoutDesc.BuilderRecordBuilder for TableLayoutDesc instances.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Enum Summary
            CompressionType 
            HashType 
            RowKeyEncoding 
            SchemaStorage 
            SchemaType 
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-tree.html new file mode 100644 index 00000000..61256606 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-tree.html @@ -0,0 +1,206 @@ + + + + + + + +org.kiji.schema.avro Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.avro +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.avro.generic.GenericData.Fixed (implements java.lang.Comparable<T>, org.apache.avro.generic.GenericFixed) +
                  +
                • org.apache.avro.specific.SpecificFixed +
                +
              • org.apache.avro.data.RecordBuilderBase<T> (implements org.apache.avro.data.RecordBuilder<T>) + +
              • org.apache.avro.specific.SpecificRecordBase (implements java.lang.Comparable<T>, org.apache.avro.specific.SpecificRecord) +
                  +
                • org.kiji.schema.avro.CellSchema (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.ColumnDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.FamilyDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.KeyValueBackupEntry (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.LocalityGroupDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.MetadataBackup (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.RowKeyFormat (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.SchemaTableEntry (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.TableBackup (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.TableLayoutBackupEntry (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.TableLayoutDesc (implements org.apache.avro.specific.SpecificRecord) +
                +
              +
            +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-use.html new file mode 100644 index 00000000..d7ff116c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/avro/package-use.html @@ -0,0 +1,555 @@ + + + + + + + +Uses of Package org.kiji.schema.avro (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.avro

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.avro
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema
            KeyValueBackupEntry + +
            +           
            RowKeyFormat + +
            +           
            SchemaTableEntry + +
            +           
            TableBackup + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.avro
            CellSchema + +
            +           
            CellSchema.Builder + +
            +          RecordBuilder for CellSchema instances.
            ColumnDesc + +
            +           
            ColumnDesc.Builder + +
            +          RecordBuilder for ColumnDesc instances.
            CompressionType + +
            +           
            FamilyDesc + +
            +           
            FamilyDesc.Builder + +
            +          RecordBuilder for FamilyDesc instances.
            HashType + +
            +           
            KeyValueBackupEntry + +
            +           
            KeyValueBackupEntry.Builder + +
            +          RecordBuilder for KeyValueBackupEntry instances.
            KijiTableLayoutRecords + +
            +           
            LocalityGroupDesc + +
            +           
            LocalityGroupDesc.Builder + +
            +          RecordBuilder for LocalityGroupDesc instances.
            MD5Hash + +
            +           
            MetadataBackup + +
            +           
            MetadataBackup.Builder + +
            +          RecordBuilder for MetadataBackup instances.
            RowKeyEncoding + +
            +           
            RowKeyFormat + +
            +           
            RowKeyFormat.Builder + +
            +          RecordBuilder for RowKeyFormat instances.
            SchemaStorage + +
            +           
            SchemaTableEntry + +
            +           
            SchemaTableEntry.Builder + +
            +          RecordBuilder for SchemaTableEntry instances.
            SchemaType + +
            +           
            TableBackup + +
            +           
            TableBackup.Builder + +
            +          RecordBuilder for TableBackup instances.
            TableLayoutBackupEntry + +
            +           
            TableLayoutBackupEntry.Builder + +
            +          RecordBuilder for TableLayoutBackupEntry instances.
            TableLayoutDesc + +
            +           
            TableLayoutDesc.Builder + +
            +          RecordBuilder for TableLayoutDesc instances.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.impl
            KeyValueBackupEntry + +
            +           
            MetadataBackup + +
            +           
            RowKeyFormat + +
            +           
            SchemaTableEntry + +
            +           
            TableBackup + +
            +           
            TableLayoutBackupEntry + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.layout
            CellSchema + +
            +           
            ColumnDesc + +
            +           
            FamilyDesc + +
            +           
            LocalityGroupDesc + +
            +           
            SchemaStorage + +
            +           
            TableLayoutBackupEntry + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.layout.impl
            CellSchema + +
            +           
            SchemaStorage + +
            +           
            SchemaType + +
            +           
            TableLayoutBackupEntry + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.tools
            RowKeyFormat + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/EntityId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/EntityId.html new file mode 100644 index 00000000..f20fab94 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/EntityId.html @@ -0,0 +1,832 @@ + + + + + + + +Uses of Class org.kiji.schema.EntityId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.EntityId

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use EntityId
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji map-reduce utilities. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return EntityId
            +abstract  EntityIdEntityIdFactory.fromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates an entity ID from an HBase row key.
            +abstract  EntityIdEntityIdFactory.fromKijiRowKey(byte[] kijiRowKey) + +
            +          Creates an entity ID from a Kiji row key.
            + EntityIdEntityIdFactory.fromKijiRowKey(String text) + +
            +          Creates an entity ID from a UTF8 text Kiji row key.
            + EntityIdKijiRowData.getEntityId() + +
            +          Gets the entity id for this row of kiji data.
            + EntityIdKijiTable.getEntityId(String kijiRowKey) + +
            +          Creates an entity ID for the specified UTF8 encoded Kiji row key.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type EntityId
            + voidKijiDeleter.deleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voidKijiDeleter.deleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voidKijiDeleter.deleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voidKijiDeleter.deleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voidKijiDeleter.deleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voidKijiDeleter.deleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voidKijiDeleter.deleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voidKijiDeleter.deleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            +abstract  KijiRowDataKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow) + +
            +          Gets a KijiRowScanner using default options.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using the specified HBaseScanOptions.
            +abstract  KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            + KijiCounterKijiIncrementer.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            + + + + + +
            +<T> void
            +            		KijiPutter.put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		KijiPutter.put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type EntityId
            +abstract  List<KijiRowData>KijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type EntityId
            KijiColumnPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HTableInterface htable) + +
            +          Creates a new KijiColumnPager.
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of EntityId in org.kiji.schema.impl
            + classHashedEntityId + +
            +          Implements the hashed row key format.
            + classHashPrefixedEntityId + +
            +          Implements the hash-prefixed row key format.
            + classHBaseEntityId + +
            +          Entity ID encapsulating an HBase row key.
            + classRawEntityId + +
            +          Implements the raw row key format.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return EntityId
            + EntityIdHBaseKijiRowData.getEntityId() + +
            +          Gets the entity id for this row of kiji data.
            + EntityIdAbstractKijiTable.getEntityId(String kijiRowKey) + +
            +          Creates an entity ID out of a UTF8 encoded Kiji row key.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type EntityId
            + Set<Map.Entry<EntityId,List<T>>>KijiDataBuffer.getEntries() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type EntityId
            + KijiDataBuffer<T>KijiDataBuffer.add(EntityId id, + T value) + +
            +          Adds a buffer element to the buffer and associates it with the specified entity.
            + voidHBaseKijiTableWriter.deleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voidHBaseKijiTableWriter.deleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voidHBaseKijiTableWriter.deleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voidHBaseKijiTableWriter.deleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voidHBaseKijiTableWriter.deleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voidHBaseKijiTableWriter.deleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voidHBaseKijiTableWriter.deleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voidHBaseKijiTableWriter.deleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            + KijiRowDataHBaseKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieve data from a single row in the Kiji table, with no post-processing.
            +protected  List<T>KijiDataBuffer.getBuffer(EntityId id) + +
            +          Gets the list of buffer elements associated with the specified entity.
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            + KijiCounterHBaseKijiTableWriter.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            + + + + + +
            +<T> void
            +            		HBaseKijiTableWriter.put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		HBaseKijiTableWriter.put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            + GetHBaseDataRequestAdapter.toGet(EntityId entityId, + KijiTableLayout tableLayout) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + GetHBaseDataRequestAdapter.toGet(EntityId entityId, + KijiTableLayout tableLayout, + int pageIndex) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type EntityId
            + List<KijiRowData>HBaseKijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type EntityId
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return EntityId
            + EntityIdKijiTableInputFormat.KijiTableRecordReader.getCurrentKey() + +
            +          
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return types with arguments of type EntityId
            + RecordReader<EntityId,KijiRowData>KijiTableInputFormat.createRecordReader(InputSplit split, + TaskAttemptContext context) + +
            +          Deprecated. 
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools that return EntityId
            +static EntityIdToolUtils.createEntityIdFromUserInputs(String entityId, + String entityHash, + RowKeyFormat format) + +
            +          Create an EntityId from the --entity-id and --entity-hash arguments to a kiji tool.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/EntityIdFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/EntityIdFactory.html new file mode 100644 index 00000000..9ef6b80a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/EntityIdFactory.html @@ -0,0 +1,218 @@ + + + + + + + +Uses of Class org.kiji.schema.EntityIdFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.EntityIdFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use EntityIdFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of EntityIdFactory in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return EntityIdFactory
            +static EntityIdFactoryEntityIdFactory.create(RowKeyFormat format) + +
            +          Creates an entity ID factory for the specified row key format.
            + EntityIdFactoryKijiTable.getEntityIdFactory() + +
            +           
            +  +

            + + + + + +
            +Uses of EntityIdFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return EntityIdFactory
            + EntityIdFactoryHBaseKijiTable.getEntityIdFactory() + +
            +          
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/GenericCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/GenericCellDecoderFactory.html new file mode 100644 index 00000000..41152768 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/GenericCellDecoderFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.GenericCellDecoderFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.GenericCellDecoderFactory

            +
            +No usage of org.kiji.schema.GenericCellDecoderFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseColumnName.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseColumnName.html new file mode 100644 index 00000000..7bc80d26 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseColumnName.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Class org.kiji.schema.HBaseColumnName (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.HBaseColumnName

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseColumnName
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of HBaseColumnName in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that return HBaseColumnName
            + HBaseColumnNameKijiColumnFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +abstract  HBaseColumnNameKijiRowFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            +  +

            + + + + + +
            +Uses of HBaseColumnName in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return HBaseColumnName
            + HBaseColumnNameColumnNameTranslator.toHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type HBaseColumnName
            + KijiColumnNameColumnNameTranslator.toKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseFactory.Provider.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseFactory.Provider.html new file mode 100644 index 00000000..cbcfc2ac --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseFactory.Provider.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.HBaseFactory.Provider (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.HBaseFactory.Provider

            +
            +No usage of org.kiji.schema.HBaseFactory.Provider +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseFactory.html new file mode 100644 index 00000000..49f1c406 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseFactory.html @@ -0,0 +1,238 @@ + + + + + + + +Uses of Interface org.kiji.schema.HBaseFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.HBaseFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return HBaseFactory
            +static HBaseFactoryHBaseFactory.Provider.get() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type HBaseFactory
            +static voidKijiInstaller.install(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            +static voidKijiInstaller.uninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  +

            + + + + + +
            +Uses of HBaseFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement HBaseFactory
            + classDefaultHBaseFactory + +
            +          Factory for HBase instances based on URIs.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseScanOptions.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseScanOptions.html new file mode 100644 index 00000000..53643fd7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/HBaseScanOptions.html @@ -0,0 +1,238 @@ + + + + + + + +Uses of Class org.kiji.schema.HBaseScanOptions (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.HBaseScanOptions

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseScanOptions
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseScanOptions in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type HBaseScanOptions
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using the specified HBaseScanOptions.
            +abstract  KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            +  +

            + + + + + +
            +Uses of HBaseScanOptions in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HBaseScanOptions
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            + ScanHBaseDataRequestAdapter.toScan(KijiTableLayout tableLayout, + HBaseScanOptions scanOptions) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/IncompatibleKijiVersionException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/IncompatibleKijiVersionException.html new file mode 100644 index 00000000..063b9441 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/IncompatibleKijiVersionException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.IncompatibleKijiVersionException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.IncompatibleKijiVersionException

            +
            +No usage of org.kiji.schema.IncompatibleKijiVersionException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/InternalKijiError.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/InternalKijiError.html new file mode 100644 index 00000000..916c5969 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/InternalKijiError.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.InternalKijiError (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.InternalKijiError

            +
            +No usage of org.kiji.schema.InternalKijiError +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/Kiji.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/Kiji.html new file mode 100644 index 00000000..a0b2a0d0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/Kiji.html @@ -0,0 +1,403 @@ + + + + + + + +Uses of Class org.kiji.schema.Kiji (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.Kiji

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use Kiji
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return Kiji
            + KijiKijiTable.getKiji() + +
            +           
            +static KijiKiji.open(KijiConfiguration kijiConf) + +
            +          Opens a Kiji instance.
            +static KijiKiji.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            +static KijiKiji.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type Kiji
            KijiAdmin(HBaseAdmin hbaseAdmin, + Kiji kiji) + +
            +          Creates a Kiji admin.
            KijiTablePool(Kiji kiji) + +
            +          Constructs a new pool of Kiji tables.
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return Kiji
            + KijiAbstractKijiTable.getKiji() + +
            +          Gets the kiji instance this table lives in.
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type Kiji
            + voidMetadataRestorer.exportMetadata(String outputFile, + Kiji kiji) + +
            +          Exports all Kiji metadata to an Avro file with the specified filename.
            +static KijiTableAbstractKijiTable.open(Kiji kiji, + String name) + +
            +          Opens a kiji table with the default implementation.
            + voidMetadataRestorer.restoreSchemas(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all SchemaTable entries from the metadata backup.
            + voidMetadataRestorer.restoreTables(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all tables from the metadata backup into the running Kiji instance.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type Kiji
            AbstractKijiTable(Kiji kiji, + String name) + +
            +          Creates a new KijiTable instance.
            DefaultKijiTableFactory(Kiji kiji) + +
            +          Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance.
            HBaseKijiTable(Kiji kiji, + String name) + +
            +          Construct an opened Kiji table stored in HBase.
            HBaseKijiTable(Kiji kiji, + String name, + HTableInterfaceFactory htableFactory) + +
            +          Construct an opened Kiji table stored in HBase.
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools that return Kiji
            +protected  KijiVersionValidatedTool.openKiji() + +
            +          Opens a kiji instance.
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema.util
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util with parameters of type Kiji
            +static StringVersionInfo.getClusterDataVersion(Kiji kiji) + +
            +          Gets the version of the Kiji data format installed in the instance of the HBase cluster.
            +static voidVersionInfo.validateVersion(Kiji kiji) + +
            +          Validates that the client data version matches the data version installed on a Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiAdmin.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiAdmin.html new file mode 100644 index 00000000..fbf333bb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiAdmin.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiAdmin (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiAdmin

            +
            +No usage of org.kiji.schema.KijiAdmin +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCell.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCell.html new file mode 100644 index 00000000..7b8ca7d7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCell.html @@ -0,0 +1,478 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiCell (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiCell

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiCell
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCell in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCell
            + KijiCell<T>KijiCellDecoder.decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + + + + + +
            +<T> KijiCell<T>
            +            		KijiRowData.getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> KijiCell<T>
            +            		KijiRowData.getMostRecentCell(String family, + String qualifier) + +
            +          Gets the latest version of the specified cell.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiCell
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		KijiRowData.getCells(String family) + +
            +          Gets all the timestamp-cell pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		KijiRowData.getCells(String family, + String qualifier) + +
            +          Gets all the timestamp-cell pairs stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		KijiRowData.getMostRecentCells(String family) + +
            +          Gets the latest version of the specified cell.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiCell
            + byte[]KijiCellEncoder.encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            +  +

            + + + + + +
            +Uses of KijiCell in org.kiji.schema.filter
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiCell
            +abstract  byte[]KijiRowFilter.Context.getHBaseCellValue(KijiColumnName column, + KijiCell<?> kijiCell) + +
            +          Converts a Kiji cell value into an HBase cell value.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.filter with parameters of type KijiCell
            ColumnValueEqualsRowFilter(String family, + String qualifier, + KijiCell<?> value) + +
            +          Creates a new ColumnValueEqualsRowFilter instance.
            +  +

            + + + + + +
            +Uses of KijiCell in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCell
            + KijiCell<T>AvroCellDecoder.decodeCell(byte[] encodedBytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + KijiCell<Long>CounterCellDecoder.decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + + + + + +
            +<T> KijiCell<T>
            +            		HBaseKijiRowData.getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> KijiCell<T>
            +            		HBaseKijiRowData.getMostRecentCell(String family, + String qualifier) + +
            +          Gets the latest version of the specified cell.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KijiCell
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		HBaseKijiRowData.getCells(String family) + +
            +          Gets all the timestamp-cell pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		HBaseKijiRowData.getCells(String family, + String qualifier) + +
            +          Gets all the timestamp-cell pairs stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		HBaseKijiRowData.getMostRecentCells(String family) + +
            +          Gets the latest version of the specified cell.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiCell
            + byte[]CounterCellEncoder.encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + byte[]AvroCellEncoder.encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellDecoder.html new file mode 100644 index 00000000..29a42e74 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellDecoder.html @@ -0,0 +1,257 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellDecoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellDecoder

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCellDecoder
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellDecoder in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCellDecoder
            + KijiCellDecoder<?>GenericCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + KijiCellDecoder<?>SpecificCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + + + + + +
            +<T> KijiCellDecoder<T>
            +            		KijiCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +  +

            + + + + + +
            +Uses of KijiCellDecoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCellDecoder
            + classAvroCellDecoder<T> + +
            +          Base class for decoders that read Kiji cells encoded using Avro.
            + classCounterCellDecoder + +
            +          Cell decoder for counters.
            + classGenericCellDecoder<T> + +
            +          Decodes cells encoded using Avro into generic types.
            + classSpecificCellDecoder<T> + +
            +          Decodes cells encoded using Avro into specific types.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellDecoderFactory.html new file mode 100644 index 00000000..14e37679 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellDecoderFactory.html @@ -0,0 +1,311 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellDecoderFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellDecoderFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCellDecoderFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellDecoderFactory in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema that implement KijiCellDecoderFactory
            + classGenericCellDecoderFactory + +
            +          Factory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas.
            + classSpecificCellDecoderFactory + +
            +          Factory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCellDecoderFactory
            +static KijiCellDecoderFactoryGenericCellDecoderFactory.get() + +
            +           
            +static KijiCellDecoderFactorySpecificCellDecoderFactory.get() + +
            +           
            + KijiCellDecoderFactoryKijiTableReader.getKijiCellDecoderFactory() + +
            +          Gets the KijiCellDecoderFactory to use for decoding KijiCells.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiCellDecoderFactory
            + voidKijiTableReader.setKijiCellDecoderFactory(KijiCellDecoderFactory kijiCellDecoderFactory) + +
            +          Sets the KijiCellDecoderFactory to be used for retrieving a KijiCell.
            +  +

            + + + + + +
            +Uses of KijiCellDecoderFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCellDecoderFactory
            + KijiCellDecoderFactoryHBaseKijiRowScanner.Options.getCellDecoderFactory() + +
            +          Gets the cell decoder factory.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiCellDecoderFactory
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory) + +
            +          Sets the cell decoder factory to use when reading cells from the scanner.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiCellDecoderFactory
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellEncoder.html new file mode 100644 index 00000000..0eccd786 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellEncoder.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellEncoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellEncoder

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCellEncoder
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellEncoder in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCellEncoder
            + KijiCellEncoderKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            + + + + + +
            +Uses of KijiCellEncoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCellEncoder
            + classAvroCellEncoder + +
            +          Serializes a KijiCell.
            + classCounterCellEncoder + +
            +          Encoder for Kiji counters.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCellEncoder
            + KijiCellEncoderDefaultKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellEncoderFactory.html new file mode 100644 index 00000000..f24a382b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCellEncoderFactory.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellEncoderFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellEncoderFactory

            +
            + + + + + + + + + +
            +Packages that use KijiCellEncoderFactory
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellEncoderFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCellEncoderFactory
            + classDefaultKijiCellEncoderFactory + +
            +          Factory for cell encoders.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiColumnName.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiColumnName.html new file mode 100644 index 00000000..7b3b08d8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiColumnName.html @@ -0,0 +1,428 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiColumnName (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiColumnName

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiColumnName
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiColumnName in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiColumnName
            + KijiColumnNameKijiDataRequest.Column.getColumnName() + +
            +          Gets the column name.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiColumnName
            + com.google.common.collect.ImmutableList<KijiColumnName>KijiURI.getColumn() + +
            +           
            + Collection<KijiColumnName>KijiURI.getColumnOrdered() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiColumnName
            + intKijiColumnName.compareTo(KijiColumnName o) + +
            +          
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiColumnName
            KijiDataRequest.Column(KijiColumnName name) + +
            +          Creates a new requested Column.
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema with type arguments of type KijiColumnName
            KijiURI(Iterable<String> zookeeperQuorum, + int zookeeperClientPort, + String instanceName, + String tableName, + Iterable<KijiColumnName> columnNames) + +
            +          Constructs a new KijiURI with the given parameters.
            +  +

            + + + + + +
            +Uses of KijiColumnName in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiColumnName
            +abstract  byte[]KijiRowFilter.Context.getHBaseCellValue(KijiColumnName column, + KijiCell<?> kijiCell) + +
            +          Converts a Kiji cell value into an HBase cell value.
            + HBaseColumnNameKijiColumnFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +abstract  HBaseColumnNameKijiRowFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            + FilterKijiColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + ColumnNameTranslator columnNameTranslator) + +
            +          Expresses a KijiColumnFilter in terms of an equivalent HBase filter, translating the + KijiColumnNames to the corresponding HBaseColumnName.
            +abstract  FilterKijiColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            + FilterRegexQualifierColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  +

            + + + + + +
            +Uses of KijiColumnName in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiColumnName
            + KijiColumnNameColumnNameTranslator.toKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiColumnName
            + Set<KijiColumnName>KijiTableLayout.getColumnNames() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type KijiColumnName
            + booleanKijiTableLayout.exists(KijiColumnName column) + +
            +          Reports whether a column exists.
            + SchemaStorageKijiTableLayout.getCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            + CellSchemaKijiTableLayout.getCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            + CellSpecKijiTableLayout.getCellSpec(KijiColumnName column) + +
            +           
            + org.apache.avro.SchemaKijiTableLayout.getSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            + HBaseColumnNameColumnNameTranslator.toHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiColumnPager.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiColumnPager.html new file mode 100644 index 00000000..4ef45456 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiColumnPager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiColumnPager (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiColumnPager

            +
            +No usage of org.kiji.schema.KijiColumnPager +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiColumnPagingNotEnabledException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiColumnPagingNotEnabledException.html new file mode 100644 index 00000000..c2481208 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiColumnPagingNotEnabledException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiColumnPagingNotEnabledException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiColumnPagingNotEnabledException

            +
            +No usage of org.kiji.schema.KijiColumnPagingNotEnabledException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiConfiguration.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiConfiguration.html new file mode 100644 index 00000000..d959ef11 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiConfiguration.html @@ -0,0 +1,406 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiConfiguration (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiConfiguration

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiConfiguration
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiConfiguration in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiConfiguration
            +static KijiConfigurationKijiConfiguration.create(String name) + +
            +          Gets a handle to a Kiji instance using the default Kiji configuration file.
            +static KijiConfigurationKijiConfiguration.create(String confFile, + String name) + +
            +          Gets a handle to a Kiji instance.
            + KijiConfigurationKiji.getKijiConf() + +
            +          Gets the kiji instance configuration.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiConfiguration
            +static KijiKiji.open(KijiConfiguration kijiConf) + +
            +          Opens a Kiji instance.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiConfiguration
            Kiji(KijiConfiguration kijiConf) + +
            +          Creates a new Kiji instance.
            Kiji(KijiConfiguration kijiConf, + boolean validateVersion, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Creates a new Kiji instance.
            KijiConfiguration(KijiConfiguration kijiConf) + +
            +          Constructs a deep copy of an existing Kiji configuration.
            +  +

            + + + + + +
            +Uses of KijiConfiguration in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiConfiguration
            +static voidHBaseMetaTable.install(HBaseAdmin admin, + KijiConfiguration kijiConfiguration) + +
            +          Install the meta table into a Kiji instance.
            +static voidHBaseSystemTable.install(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Installs a Kiji system table into a running HBase instance.
            +static voidHBaseSchemaTable.install(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static LockHBaseSchemaTable.newLock(KijiConfiguration conf, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +static HTableInterfaceHBaseMetaTable.newMetaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates an HTableInterface for the specified table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaHashTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema hash table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaIdTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema ID table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaV5Table(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema V5 table.
            +static HTableInterfaceHBaseSystemTable.newSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates a new HTableInterface for the Kiji system table.
            +static voidHBaseSystemTable.uninstall(HBaseAdmin admin, + KijiConfiguration kijiConf) + +
            +          Disables and delete the system table from HBase.
            +static voidHBaseMetaTable.uninstall(HBaseAdmin admin, + KijiConfiguration kijiConf) + +
            +          Removes the meta table from HBase.
            +static voidHBaseSchemaTable.uninstall(HBaseAdmin admin, + KijiConfiguration kijiConf) + +
            +          Disables and removes the schema table from HBase.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiConfiguration
            HBaseMetaTable(KijiConfiguration kijiConf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseSchemaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            HBaseSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Connect to the HBase system table inside a Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCounter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCounter.html new file mode 100644 index 00000000..ec0d6af5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiCounter.html @@ -0,0 +1,271 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCounter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCounter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCounter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCounter in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCounter
            + KijiCounterKijiRowData.getCounter(String family, + String qualifier) + +
            +          Gets the most recent counter from a column.
            + KijiCounterKijiRowData.getCounter(String family, + String qualifier, + long timestamp) + +
            +          Reads a counter as it was at a particular timestamp.
            + KijiCounterKijiIncrementer.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            +  +

            + + + + + +
            +Uses of KijiCounter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCounter
            + classDefaultKijiCounter + +
            +          The default implementation of a Kiji counter, which contains the data in a counter cell + of a column.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCounter
            + KijiCounterHBaseKijiRowData.getCounter(String family, + String qualifier) + +
            +          Deprecated. 
            + KijiCounterHBaseKijiRowData.getCounter(String family, + String qualifier, + long timestamp) + +
            +          Deprecated. 
            + KijiCounterHBaseKijiTableWriter.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequest.Column.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequest.Column.html new file mode 100644 index 00000000..c1148dd4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequest.Column.html @@ -0,0 +1,239 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequest.Column (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequest.Column

            +
            + + + + + + + + + +
            +Packages that use KijiDataRequest.Column
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiDataRequest.Column in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiDataRequest.Column
            + KijiDataRequest.ColumnKijiDataRequest.getColumn(String family, + String key) + +
            +          Gets a Column requested named "family:key", or + null if none exists.
            + KijiDataRequest.ColumnKijiDataRequest.Column.withFilter(KijiColumnFilter filter) + +
            +          Sets a filter to use on the column.
            + KijiDataRequest.ColumnKijiDataRequest.Column.withMaxVersions(int num) + +
            +          Sets the maximum number of the most recent versions to return.
            + KijiDataRequest.ColumnKijiDataRequest.Column.withPageSize(int cellsPerPage) + +
            +          Sets the number of cells per page (defaults to zero, which means paging is disabled).
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiDataRequest.Column
            + Collection<KijiDataRequest.Column>KijiDataRequest.getColumns() + +
            +          Gets the collection of requested columns.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiDataRequest.Column
            + KijiDataRequestKijiDataRequest.addColumn(KijiDataRequest.Column column) + +
            +          Add a request for a column to this data request.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequest.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequest.html new file mode 100644 index 00000000..b88a114d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequest.html @@ -0,0 +1,532 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequest (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequest

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiDataRequest
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji map-reduce utilities. 
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiDataRequest
            + KijiDataRequestKijiDataRequest.addColumn(KijiDataRequest.Column column) + +
            +          Add a request for a column to this data request.
            + KijiDataRequestKijiDataRequest.merge(KijiDataRequest other) + +
            +          Merges the requested columns in other into this data request.
            + KijiDataRequestKijiDataRequest.withTimeRange(long minTimestamp, + long maxTimestamp) + +
            +          Sets the time range of cells to return: [minTimestamp, + maxTimestamp).
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiDataRequest
            +abstract  List<KijiRowData>KijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +abstract  KijiRowDataKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow) + +
            +          Gets a KijiRowScanner using default options.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using the specified HBaseScanOptions.
            +abstract  KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            + KijiDataRequestKijiDataRequest.merge(KijiDataRequest other) + +
            +          Merges the requested columns in other into this data request.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiDataRequest
            KijiColumnPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HTableInterface htable) + +
            +          Creates a new KijiColumnPager.
            KijiDataRequest(KijiDataRequest copy) + +
            +          Creates a new KijiDataRequest from a copy.
            KijiDataRequestValidator(KijiDataRequest dataRequest) + +
            +          Construct a validator for a data request.
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that return KijiDataRequest
            + KijiDataRequestStripValueRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            +abstract  KijiDataRequestKijiRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + KijiDataRequestOperatorRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + KijiDataRequestColumnValueEqualsRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + KijiDataRequestHasColumnDataRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiDataRequest
            + KijiDataRequestHBaseKijiRowScanner.Options.getDataRequest() + +
            +          Gets the data request.
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiDataRequest
            + List<KijiRowData>HBaseKijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + KijiRowDataHBaseKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieve data from a single row in the Kiji table, with no post-processing.
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withDataRequest(KijiDataRequest dataRequest) + +
            +          Sets the data request used to generate the KijiRowScanner.
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiDataRequest
            HBaseDataRequestAdapter(KijiDataRequest kijiDataRequest) + +
            +          Wraps a KijiDataRequest.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.mapreduce declared as KijiDataRequest
            +protected  KijiDataRequestKijiTableInputFormat.KijiTableRecordReader.mDataRequest + +
            +          Data request.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce with parameters of type KijiDataRequest
            +static voidKijiTableInputFormat.configureJob(Job job, + KijiURI tableURI, + KijiDataRequest dataRequest, + String startRow, + String endRow) + +
            +          Deprecated. Configures a Hadoop M/R job to read from a given table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequestException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequestException.html new file mode 100644 index 00000000..45dcbb6c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequestException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequestException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequestException

            +
            +No usage of org.kiji.schema.KijiDataRequestException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequestValidator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequestValidator.html new file mode 100644 index 00000000..54a95687 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDataRequestValidator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequestValidator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequestValidator

            +
            +No usage of org.kiji.schema.KijiDataRequestValidator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDeleter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDeleter.html new file mode 100644 index 00000000..5fc41ece --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiDeleter.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiDeleter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiDeleter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiDeleter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiDeleter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiDeleter in org.kiji.schema
            + interfaceKijiTableWriter + +
            +          Interface for modifying a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiDeleter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiDeleter
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiIncrementer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiIncrementer.html new file mode 100644 index 00000000..976cecbf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiIncrementer.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiIncrementer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiIncrementer

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiIncrementer
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiIncrementer in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiIncrementer in org.kiji.schema
            + interfaceKijiTableWriter + +
            +          Interface for modifying a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiIncrementer in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiIncrementer
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiInstaller.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiInstaller.html new file mode 100644 index 00000000..cace3302 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiInstaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiInstaller (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiInstaller

            +
            +No usage of org.kiji.schema.KijiInstaller +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiInvalidNameException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiInvalidNameException.html new file mode 100644 index 00000000..acd15404 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiInvalidNameException.html @@ -0,0 +1,239 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiInvalidNameException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiInvalidNameException

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiInvalidNameException
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of KijiInvalidNameException in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that throw KijiInvalidNameException
            +static voidKijiInstaller.install(KijiURI uri, + Configuration conf) + +
            +          Installs the specified Kiji instance.
            +static voidKijiInstaller.install(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiInvalidNameException in org.kiji.schema.util
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util that throw KijiInvalidNameException
            +static voidKijiNameValidator.validateAlias(CharSequence name) + +
            +          Validates characters that may be used in an alias for a qualifier, family, or + locality group.
            +static voidKijiNameValidator.validateKijiName(CharSequence name) + +
            +          Determines whether a string is a valid Kiji instance name.
            +static voidKijiNameValidator.validateLayoutName(CharSequence name) + +
            +          Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiManagedHBaseTableName.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiManagedHBaseTableName.html new file mode 100644 index 00000000..7c63ec6c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiManagedHBaseTableName.html @@ -0,0 +1,260 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiManagedHBaseTableName (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiManagedHBaseTableName

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiManagedHBaseTableName
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiManagedHBaseTableName in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiManagedHBaseTableName
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.get(String hbaseTableName) + +
            +          Constructs using an HBase HTable name.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getKijiTableName(String kijiInstanceName, + String kijiTableName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getMetaTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSchemaHashTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSchemaIdTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSchemaV5TableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSystemTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table.
            +  +

            + + + + + +
            +Uses of KijiManagedHBaseTableName in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiManagedHBaseTableName
            +static HTableDescriptorHTableDescriptorComparator.makeEmptyTableDescriptor(KijiManagedHBaseTableName hbaseTableName) + +
            +          Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout().
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiMetaTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiMetaTable.html new file mode 100644 index 00000000..687f9d0b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiMetaTable.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiMetaTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiMetaTable

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiMetaTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiMetaTable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiMetaTable
            + KijiMetaTableKiji.getMetaTable() + +
            +          Gets the meta table for this Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiMetaTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiMetaTable in org.kiji.schema.impl
            + classHBaseMetaTable + +
            +          An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiNotInstalledException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiNotInstalledException.html new file mode 100644 index 00000000..ba4f6d10 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiNotInstalledException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiNotInstalledException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiNotInstalledException

            +
            +No usage of org.kiji.schema.KijiNotInstalledException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiPutter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiPutter.html new file mode 100644 index 00000000..939ed74d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiPutter.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiPutter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiPutter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiPutter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiPutter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiPutter in org.kiji.schema
            + interfaceKijiTableWriter + +
            +          Interface for modifying a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiPutter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiPutter
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiRowData.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiRowData.html new file mode 100644 index 00000000..e4453606 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiRowData.html @@ -0,0 +1,308 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiRowData (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiRowData

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiRowData
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji map-reduce utilities. 
            +  +

            + + + + + +
            +Uses of KijiRowData in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiRowData
            +abstract  KijiRowDataKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiRowData
            +abstract  List<KijiRowData>KijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + +
            +Uses of KijiRowData in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiRowData
            + classHBaseKijiRowData + +
            +          An implementation of KijiRowData that wraps an HBase Result object.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiRowData
            + KijiRowDataHBaseKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieve data from a single row in the Kiji table, with no post-processing.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KijiRowData
            + List<KijiRowData>HBaseKijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + +
            +Uses of KijiRowData in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return KijiRowData
            + KijiRowDataKijiTableInputFormat.KijiTableRecordReader.getCurrentValue() + +
            +          
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return types with arguments of type KijiRowData
            + RecordReader<EntityId,KijiRowData>KijiTableInputFormat.createRecordReader(InputSplit split, + TaskAttemptContext context) + +
            +          Deprecated. 
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiRowKeySplitter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiRowKeySplitter.html new file mode 100644 index 00000000..79c3e929 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiRowKeySplitter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiRowKeySplitter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiRowKeySplitter

            +
            +No usage of org.kiji.schema.KijiRowKeySplitter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiRowScanner.html new file mode 100644 index 00000000..e9c95e0f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiRowScanner.html @@ -0,0 +1,255 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiRowScanner (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiRowScanner

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiRowScanner
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiRowScanner in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiRowScanner
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow) + +
            +          Gets a KijiRowScanner using default options.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using the specified HBaseScanOptions.
            +abstract  KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            +  +

            + + + + + +
            +Uses of KijiRowScanner in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiRowScanner
            + classHBaseKijiRowScanner + +
            +          The internal implementation of KijiRowScanner that reads from HTables.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiRowScanner
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html new file mode 100644 index 00000000..13f0a5ef --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiSchemaTable.SchemaEntry (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiSchemaTable.SchemaEntry

            +
            + + + + + + + + + +
            +Packages that use KijiSchemaTable.SchemaEntry
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiSchemaTable.SchemaEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiSchemaTable.SchemaEntry
            +static KijiSchemaTable.SchemaEntryHBaseSchemaTable.fromAvroEntry(SchemaTableEntry avroEntry) + +
            +          Converts an Avro SchemaTableEntry into a SchemaEntry.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiSchemaTable.SchemaEntry
            +static SchemaTableEntryHBaseSchemaTable.toAvroEntry(KijiSchemaTable.SchemaEntry entry) + +
            +          Converts a SchemaEntry into an Avro SchemaTableEntry.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiSchemaTable.html new file mode 100644 index 00000000..1718d452 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiSchemaTable.html @@ -0,0 +1,370 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiSchemaTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiSchemaTable

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiSchemaTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiSchemaTable
            + KijiSchemaTableKiji.getSchemaTable() + +
            +          Gets the schema table for this Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema.filter
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.filter with parameters of type KijiSchemaTable
            KijiRowFilterApplicator(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiSchemaTable in org.kiji.schema.impl
            + classHBaseSchemaTable + +
            +           + Mapping between schema IDs, hashes and Avro schema objects.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiSchemaTable
            + KijiSchemaTableHBaseKijiRowData.getSchemaTable() + +
            +          Gets the schema table this kiji row data uses for decoding.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiSchemaTable
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseMetaTable(HTableInterface htable, + KijiSchemaTable schemaTable) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseMetaTable(KijiConfiguration kijiConf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return KijiSchemaTable
            + KijiSchemaTableCellSpec.getSchemaTable() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type KijiSchemaTable
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            + CellSpecCellSpec.setSchemaTable(KijiSchemaTable schemaTable) + +
            +          Sets the schema table.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout.impl with parameters of type KijiSchemaTable
            HBaseTableLayoutDatabase(HTableInterface htable, + String family, + KijiSchemaTable schemaTable) + +
            +          Creates a new HBaseTableLayoutDatabase instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiSystemTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiSystemTable.html new file mode 100644 index 00000000..6dd509e8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiSystemTable.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiSystemTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiSystemTable

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiSystemTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiSystemTable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiSystemTable
            + KijiSystemTableKiji.getSystemTable() + +
            +          Gets the system table for this Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiSystemTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiSystemTable in org.kiji.schema.impl
            + classHBaseSystemTable + +
            +          The Kiji system table that is stored in HBase.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTable.html new file mode 100644 index 00000000..1c1171f3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTable.html @@ -0,0 +1,335 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTable

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTable in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTable
            + KijiTableKijiTablePool.get(String name) + +
            +          Gets a previously opened table from the pool, or open a new connection.
            + KijiTableKijiTableReader.getTable() + +
            +          Gets the table this reads from.
            + KijiTableKijiTableFactory.openTable(String tableName) + +
            +          Opens a KijiTable by name.
            + KijiTableKiji.openTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiTable
            + voidKijiTablePool.release(KijiTable table) + +
            +          Releases a table back to the pool.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiTable
            KijiTableReader(KijiTable table) + +
            +          Creates a reader over a kiji table.
            +  +

            + + + + + +
            +Uses of KijiTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTable
            + classAbstractKijiTable + +
            +          Main handle for a Kiji table with basic functionality.
            + classHBaseKijiTable + +
            +          A KijiTable that exposes the underlying HBase implementation.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTable
            +static KijiTableAbstractKijiTable.open(Kiji kiji, + String name) + +
            +          Opens a kiji table with the default implementation.
            + KijiTableDefaultKijiTableFactory.openTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiTable
            +static HBaseKijiTableHBaseKijiTable.downcast(KijiTable kijiTable) + +
            +          We know that all KijiTables are really HBaseKijiTables + instances.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTable
            HBaseKijiTableReader(KijiTable table) + +
            +          Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase.
            HBaseKijiTableWriter(KijiTable table) + +
            +          Creates a non-buffered kiji table writer that sends modifications directly to Kiji.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableFactory.html new file mode 100644 index 00000000..9cdfd891 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableFactory.html @@ -0,0 +1,232 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema that implement KijiTableFactory
            + classKiji + +
            +          Kiji instance class that contains configuration and table + information.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiTableFactory
            KijiTablePool(KijiTableFactory tableFactory) + +
            +          Constructs a new pool of Kiji tables.
            KijiTablePool(KijiTableFactory tableFactory, + KijiTablePool.Options options) + +
            +          Constructs a new pool of Kiji tables.
            +  +

            + + + + + +
            +Uses of KijiTableFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableFactory
            + classDefaultKijiTableFactory + +
            +          The default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open().
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html new file mode 100644 index 00000000..9e12d0f8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html @@ -0,0 +1,288 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableKeyValueDatabase (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableKeyValueDatabase

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableKeyValueDatabase
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableKeyValueDatabase in org.kiji.schema
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema that implement KijiTableKeyValueDatabase
            + classKijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableKeyValueDatabase
            + KijiTableKeyValueDatabaseKijiTableKeyValueDatabase.putValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            +  +

            + + + + + +
            +Uses of KijiTableKeyValueDatabase in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableKeyValueDatabase
            + classHBaseMetaTable + +
            +          An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            + classHBaseTableKeyValueDatabase + +
            +          Manages key-value pairs on a per table basis.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableKeyValueDatabase
            + KijiTableKeyValueDatabaseHBaseMetaTable.putValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + KijiTableKeyValueDatabaseHBaseTableKeyValueDatabase.putValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTableKeyValueDatabase
            HBaseMetaTable(HTableInterface htable, + KijiTableLayoutDatabase tableLayoutDatabase, + KijiTableKeyValueDatabase tableKeyValueDatabase) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableNotFoundException.html new file mode 100644 index 00000000..3bcbf059 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableNotFoundException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTableNotFoundException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTableNotFoundException

            +
            +No usage of org.kiji.schema.KijiTableNotFoundException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html new file mode 100644 index 00000000..37a94d14 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTablePool.NoCapacityException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTablePool.NoCapacityException

            +
            +No usage of org.kiji.schema.KijiTablePool.NoCapacityException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTablePool.Options.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTablePool.Options.html new file mode 100644 index 00000000..359f4777 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTablePool.Options.html @@ -0,0 +1,220 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTablePool.Options (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTablePool.Options

            +
            + + + + + + + + + +
            +Packages that use KijiTablePool.Options
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiTablePool.Options in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTablePool.Options
            + KijiTablePool.OptionsKijiTablePool.Options.withClock(Clock clock) + +
            +          Sets a clock.
            + KijiTablePool.OptionsKijiTablePool.Options.withIdlePollPeriod(long periodMillis) + +
            +          Sets the amount of time between sweeps of the pool for removing idle connections.
            + KijiTablePool.OptionsKijiTablePool.Options.withIdleTimeout(long timeoutMillis) + +
            +          Sets the amount of time a connection may be idle before being removed from the pool.
            + KijiTablePool.OptionsKijiTablePool.Options.withMaxSize(int maxSize) + +
            +          Sets the maximum number of connections to keep per table.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiTablePool.Options
            KijiTablePool(KijiTableFactory tableFactory, + KijiTablePool.Options options) + +
            +          Constructs a new pool of Kiji tables.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTablePool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTablePool.html new file mode 100644 index 00000000..9071cd8c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTablePool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTablePool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTablePool

            +
            +No usage of org.kiji.schema.KijiTablePool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableReader.html new file mode 100644 index 00000000..02a55d5b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableReader.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTableReader (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTableReader

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableReader
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableReader in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableReader
            + KijiTableReaderKijiTable.openTableReader() + +
            +          Opens an appropriate implementation of KijiTableReader for this table.
            +  +

            + + + + + +
            +Uses of KijiTableReader in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiTableReader in org.kiji.schema.impl
            + classHBaseKijiTableReader + +
            +          Reads from a kiji table by sending the requests directly to the HBase tables.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableReader
            + KijiTableReaderHBaseKijiTable.openTableReader() + +
            +          Opens an appropriate implementation of KijiTableReader for this table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableWriter.html new file mode 100644 index 00000000..a7097fc8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiTableWriter.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableWriter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableWriter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableWriter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableWriter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableWriter
            + KijiTableWriterKijiTable.openTableWriter() + +
            +          Opens an appropriate implementation of KijiTableWriter for this table.
            +  +

            + + + + + +
            +Uses of KijiTableWriter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableWriter
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableWriter
            + KijiTableWriterHBaseKijiTable.openTableWriter() + +
            +          Opens an appropriate implementation of KijiTableWriter for this table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiURI.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiURI.html new file mode 100644 index 00000000..1ab22107 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiURI.html @@ -0,0 +1,449 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiURI (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiURI

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiURI
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji map-reduce utilities. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiURI
            +static KijiURIKijiURI.parse(String uri) + +
            +          Constructs a fully qualified Kiji table URI from a string.
            + KijiURIKijiURI.resolve(String path) + +
            +          Resolve the path relative to this KijiURI.
            + KijiURIKijiURI.setColumnNames(Collection<String> columnNames) + +
            +          Creates a KijiURI with these column names added.
            + KijiURIKijiURI.setInstanceName(String instanceName) + +
            +          Creates a new KijiURI with this instance name added.
            + KijiURIKijiURI.setTableName(String tableName) + +
            +          Creates a KijiURI with this table name added.
            + KijiURIKijiURI.setZookeeperQuorum(String[] quorum) + +
            +          Creates a new KijiURI with this zookeeper quorum.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiURI
            + HBaseAdminFactoryHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactoryHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactoryHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +static voidKijiInstaller.install(KijiURI uri, + Configuration conf) + +
            +          Installs the specified Kiji instance.
            +static voidKijiInstaller.install(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            +static KijiKiji.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            +static KijiKiji.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +static voidKijiInstaller.uninstall(KijiURI uri, + Configuration conf) + +
            +          Uninstalls the specified Kiji instance.
            +static voidKijiInstaller.uninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiURI
            KijiConfiguration(Configuration conf, + KijiURI uri) + +
            +          Initializes a Kiji configuration from a Hadoop configuration and a Kiji URI.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiURI
            + HBaseAdminFactoryDefaultHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactoryDefaultHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactoryDefaultHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce with parameters of type KijiURI
            +static voidKijiTableInputFormat.configureJob(Job job, + KijiURI tableURI, + KijiDataRequest dataRequest, + String startRow, + String endRow) + +
            +          Deprecated. Configures a Hadoop M/R job to read from a given table.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools that return KijiURI
            +protected  KijiURIBaseTool.getURI() + +
            +          Returns the kiji URI of the target this tool operates on.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type KijiURI
            +protected  voidBaseTool.setURI(KijiURI uri) + +
            +          Sets the kiji URI of the target this tool operates on.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiURIException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiURIException.html new file mode 100644 index 00000000..e4fb1eae --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/KijiURIException.html @@ -0,0 +1,245 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiURIException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiURIException

            +
            + + + + + + + + + +
            +Packages that use KijiURIException
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiURIException in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that throw KijiURIException
            +static KijiURIKijiURI.parse(String uri) + +
            +          Constructs a fully qualified Kiji table URI from a string.
            + KijiURIKijiURI.resolve(String path) + +
            +          Resolve the path relative to this KijiURI.
            + KijiURIKijiURI.setColumnNames(Collection<String> columnNames) + +
            +          Creates a KijiURI with these column names added.
            + KijiURIKijiURI.setInstanceName(String instanceName) + +
            +          Creates a new KijiURI with this instance name added.
            + KijiURIKijiURI.setTableName(String tableName) + +
            +          Creates a KijiURI with this table name added.
            + KijiURIKijiURI.setZookeeperQuorum(String[] quorum) + +
            +          Creates a new KijiURI with this zookeeper quorum.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema that throw KijiURIException
            KijiURI(Iterable<String> zookeeperQuorum, + int zookeeperClientPort, + String instanceName, + String tableName, + Iterable<KijiColumnName> columnNames) + +
            +          Constructs a new KijiURI with the given parameters.
            KijiURI(URI uri) + +
            +          Constructs a URI that fully qualifies a Kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/NoCellDataException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/NoCellDataException.html new file mode 100644 index 00000000..f644861d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/NoCellDataException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.NoCellDataException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.NoCellDataException

            +
            +No usage of org.kiji.schema.NoCellDataException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/NoSuchColumnException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/NoSuchColumnException.html new file mode 100644 index 00000000..4ae02a64 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/NoSuchColumnException.html @@ -0,0 +1,250 @@ + + + + + + + +Uses of Class org.kiji.schema.NoSuchColumnException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.NoSuchColumnException

            +
            + + + + + + + + + + + + + +
            +Packages that use NoSuchColumnException
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of NoSuchColumnException in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that throw NoSuchColumnException
            + HBaseColumnNameKijiColumnFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +abstract  HBaseColumnNameKijiRowFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            +  +

            + + + + + +
            +Uses of NoSuchColumnException in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that throw NoSuchColumnException
            + SchemaStorageKijiTableLayout.getCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            + CellSchemaKijiTableLayout.getCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            + org.apache.avro.SchemaKijiTableLayout.getSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            + HBaseColumnNameColumnNameTranslator.toHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            + KijiColumnNameColumnNameTranslator.toKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/NotAKijiManagedTableException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/NotAKijiManagedTableException.html new file mode 100644 index 00000000..4a71e68e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/NotAKijiManagedTableException.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.NotAKijiManagedTableException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.NotAKijiManagedTableException

            +
            + + + + + + + + + +
            +Packages that use NotAKijiManagedTableException
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of NotAKijiManagedTableException in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that throw NotAKijiManagedTableException
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.get(String hbaseTableName) + +
            +          Constructs using an HBase HTable name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/SpecificCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/SpecificCellDecoderFactory.html new file mode 100644 index 00000000..258ba82b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/SpecificCellDecoderFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.SpecificCellDecoderFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.SpecificCellDecoderFactory

            +
            +No usage of org.kiji.schema.SpecificCellDecoderFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/TableKeyNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/TableKeyNotFoundException.html new file mode 100644 index 00000000..57ed4e45 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/class-use/TableKeyNotFoundException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.TableKeyNotFoundException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.TableKeyNotFoundException

            +
            +No usage of org.kiji.schema.TableKeyNotFoundException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/AndRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/AndRowFilter.html new file mode 100644 index 00000000..64823c5e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/AndRowFilter.html @@ -0,0 +1,277 @@ + + + + + + + +AndRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class AndRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.OperatorRowFilter
+          extended by org.kiji.schema.filter.AndRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class AndRowFilter
            extends OperatorRowFilter
            + + +

            +A KijiRowFilter for a conjunction (AND operator) of other filters. + +

            If a row R is accepted by both filter A and B, R + will be accepted by AndRowFilter(A, B).

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.OperatorRowFilter
            OperatorRowFilter.Operator
            +  + + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            AndRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new AndRowFilter instance.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.filter.OperatorRowFilter
            getDataRequest, toHBaseFilter
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AndRowFilter

            +
            +public AndRowFilter(List<? extends KijiRowFilter> filters)
            +
            +
            Creates a new AndRowFilter instance. +

            +

            +
            Parameters:
            filters - The filters that should be used in the filter conjunction.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html new file mode 100644 index 00000000..bdda71b4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html @@ -0,0 +1,352 @@ + + + + + + + +ColumnValueEqualsRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class ColumnValueEqualsRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.ColumnValueEqualsRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class ColumnValueEqualsRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value. + +

            This filter will only pass if the data in the Kiji cell matches the specified value + exactly. Both the data and the Avro schema must be the same.

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            ColumnValueEqualsRowFilter(String family, + String qualifier, + KijiCell<?> value) + +
            +          Creates a new ColumnValueEqualsRowFilter instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ColumnValueEqualsRowFilter

            +
            +public ColumnValueEqualsRowFilter(String family,
+                                  String qualifier,
+                                  KijiCell<?> value)
            +
            +
            Creates a new ColumnValueEqualsRowFilter instance. +

            +

            +
            Parameters:
            family - The column family of interest.
            qualifier - The column qualifier of interest.
            value - The value the most recent cell in the column must equal to pass the filter.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/HasColumnDataRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/HasColumnDataRowFilter.html new file mode 100644 index 00000000..2f34dd41 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/HasColumnDataRowFilter.html @@ -0,0 +1,364 @@ + + + + + + + +HasColumnDataRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class HasColumnDataRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.HasColumnDataRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class HasColumnDataRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter that excludes rows that have no data for some column columnName. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + + + + +
            +Constructor Summary
            HasColumnDataRowFilter(String columnName) + +
            +          Constructs a row filter that excludes rows that have no data in columnName.
            HasColumnDataRowFilter(String family, + String qualifier) + +
            +          Constructs a row filter that excludes rows that have no data in columnName.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HasColumnDataRowFilter

            +
            +public HasColumnDataRowFilter(String family,
+                              String qualifier)
            +
            +
            Constructs a row filter that excludes rows that have no data in columnName. +

            +

            +
            Parameters:
            family - The column family of interest.
            qualifier - The column qualifier of interest.
            +
            +
            + +

            +HasColumnDataRowFilter

            +
            +public HasColumnDataRowFilter(String columnName)
            +
            +
            Constructs a row filter that excludes rows that have no data in columnName. +

            +

            +
            Parameters:
            columnName - The column family:qualifier of interest.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiColumnFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiColumnFilter.Context.html new file mode 100644 index 00000000..2e917dfa --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiColumnFilter.Context.html @@ -0,0 +1,221 @@ + + + + + + + +KijiColumnFilter.Context (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Interface KijiColumnFilter.Context

            +
            +
            Enclosing class:
            KijiColumnFilter
            +
            +
            +
            +
            public static interface KijiColumnFilter.Context
            + + +

            +An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + HBaseColumnNamegetHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseColumnName

            +
            +HBaseColumnName getHBaseColumnName(KijiColumnName kijiColumnName)
+                                   throws NoSuchColumnException
            +
            +
            Converts a Kiji column name to an HBase column name. +

            +

            +
            Parameters:
            kijiColumnName - The name of a kiji column. +
            Returns:
            The name of the HBase column that stores the kiji column data. +
            Throws: +
            NoSuchColumnException - If there is no such column in the kiji table.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiColumnFilter.html new file mode 100644 index 00000000..3abeedb5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiColumnFilter.html @@ -0,0 +1,337 @@ + + + + + + + +KijiColumnFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiColumnFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiColumnFilter
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Direct Known Subclasses:
            RegexQualifierColumnFilter
            +
            +
            +
            +
            @ApiAudience.Public
+public abstract class KijiColumnFilter
            extends Object
            implements Serializable
            + + +

            +A column filter provides a means of filtering cells from a column on the server side. + +

            To make your jobs more efficient, you may use a KijiColumnFilter to specify that + certain cells from a column be filtered. The cells will be filtered on the server, + which reduces the amount of data that needs to be sent to the client.

            + +

            KijiColumnFilters filter cells from a column, in contrast with KijiRowFilters, which + filters rows from a table.

            +

            + +

            +

            +
            See Also:
            KijiRowFilter, +KijiDataRequest.Column.withFilter(KijiColumnFilter), +Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static interfaceKijiColumnFilter.Context + +
            +          An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiColumnFilter() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + FiltertoHBaseFilter(KijiColumnName kijiColumnName, + ColumnNameTranslator columnNameTranslator) + +
            +          Expresses a KijiColumnFilter in terms of an equivalent HBase filter, translating the + KijiColumnNames to the corresponding HBaseColumnName.
            +abstract  FiltertoHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiColumnFilter

            +
            +public KijiColumnFilter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toHBaseFilter

            +
            +public abstract Filter toHBaseFilter(KijiColumnName kijiColumnName,
+                                     KijiColumnFilter.Context context)
+                              throws IOException
            +
            +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +

            +

            +
            +
            +
            +
            Parameters:
            kijiColumnName - The column this filter applies to.
            context - The context. +
            Returns:
            An equivalent HBase Filter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiColumnName kijiColumnName,
+                            ColumnNameTranslator columnNameTranslator)
+                     throws IOException
            +
            +
            Expresses a KijiColumnFilter in terms of an equivalent HBase filter, translating the + KijiColumnNames to the corresponding HBaseColumnName. +

            +

            +
            +
            +
            +
            Parameters:
            kijiColumnName - The column this filter applies to.
            columnNameTranslator - The column name translator that maps KijiColumnNames to + HBaseColumnNames. +
            Returns:
            An equivalent HBase Filter +
            Throws: +
            IOException - If there is an error
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiRowFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiRowFilter.Context.html new file mode 100644 index 00000000..c16aa0ee --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiRowFilter.Context.html @@ -0,0 +1,319 @@ + + + + + + + +KijiRowFilter.Context (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiRowFilter.Context

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter.Context
+
            +
            +
            Enclosing class:
            KijiRowFilter
            +
            +
            +
            +
            @ApiAudience.Public
+public abstract static class KijiRowFilter.Context
            extends Object
            + + +

            +A helper class for converting between Kiji objects and their HBase counterparts. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiRowFilter.Context() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  byte[]getHBaseCellValue(KijiColumnName column, + KijiCell<?> kijiCell) + +
            +          Converts a Kiji cell value into an HBase cell value.
            +abstract  HBaseColumnNamegetHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            +abstract  byte[]getHBaseRowKey(String kijiRowKey) + +
            +          Converts a Kiji row key into an HBase row key.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiRowFilter.Context

            +
            +public KijiRowFilter.Context()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseRowKey

            +
            +public abstract byte[] getHBaseRowKey(String kijiRowKey)
            +
            +
            Converts a Kiji row key into an HBase row key. + +

            This method is useful only on tables with row key hashing disabled, since hashed + row keys have no ordering or semantics beyond being an identifier.

            +

            +

            +
            Parameters:
            kijiRowKey - A kiji row key. +
            Returns:
            The corresponding HBase row key.
            +
            +
            +
            + +

            +getHBaseColumnName

            +
            +public abstract HBaseColumnName getHBaseColumnName(KijiColumnName kijiColumnName)
+                                            throws NoSuchColumnException
            +
            +
            Converts a Kiji column name to an HBase column family name. +

            +

            +
            Parameters:
            kijiColumnName - The name of a kiji column. +
            Returns:
            The name of the HBase column that stores the kiji column data. +
            Throws: +
            NoSuchColumnException - If there is no such column in the kiji table.
            +
            +
            +
            + +

            +getHBaseCellValue

            +
            +public abstract byte[] getHBaseCellValue(KijiColumnName column,
+                                         KijiCell<?> kijiCell)
+                                  throws IOException
            +
            +
            Converts a Kiji cell value into an HBase cell value. +

            +

            +
            Parameters:
            column - Name of the column this cell belongs to.
            kijiCell - A kiji cell value. +
            Returns:
            The Kiji cell encoded as an HBase value. +
            Throws: +
            IOException - If there is an error encoding the cell value.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiRowFilter.html new file mode 100644 index 00000000..0fe597b0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiRowFilter.html @@ -0,0 +1,334 @@ + + + + + + + +KijiRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+
            +
            +
            Direct Known Subclasses:
            ColumnValueEqualsRowFilter, HasColumnDataRowFilter, OperatorRowFilter, StripValueRowFilter
            +
            +
            +
            +
            @ApiAudience.Public
+public abstract class KijiRowFilter
            extends Object
            + + +

            +The abstract base class for filters that exclude data from KijiRows. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiRowFilter.Context + +
            +          A helper class for converting between Kiji objects and their HBase counterparts.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiRowFilter() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            +abstract  FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiRowFilter

            +
            +public KijiRowFilter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public abstract KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public abstract Filter toHBaseFilter(KijiRowFilter.Context context)
+                              throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiRowFilterApplicator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiRowFilterApplicator.html new file mode 100644 index 00000000..4c8a6c50 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/KijiRowFilterApplicator.html @@ -0,0 +1,277 @@ + + + + + + + +KijiRowFilterApplicator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiRowFilterApplicator

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilterApplicator
+
            +
            +
            +
            @ApiAudience.Private
+public final class KijiRowFilterApplicator
            extends Object
            + + +

            +Applies a KijiRowFilter to various row-savvy objects. + + There are several limitations when filtering cells this way, as the filter relies on byte + comparisons, which does not play well with Avro records. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiRowFilterApplicator(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + voidapplyTo(Scan scan) + +
            +          Applies the row filter to an HBase scan object.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiRowFilterApplicator

            +
            +public KijiRowFilterApplicator(KijiRowFilter rowFilter,
+                               KijiTableLayout tableLayout,
+                               KijiSchemaTable schemaTable)
            +
            +
            Creates a new KijiRowFilterApplicator instance. +

            +

            +
            Parameters:
            rowFilter - The row filter to be applied.
            schemaTable - The kiji schema table.
            tableLayout - The layout of the table this filter applies to.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +applyTo

            +
            +public void applyTo(Scan scan)
+             throws IOException
            +
            +
            Applies the row filter to an HBase scan object. + +

            This will tell HBase region servers to filter rows on the server-side, so filtered + rows will not even need to get sent across the network back to the client.

            +

            +

            +
            Parameters:
            scan - An HBase scan descriptor. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/OperatorRowFilter.Operator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/OperatorRowFilter.Operator.html new file mode 100644 index 00000000..5777ebb4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/OperatorRowFilter.Operator.html @@ -0,0 +1,334 @@ + + + + + + + +OperatorRowFilter.Operator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Enum OperatorRowFilter.Operator

            +
            +java.lang.Object
+  extended by java.lang.Enum<OperatorRowFilter.Operator>
+      extended by org.kiji.schema.filter.OperatorRowFilter.Operator
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<OperatorRowFilter.Operator>
            +
            +
            +
            Enclosing class:
            OperatorRowFilter
            +
            +
            +
            +
            public static enum OperatorRowFilter.Operator
            extends Enum<OperatorRowFilter.Operator>
            + + +

            +Available logical operators. +

            + +

            +

            + +

            + + + + + + + + + + + + + +
            +Enum Constant Summary
            AND + +
            +          Conjunction.
            OR + +
            +          Disjunction.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static OperatorRowFilter.OperatorvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static OperatorRowFilter.Operator[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +AND

            +
            +public static final OperatorRowFilter.Operator AND
            +
            +
            Conjunction. +

            +

            +
            +
            +
            + +

            +OR

            +
            +public static final OperatorRowFilter.Operator OR
            +
            +
            Disjunction. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static OperatorRowFilter.Operator[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (OperatorRowFilter.Operator c : OperatorRowFilter.Operator.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static OperatorRowFilter.Operator valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/OperatorRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/OperatorRowFilter.html new file mode 100644 index 00000000..c338b10b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/OperatorRowFilter.html @@ -0,0 +1,318 @@ + + + + + + + +OperatorRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class OperatorRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.OperatorRowFilter
+
            +
            +
            Direct Known Subclasses:
            AndRowFilter, OrRowFilter
            +
            +
            +
            +
            @ApiAudience.Public
+public class OperatorRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter for a logical operator of composed of other filters. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classOperatorRowFilter.Operator + +
            +          Available logical operators.
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/OrRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/OrRowFilter.html new file mode 100644 index 00000000..2da96eaf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/OrRowFilter.html @@ -0,0 +1,277 @@ + + + + + + + +OrRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class OrRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.OperatorRowFilter
+          extended by org.kiji.schema.filter.OrRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class OrRowFilter
            extends OperatorRowFilter
            + + +

            +A KijiRowFilter for a disjunction (OR operator) of other filters. + +

            If a row R is accepted by filter A or B, R + will be accepted by OrRowFilter(A, B).

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.OperatorRowFilter
            OperatorRowFilter.Operator
            +  + + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            OrRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new OrRowFilter instance.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.filter.OperatorRowFilter
            getDataRequest, toHBaseFilter
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +OrRowFilter

            +
            +public OrRowFilter(List<? extends KijiRowFilter> filters)
            +
            +
            Creates a new OrRowFilter instance. +

            +

            +
            Parameters:
            filters - The filters that should be used in the filter conjunction.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/RegexQualifierColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/RegexQualifierColumnFilter.html new file mode 100644 index 00000000..90704872 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/RegexQualifierColumnFilter.html @@ -0,0 +1,309 @@ + + + + + + + +RegexQualifierColumnFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class RegexQualifierColumnFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiColumnFilter
+      extended by org.kiji.schema.filter.RegexQualifierColumnFilter
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class RegexQualifierColumnFilter
            extends KijiColumnFilter
            + + +

            +A KijiColumnFilter that only allows qualifiers that match a given regular expression. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiColumnFilter
            KijiColumnFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            RegexQualifierColumnFilter(String regularExpression) + +
            +          Constructor.
            +  + + + + + + + + + + + +
            +Method Summary
            + FiltertoHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.filter.KijiColumnFilter
            toHBaseFilter
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +RegexQualifierColumnFilter

            +
            +public RegexQualifierColumnFilter(String regularExpression)
            +
            +
            Constructor. +

            +

            +
            Parameters:
            regularExpression - The regular expression for qualifiers that should be + accepted by this filter. The expression is matched against the full qualifier (as + if it implicitly starts with '^' and ends with '$'.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiColumnName kijiColumnName,
+                            KijiColumnFilter.Context context)
+                     throws IOException
            +
            +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +

            +

            +
            Specified by:
            toHBaseFilter in class KijiColumnFilter
            +
            +
            +
            Parameters:
            kijiColumnName - The column this filter applies to.
            context - The context. +
            Returns:
            An equivalent HBase Filter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/StripValueRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/StripValueRowFilter.html new file mode 100644 index 00000000..969afffb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/StripValueRowFilter.html @@ -0,0 +1,343 @@ + + + + + + + +StripValueRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class StripValueRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.StripValueRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class StripValueRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest. This strips out + all values from all columns and is useful if you just want to retrieve timestamps. Note that + attempting to decode the data (through calls like KijiRowData.getValues()) will + result in an IOException. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            StripValueRowFilter() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +StripValueRowFilter

            +
            +public StripValueRowFilter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/AndRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/AndRowFilter.html new file mode 100644 index 00000000..5154e638 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/AndRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.AndRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.AndRowFilter

            +
            +No usage of org.kiji.schema.filter.AndRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html new file mode 100644 index 00000000..ccd77861 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.ColumnValueEqualsRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.ColumnValueEqualsRowFilter

            +
            +No usage of org.kiji.schema.filter.ColumnValueEqualsRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html new file mode 100644 index 00000000..484ff097 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.HasColumnDataRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.HasColumnDataRowFilter

            +
            +No usage of org.kiji.schema.filter.HasColumnDataRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html new file mode 100644 index 00000000..8df6a492 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Interface org.kiji.schema.filter.KijiColumnFilter.Context (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.filter.KijiColumnFilter.Context

            +
            + + + + + + + + + +
            +Packages that use KijiColumnFilter.Context
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiColumnFilter.Context in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiColumnFilter.Context
            +abstract  FilterKijiColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            + FilterRegexQualifierColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiColumnFilter.html new file mode 100644 index 00000000..aeaeee62 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiColumnFilter.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiColumnFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiColumnFilter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiColumnFilter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiColumnFilter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiColumnFilter
            + KijiColumnFilterKijiDataRequest.Column.getFilter() + +
            +          Gets the column filter, or null if no filter was specified.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiColumnFilter
            + KijiDataRequest.ColumnKijiDataRequest.Column.withFilter(KijiColumnFilter filter) + +
            +          Sets a filter to use on the column.
            +  +

            + + + + + +
            +Uses of KijiColumnFilter in org.kiji.schema.filter
            +  +

            + + + + + + + + + +
            Subclasses of KijiColumnFilter in org.kiji.schema.filter
            + classRegexQualifierColumnFilter + +
            +          A KijiColumnFilter that only allows qualifiers that match a given regular expression.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html new file mode 100644 index 00000000..585ee011 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html @@ -0,0 +1,218 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiRowFilter.Context (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiRowFilter.Context

            +
            + + + + + + + + + +
            +Packages that use KijiRowFilter.Context
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiRowFilter.Context in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiRowFilter.Context
            + FilterStripValueRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +abstract  FilterKijiRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            + FilterOperatorRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            + FilterColumnValueEqualsRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            + FilterHasColumnDataRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiRowFilter.html new file mode 100644 index 00000000..764c41ff --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiRowFilter.html @@ -0,0 +1,324 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiRowFilter

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiRowFilter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiRowFilter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiRowFilter
            +abstract  KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            +  +

            + + + + + +
            +Uses of KijiRowFilter in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of KijiRowFilter in org.kiji.schema.filter
            + classAndRowFilter + +
            +          A KijiRowFilter for a conjunction (AND operator) of other filters.
            + classColumnValueEqualsRowFilter + +
            +          A KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value.
            + classHasColumnDataRowFilter + +
            +          A KijiRowFilter that excludes rows that have no data for some column columnName.
            + classOperatorRowFilter + +
            +          A KijiRowFilter for a logical operator of composed of other filters.
            + classOrRowFilter + +
            +          A KijiRowFilter for a disjunction (OR operator) of other filters.
            + classStripValueRowFilter + +
            +          A KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.filter with parameters of type KijiRowFilter
            KijiRowFilterApplicator(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  +

            + + + + + + + + + + + +
            Constructor parameters in org.kiji.schema.filter with type arguments of type KijiRowFilter
            AndRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new AndRowFilter instance.
            OrRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new OrRowFilter instance.
            +  +

            + + + + + +
            +Uses of KijiRowFilter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiRowFilter
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html new file mode 100644 index 00000000..985f4b28 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiRowFilterApplicator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiRowFilterApplicator

            +
            +No usage of org.kiji.schema.filter.KijiRowFilterApplicator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/OperatorRowFilter.Operator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/OperatorRowFilter.Operator.html new file mode 100644 index 00000000..970a0c0d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/OperatorRowFilter.Operator.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.OperatorRowFilter.Operator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.OperatorRowFilter.Operator

            +
            + + + + + + + + + +
            +Packages that use OperatorRowFilter.Operator
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of OperatorRowFilter.Operator in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that return OperatorRowFilter.Operator
            +static OperatorRowFilter.OperatorOperatorRowFilter.Operator.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static OperatorRowFilter.Operator[]OperatorRowFilter.Operator.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/OperatorRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/OperatorRowFilter.html new file mode 100644 index 00000000..e62df355 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/OperatorRowFilter.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.OperatorRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.OperatorRowFilter

            +
            + + + + + + + + + +
            +Packages that use OperatorRowFilter
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of OperatorRowFilter in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Subclasses of OperatorRowFilter in org.kiji.schema.filter
            + classAndRowFilter + +
            +          A KijiRowFilter for a conjunction (AND operator) of other filters.
            + classOrRowFilter + +
            +          A KijiRowFilter for a disjunction (OR operator) of other filters.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/OrRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/OrRowFilter.html new file mode 100644 index 00000000..76ca4d03 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/OrRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.OrRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.OrRowFilter

            +
            +No usage of org.kiji.schema.filter.OrRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html new file mode 100644 index 00000000..bb5db319 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.RegexQualifierColumnFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.RegexQualifierColumnFilter

            +
            +No usage of org.kiji.schema.filter.RegexQualifierColumnFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/StripValueRowFilter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/StripValueRowFilter.html new file mode 100644 index 00000000..f99d25e5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/class-use/StripValueRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.StripValueRowFilter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.StripValueRowFilter

            +
            +No usage of org.kiji.schema.filter.StripValueRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-frame.html new file mode 100644 index 00000000..762e5008 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-frame.html @@ -0,0 +1,75 @@ + + + + + + + +org.kiji.schema.filter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.schema.filter + + + + +
            +Interfaces  + +
            +KijiColumnFilter.Context
            + + + + + + +
            +Classes  + +
            +AndRowFilter +
            +ColumnValueEqualsRowFilter +
            +HasColumnDataRowFilter +
            +KijiColumnFilter +
            +KijiRowFilter +
            +KijiRowFilter.Context +
            +KijiRowFilterApplicator +
            +OperatorRowFilter +
            +OrRowFilter +
            +RegexQualifierColumnFilter +
            +StripValueRowFilter
            + + + + + + +
            +Enums  + +
            +OperatorRowFilter.Operator
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-summary.html new file mode 100644 index 00000000..df727edd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-summary.html @@ -0,0 +1,253 @@ + + + + + + + +org.kiji.schema.filter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.filter +

            +Row level filters used when reading data from Kiji tables. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            KijiColumnFilter.ContextAn object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AndRowFilterA KijiRowFilter for a conjunction (AND operator) of other filters.
            ColumnValueEqualsRowFilterA KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value.
            HasColumnDataRowFilterA KijiRowFilter that excludes rows that have no data for some column columnName.
            KijiColumnFilterA column filter provides a means of filtering cells from a column on the server side.
            KijiRowFilterThe abstract base class for filters that exclude data from KijiRows.
            KijiRowFilter.ContextA helper class for converting between Kiji objects and their HBase counterparts.
            KijiRowFilterApplicatorApplies a KijiRowFilter to various row-savvy objects.
            OperatorRowFilterA KijiRowFilter for a logical operator of composed of other filters.
            OrRowFilterA KijiRowFilter for a disjunction (OR operator) of other filters.
            RegexQualifierColumnFilterA KijiColumnFilter that only allows qualifiers that match a given regular expression.
            StripValueRowFilterA KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest.
            +  + +

            + + + + + + + + + +
            +Enum Summary
            OperatorRowFilter.OperatorAvailable logical operators.
            +  + +

            +

            +Package org.kiji.schema.filter Description +

            + +

            +Row level filters used when reading data from Kiji tables. + +

            + Provides row level filters which are applied to data read from + KijiTable. Only one filter can be used + at a time, but a single filter can be composed as a + combination of multiple filters using the operator filters: + AndRowFilter and + OrRowFilter. Filters are applied to + KijiDataRequest objects. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-tree.html new file mode 100644 index 00000000..af5d8755 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-tree.html @@ -0,0 +1,176 @@ + + + + + + + +org.kiji.schema.filter Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.filter +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-use.html new file mode 100644 index 00000000..9eba6547 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/filter/package-use.html @@ -0,0 +1,246 @@ + + + + + + + +Uses of Package org.kiji.schema.filter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.filter

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.filter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.filter used by org.kiji.schema
            KijiColumnFilter + +
            +          A column filter provides a means of filtering cells from a column on the server side.
            KijiRowFilter + +
            +          The abstract base class for filters that exclude data from KijiRows.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.filter used by org.kiji.schema.filter
            KijiColumnFilter + +
            +          A column filter provides a means of filtering cells from a column on the server side.
            KijiColumnFilter.Context + +
            +          An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            KijiRowFilter + +
            +          The abstract base class for filters that exclude data from KijiRows.
            KijiRowFilter.Context + +
            +          A helper class for converting between Kiji objects and their HBase counterparts.
            OperatorRowFilter + +
            +          A KijiRowFilter for a logical operator of composed of other filters.
            OperatorRowFilter.Operator + +
            +          Available logical operators.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.filter used by org.kiji.schema.impl
            KijiRowFilter + +
            +          The abstract base class for filters that exclude data from KijiRows.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/AbstractKijiTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/AbstractKijiTable.html new file mode 100644 index 00000000..6aee7905 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/AbstractKijiTable.html @@ -0,0 +1,465 @@ + + + + + + + +AbstractKijiTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class AbstractKijiTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AbstractKijiTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTable
            +
            +
            +
            Direct Known Subclasses:
            HBaseKijiTable
            +
            +
            +
            +
            @ApiAudience.Private
+public abstract class AbstractKijiTable
            extends Object
            implements KijiTable
            + + +

            +Main handle for a Kiji table with basic functionality. + + A KijiTable has all the data about an entity. + Entity data is keyed by the entityId. + Each row in the table represents one entity. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected AbstractKijiTable(Kiji kiji, + String name) + +
            +          Creates a new KijiTable instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +           
            + booleanequals(Object obj) + +
            +           
            +protected  voidfinalize() + +
            +           
            + EntityIdgetEntityId(String kijiRowKey) + +
            +          Creates an entity ID out of a UTF8 encoded Kiji row key.
            + KijigetKiji() + +
            +          Gets the kiji instance this table lives in.
            + StringgetName() + +
            +          Gets the name of this kiji table.
            + inthashCode() + +
            +           
            +static KijiTableopen(Kiji kiji, + String name) + +
            +          Opens a kiji table with the default implementation.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, getClass, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiTable
            getEntityIdFactory, getLayout, openTableReader, openTableWriter
            +  +

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

            +AbstractKijiTable

            +
            +protected AbstractKijiTable(Kiji kiji,
+                            String name)
            +
            +
            Creates a new KijiTable instance. +

            +

            +
            Parameters:
            kiji - The kiji instance.
            name - The name of the kiji table.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +open

            +
            +public static KijiTable open(Kiji kiji,
+                             String name)
+                      throws IOException
            +
            +
            Opens a kiji table with the default implementation. +

            +

            +
            +
            +
            +
            Parameters:
            kiji - The kiji instance.
            name - The name of the table to open. +
            Returns:
            An opened KijiTable. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +public Kiji getKiji()
            +
            +
            Gets the kiji instance this table lives in. +

            +

            +
            Specified by:
            getKiji in interface KijiTable
            +
            +
            + +
            Returns:
            The Kiji instance this table belongs to.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the name of this kiji table. +

            +

            +
            Specified by:
            getName in interface KijiTable
            +
            +
            + +
            Returns:
            The name of the table.
            +
            +
            +
            + +

            +getEntityId

            +
            +public EntityId getEntityId(String kijiRowKey)
            +
            +
            Creates an entity ID out of a UTF8 encoded Kiji row key. +

            +

            +
            Specified by:
            getEntityId in interface KijiTable
            +
            +
            +
            Parameters:
            kijiRowKey - UTF8 encoded Kiji row key. +
            Returns:
            an entity ID with the specified Kiji row key.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object obj)
            +
            +
            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/AvroCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/AvroCellDecoder.html new file mode 100644 index 00000000..dd54dc35 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/AvroCellDecoder.html @@ -0,0 +1,410 @@ + + + + + + + +AvroCellDecoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class AvroCellDecoder<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellDecoder<T>
+
            +
            +
            Type Parameters:
            T - The type of the decoded cell data.
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<T>
            +
            +
            +
            Direct Known Subclasses:
            GenericCellDecoder, SpecificCellDecoder
            +
            +
            +
            +
            @ApiAudience.Private
+public abstract class AvroCellDecoder<T>
            extends Object
            implements KijiCellDecoder<T>
            + + +

            +Base class for decoders that read Kiji cells encoded using Avro. + + Kiji cells are encoded as Extension records, although for efficiency reasons, this class + provides a custom decoder that avoid copying bytes unnecessarily. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected AvroCellDecoder(CellSpec cellSpec) + +
            +          Initializes an abstract KijiAvroCellDecoder.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected abstract  org.apache.avro.io.DatumReader<T>createDatumReader(org.apache.avro.Schema writer, + org.apache.avro.Schema reader) + +
            +          Factory for DatumReader instances.
            +protected  TdecodeAvro(ByteBuffer encodedData, + org.apache.avro.Schema writerSchema, + org.apache.avro.Schema readerSchema, + T reuse) + +
            +          Decodes the data payload given the reader and writer schema.
            + KijiCell<T>decodeCell(byte[] encodedBytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + TdecodeValue(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + ByteBuffergetPayload(byte[] bytes) + +
            +          Gets the portion of the encoded byte array from an HBase table cell that has the avro-encoded + data payload.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroCellDecoder

            +
            +protected AvroCellDecoder(CellSpec cellSpec)
+                   throws IOException
            +
            +
            Initializes an abstract KijiAvroCellDecoder. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createDatumReader

            +
            +protected abstract org.apache.avro.io.DatumReader<T> createDatumReader(org.apache.avro.Schema writer,
+                                                                       org.apache.avro.Schema reader)
            +
            +
            Factory for DatumReader instances. + + Sub-classes must create DatumReader implementations for specific or generic records. +

            +

            +
            +
            +
            +
            Parameters:
            writer - Writer schema.
            reader - Reader schema. +
            Returns:
            a new DatumReader instance for the specified writer/reader schema combination.
            +
            +
            +
            + +

            +decodeCell

            +
            +public KijiCell<T> decodeCell(byte[] encodedBytes)
+                       throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeCell in interface KijiCellDecoder<T>
            +
            +
            +
            Parameters:
            encodedBytes - Binary encoded Kiji cell. +
            Returns:
            the decoded KijiCell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeValue

            +
            +public T decodeValue(byte[] bytes)
+              throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeValue in interface KijiCellDecoder<T>
            +
            +
            +
            Parameters:
            bytes - Binary encoded Kiji cell value. +
            Returns:
            the decoded cell value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getPayload

            +
            +public ByteBuffer getPayload(byte[] bytes)
+                      throws IOException
            +
            +
            Gets the portion of the encoded byte array from an HBase table cell that has the avro-encoded + data payload. +

            +

            +
            +
            +
            +
            Parameters:
            bytes - The bytes from an HBase table cell. +
            Returns:
            the portion of the encoded byte array that contains the binary-encoded avro message. +
            Throws: +
            IOException - on I/O error (eg. decoding error).
            +
            +
            +
            + +

            +decodeAvro

            +
            +protected T decodeAvro(ByteBuffer encodedData,
+                       org.apache.avro.Schema writerSchema,
+                       org.apache.avro.Schema readerSchema,
+                       T reuse)
+                throws IOException
            +
            +
            Decodes the data payload given the reader and writer schema. If reuse is non-null, the + implementation may fill it and return that object. +

            +

            +
            +
            +
            +
            Parameters:
            encodedData - The avro-encoded bytes of the data payload.
            writerSchema - The schema that was used to encode the data.
            readerSchema - The schema that is expected by the reader.
            reuse - An optional object to be filled and returned to save on object construction + (may be null). +
            Returns:
            The decoded avro object. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/AvroCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/AvroCellEncoder.html new file mode 100644 index 00000000..e441af88 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/AvroCellEncoder.html @@ -0,0 +1,315 @@ + + + + + + + +AvroCellEncoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class AvroCellEncoder

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellEncoder
+
            +
            +
            All Implemented Interfaces:
            KijiCellEncoder
            +
            +
            +
            +
            @ApiAudience.Private
+public final class AvroCellEncoder
            extends Object
            implements KijiCellEncoder
            + + +

            +Serializes a KijiCell. + + A Kiji cell is encoded as an Extension record, although this class implements the encoder + in a specific way for efficiency. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            AvroCellEncoder(CellSpec cellSpec) + +
            +          Creates a new KijiCellEncoder instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + + + + + +
            +<T> byte[]
            +            		encode(T cellValue) + +
            +          Encodes the specified value.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroCellEncoder

            +
            +public AvroCellEncoder(CellSpec cellSpec)
+                throws IOException
            +
            +
            Creates a new KijiCellEncoder instance. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell to encode. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +encode

            +
            +public byte[] encode(KijiCell<?> cell)
+              throws IOException
            +
            +
            Encodes the specified Kiji cell. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Parameters:
            cell - Kiji cell to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encode

            +
            +public <T> byte[] encode(T cellValue)
+              throws IOException
            +
            +
            Encodes the specified value. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Type Parameters:
            T - type of the value to encode.
            Parameters:
            cellValue - value to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/CounterCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/CounterCellDecoder.html new file mode 100644 index 00000000..f874d296 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/CounterCellDecoder.html @@ -0,0 +1,288 @@ + + + + + + + +CounterCellDecoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class CounterCellDecoder

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.CounterCellDecoder
+
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<Long>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class CounterCellDecoder
            extends Object
            implements KijiCellDecoder<Long>
            + + +

            +Cell decoder for counters. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCell<Long>decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + LongdecodeValue(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            +static CounterCellDecoderget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static CounterCellDecoder get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the counter cell decoder singleton.
            +
            +
            +
            + +

            +decodeCell

            +
            +public KijiCell<Long> decodeCell(byte[] bytes)
+                          throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeCell in interface KijiCellDecoder<Long>
            +
            +
            +
            Parameters:
            bytes - Binary encoded Kiji cell. +
            Returns:
            the decoded KijiCell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeValue

            +
            +public Long decodeValue(byte[] bytes)
+                 throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeValue in interface KijiCellDecoder<Long>
            +
            +
            +
            Parameters:
            bytes - Binary encoded Kiji cell value. +
            Returns:
            the decoded cell value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/CounterCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/CounterCellEncoder.html new file mode 100644 index 00000000..54453ff7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/CounterCellEncoder.html @@ -0,0 +1,295 @@ + + + + + + + +CounterCellEncoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class CounterCellEncoder

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.CounterCellEncoder
+
            +
            +
            All Implemented Interfaces:
            KijiCellEncoder
            +
            +
            +
            +
            @ApiAudience.Private
+public final class CounterCellEncoder
            extends Object
            implements KijiCellEncoder
            + + +

            +Encoder for Kiji counters. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + + + + + +
            +<T> byte[]
            +            		encode(T cellValue) + +
            +          Encodes the specified value.
            +static CounterCellEncoderget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static CounterCellEncoder get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the singleton encoder for counters.
            +
            +
            +
            + +

            +encode

            +
            +public byte[] encode(KijiCell<?> cell)
+              throws IOException
            +
            +
            Encodes the specified Kiji cell. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Parameters:
            cell - Kiji cell to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encode

            +
            +public <T> byte[] encode(T cellValue)
+              throws IOException
            +
            +
            Encodes the specified value. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Type Parameters:
            T - type of the value to encode.
            Parameters:
            cellValue - value to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultHBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultHBaseAdminFactory.html new file mode 100644 index 00000000..61225878 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultHBaseAdminFactory.html @@ -0,0 +1,260 @@ + + + + + + + +DefaultHBaseAdminFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultHBaseAdminFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultHBaseAdminFactory
+
            +
            +
            All Implemented Interfaces:
            HBaseAdminFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultHBaseAdminFactory
            extends Object
            implements HBaseAdminFactory
            + + +

            +Factory for HBaseAdmin that creates concrete HBaseAdmin instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdmincreate(Configuration conf) + +
            +          Creates a new HBaseAdmin instance.
            +static HBaseAdminFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static HBaseAdminFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            an instance of the default factory.
            +
            +
            +
            + +

            +create

            +
            +public HBaseAdmin create(Configuration conf)
+                  throws IOException
            +
            +
            Creates a new HBaseAdmin instance. +

            +

            +
            Specified by:
            create in interface HBaseAdminFactory
            +
            +
            +
            Parameters:
            conf - Configuration. +
            Returns:
            a new HBaseAdmin. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultHBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultHBaseFactory.html new file mode 100644 index 00000000..409fa5cf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultHBaseFactory.html @@ -0,0 +1,368 @@ + + + + + + + +DefaultHBaseFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultHBaseFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultHBaseFactory
+
            +
            +
            All Implemented Interfaces:
            org.kiji.delegation.PriorityProvider, HBaseFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultHBaseFactory
            extends Object
            implements HBaseFactory
            + + +

            +Factory for HBase instances based on URIs. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.schema.HBaseFactory
            HBaseFactory.Provider
            +  + + + + + + + + + + + +
            +Constructor Summary
            DefaultHBaseFactory() + +
            +          Public constructor for use by the service loader.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdminFactorygetHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactorygetHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactorygetLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            + intgetPriority(Map<String,String> runtimeHints) + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DefaultHBaseFactory

            +
            +public DefaultHBaseFactory()
            +
            +
            Public constructor for use by the service loader. Clients should use + HBaseFactory.Provider.get(), which maintains a singleton instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getHTableInterfaceFactory

            +
            +public HTableInterfaceFactory getHTableInterfaceFactory(KijiURI uri)
            +
            +
            Reports a factory for HTableInterface for a given HBase instance. +

            +

            +
            Specified by:
            getHTableInterfaceFactory in interface HBaseFactory
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HTableInterface for the specified HBase instance.
            +
            +
            +
            + +

            +getHBaseAdminFactory

            +
            +public HBaseAdminFactory getHBaseAdminFactory(KijiURI uri)
            +
            +
            Reports a factory for HBaseAdmin for a given HBase instance. +

            +

            +
            Specified by:
            getHBaseAdminFactory in interface HBaseFactory
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HBaseAdmin for the specified HBase instance.
            +
            +
            +
            + +

            +getLockFactory

            +
            +public LockFactory getLockFactory(KijiURI uri,
+                                  Configuration conf)
+                           throws IOException
            +
            +
            Creates a lock factory for a given Kiji instance. +

            +

            +
            Specified by:
            getLockFactory in interface HBaseFactory
            +
            +
            +
            Parameters:
            uri - URI of the Kiji instance to create a lock factory for.
            conf - Hadoop configuration. +
            Returns:
            a factory for locks for the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getPriority

            +
            +public int getPriority(Map<String,String> runtimeHints)
            +
            +
            +

            +

            +
            Specified by:
            getPriority in interface org.kiji.delegation.PriorityProvider
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultHTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultHTableInterfaceFactory.html new file mode 100644 index 00000000..f9c56994 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultHTableInterfaceFactory.html @@ -0,0 +1,262 @@ + + + + + + + +DefaultHTableInterfaceFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultHTableInterfaceFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultHTableInterfaceFactory
+
            +
            +
            All Implemented Interfaces:
            HTableInterfaceFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultHTableInterfaceFactory
            extends Object
            implements HTableInterfaceFactory
            + + +

            +Factory for HTableInterface that creates concrete HTable instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + HTableInterfacecreate(Configuration conf, + String hbaseTableName) + +
            +          Creates a new HTableInterface instance.
            +static HTableInterfaceFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static HTableInterfaceFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the default factory singleton.
            +
            +
            +
            + +

            +create

            +
            +public HTableInterface create(Configuration conf,
+                              String hbaseTableName)
+                       throws IOException
            +
            +
            Creates a new HTableInterface instance. +

            +

            +
            Specified by:
            create in interface HTableInterfaceFactory
            +
            +
            +
            Parameters:
            conf - The configuration for the HBase cluster.
            hbaseTableName - The name of the HBase table to create a connection to. +
            Returns:
            a new HTableInterface for the specified table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultKijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultKijiCellEncoderFactory.html new file mode 100644 index 00000000..57b3d20a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultKijiCellEncoderFactory.html @@ -0,0 +1,260 @@ + + + + + + + +DefaultKijiCellEncoderFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultKijiCellEncoderFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultKijiCellEncoderFactory
+
            +
            +
            All Implemented Interfaces:
            KijiCellEncoderFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultKijiCellEncoderFactory
            extends Object
            implements KijiCellEncoderFactory
            + + +

            +Factory for cell encoders. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellEncodercreate(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +static DefaultKijiCellEncoderFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static DefaultKijiCellEncoderFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the default factory for cell encoders.
            +
            +
            +
            + +

            +create

            +
            +public KijiCellEncoder create(CellSpec cellSpec)
+                       throws IOException
            +
            +
            Creates a new Kiji cell encoder. +

            +

            +
            Specified by:
            create in interface KijiCellEncoderFactory
            +
            +
            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell encoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultKijiCounter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultKijiCounter.html new file mode 100644 index 00000000..cafa4cb0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultKijiCounter.html @@ -0,0 +1,299 @@ + + + + + + + +DefaultKijiCounter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultKijiCounter

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultKijiCounter
+
            +
            +
            All Implemented Interfaces:
            KijiCounter
            +
            +
            +
            +
            @ApiAudience.Private
+public class DefaultKijiCounter
            extends Object
            implements KijiCounter
            + + +

            +The default implementation of a Kiji counter, which contains the data in a counter cell + of a column. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DefaultKijiCounter(long timestamp, + long value) + +
            +          Creates a new DefaultKijiCounter instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + longgetTimestamp() + +
            +          Gets the timestamp at which the counter was incremented.
            + longgetValue() + +
            +          Gets the value of the counter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DefaultKijiCounter

            +
            +public DefaultKijiCounter(long timestamp,
+                          long value)
            +
            +
            Creates a new DefaultKijiCounter instance. +

            +

            +
            Parameters:
            timestamp - The timestamp at which the counter was incremented.
            value - The counter value.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getTimestamp

            +
            +public long getTimestamp()
            +
            +
            Gets the timestamp at which the counter was incremented. +

            +

            +
            Specified by:
            getTimestamp in interface KijiCounter
            +
            +
            + +
            Returns:
            A timestamp, in milliseconds since the epoch.
            +
            +
            +
            + +

            +getValue

            +
            +public long getValue()
            +
            +
            Gets the value of the counter. +

            +

            +
            Specified by:
            getValue in interface KijiCounter
            +
            +
            + +
            Returns:
            The value of the counter, which is zero if the counter has never been incremented.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultKijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultKijiTableFactory.html new file mode 100644 index 00000000..f05ab915 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/DefaultKijiTableFactory.html @@ -0,0 +1,276 @@ + + + + + + + +DefaultKijiTableFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultKijiTableFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultKijiTableFactory
+
            +
            +
            All Implemented Interfaces:
            KijiTableFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public class DefaultKijiTableFactory
            extends Object
            implements KijiTableFactory
            + + +

            +The default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open(). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DefaultKijiTableFactory(Kiji kiji) + +
            +          Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + KijiTableopenTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DefaultKijiTableFactory

            +
            +public DefaultKijiTableFactory(Kiji kiji)
            +
            +
            Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance. +

            +

            +
            Parameters:
            kiji - The kiji instance containing the tables to open.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +openTable

            +
            +public KijiTable openTable(String tableName)
+                    throws IOException
            +
            +
            Opens a KijiTable by name. + +

            Clients must take care to close the KijiTable instance when finished.

            +

            +

            +
            Specified by:
            openTable in interface KijiTableFactory
            +
            +
            +
            Parameters:
            tableName - Name of the table to open. +
            Returns:
            the opened Kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/GenericCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/GenericCellDecoder.html new file mode 100644 index 00000000..61f2834e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/GenericCellDecoder.html @@ -0,0 +1,290 @@ + + + + + + + +GenericCellDecoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class GenericCellDecoder<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellDecoder<T>
+      extended by org.kiji.schema.impl.GenericCellDecoder<T>
+
            +
            +
            Type Parameters:
            T - The type of the decoded data.
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<T>
            +
            +
            +
            +
            @ApiAudience.Private
+public class GenericCellDecoder<T>
            extends AvroCellDecoder<T>
            + + +

            +Decodes cells encoded using Avro into generic types. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            GenericCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates generic Avro types.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  org.apache.avro.io.DatumReader<T>createDatumReader(org.apache.avro.Schema writer, + org.apache.avro.Schema reader) + +
            +          Factory for DatumReader instances.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.impl.AvroCellDecoder
            decodeAvro, decodeCell, decodeValue, getPayload
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +GenericCellDecoder

            +
            +public GenericCellDecoder(CellSpec cellSpec)
+                   throws IOException
            +
            +
            Initializes a cell decoder that creates generic Avro types. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createDatumReader

            +
            +protected org.apache.avro.io.DatumReader<T> createDatumReader(org.apache.avro.Schema writer,
+                                                              org.apache.avro.Schema reader)
            +
            +
            Factory for DatumReader instances. + + Sub-classes must create DatumReader implementations for specific or generic records. +

            +

            +
            Specified by:
            createDatumReader in class AvroCellDecoder<T>
            +
            +
            +
            Parameters:
            writer - Writer schema.
            reader - Reader schema. +
            Returns:
            a new DatumReader instance for the specified writer/reader schema combination.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseAdminFactory.html new file mode 100644 index 00000000..5a4626b9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseAdminFactory.html @@ -0,0 +1,222 @@ + + + + + + + +HBaseAdminFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Interface HBaseAdminFactory

            +
            +
            All Known Implementing Classes:
            DefaultHBaseAdminFactory
            +
            +
            +
            +
            public interface HBaseAdminFactory
            + + +

            +Factory for HBaseAdmin. + + Note: there is no interface for HBaseAdmin :( +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdmincreate(Configuration conf) + +
            +          Creates a new HBaseAdmin instance.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +HBaseAdmin create(Configuration conf)
+                  throws IOException
            +
            +
            Creates a new HBaseAdmin instance. +

            +

            +
            Parameters:
            conf - Configuration. +
            Returns:
            a new HBaseAdmin. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseDataRequestAdapter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseDataRequestAdapter.html new file mode 100644 index 00000000..3fbe7428 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseDataRequestAdapter.html @@ -0,0 +1,390 @@ + + + + + + + +HBaseDataRequestAdapter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseDataRequestAdapter

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseDataRequestAdapter
+
            +
            +
            +
            @ApiAudience.Private
+public class HBaseDataRequestAdapter
            extends Object
            + + +

            +Wraps a KijiDataRequest to expose methods that generate meaningful objects in HBase + land, like Puts and Gets. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseDataRequestAdapter(KijiDataRequest kijiDataRequest) + +
            +          Wraps a KijiDataRequest.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidapplyToScan(Scan scan, + KijiTableLayout tableLayout) + +
            +          Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one.
            + GettoGet(EntityId entityId, + KijiTableLayout tableLayout) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + GettoGet(EntityId entityId, + KijiTableLayout tableLayout, + int pageIndex) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + ScantoScan(KijiTableLayout tableLayout) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            + ScantoScan(KijiTableLayout tableLayout, + HBaseScanOptions scanOptions) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseDataRequestAdapter

            +
            +public HBaseDataRequestAdapter(KijiDataRequest kijiDataRequest)
            +
            +
            Wraps a KijiDataRequest. +

            +

            +
            Parameters:
            kijiDataRequest - The Kiji data request to wrap.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toScan

            +
            +public Scan toScan(KijiTableLayout tableLayout)
+            throws IOException
            +
            +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +

            +

            +
            Parameters:
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns. +
            Returns:
            An HBase Scan descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toScan

            +
            +public Scan toScan(KijiTableLayout tableLayout,
+                   HBaseScanOptions scanOptions)
+            throws IOException
            +
            +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +

            +

            +
            Parameters:
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns.
            scanOptions - Custom options for this scan. +
            Returns:
            An HBase Scan descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +applyToScan

            +
            +public void applyToScan(Scan scan,
+                        KijiTableLayout tableLayout)
+                 throws IOException
            +
            +
            Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one. + +

            Any existing request settings in the Scan object will be preserved.

            +

            +

            +
            Parameters:
            scan - The existing scan object to apply the data request to.
            tableLayout - The layout of the Kiji table the scan will read from. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toGet

            +
            +public Get toGet(EntityId entityId,
+                 KijiTableLayout tableLayout)
+          throws IOException
            +
            +
            Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row. +

            +

            +
            Parameters:
            entityId - The row to build an HBase Get request for.
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns. +
            Returns:
            An HBase Get descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toGet

            +
            +public Get toGet(EntityId entityId,
+                 KijiTableLayout tableLayout,
+                 int pageIndex)
+          throws IOException
            +
            +
            Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row. +

            +

            +
            Parameters:
            entityId - The row to build an HBase Get request for.
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns.
            pageIndex - Which page of column data to retrieve (zero means the first page). +
            Returns:
            An HBase Get descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseEntityId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseEntityId.html new file mode 100644 index 00000000..0ae2f6ec --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseEntityId.html @@ -0,0 +1,328 @@ + + + + + + + +HBaseEntityId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.HBaseEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public class HBaseEntityId
            extends EntityId
            + + +

            +Entity ID encapsulating an HBase row key. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseEntityId(byte[] hbaseRowKey) + +
            +          Creates an HBaseEntityId from the specified HBase row key.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + RowKeyFormatgetFormat() + +
            +          
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + byte[]getKijiRowKey() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseEntityId

            +
            +public HBaseEntityId(byte[] hbaseRowKey)
            +
            +
            Creates an HBaseEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getFormat

            +
            +public RowKeyFormat getFormat()
            +
            +
            +

            +

            +
            Specified by:
            getFormat in class EntityId
            +
            +
            + +
            Returns:
            the format of this row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public byte[] getKijiRowKey()
            +
            +
            +

            +

            +
            Specified by:
            getKijiRowKey in class EntityId
            +
            +
            + +
            Returns:
            the Kiji row key as a byte array.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiRowData.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiRowData.html new file mode 100644 index 00000000..5203a0a0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiRowData.html @@ -0,0 +1,1206 @@ + + + + + + + +HBaseKijiRowData (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiRowData

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiRowData
+
            +
            +
            All Implemented Interfaces:
            KijiRowData
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseKijiRowData
            extends Object
            implements KijiRowData
            + + +

            +An implementation of KijiRowData that wraps an HBase Result object. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleancontainsColumn(String family) + +
            +          Determines whether a particular column family has any data in this row.
            + booleancontainsColumn(String family, + String qualifier) + +
            +          Determines whether a particular column has data in this row.
            + + + + + +
            +<T> KijiCell<T>
            +            		getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		getCells(String family) + +
            +          Gets all the timestamp-cell pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		getCells(String family, + String qualifier) + +
            +          Gets all the timestamp-cell pairs stored within the specified cell.
            + KijiCountergetCounter(String family, + String qualifier) + +
            +          Deprecated. 
            + KijiCountergetCounter(String family, + String qualifier, + long timestamp) + +
            +          Deprecated. 
            + EntityIdgetEntityId() + +
            +          Gets the entity id for this row of kiji data.
            + ResultgetHBaseResult() + +
            +          Gets the HBase result backing this KijiRowData.
            + NavigableMap<String,NavigableMap<String,NavigableMap<Long,byte[]>>>getMap() + +
            +          Gets a map from kiji family to qualifier to timestamp to raw kiji-encoded bytes of a cell.
            + + + + + +
            +<T> KijiCell<T>
            +            		getMostRecentCell(String family, + String qualifier) + +
            +          Gets the latest version of the specified cell.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		getMostRecentCells(String family) + +
            +          Gets the latest version of the specified cell.
            + + + + + +
            +<T> T
            +            		getMostRecentValue(String family, + String qualifier) + +
            +          Gets the value with the latest timestamp stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,T>
            +            		getMostRecentValues(String family) + +
            +          Gets the value with the latest timestamp stored within the specified cell.
            + NavigableSet<String>getQualifiers(String family) + +
            +          Gets the set of column qualifiers that exist in a family.
            + org.apache.avro.SchemagetReaderSchema(String family, + String qualifier) + +
            +          Gets the reader schema for a column as declared in the layout of the table this row + comes from.
            + KijiSchemaTablegetSchemaTable() + +
            +          Gets the schema table this kiji row data uses for decoding.
            + KijiTableLayoutgetTableLayout() + +
            +          Gets the layout of the table this row data belongs to.
            + NavigableSet<Long>getTimestamps(String family, + String qualifier) + +
            +          Gets the set of timestamps on cells that exist in a column.
            + + + + + +
            +<T> T
            +            		getValue(String family, + String qualifier, + long timestamp) + +
            +          Gets the value stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,T>>
            +            		getValues(String family) + +
            +          Gets all the timestamp-value pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,T>
            +            		getValues(String family, + String qualifier) + +
            +          Gets all the timestamp-value pairs stored within the specified cell.
            + voidmerge(Collection<KeyValue> keyValues) + +
            +          Merges in the data from a collection of KeyValues.
            + voidmerge(HBaseKijiRowData kijiRowData) + +
            +          Merges in the data from another HBaseKijiRowData instance.
            + voidmerge(Put put) + +
            +          Merges in the data an HBase Put object.
            + booleannextPage(String family) + +
            +          Populates the next page of cells for a requested column family.
            + booleannextPage(String family, + String qualifier) + +
            +          Populates the next page of cells for a column.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiRowData

            +
            +@Deprecated
+public HBaseKijiRowData(EntityId entityId,
+                                   KijiDataRequest request,
+                                   KijiCellDecoderFactory decoderFactory,
+                                   KijiTableLayout layout,
+                                   Result result,
+                                   KijiSchemaTable schemaTable)
            +
            +
            Deprecated.  +

            +

            Initializes a row data. +

            +

            +
            Parameters:
            entityId - Entity ID of the row.
            request - Data request to build the row.
            decoderFactory - Factory for cell decoders.
            layout - Layout of the table the row belongs to.
            result - HTable result with the encoded row content.
            schemaTable - Schema table.
            +
            +
            + +

            +HBaseKijiRowData

            +
            +@Deprecated
+public HBaseKijiRowData(KijiDataRequest request,
+                                   KijiCellDecoderFactory decoderFactory,
+                                   KijiTableLayout layout,
+                                   Result result,
+                                   KijiSchemaTable schemaTable)
            +
            +
            Deprecated.  +

            +

            Initializes a row data. + + The entity ID is constructed from the HTable encoded result. + This may fail if the table uses hashed row keys. +

            +

            +
            Parameters:
            request - Data request to build the row.
            decoderFactory - Factory for cell decoders.
            layout - Layout of the table the row belongs to.
            result - HTable result with the encoded row content.
            schemaTable - Schema table.
            +
            +
            + +

            +HBaseKijiRowData

            +
            +public HBaseKijiRowData(EntityId entityId,
+                        KijiDataRequest request,
+                        HBaseKijiTable table,
+                        Result result)
            +
            +
            Initializes a row data. +

            +

            +
            Parameters:
            entityId - The entityId of the row.
            request - The requested data.
            table - The Kiji table that this row belongs to.
            result - The HBase result containing the row data.
            +
            +
            + +

            +HBaseKijiRowData

            +
            +public HBaseKijiRowData(KijiDataRequest request,
+                        HBaseKijiTable table,
+                        Result result)
+                 throws IOException
            +
            +
            Initializes a row data. + + The entity ID is constructed from the HTable encoded result. + This may fail if the table uses hashed row keys. +

            +

            +
            Parameters:
            request - The requested data.
            table - The Kiji table that this row belongs to.
            result - The HBase result containing the row data. +
            Throws: +
            IOException - If there is an error reading the entityId from the hbase result.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseResult

            +
            +public Result getHBaseResult()
            +
            +
            Gets the HBase result backing this KijiRowData. +

            +

            +
            +
            +
            + +
            Returns:
            The HBase result.
            +
            +
            +
            + +

            +getEntityId

            +
            +public EntityId getEntityId()
            +
            +
            Gets the entity id for this row of kiji data. +

            +

            +
            Specified by:
            getEntityId in interface KijiRowData
            +
            +
            + +
            Returns:
            The row key.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout()
            +
            +
            Gets the layout of the table this row data belongs to. +

            +

            +
            +
            +
            + +
            Returns:
            The table layout.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public KijiSchemaTable getSchemaTable()
            +
            +
            Gets the schema table this kiji row data uses for decoding. +

            +

            +
            +
            +
            + +
            Returns:
            The schema table.
            +
            +
            +
            + +

            +merge

            +
            +public void merge(HBaseKijiRowData kijiRowData)
            +
            +
            Merges in the data from another HBaseKijiRowData instance. +

            +

            +
            +
            +
            +
            Parameters:
            kijiRowData - The data to merge in.
            +
            +
            +
            + +

            +merge

            +
            +public void merge(Put put)
            +
            +
            Merges in the data an HBase Put object. +

            +

            +
            +
            +
            +
            Parameters:
            put - The data to merge in.
            +
            +
            +
            + +

            +merge

            +
            +public void merge(Collection<KeyValue> keyValues)
            +
            +
            Merges in the data from a collection of KeyValues. +

            +

            +
            +
            +
            +
            Parameters:
            keyValues - The data to merge in.
            +
            +
            +
            + +

            +getMap

            +
            +public NavigableMap<String,NavigableMap<String,NavigableMap<Long,byte[]>>> getMap()
            +
            +
            Gets a map from kiji family to qualifier to timestamp to raw kiji-encoded bytes of a cell. +

            +

            +
            +
            +
            + +
            Returns:
            The map.
            +
            +
            +
            + +

            +containsColumn

            +
            +public boolean containsColumn(String family,
+                              String qualifier)
            +
            +
            Determines whether a particular column has data in this row. +

            +

            +
            Specified by:
            containsColumn in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family.
            qualifier - A column qualifier. +
            Returns:
            Whether the column has data in this row.
            +
            +
            +
            + +

            +containsColumn

            +
            +public boolean containsColumn(String family)
            +
            +
            Determines whether a particular column family has any data in this row. +

            +

            +
            Specified by:
            containsColumn in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family. +
            Returns:
            Whether the family has data in this row.
            +
            +
            +
            + +

            +getQualifiers

            +
            +public NavigableSet<String> getQualifiers(String family)
            +
            +
            Gets the set of column qualifiers that exist in a family. +

            +

            +
            Specified by:
            getQualifiers in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family name. +
            Returns:
            The set of column qualifiers that exist in family.
            +
            +
            +
            + +

            +getTimestamps

            +
            +public NavigableSet<Long> getTimestamps(String family,
+                                        String qualifier)
            +
            +
            Gets the set of timestamps on cells that exist in a column. + +

            If iterating over the set, you will get items in order of decreasing timestamp.

            +

            +

            +
            Specified by:
            getTimestamps in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The set of all timestamps of cells in the family:qualifier column.
            +
            +
            +
            + +

            +getReaderSchema

            +
            +public org.apache.avro.Schema getReaderSchema(String family,
+                                              String qualifier)
+                                       throws IOException
            +
            +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +

            +

            +
            Specified by:
            getReaderSchema in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The Avro reader schema for the column. +
            Throws: +
            IOException - If there is an error or the column does not exist.
            +
            +
            +
            + +

            +nextPage

            +
            +public boolean nextPage(String family,
+                        String qualifier)
+                 throws IOException
            +
            +
            Populates the next page of cells for a column. + +

            If there are cells remaining, this KijiRowData object is populated with the next + page of cells for the requested column and the method returns true. Otherwise, data + from the column's previous page is removed, and this method returns false. This + method throws an IOException if the column does not have paging enabled in the + KijiDataRequest.

            +

            +

            +
            Specified by:
            nextPage in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family.
            qualifier - A column qualifier. +
            Returns:
            Whether a new page of cells has been fetched. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +nextPage

            +
            +public boolean nextPage(String family)
+                 throws IOException
            +
            +
            Populates the next page of cells for a requested column family. + +

            If there are cells remaining, this KijiRowData object is populated with the next + page of cells for the requested family and the method returns true. Otherwise, data + from the family's previous page is removed, and this method returns false. This + method throws an IOException if the column does not have paging enabled in the + KijiDataRequest.

            + +

            An IOException is thrown if this method is called on a family that was not + requested explicitly in the KijiDataRequest. For example, consider the following: + + 

            +   new KijiDataRequest()
+       .addColumn(new KijiDataRequest.Column("foo").withPageSize(10))
+       .addColumn(new KijiDataRequest.Column("bar", "baz").withPageSize(10));
+
            + + It would be valid to call nextPage("foo"), but calling nextPage("bar") would throw an + IOException, since paging was not enabled on the entire "bar" family.

            +

            +

            +
            Specified by:
            nextPage in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family. +
            Returns:
            Whether a new page of cells has been fetched. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValue

            +
            +public <T> T getValue(String family,
+                      String qualifier,
+                      long timestamp)
+           throws IOException
            +
            +
            Gets the value stored within the specified cell. +

            +

            +
            Specified by:
            getValue in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. Use #containsColumn() to distinguish between this scenarios. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCell

            +
            +public <T> KijiCell<T> getCell(String family,
+                               String qualifier,
+                               long timestamp)
+                    throws IOException
            +
            +
            Gets the specified cell. +

            +

            +
            Specified by:
            getCell in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            the specified cell, or null if the cell does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValue

            +
            +public <T> T getMostRecentValue(String family,
+                                String qualifier)
+                     throws IOException
            +
            +
            Gets the value with the latest timestamp stored within the specified cell. +

            +

            +
            Specified by:
            getMostRecentValue in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValues

            +
            +public <T> NavigableMap<String,T> getMostRecentValues(String family)
+                                           throws IOException
            +
            +
            Gets the value with the latest timestamp stored within the specified cell. +

            +

            +
            Specified by:
            getMostRecentValues in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public <T> NavigableMap<Long,T> getValues(String family,
+                                          String qualifier)
+                               throws IOException
            +
            +
            Gets all the timestamp-value pairs stored within the specified cell. +

            +

            +
            Specified by:
            getValues in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            A sorted map containing the values stored in the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public <T> NavigableMap<String,NavigableMap<Long,T>> getValues(String family)
+                                                    throws IOException
            +
            +
            Gets all the timestamp-value pairs stored within the specified family. +

            +

            +
            Specified by:
            getValues in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            A sorted map containing the values stored in the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCell

            +
            +public <T> KijiCell<T> getMostRecentCell(String family,
+                                         String qualifier)
+                              throws IOException
            +
            +
            Gets the latest version of the specified cell. +

            +

            +
            Specified by:
            getMostRecentCell in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            the most recent version of the specified cell, or null if the cell does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCells

            +
            +public <T> NavigableMap<String,KijiCell<T>> getMostRecentCells(String family)
+                                                    throws IOException
            +
            +
            Gets the latest version of the specified cell. +

            +

            +
            Specified by:
            getMostRecentCells in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            a map from qualifier to the most recent versions of the cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +public <T> NavigableMap<Long,KijiCell<T>> getCells(String family,
+                                                   String qualifier)
+                                        throws IOException
            +
            +
            Gets all the timestamp-cell pairs stored within the specified cell. +

            +

            +
            Specified by:
            getCells in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            A sorted map versions of the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +public <T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>> getCells(String family)
+                                                             throws IOException
            +
            +
            Gets all the timestamp-cell pairs stored within the specified family. +

            +

            +
            Specified by:
            getCells in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            A sorted map versions of the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCounter

            +
            +@Deprecated
+public KijiCounter getCounter(String family,
+                                         String qualifier)
+                       throws IOException
            +
            +
            Deprecated.  +

            +

            Gets the most recent counter from a column. + +

            Only columns that have been declared with <schema type="counter"/> may be + read using this method, otherwise an exception is thrown.

            +

            +

            +
            Specified by:
            getCounter in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The most recent counter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCounter

            +
            +@Deprecated
+public KijiCounter getCounter(String family,
+                                         String qualifier,
+                                         long timestamp)
+                       throws IOException
            +
            +
            Deprecated.  +

            +

            Reads a counter as it was at a particular timestamp. + +

            Only columns that have been declared with <schema type="counter"/> may be + read using this method, otherwise an exception is thrown.

            +

            +

            +
            Specified by:
            getCounter in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            The counter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html new file mode 100644 index 00000000..bde5caee --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html @@ -0,0 +1,417 @@ + + + + + + + +HBaseKijiRowScanner.Options (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiRowScanner.Options

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiRowScanner.Options
+
            +
            +
            Enclosing class:
            HBaseKijiRowScanner
            +
            +
            +
            +
            public static class HBaseKijiRowScanner.Options
            extends Object
            + + +

            +A class to encapsulate the various options the HBaseKijiRowScanner constructor requires. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiRowScanner.Options() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellDecoderFactorygetCellDecoderFactory() + +
            +          Gets the cell decoder factory.
            + KijiDataRequestgetDataRequest() + +
            +          Gets the data request.
            + ResultScannergetHBaseResultScanner() + +
            +          Gets the HBase result scanner.
            + HBaseKijiTablegetTable() + +
            +          Gets the table being scanned.
            + HBaseKijiRowScanner.OptionswithCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory) + +
            +          Sets the cell decoder factory to use when reading cells from the scanner.
            + HBaseKijiRowScanner.OptionswithDataRequest(KijiDataRequest dataRequest) + +
            +          Sets the data request used to generate the KijiRowScanner.
            + HBaseKijiRowScanner.OptionswithHBaseResultScanner(ResultScanner hbaseResultScanner) + +
            +          Sets the HBase result scanner the KijiRowScanner will wrap.
            + HBaseKijiRowScanner.OptionswithTable(HBaseKijiTable table) + +
            +          Sets the table being scanned.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiRowScanner.Options

            +
            +public HBaseKijiRowScanner.Options()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +withHBaseResultScanner

            +
            +public HBaseKijiRowScanner.Options withHBaseResultScanner(ResultScanner hbaseResultScanner)
            +
            +
            Sets the HBase result scanner the KijiRowScanner will wrap. +

            +

            +
            Parameters:
            hbaseResultScanner - An HBase result scanner. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +withDataRequest

            +
            +public HBaseKijiRowScanner.Options withDataRequest(KijiDataRequest dataRequest)
            +
            +
            Sets the data request used to generate the KijiRowScanner. +

            +

            +
            Parameters:
            dataRequest - A data request. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +withTable

            +
            +public HBaseKijiRowScanner.Options withTable(HBaseKijiTable table)
            +
            +
            Sets the table being scanned. +

            +

            +
            Parameters:
            table - The table being scanned. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +withCellDecoderFactory

            +
            +public HBaseKijiRowScanner.Options withCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory)
            +
            +
            Sets the cell decoder factory to use when reading cells from the scanner. +

            +

            +
            Parameters:
            cellDecoderFactory - A cell decoder factory. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +getHBaseResultScanner

            +
            +public ResultScanner getHBaseResultScanner()
            +
            +
            Gets the HBase result scanner. +

            +

            + +
            Returns:
            The HBase result scanner.
            +
            +
            +
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Gets the data request. +

            +

            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +getTable

            +
            +public HBaseKijiTable getTable()
            +
            +
            Gets the table being scanned. +

            +

            + +
            Returns:
            The Kiji table.
            +
            +
            +
            + +

            +getCellDecoderFactory

            +
            +public KijiCellDecoderFactory getCellDecoderFactory()
            +
            +
            Gets the cell decoder factory. +

            +

            + +
            Returns:
            The cell decoder factory.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiRowScanner.html new file mode 100644 index 00000000..cd30cd11 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiRowScanner.html @@ -0,0 +1,341 @@ + + + + + + + +HBaseKijiRowScanner (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiRowScanner

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiRowScanner
+
            +
            +
            All Implemented Interfaces:
            Closeable, Iterable<KijiRowData>, KijiRowScanner
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseKijiRowScanner
            extends Object
            implements KijiRowScanner
            + + +

            +The internal implementation of KijiRowScanner that reads from HTables. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classHBaseKijiRowScanner.Options + +
            +          A class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            +  + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiRowScanner(HBaseKijiRowScanner.Options options) + +
            +          Creates a new KijiRowScanner instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Closes this scanner and releases any system resources associated with it.
            +protected  voidfinalize() + +
            +          
            + org.kiji.schema.impl.HBaseKijiRowScanner.KijiRowIteratoriterator() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiRowScanner

            +
            +public HBaseKijiRowScanner(HBaseKijiRowScanner.Options options)
            +
            +
            Creates a new KijiRowScanner instance. +

            +

            +
            Parameters:
            options - The options for this scanner.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +iterator

            +
            +public org.kiji.schema.impl.HBaseKijiRowScanner.KijiRowIterator iterator()
            +
            +
            +

            +

            +
            Specified by:
            iterator in interface Iterable<KijiRowData>
            +
            +
            +
            +
            +
            +
            + +

            +close

            +
            +public void close()
            +
            +
            Closes this scanner and releases any system resources associated with it. + +

            Calling this method when you are finished with the scanner is important. + See http://hbase.apache.org/book.html#perf.hbase.client.scannerclose for details.

            +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in interface KijiRowScanner
            +
            +
            +
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiTable.html new file mode 100644 index 00000000..fb9c5aa8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiTable.html @@ -0,0 +1,455 @@ + + + + + + + +HBaseKijiTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AbstractKijiTable
+      extended by org.kiji.schema.impl.HBaseKijiTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseKijiTable
            extends AbstractKijiTable
            + + +

            +

            A KijiTable that exposes the underlying HBase implementation.

            + +

            Within the internal Kiji code, we use this class so that we have + access to the HTable interface. Methods that Kiji clients should + have access to should be added to org.kiji.schema.KijiTable.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiTable(Kiji kiji, + String name) + +
            +          Construct an opened Kiji table stored in HBase.
            HBaseKijiTable(Kiji kiji, + String name, + HTableInterfaceFactory htableFactory) + +
            +          Construct an opened Kiji table stored in HBase.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +static HBaseKijiTabledowncast(KijiTable kijiTable) + +
            +          We know that all KijiTables are really HBaseKijiTables + instances.
            + EntityIdFactorygetEntityIdFactory() + +
            +          
            + HTableInterfacegetHTable() + +
            +           
            + KijiTableLayoutgetLayout() + +
            +          
            + KijiTableReaderopenTableReader() + +
            +          Opens an appropriate implementation of KijiTableReader for this table.
            + KijiTableWriteropenTableWriter() + +
            +          Opens an appropriate implementation of KijiTableWriter for this table.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.impl.AbstractKijiTable
            equals, finalize, getEntityId, getKiji, getName, hashCode, open
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiTable

            +
            +public HBaseKijiTable(Kiji kiji,
+                      String name)
+               throws IOException
            +
            +
            Construct an opened Kiji table stored in HBase. +

            +

            +
            Parameters:
            kiji - The Kiji instance.
            name - The name of the Kiji user-space table to open. +
            Throws: +
            IOException - On an HBase error.
            +
            +
            + +

            +HBaseKijiTable

            +
            +public HBaseKijiTable(Kiji kiji,
+                      String name,
+                      HTableInterfaceFactory htableFactory)
+               throws IOException
            +
            +
            Construct an opened Kiji table stored in HBase. +

            +

            +
            Parameters:
            kiji - The Kiji instance.
            name - The name of the Kiji user-space table to open.
            htableFactory - A factory that creates HTable objects. +
            Throws: +
            IOException - On an HBase error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +downcast

            +
            +public static HBaseKijiTable downcast(KijiTable kijiTable)
            +
            +
            We know that all KijiTables are really HBaseKijiTables + instances. This is a convenience method for downcasting, which + is common within the internals of Kiji code. +

            +

            +
            Parameters:
            kijiTable - The Kiji table to downcast to an HBaseKijiTable. +
            Returns:
            The given Kiji table as an HBaseKijiTable.
            +
            +
            +
            + +

            +getHTable

            +
            +public HTableInterface getHTable()
            +
            +
            + +
            Returns:
            The underlying HTable instance.
            +
            +
            +
            + +

            +getLayout

            +
            +public KijiTableLayout getLayout()
            +
            +
            +

            +

            + +
            Returns:
            the layout of this table.
            +
            +
            +
            + +

            +getEntityIdFactory

            +
            +public EntityIdFactory getEntityIdFactory()
            +
            +
            +

            +

            + +
            Returns:
            the entity ID factory for this table.
            +
            +
            +
            + +

            +openTableReader

            +
            +public KijiTableReader openTableReader()
            +
            +
            Opens an appropriate implementation of KijiTableReader for this table. The caller is + responsible for closing this reader. +

            +

            + +
            Returns:
            A KijiTableReader for this table.
            +
            +
            +
            + +

            +openTableWriter

            +
            +public KijiTableWriter openTableWriter()
+                                throws IOException
            +
            +
            Opens an appropriate implementation of KijiTableWriter for this table. The caller is + responsible for closing this writer. +

            +

            + +
            Returns:
            A KijiTableWriter for this table. +
            Throws: +
            IOException - If there was an error opening the writer.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Overrides:
            close in class AbstractKijiTable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiTableReader.html new file mode 100644 index 00000000..64e2628f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiTableReader.html @@ -0,0 +1,360 @@ + + + + + + + +HBaseKijiTableReader (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiTableReader

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiTableReader
+      extended by org.kiji.schema.impl.HBaseKijiTableReader
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseKijiTableReader
            extends KijiTableReader
            + + +

            +Reads from a kiji table by sending the requests directly to the HBase tables. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiTableReader(KijiTable table) + +
            +          Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + List<KijiRowData>bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + KijiRowDataget(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieve data from a single row in the Kiji table, with no post-processing.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest, + EntityId startRow, + EntityId stopRow, + KijiRowFilter rowFilter, + HBaseScanOptions scanOptions) + +
            +          Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.KijiTableReader
            close, finalize, getKijiCellDecoderFactory, getScanner, getScanner, getTable, setKijiCellDecoderFactory
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiTableReader

            +
            +public HBaseKijiTableReader(KijiTable table)
            +
            +
            Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase. +

            +

            +
            Parameters:
            table - The kiji table to read from.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public KijiRowData get(EntityId entityId,
+                       KijiDataRequest dataRequest)
+                throws IOException
            +
            +
            Retrieve data from a single row in the Kiji table, with no post-processing. +

            +

            +
            Specified by:
            get in class KijiTableReader
            +
            +
            +
            Parameters:
            entityId - The entity id for the row to get data from.
            dataRequest - Specifies the columns of data to retrieve. +
            Returns:
            The requested data. If there is no row for the specified entityId, this + will return an empty KijiRowData. (containsColumn() will return false for all + columns.) +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +bulkGet

            +
            +public List<KijiRowData> bulkGet(List<EntityId> entityIds,
+                                 KijiDataRequest dataRequest)
+                          throws IOException
            +
            +
            Retrieves data from a list of rows in the kiji table. +

            +

            +
            Specified by:
            bulkGet in class KijiTableReader
            +
            +
            +
            Parameters:
            entityIds - The list of entity ids to collect data for.
            dataRequest - Specifies constraints on the data to retrieve for each entity id. +
            Returns:
            The requested data. If an EntityId specified in entityIds + does not exist, then the corresponding KijiRowData will be empty. + If a get fails, then the corresponding KijiRowData will be null (instead of empty). +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +getScanner

            +
            +public KijiRowScanner getScanner(KijiDataRequest dataRequest,
+                                 EntityId startRow,
+                                 EntityId stopRow,
+                                 KijiRowFilter rowFilter,
+                                 HBaseScanOptions scanOptions)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner using a KijiRowFilter and the specified HBaseScanOptions. +

            +

            +
            Specified by:
            getScanner in class KijiTableReader
            +
            +
            +
            Parameters:
            dataRequest - Specifies the columns of data to retrieve.
            startRow - The entity id for the row to start the scan from. If null, the scanner + will read all rows up to the stopRow.
            stopRow - The entity id for the row to end the scan at. If null, the scanner will + read all rows after the startRow.
            rowFilter - The KijiRowFilter to filter these results on
            scanOptions - The custom scanner configuration to use. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiTableWriter.html new file mode 100644 index 00000000..9c8b3c28 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseKijiTableWriter.html @@ -0,0 +1,662 @@ + + + + + + + +HBaseKijiTableWriter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiTableWriter

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiTableWriter
+
            +
            +
            All Implemented Interfaces:
            Closeable, Flushable, KijiDeleter, KijiIncrementer, KijiPutter, KijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseKijiTableWriter
            extends Object
            implements KijiTableWriter
            + + +

            +Makes modifications to a Kiji table by sending requests directly to HBase from the local client. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiTableWriter(KijiTable table) + +
            +          Creates a non-buffered kiji table writer that sends modifications directly to Kiji.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +           
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voiddeleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voiddeleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voiddeleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voiddeleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            + voidflush() + +
            +           
            + KijiCounterincrement(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiTableWriter

            +
            +public HBaseKijiTableWriter(KijiTable table)
+                     throws IOException
            +
            +
            Creates a non-buffered kiji table writer that sends modifications directly to Kiji. +

            +

            +
            Parameters:
            table - A kiji table. +
            Throws: +
            IOException - If there is an error creating the writer.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +put

            +
            +public <T> void put(EntityId entityId,
+                    String family,
+                    String qualifier,
+                    T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            Specified by:
            put in interface KijiPutter
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(EntityId entityId,
+                    String family,
+                    String qualifier,
+                    long timestamp,
+                    T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            Specified by:
            put in interface KijiPutter
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            timestamp - Timestamp, in millisecond since the Epoch.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +increment

            +
            +public KijiCounter increment(EntityId entityId,
+                             String family,
+                             String qualifier,
+                             long amount)
+                      throws IOException
            +
            +
            Atomically increments a counter in a kiji table. + +

            Throws an exception if the specified column is not a counter.

            +

            +

            +
            Specified by:
            increment in interface KijiIncrementer
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row containing the counter.
            family - Column family.
            qualifier - Column qualifier.
            amount - Amount to increment the counter (may be negative). +
            Returns:
            the new counter value, post increment. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteRow

            +
            +public void deleteRow(EntityId entityId)
+               throws IOException
            +
            +
            Deletes an entire row. +

            +

            +
            Specified by:
            deleteRow in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteRow

            +
            +public void deleteRow(EntityId entityId,
+                      long upToTimestamp)
+               throws IOException
            +
            +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +

            +

            +
            Specified by:
            deleteRow in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +public void deleteFamily(EntityId entityId,
+                         String family)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a family. +

            +

            +
            Specified by:
            deleteFamily in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +public void deleteFamily(EntityId entityId,
+                         String family,
+                         long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +

            +

            +
            Specified by:
            deleteFamily in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +public void deleteColumn(EntityId entityId,
+                         String family,
+                         String qualifier)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a column. +

            +

            +
            Specified by:
            deleteColumn in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +public void deleteColumn(EntityId entityId,
+                         String family,
+                         String qualifier,
+                         long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +

            +

            +
            Specified by:
            deleteColumn in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +public void deleteCell(EntityId entityId,
+                       String family,
+                       String qualifier)
+                throws IOException
            +
            +
            Deletes the most recent version of the cell in a column. +

            +

            +
            Specified by:
            deleteCell in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +public void deleteCell(EntityId entityId,
+                       String family,
+                       String qualifier,
+                       long timestamp)
+                throws IOException
            +
            +
            Deletes a single cell with a specified timestamp. +

            +

            +
            Specified by:
            deleteCell in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            timestamp - The timestamp of the cell to delete (use HConstants.LATEST_TIMESTAMP + to delete the most recent cell in the column). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            +
            Specified by:
            flush in interface Flushable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseMetaTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseMetaTable.html new file mode 100644 index 00000000..79f96267 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseMetaTable.html @@ -0,0 +1,1016 @@ + + + + + + + +HBaseMetaTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseMetaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiMetaTable
+      extended by org.kiji.schema.impl.HBaseMetaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTableKeyValueDatabase, KijiTableLayoutDatabase
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseMetaTable
            extends KijiMetaTable
            + + +

            +An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseMetaTable(HTableInterface htable, + KijiSchemaTable schemaTable) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseMetaTable(HTableInterface htable, + KijiTableLayoutDatabase tableLayoutDatabase, + KijiTableKeyValueDatabase tableKeyValueDatabase) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseMetaTable(KijiConfiguration kijiConf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + voiddeleteTable(String table) + +
            +          Remove all metadata, including layouts, for a particular table.
            + voidfromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            + KijiTableLayoutgetTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + List<KijiTableLayout>getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            + NavigableMap<Long,byte[]>getTimedValues(String table, + String key, + int numVersions) + +
            +          Returns a map of values associated with the specified table and key.
            + byte[]getValue(String table, + String key) + +
            +          Returns the most recent value associated with the specified table and key.
            + List<byte[]>getValues(String table, + String key, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key.
            +static voidinstall(HBaseAdmin admin, + KijiConfiguration kijiConfiguration) + +
            +          Install the meta table into a Kiji instance.
            + Set<String>keySet(String table) + +
            +          Returns a set view of keys contained in the map for the specified table.
            + voidkeyValuesFromBackup(String table, + List<KeyValueBackupEntry> tableBackup) + +
            +          Restores all table's key value history from a backup.
            + List<KeyValueBackupEntry>keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + voidlayoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +          Restores a table layout history from a backup.
            + List<TableLayoutBackupEntry>layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            + List<String>listTables() + +
            +          Lists the tables in this Kiji instance.
            +static HTableInterfacenewMetaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates an HTableInterface for the specified table.
            + KijiTableKeyValueDatabaseputValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + voidremoveAllTableLayoutVersions(String table) + +
            +          Removes all layout information for a particular table.
            + voidremoveAllValues(String table) + +
            +          Deletes all key-value pairs associated with the specified table.
            + voidremoveRecentTableLayoutVersions(String table, + int numVersions) + +
            +          Removes the most recent layout information for a given table.
            + voidremoveValues(String table, + String key) + +
            +          Removes all values associated with the specified table and key.
            + Set<String>tableSet() + +
            +          Returns a set view of the tables that have key-value pairs defined.
            + Map<String,TableBackup>toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +static voiduninstall(HBaseAdmin admin, + KijiConfiguration kijiConf) + +
            +          Removes the meta table from HBase.
            + KijiTableLayoutupdateTableLayout(String table, + TableLayoutDesc layoutUpdate) + +
            +          Sets a table's layout.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.KijiMetaTable
            finalize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseMetaTable

            +
            +public HBaseMetaTable(KijiConfiguration kijiConf,
+                      KijiSchemaTable schemaTable,
+                      HTableInterfaceFactory factory)
+               throws IOException
            +
            +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +

            +

            +
            Parameters:
            kijiConf - The Kiji configuration.
            schemaTable - The Kiji schema table.
            factory - HTableInterface factory. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +

            +HBaseMetaTable

            +
            +public HBaseMetaTable(HTableInterface htable,
+                      KijiSchemaTable schemaTable)
+               throws IOException
            +
            +
            Create a connection to a Kiji meta table backed by an HTable within HBase. + +

            This class takes ownership of the HTable. It will be closed when this instance is + closed.

            +

            +

            +
            Parameters:
            htable - The HTable to use for storing Kiji meta data.
            schemaTable - The Kiji schema table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +

            +HBaseMetaTable

            +
            +public HBaseMetaTable(HTableInterface htable,
+                      KijiTableLayoutDatabase tableLayoutDatabase,
+                      KijiTableKeyValueDatabase tableKeyValueDatabase)
            +
            +
            Create a connection to a Kiji meta table backed by an HTable within HBase. + +

            This class takes ownership of the HTable. It will be closed when this instance is + closed.

            +

            +

            +
            Parameters:
            htable - The HTable to use for storing Kiji meta data.
            tableLayoutDatabase - A database of table layouts to delegate layout storage to.
            tableKeyValueDatabase - A database of key-value pairs to delegate metadata storage to.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newMetaTable

            +
            +public static HTableInterface newMetaTable(KijiConfiguration kijiConf,
+                                           HTableInterfaceFactory factory)
+                                    throws IOException
            +
            +
            Creates an HTableInterface for the specified table. +

            +

            +
            Parameters:
            kijiConf - Kiji configuration.
            factory - HTableInterface factory to use. +
            Returns:
            a new HTableInterface for the specified table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteTable

            +
            +public void deleteTable(String table)
+                 throws IOException
            +
            +
            Remove all metadata, including layouts, for a particular table. +

            +

            +
            Specified by:
            deleteTable in class KijiMetaTable
            +
            +
            +
            Parameters:
            table - The name of the kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +updateTableLayout

            +
            +public KijiTableLayout updateTableLayout(String table,
+                                         TableLayoutDesc layoutUpdate)
+                                  throws IOException
            +
            +
            Sets a table's layout. Also calls validateAndAssignLayout(). +

            +

            +
            Parameters:
            table - The name of the Kiji table to affect.
            layoutUpdate - Descriptor for the layout update. +
            Returns:
            the new effective layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout(String table)
+                               throws IOException
            +
            +
            Gets the most recent versions of the layout for a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            The table's layout. +
            Throws: +
            IOException - If there is an error or no such table.
            +
            +
            +
            + +

            +getTableLayoutVersions

            +
            +public List<KijiTableLayout> getTableLayoutVersions(String table,
+                                                    int numVersions)
+                                             throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the table layout. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the layout for the table, sorted by + most-recent-first. If there are no layouts, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedTableLayoutVersions

            +
            +public NavigableMap<Long,KijiTableLayout> getTimedTableLayoutVersions(String table,
+                                                                      int numVersions)
+                                                               throws IOException
            +
            +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values the most recent versions of the layout for the table, and + keys the corresponding timestamps, ordered from most recent first to least recent last. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllTableLayoutVersions

            +
            +public void removeAllTableLayoutVersions(String table)
+                                  throws IOException
            +
            +
            Removes all layout information for a particular table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeRecentTableLayoutVersions

            +
            +public void removeRecentTableLayoutVersions(String table,
+                                            int numVersions)
+                                     throws IOException
            +
            +
            Removes the most recent layout information for a given table. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +listTables

            +
            +public List<String> listTables()
+                        throws IOException
            +
            +
            Lists the tables in this Kiji instance. +

            +

            + +
            Returns:
            The list of table names. +
            Throws: +
            IOException - If the list of tables cannot be retrieved.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Overrides:
            close in class KijiMetaTable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getValue

            +
            +public byte[] getValue(String table,
+                       String key)
+                throws IOException
            +
            +
            Returns the most recent value associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for. +
            Returns:
            The value in the meta table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public KijiTableKeyValueDatabase putValue(String table,
+                                          String key,
+                                          byte[] value)
+                                   throws IOException
            +
            +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +

            +

            +
            Parameters:
            table - The kiji table that this key-value pair will be set with.
            key - The key to associate with the specified value.
            value - The value to associate with the specified key. +
            Returns:
            The same KijiTableKeyValueDatabase. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeValues

            +
            +public void removeValues(String table,
+                         String key)
+                  throws IOException
            +
            +
            Removes all values associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table associated with the metadata.
            key - The metadata key to look up. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +tableSet

            +
            +public Set<String> tableSet()
+                     throws IOException
            +
            +
            Returns a set view of the tables that have key-value pairs defined. +

            +

            + +
            Returns:
            A set of tables that have key-value pairs defined. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keySet

            +
            +public Set<String> keySet(String table)
+                   throws IOException
            +
            +
            Returns a set view of keys contained in the map for the specified table. +

            +

            +
            Parameters:
            table - The table to look up in use keys for. +
            Returns:
            A navigable set of keys used to store meta information for a given table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllValues

            +
            +public void removeAllValues(String table)
+                     throws IOException
            +
            +
            Deletes all key-value pairs associated with the specified table. +

            +

            +
            Parameters:
            table - The table to delete remove key-value pairs for. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +install

            +
            +public static void install(HBaseAdmin admin,
+                           KijiConfiguration kijiConfiguration)
+                    throws IOException
            +
            +
            Install the meta table into a Kiji instance. +

            +

            +
            Parameters:
            admin - The HBase Admin interface for the HBase cluster to install into.
            kijiConfiguration - The Kiji configuration. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(HBaseAdmin admin,
+                             KijiConfiguration kijiConf)
+                      throws IOException
            +
            +
            Removes the meta table from HBase. +

            +

            +
            Parameters:
            admin - The HBase admin object.
            kijiConf - The configuration for the Kiji instance to uninstall. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toBackup

            +
            +public Map<String,TableBackup> toBackup()
+                                 throws IOException
            +
            +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            Specified by:
            toBackup in class KijiMetaTable
            +
            +
            + +
            Returns:
            A map from table names to TableBackup records. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public void fromBackup(Map<String,TableBackup> backup)
+                throws IOException
            +
            +
            Restores metadata from a backup record. This consists of table layouts, schemas, and user + defined key-value pairs. +

            +

            +
            Specified by:
            fromBackup in class KijiMetaTable
            +
            +
            +
            Parameters:
            backup - A map from table name to table backup record. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +layoutsToBackup

            +
            +public List<TableLayoutBackupEntry> layoutsToBackup(String table)
+                                             throws IOException
            +
            +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableLayoutBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public List<byte[]> getValues(String table,
+                              String key,
+                              int numVersions)
+                       throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +

            +

            +
            Parameters:
            table - The Kiji table.
            key - The key to look up associated values for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the values for the specified table and key, + sorted by most-recent-first. If there are no values, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedValues

            +
            +public NavigableMap<Long,byte[]> getTimedValues(String table,
+                                                String key,
+                                                int numVersions)
+                                         throws IOException
            +
            +
            Returns a map of values associated with the specified table and key. The Map + is keyed by timestamp. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values that are the user defined values for the specified key + and table, and keys that correspond to timestamps, ordered from newest to oldest. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesToBackup

            +
            +public List<KeyValueBackupEntry> keyValuesToBackup(String table)
+                                            throws IOException
            +
            +
            Gets a list of the TableKeyValueBackupEntries. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableKeyValueBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesFromBackup

            +
            +public void keyValuesFromBackup(String table,
+                                List<KeyValueBackupEntry> tableBackup)
+                         throws IOException
            +
            +
            Restores all table's key value history from a backup. +

            +

            +
            Parameters:
            table - The name of the kiji table.
            tableBackup - The key values associated with the table to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +layoutsFromBackup

            +
            +public void layoutsFromBackup(String tableName,
+                              List<TableLayoutBackupEntry> tableBackup)
+                       throws IOException
            +
            +
            Description copied from interface: KijiTableLayoutDatabase
            +
            Restores a table layout history from a backup. +

            +

            +
            Parameters:
            tableName - The name of the table to restore layouts for.
            tableBackup - Table layout backup entries to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseSchemaTable.html new file mode 100644 index 00000000..d8507302 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseSchemaTable.html @@ -0,0 +1,912 @@ + + + + + + + +HBaseSchemaTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseSchemaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSchemaTable
+      extended by org.kiji.schema.impl.HBaseSchemaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseSchemaTable
            extends KijiSchemaTable
            + + +

            +

            + Mapping between schema IDs, hashes and Avro schema objects. + This class is thread-safe. +

            + +

            + Schemas are stored in two tables with a single column family named "schema" and that contains + SchemaTableEntry records. One table is indexed by schema hashes (128-bit MD5 hashes of the + schema JSON representation). Other table is indexed by schema IDs (integers >= 0). + + There may be multiple schema IDs for a single schema. +

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.KijiSchemaTable
            KijiSchemaTable.SchemaEntry
            +  + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringSCHEMA_COLUMN_FAMILY + +
            +          The column family in HBase used to store schema entries.
            +static StringSCHEMA_COLUMN_QUALIFIER + +
            +          The column qualifier in HBase used to store schema entries.
            +static StringSCHEMA_COUNTER_ROW_NAME + +
            +          Schema IDs are generated using a counter.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseSchemaTable(HTableInterface hashTable, + HTableInterface idTable, + Lock zkLock) + +
            +          Wrap an existing HBase table assumed to be where the schema data is stored.
            HBaseSchemaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Flushes and closes the KijiSchemaTable.
            +static SchemaTableEntrydecodeSchemaEntry(byte[] bytes) + +
            +          Decodes a binary-encoded Avro schema entry.
            +static byte[]encodeSchemaEntry(SchemaTableEntry avroEntry) + +
            +          Encodes an Avro schema entry into binary.
            +protected  voidfinalize() + +
            +          
            + voidflush() + +
            +          Commits any pending additions to the schema table.
            +static KijiSchemaTable.SchemaEntryfromAvroEntry(SchemaTableEntry avroEntry) + +
            +          Converts an Avro SchemaTableEntry into a SchemaEntry.
            + voidfromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            + BytesKeygetOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            + longgetOrCreateSchemaId(org.apache.avro.Schema schema) + +
            +          Looks up a schema ID given an Avro schema object.
            + org.apache.avro.SchemagetSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            + org.apache.avro.SchemagetSchema(long schemaId) + +
            +          Looks up a schema given an ID.
            +static voidinstall(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static LocknewLock(KijiConfiguration conf, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +static HTableInterfacenewSchemaHashTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema hash table.
            +static HTableInterfacenewSchemaIdTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema ID table.
            +static HTableInterfacenewSchemaV5Table(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema V5 table.
            +static SchemaTableEntrytoAvroEntry(KijiSchemaTable.SchemaEntry entry) + +
            +          Converts a SchemaEntry into an Avro SchemaTableEntry.
            + List<SchemaTableEntry>toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +static voiduninstall(HBaseAdmin admin, + KijiConfiguration kijiConf) + +
            +          Disables and removes the schema table from HBase.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.KijiSchemaTable
            getSchemaHash, hashSchema
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA_COLUMN_FAMILY

            +
            +public static final String SCHEMA_COLUMN_FAMILY
            +
            +
            The column family in HBase used to store schema entries. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +SCHEMA_COLUMN_QUALIFIER

            +
            +public static final String SCHEMA_COLUMN_QUALIFIER
            +
            +
            The column qualifier in HBase used to store schema entries. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +SCHEMA_COUNTER_ROW_NAME

            +
            +public static final String SCHEMA_COUNTER_ROW_NAME
            +
            +
            Schema IDs are generated using a counter. The counter is stored in the schema ID table. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +HBaseSchemaTable

            +
            +public HBaseSchemaTable(KijiConfiguration kijiConf,
+                        HTableInterfaceFactory tableFactory,
+                        LockFactory lockFactory)
+                 throws IOException
            +
            +
            Open a connection to the HBase schema table for a Kiji instance. +

            +

            +
            Parameters:
            kijiConf - The kiji configuration.
            tableFactory - HTableInterface factory.
            lockFactory - Factory for locks. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +

            +HBaseSchemaTable

            +
            +public HBaseSchemaTable(HTableInterface hashTable,
+                        HTableInterface idTable,
+                        Lock zkLock)
+                 throws IOException
            +
            +
            Wrap an existing HBase table assumed to be where the schema data is stored. +

            +

            +
            Parameters:
            hashTable - The HTable that maps schema hashes to schema entries.
            idTable - The HTable that maps schema IDs to schema entries.
            zkLock - Lock protecting the schema tables. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newSchemaV5Table

            +
            +public static HTableInterface newSchemaV5Table(KijiConfiguration conf,
+                                               HTableInterfaceFactory factory)
+                                        throws IOException
            +
            +
            Creates an HTable handle to the schema V5 table. +

            +

            +
            Parameters:
            conf - Kiji/HBase configuration to open the table.
            factory - HTableInterface factory. +
            Returns:
            a new interface for the table storing the schemas up until data layout v5. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +newSchemaHashTable

            +
            +public static HTableInterface newSchemaHashTable(KijiConfiguration conf,
+                                                 HTableInterfaceFactory factory)
+                                          throws IOException
            +
            +
            Creates an HTable handle to the schema hash table. +

            +

            +
            Parameters:
            conf - Kiji/HBase configuration to open the table.
            factory - HTableInterface factory. +
            Returns:
            a new interface for the table storing the mapping from schema hash to schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +newSchemaIdTable

            +
            +public static HTableInterface newSchemaIdTable(KijiConfiguration conf,
+                                               HTableInterfaceFactory factory)
+                                        throws IOException
            +
            +
            Creates an HTable handle to the schema ID table. +

            +

            +
            Parameters:
            conf - Kiji/HBase configuration to open the table.
            factory - HTableInterface factory. +
            Returns:
            a new interface for the table storing the mapping from schema ID to schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +newLock

            +
            +public static Lock newLock(KijiConfiguration conf,
+                           LockFactory factory)
+                    throws IOException
            +
            +
            Creates a lock for a given Kiji instance. +

            +

            +
            Parameters:
            conf - Configuration of the Kiji instance.
            factory - Factory for locks. +
            Returns:
            a lock for the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeSchemaEntry

            +
            +public static SchemaTableEntry decodeSchemaEntry(byte[] bytes)
+                                          throws IOException
            +
            +
            Decodes a binary-encoded Avro schema entry. +

            +

            +
            Parameters:
            bytes - Binary-encoded Avro schema entry. +
            Returns:
            Decoded Avro schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encodeSchemaEntry

            +
            +public static byte[] encodeSchemaEntry(SchemaTableEntry avroEntry)
+                                throws IOException
            +
            +
            Encodes an Avro schema entry into binary. +

            +

            +
            Parameters:
            avroEntry - Avro schema entry to encode. +
            Returns:
            Binary-encoded Avro schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getOrCreateSchemaId

            +
            +public long getOrCreateSchemaId(org.apache.avro.Schema schema)
+                         throws IOException
            +
            +
            Looks up a schema ID given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            Specified by:
            getOrCreateSchemaId in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schema - The full schema to store in the table. +
            Returns:
            The schema ID. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getOrCreateSchemaHash

            +
            +public BytesKey getOrCreateSchemaHash(org.apache.avro.Schema schema)
+                               throws IOException
            +
            +
            Looks up a schema hash given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            Specified by:
            getOrCreateSchemaHash in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schema - Avro schema to look up. +
            Returns:
            The schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +fromAvroEntry

            +
            +public static KijiSchemaTable.SchemaEntry fromAvroEntry(SchemaTableEntry avroEntry)
            +
            +
            Converts an Avro SchemaTableEntry into a SchemaEntry. +

            +

            +
            Parameters:
            avroEntry - Avro SchemaTableEntry +
            Returns:
            an equivalent SchemaEntry
            +
            +
            +
            + +

            +toAvroEntry

            +
            +public static SchemaTableEntry toAvroEntry(KijiSchemaTable.SchemaEntry entry)
            +
            +
            Converts a SchemaEntry into an Avro SchemaTableEntry. +

            +

            +
            Parameters:
            entry - a SchemaEntry. +
            Returns:
            an equivalent Avro SchemaTableEntry.
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema(long schemaId)
+                                 throws IOException
            +
            +
            Looks up a schema given an ID. +

            +

            +
            Specified by:
            getSchema in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schemaId - Schema ID to look up. +
            Returns:
            Avro schema, or null if the schema ID is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema(BytesKey schemaHash)
+                                 throws IOException
            +
            +
            Looks up a schema given a hash. +

            +

            +
            Specified by:
            getSchema in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schemaHash - Schema hash to look up. +
            Returns:
            Avro schema, or null if the schema hash is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            Commits any pending additions to the schema table. + + Default implementation is blank as flushing is not generally a vital operation +

            +

            +
            Overrides:
            flush in class KijiSchemaTable
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            Flushes and closes the KijiSchemaTable. No other methods may be called after this. +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in class KijiSchemaTable
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +install

            +
            +public static void install(HBaseAdmin admin,
+                           KijiConfiguration kijiConf,
+                           HTableInterfaceFactory tableFactory,
+                           LockFactory lockFactory)
+                    throws IOException
            +
            +
            Install the schema table into a Kiji instance. +

            +

            +
            Parameters:
            admin - The HBase Admin interface for the HBase cluster to install into.
            kijiConf - The Kiji configuration.
            tableFactory - HTableInterface factory.
            lockFactory - Factory for locks. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(HBaseAdmin admin,
+                             KijiConfiguration kijiConf)
+                      throws IOException
            +
            +
            Disables and removes the schema table from HBase. +

            +

            +
            Parameters:
            admin - The HBase Admin object.
            kijiConf - The configuration for the kiji instance to remove. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toBackup

            +
            +public List<SchemaTableEntry> toBackup()
+                                throws IOException
            +
            +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            Specified by:
            toBackup in class KijiSchemaTable
            +
            +
            + +
            Returns:
            A list of schema table entries. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public void fromBackup(List<SchemaTableEntry> backup)
+                throws IOException
            +
            +
            Restores the schema entries from the specified backup record. +

            +

            +
            Specified by:
            fromBackup in class KijiSchemaTable
            +
            +
            +
            Parameters:
            backup - The schema entries from a MetadataBackup record. This consist of the schema + definition, schema id, and schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseSystemTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseSystemTable.html new file mode 100644 index 00000000..3b52271f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseSystemTable.html @@ -0,0 +1,629 @@ + + + + + + + +HBaseSystemTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseSystemTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSystemTable
+      extended by org.kiji.schema.impl.HBaseSystemTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseSystemTable
            extends KijiSystemTable
            + + +

            +

            The Kiji system table that is stored in HBase.

            + +

            The system table (a Kiji system table) is a simple key-value store for system-wide + properties of a Kiji installation. There is a single column family "value". For a + key-value property (K,V), the key K is stored as the row key in the HTable, + and the value V is stored in the "value:" column.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringDEFAULTS_PROPERTIES_FILE + +
            +          The name of the file that stores the current system table defaults that are loaded + at installation time.
            +static StringKEY_DATA_VERSION + +
            +          The HBase row key that stores the installed Kiji data format version.
            +static StringVALUE_COLUMN_FAMILY + +
            +          The HBase column family that stores the value of the properties.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseSystemTable(HTableInterface htable) + +
            +          Wrap an existing HTable connection that is assumed to be the table that stores the + Kiji instance properties.
            HBaseSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Connect to the HBase system table inside a Kiji instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +protected  voidfinalize() + +
            +          
            + StringgetDataVersion() + +
            +          Gets the version of kiji installed.
            + byte[]getValue(String key) + +
            +          Gets the value associated with a property key.
            +static voidinstall(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Installs a Kiji system table into a running HBase instance.
            +protected  voidloadDefaults(String resource) + +
            +          Load the system table with the key/value pairs from the properties file named by resource.
            +static HTableInterfacenewSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates a new HTableInterface for the Kiji system table.
            + voidputValue(String key, + byte[] value) + +
            +          Sets a value for a property key, which creates it if it doesn't exist.
            + voidsetDataVersion(String version) + +
            +          Sets the version of kiji installed.
            +static voiduninstall(HBaseAdmin admin, + KijiConfiguration kijiConf) + +
            +          Disables and delete the system table from HBase.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +VALUE_COLUMN_FAMILY

            +
            +public static final String VALUE_COLUMN_FAMILY
            +
            +
            The HBase column family that stores the value of the properties. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KEY_DATA_VERSION

            +
            +public static final String KEY_DATA_VERSION
            +
            +
            The HBase row key that stores the installed Kiji data format version. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULTS_PROPERTIES_FILE

            +
            +public static final String DEFAULTS_PROPERTIES_FILE
            +
            +
            The name of the file that stores the current system table defaults that are loaded + at installation time. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +HBaseSystemTable

            +
            +public HBaseSystemTable(KijiConfiguration kijiConf,
+                        HTableInterfaceFactory factory)
+                 throws IOException
            +
            +
            Connect to the HBase system table inside a Kiji instance. +

            +

            +
            Parameters:
            kijiConf - The Kiji configuration.
            factory - HTableInterface factory. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +

            +HBaseSystemTable

            +
            +public HBaseSystemTable(HTableInterface htable)
            +
            +
            Wrap an existing HTable connection that is assumed to be the table that stores the + Kiji instance properties. +

            +

            +
            Parameters:
            htable - An HTable to wrap.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newSystemTable

            +
            +public static HTableInterface newSystemTable(KijiConfiguration kijiConf,
+                                             HTableInterfaceFactory factory)
+                                      throws IOException
            +
            +
            Creates a new HTableInterface for the Kiji system table. +

            +

            +
            Parameters:
            kijiConf - Kiji configuration.
            factory - HTableInterface factory. +
            Returns:
            a new HTableInterface for the Kiji system table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getDataVersion

            +
            +public String getDataVersion()
+                      throws IOException
            +
            +
            Gets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            Specified by:
            getDataVersion in class KijiSystemTable
            +
            +
            + +
            Returns:
            the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +setDataVersion

            +
            +public void setDataVersion(String version)
+                    throws IOException
            +
            +
            Sets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            Specified by:
            setDataVersion in class KijiSystemTable
            +
            +
            +
            Parameters:
            version - the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +getValue

            +
            +public byte[] getValue(String key)
+                throws IOException
            +
            +
            Gets the value associated with a property key. +

            +

            +
            Specified by:
            getValue in class KijiSystemTable
            +
            +
            +
            Parameters:
            key - The property key to look up. +
            Returns:
            The value in the HBase table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public void putValue(String key,
+                     byte[] value)
+              throws IOException
            +
            +
            Sets a value for a property key, which creates it if it doesn't exist. +

            +

            +
            Specified by:
            putValue in class KijiSystemTable
            +
            +
            +
            Parameters:
            key - The property key to set.
            value - The value of the property. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +loadDefaults

            +
            +protected void loadDefaults(String resource)
+                     throws IOException
            +
            +
            Load the system table with the key/value pairs from the properties file named by resource. +

            +

            +
            Parameters:
            resource - The name of the properties resource holding the defaults. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +install

            +
            +public static void install(HBaseAdmin admin,
+                           KijiConfiguration kijiConf,
+                           HTableInterfaceFactory factory)
+                    throws IOException
            +
            +
            Installs a Kiji system table into a running HBase instance. +

            +

            +
            Parameters:
            admin - The HBase cluster to install into.
            kijiConf - The Kiji configuration.
            factory - HTableInterface factory. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(HBaseAdmin admin,
+                             KijiConfiguration kijiConf)
+                      throws IOException
            +
            +
            Disables and delete the system table from HBase. +

            +

            +
            Parameters:
            admin - The HBase admin object.
            kijiConf - The configuration for the kiji instance to remove. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html new file mode 100644 index 00000000..fda2d700 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html @@ -0,0 +1,590 @@ + + + + + + + +HBaseTableKeyValueDatabase (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseTableKeyValueDatabase

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseTableKeyValueDatabase
+
            +
            +
            All Implemented Interfaces:
            KijiTableKeyValueDatabase
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseTableKeyValueDatabase
            extends Object
            implements KijiTableKeyValueDatabase
            + + +

            +Manages key-value pairs on a per table basis. Storage of these key-value pairs is provided by + a column family of an HTable. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static org.slf4j.LoggerLOG + +
            +           
            +  + + + + + + + + + + +
            +Constructor Summary
            HBaseTableKeyValueDatabase(HTableInterface hTable, + String metaFamily) + +
            +          This class manages the storage and retrieval of key-value pairs on a per table basis.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + NavigableMap<Long,byte[]>getTimedValues(String table, + String key, + int numVersions) + +
            +          Returns a map of values associated with the specified table and key.
            + byte[]getValue(String table, + String key) + +
            +          Returns the most recent value associated with the specified table and key.
            + List<byte[]>getValues(String table, + String key, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key.
            + Set<String>keySet(String table) + +
            +          Returns a set view of keys contained in the map for the specified table.
            + voidkeyValuesFromBackup(String tableName, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            + List<KeyValueBackupEntry>keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + KijiTableKeyValueDatabaseputValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + voidremoveAllValues(String table) + +
            +          Deletes all key-value pairs associated with the specified table.
            + voidremoveValues(String table, + String key) + +
            +          Removes all values associated with the specified table and key.
            + Set<String>tableSet() + +
            +          Returns a set view of the tables that have key-value pairs defined.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +LOG

            +
            +public static final org.slf4j.Logger LOG
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +HBaseTableKeyValueDatabase

            +
            +public HBaseTableKeyValueDatabase(HTableInterface hTable,
+                                  String metaFamily)
            +
            +
            This class manages the storage and retrieval of key-value pairs on a per table basis. It is + backed by a column family in HBase specified by metaFamily, in the table specified by table. +

            +

            +
            Parameters:
            hTable - The table to store the key-value information in.
            metaFamily - the name of the column family to use.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getValue

            +
            +public byte[] getValue(String table,
+                       String key)
+                throws IOException
            +
            +
            Returns the most recent value associated with the specified table and key. +

            +

            +
            Specified by:
            getValue in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for. +
            Returns:
            The value in the meta table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public List<byte[]> getValues(String table,
+                              String key,
+                              int numVersions)
+                       throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +

            +

            +
            Specified by:
            getValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The Kiji table.
            key - The key to look up associated values for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the values for the specified table and key, + sorted by most-recent-first. If there are no values, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedValues

            +
            +public NavigableMap<Long,byte[]> getTimedValues(String table,
+                                                String key,
+                                                int numVersions)
+                                         throws IOException
            +
            +
            Returns a map of values associated with the specified table and key. The Map + is keyed by timestamp. +

            +

            +
            Specified by:
            getTimedValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values that are the user defined values for the specified key + and table, and keys that correspond to timestamps, ordered from newest to oldest. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public KijiTableKeyValueDatabase putValue(String table,
+                                          String key,
+                                          byte[] value)
+                                   throws IOException
            +
            +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +

            +

            +
            Specified by:
            putValue in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table that this key-value pair will be set with.
            key - The key to associate with the specified value.
            value - The value to associate with the specified key. +
            Returns:
            The same KijiTableKeyValueDatabase. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeValues

            +
            +public void removeValues(String table,
+                         String key)
+                  throws IOException
            +
            +
            Removes all values associated with the specified table and key. +

            +

            +
            Specified by:
            removeValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table associated with the metadata.
            key - The metadata key to look up. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keySet

            +
            +public Set<String> keySet(String table)
+                   throws IOException
            +
            +
            Returns a set view of keys contained in the map for the specified table. +

            +

            +
            Specified by:
            keySet in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The table to look up in use keys for. +
            Returns:
            A navigable set of keys used to store meta information for a given table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +tableSet

            +
            +public Set<String> tableSet()
+                     throws IOException
            +
            +
            Returns a set view of the tables that have key-value pairs defined. +

            +

            +
            Specified by:
            tableSet in interface KijiTableKeyValueDatabase
            +
            +
            + +
            Returns:
            A set of tables that have key-value pairs defined. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllValues

            +
            +public void removeAllValues(String table)
+                     throws IOException
            +
            +
            Deletes all key-value pairs associated with the specified table. +

            +

            +
            Specified by:
            removeAllValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The table to delete remove key-value pairs for. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesToBackup

            +
            +public List<KeyValueBackupEntry> keyValuesToBackup(String table)
+                                            throws IOException
            +
            +
            Gets a list of the TableKeyValueBackupEntries. +

            +

            +
            Specified by:
            keyValuesToBackup in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableKeyValueBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesFromBackup

            +
            +public void keyValuesFromBackup(String tableName,
+                                List<KeyValueBackupEntry> keyValues)
+                         throws IOException
            +
            +
            Restores all table's key value history from a backup. +

            +

            +
            Specified by:
            keyValuesFromBackup in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            tableName - The name of the kiji table.
            keyValues - The key values associated with the table to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseTableRecordReader.html new file mode 100644 index 00000000..7e25d750 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HBaseTableRecordReader.html @@ -0,0 +1,301 @@ + + + + + + + +HBaseTableRecordReader (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseTableRecordReader

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.RecordReader<ImmutableBytesWritable,Result>
+      extended by org.apache.hadoop.hbase.mapreduce.TableRecordReader
+          extended by org.kiji.schema.impl.HBaseTableRecordReader
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseTableRecordReader
            extends TableRecordReader
            + + +

            +A record reader that reads from a HBase table that reports progress correctly. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseTableRecordReader(RowKeyFormat rowKeyFormat) + +
            +          Constructs a new record reader.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + floatgetProgress() + +
            +           
            + voidsetScan(Scan scan) + +
            +           
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.hbase.mapreduce.TableRecordReader
            close, getCurrentKey, getCurrentValue, init, initialize, nextKeyValue, restart, setHTable
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseTableRecordReader

            +
            +public HBaseTableRecordReader(RowKeyFormat rowKeyFormat)
            +
            +
            Constructs a new record reader. +

            +

            +
            Parameters:
            rowKeyFormat - The row key encoding.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +setScan

            +
            +public void setScan(Scan scan)
            +
            +
            +
            Overrides:
            setScan in class TableRecordReader
            +
            +
            +
            +
            +
            +
            + +

            +getProgress

            +
            +public float getProgress()
            +
            +
            +
            Overrides:
            getProgress in class TableRecordReader
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HColumnDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HColumnDescriptorComparator.html new file mode 100644 index 00000000..7c605bc3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HColumnDescriptorComparator.html @@ -0,0 +1,276 @@ + + + + + + + +HColumnDescriptorComparator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HColumnDescriptorComparator

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HColumnDescriptorComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator<HColumnDescriptor>
            +
            +
            +
            +
            @ApiAudience.Private
+public class HColumnDescriptorComparator
            extends Object
            implements Comparator<HColumnDescriptor>
            + + +

            +Comparator for HColumnDescriptors. They are sorted by name, then + by max versions, ttl, and whether it is in memory. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HColumnDescriptorComparator() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + intcompare(HColumnDescriptor o1, + HColumnDescriptor o2) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

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

            +HColumnDescriptorComparator

            +
            +public HColumnDescriptorComparator()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(HColumnDescriptor o1,
+                   HColumnDescriptor o2)
            +
            +
            +
            Specified by:
            compare in interface Comparator<HColumnDescriptor>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HTableDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HTableDescriptorComparator.html new file mode 100644 index 00000000..1903b9c1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HTableDescriptorComparator.html @@ -0,0 +1,304 @@ + + + + + + + +HTableDescriptorComparator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HTableDescriptorComparator

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HTableDescriptorComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator<HTableDescriptor>
            +
            +
            +
            +
            @ApiAudience.Private
+public class HTableDescriptorComparator
            extends Object
            implements Comparator<HTableDescriptor>
            + + +

            +Compares HTableDescriptors. They + are equal if they have the same HTable name with the same column + families. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HTableDescriptorComparator() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + intcompare(HTableDescriptor o1, + HTableDescriptor o2) + +
            +           
            +static HTableDescriptormakeEmptyTableDescriptor(KijiManagedHBaseTableName hbaseTableName) + +
            +          Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout().
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

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

            +HTableDescriptorComparator

            +
            +public HTableDescriptorComparator()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(HTableDescriptor o1,
+                   HTableDescriptor o2)
            +
            +
            +
            Specified by:
            compare in interface Comparator<HTableDescriptor>
            +
            +
            +
            +
            +
            +
            + +

            +makeEmptyTableDescriptor

            +
            +public static HTableDescriptor makeEmptyTableDescriptor(KijiManagedHBaseTableName hbaseTableName)
            +
            +
            Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout(). +

            +

            +
            +
            +
            +
            Parameters:
            hbaseTableName - the HBase table name being represented by this "empty table." +
            Returns:
            an HTableDescriptor that represents a table with no column families.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HTableInterfaceFactory.html new file mode 100644 index 00000000..6d951083 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HTableInterfaceFactory.html @@ -0,0 +1,225 @@ + + + + + + + +HTableInterfaceFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Interface HTableInterfaceFactory

            +
            +
            All Known Implementing Classes:
            DefaultHTableInterfaceFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public interface HTableInterfaceFactory
            + + +

            +Factory for HTableInterface instances. + + This interface exists because the HBase HTableInstanceFactory doesn't throw IOException. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + HTableInterfacecreate(Configuration conf, + String hbaseTableName) + +
            +          Creates a new HTableInterface instance.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +HTableInterface create(Configuration conf,
+                       String hbaseTableName)
+                       throws IOException
            +
            +
            Creates a new HTableInterface instance. +

            +

            +
            Parameters:
            conf - The configuration for the HBase cluster.
            hbaseTableName - The name of the HBase table to create a connection to. +
            Returns:
            a new HTableInterface for the specified table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HashPrefixedEntityId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HashPrefixedEntityId.html new file mode 100644 index 00000000..e4405d44 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HashPrefixedEntityId.html @@ -0,0 +1,363 @@ + + + + + + + +HashPrefixedEntityId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HashPrefixedEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.HashPrefixedEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public final class HashPrefixedEntityId
            extends EntityId
            + + +

            +Implements the hash-prefixed row key format. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static HashPrefixedEntityIdfromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified HBase row key.
            +static HashPrefixedEntityIdfromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified Kiji row key.
            + RowKeyFormatgetFormat() + +
            +          
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + byte[]getKijiRowKey() + +
            +          
            +static byte[]hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +fromKijiRowKey

            +
            +public static HashPrefixedEntityId fromKijiRowKey(byte[] kijiRowKey,
+                                                  RowKeyFormat format)
            +
            +
            Creates a HashPrefixedEntityId from the specified Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key.
            format - Row key hashing specification. +
            Returns:
            a new HashPrefixedEntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public static HashPrefixedEntityId fromHBaseRowKey(byte[] hbaseRowKey,
+                                                   RowKeyFormat format)
            +
            +
            Creates a HashPrefixedEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key.
            format - Row key hashing specification. +
            Returns:
            a new HashedEntityId with the specified HBase row key.
            +
            +
            +
            + +

            +hashKijiRowKey

            +
            +public static byte[] hashKijiRowKey(RowKeyFormat format,
+                                    byte[] kijiRowKey)
            +
            +
            Hashes a Kiji row key. +

            +

            +
            Parameters:
            format - Hashing specification.
            kijiRowKey - Kiji row key. +
            Returns:
            a hash of the Kiji row key.
            +
            +
            +
            + +

            +getFormat

            +
            +public RowKeyFormat getFormat()
            +
            +
            +

            +

            +
            Specified by:
            getFormat in class EntityId
            +
            +
            + +
            Returns:
            the format of this row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public byte[] getKijiRowKey()
            +
            +
            +

            +

            +
            Specified by:
            getKijiRowKey in class EntityId
            +
            +
            + +
            Returns:
            the Kiji row key as a byte array.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HashedEntityId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HashedEntityId.html new file mode 100644 index 00000000..0dde27ce --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/HashedEntityId.html @@ -0,0 +1,363 @@ + + + + + + + +HashedEntityId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HashedEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.HashedEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public final class HashedEntityId
            extends EntityId
            + + +

            +Implements the hashed row key format. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static HashedEntityIdfromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified HBase row key.
            +static HashedEntityIdfromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified Kiji row key.
            + RowKeyFormatgetFormat() + +
            +          
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + byte[]getKijiRowKey() + +
            +          
            +static byte[]hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +fromKijiRowKey

            +
            +public static HashedEntityId fromKijiRowKey(byte[] kijiRowKey,
+                                            RowKeyFormat format)
            +
            +
            Creates a HashedEntityId from the specified Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key.
            format - Row key hashing specification. +
            Returns:
            a new HashedEntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public static HashedEntityId fromHBaseRowKey(byte[] hbaseRowKey,
+                                             RowKeyFormat format)
            +
            +
            Creates a HashedEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key.
            format - Row key hashing specification. +
            Returns:
            a new HashedEntityId with the specified HBase row key.
            +
            +
            +
            + +

            +hashKijiRowKey

            +
            +public static byte[] hashKijiRowKey(RowKeyFormat format,
+                                    byte[] kijiRowKey)
            +
            +
            Hashes a Kiji row key. +

            +

            +
            Parameters:
            format - Hashing specification.
            kijiRowKey - Kiji row key to hash. +
            Returns:
            a hash of the given Kiji row key.
            +
            +
            +
            + +

            +getFormat

            +
            +public RowKeyFormat getFormat()
            +
            +
            +

            +

            +
            Specified by:
            getFormat in class EntityId
            +
            +
            + +
            Returns:
            the format of this row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public byte[] getKijiRowKey()
            +
            +
            +

            +

            +
            Specified by:
            getKijiRowKey in class EntityId
            +
            +
            + +
            Returns:
            the Kiji row key as a byte array.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/InvalidColumnNameException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/InvalidColumnNameException.html new file mode 100644 index 00000000..3c5a1590 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/InvalidColumnNameException.html @@ -0,0 +1,251 @@ + + + + + + + +InvalidColumnNameException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class InvalidColumnNameException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.impl.InvalidColumnNameException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Private
+public final class InvalidColumnNameException
            extends RuntimeException
            + + +

            +Thrown when kiji encounters a column name that is not valid. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            InvalidColumnNameException(String message) + +
            +          Creates a new InvalidColumnNameException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +InvalidColumnNameException

            +
            +public InvalidColumnNameException(String message)
            +
            +
            Creates a new InvalidColumnNameException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/KijiDataBuffer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/KijiDataBuffer.html new file mode 100644 index 00000000..27254f7a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/KijiDataBuffer.html @@ -0,0 +1,370 @@ + + + + + + + +KijiDataBuffer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class KijiDataBuffer<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.KijiDataBuffer<T>
+
            +
            +
            Type Parameters:
            T - The type of the elements being stored in the buffer.
            +
            +
            +
            @ApiAudience.Private
+public class KijiDataBuffer<T>
            extends Object
            + + +

            +A buffer used to hold data entries waiting to be written to a KijiTable. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiDataBuffer() + +
            +          Creates an instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataBuffer<T>add(EntityId id, + T value) + +
            +          Adds a buffer element to the buffer and associates it with the specified entity.
            + voidclear() + +
            +          Clears the buffer by removing all elements stored in it.
            +protected  List<T>getBuffer(EntityId id) + +
            +          Gets the list of buffer elements associated with the specified entity.
            + Collection<List<T>>getBuffers() + +
            +           
            + Set<Map.Entry<EntityId,List<T>>>getEntries() + +
            +           
            + intsize() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiDataBuffer

            +
            +public KijiDataBuffer()
            +
            +
            Creates an instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +add

            +
            +public KijiDataBuffer<T> add(EntityId id,
+                             T value)
            +
            +
            Adds a buffer element to the buffer and associates it with the specified entity. +

            +

            +
            Parameters:
            id - The entity id.
            value - The buffer element to add to the buffer. +
            Returns:
            A reference to this to allow chaining of add statements.
            +
            +
            +
            + +

            +clear

            +
            +public void clear()
            +
            +
            Clears the buffer by removing all elements stored in it. +

            +

            +
            +
            +
            +
            + +

            +getBuffer

            +
            +protected List<T> getBuffer(EntityId id)
            +
            +
            Gets the list of buffer elements associated with the specified entity. +

            +

            +
            Parameters:
            id - The entity id. +
            Returns:
            The list of buffer elements used for buffering.
            +
            +
            +
            + +

            +getBuffers

            +
            +public Collection<List<T>> getBuffers()
            +
            +
            + +
            Returns:
            The elements stored in this buffer grouped by their entityId.
            +
            +
            +
            + +

            +getEntries

            +
            +public Set<Map.Entry<EntityId,List<T>>> getEntries()
            +
            +
            + +
            Returns:
            The Map.Entrys that are stored in the buffer.
            +
            +
            +
            + +

            +size

            +
            +public int size()
            +
            +
            + +
            Returns:
            The number of elements stored in this buffer.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/MetadataRestorer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/MetadataRestorer.html new file mode 100644 index 00000000..6ec44848 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/MetadataRestorer.html @@ -0,0 +1,317 @@ + + + + + + + +MetadataRestorer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class MetadataRestorer

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.MetadataRestorer
+
            +
            +
            +
            public class MetadataRestorer
            extends Object
            + + +

            +Metadata restorer backups up meta info to MetadataBackup records and can restore metadata to the + meta and schema tables. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            MetadataRestorer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidexportMetadata(String outputFile, + Kiji kiji) + +
            +          Exports all Kiji metadata to an Avro file with the specified filename.
            + voidrestoreSchemas(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all SchemaTable entries from the metadata backup.
            + voidrestoreTables(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all tables from the metadata backup into the running Kiji instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MetadataRestorer

            +
            +public MetadataRestorer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +exportMetadata

            +
            +public void exportMetadata(String outputFile,
+                           Kiji kiji)
+                    throws IOException
            +
            +
            Exports all Kiji metadata to an Avro file with the specified filename. +

            +

            +
            Parameters:
            outputFile - the output filename. This file must not exist.
            kiji - the Kiji instance to backup. +
            Throws: +
            IOException - when an error communicating with HBase or the filesystem occurs.
            +
            +
            +
            + +

            +restoreTables

            +
            +public void restoreTables(MetadataBackup backup,
+                          Kiji kiji)
+                   throws IOException
            +
            +
            Restores all tables from the metadata backup into the running Kiji instance. +

            +

            +
            Parameters:
            backup - the deserialized backup of the metadata.
            kiji - the connected Kiji instance. +
            Throws: +
            IOException - if there is an error communicating with HBase.
            +
            +
            +
            + +

            +restoreSchemas

            +
            +public void restoreSchemas(MetadataBackup backup,
+                           Kiji kiji)
+                    throws IOException
            +
            +
            Restores all SchemaTable entries from the metadata backup. +

            +

            +
            Parameters:
            backup - the deserialized backup of the metadata.
            kiji - the connected Kiji instance. +
            Throws: +
            IOException - if there is an error communicating with HBase.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/RawEntityId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/RawEntityId.html new file mode 100644 index 00000000..75ef1f32 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/RawEntityId.html @@ -0,0 +1,372 @@ + + + + + + + +RawEntityId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class RawEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.RawEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public final class RawEntityId
            extends EntityId
            + + +

            +Implements the raw row key format. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            RawEntityId(byte[] rowKey) + +
            +          Creates a raw entity ID.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static RawEntityIdfromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates a RawEntityId from the specified HBase row key.
            +static RawEntityIdfromKijiRowKey(byte[] kijiRowKey) + +
            +          Creates a RawEntityId from the specified Kiji row key.
            + RowKeyFormatgetFormat() + +
            +          
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + byte[]getKijiRowKey() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +RawEntityId

            +
            +public RawEntityId(byte[] rowKey)
            +
            +
            Creates a raw entity ID. +

            +

            +
            Parameters:
            rowKey - Kiji/HBase row key (both row keys are identical).
            +
            + + + + + + + + +
            +Method Detail
            + +

            +fromKijiRowKey

            +
            +public static RawEntityId fromKijiRowKey(byte[] kijiRowKey)
            +
            +
            Creates a RawEntityId from the specified Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key. +
            Returns:
            a new RawEntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public static RawEntityId fromHBaseRowKey(byte[] hbaseRowKey)
            +
            +
            Creates a RawEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key. +
            Returns:
            a new RawEntityId with the specified HBase row key.
            +
            +
            +
            + +

            +getFormat

            +
            +public RowKeyFormat getFormat()
            +
            +
            +

            +

            +
            Specified by:
            getFormat in class EntityId
            +
            +
            + +
            Returns:
            the format of this row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public byte[] getKijiRowKey()
            +
            +
            +

            +

            +
            Specified by:
            getKijiRowKey in class EntityId
            +
            +
            + +
            Returns:
            the Kiji row key as a byte array.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/SpecificCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/SpecificCellDecoder.html new file mode 100644 index 00000000..9060c5ff --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/SpecificCellDecoder.html @@ -0,0 +1,290 @@ + + + + + + + +SpecificCellDecoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class SpecificCellDecoder<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellDecoder<T>
+      extended by org.kiji.schema.impl.SpecificCellDecoder<T>
+
            +
            +
            Type Parameters:
            T - The type of the decoded data.
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<T>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class SpecificCellDecoder<T>
            extends AvroCellDecoder<T>
            + + +

            +Decodes cells encoded using Avro into specific types. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            SpecificCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates specific Avro types.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  org.apache.avro.io.DatumReader<T>createDatumReader(org.apache.avro.Schema writer, + org.apache.avro.Schema reader) + +
            +          Factory for DatumReader instances.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.impl.AvroCellDecoder
            decodeAvro, decodeCell, decodeValue, getPayload
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +SpecificCellDecoder

            +
            +public SpecificCellDecoder(CellSpec cellSpec)
+                    throws IOException
            +
            +
            Initializes a cell decoder that creates specific Avro types. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createDatumReader

            +
            +protected org.apache.avro.io.DatumReader<T> createDatumReader(org.apache.avro.Schema writer,
+                                                              org.apache.avro.Schema reader)
            +
            +
            Factory for DatumReader instances. + + Sub-classes must create DatumReader implementations for specific or generic records. +

            +

            +
            Specified by:
            createDatumReader in class AvroCellDecoder<T>
            +
            +
            +
            Parameters:
            writer - Writer schema.
            reader - Reader schema. +
            Returns:
            a new DatumReader instance for the specified writer/reader schema combination.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/AbstractKijiTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/AbstractKijiTable.html new file mode 100644 index 00000000..f08a6fe6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/AbstractKijiTable.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.AbstractKijiTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.AbstractKijiTable

            +
            + + + + + + + + + +
            +Packages that use AbstractKijiTable
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of AbstractKijiTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of AbstractKijiTable in org.kiji.schema.impl
            + classHBaseKijiTable + +
            +          A KijiTable that exposes the underlying HBase implementation.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/AvroCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/AvroCellDecoder.html new file mode 100644 index 00000000..57383b07 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/AvroCellDecoder.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.AvroCellDecoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.AvroCellDecoder

            +
            + + + + + + + + + +
            +Packages that use AvroCellDecoder
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of AvroCellDecoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Subclasses of AvroCellDecoder in org.kiji.schema.impl
            + classGenericCellDecoder<T> + +
            +          Decodes cells encoded using Avro into generic types.
            + classSpecificCellDecoder<T> + +
            +          Decodes cells encoded using Avro into specific types.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/AvroCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/AvroCellEncoder.html new file mode 100644 index 00000000..f44ed095 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/AvroCellEncoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.AvroCellEncoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.AvroCellEncoder

            +
            +No usage of org.kiji.schema.impl.AvroCellEncoder +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/CounterCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/CounterCellDecoder.html new file mode 100644 index 00000000..61ac2dd9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/CounterCellDecoder.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.CounterCellDecoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.CounterCellDecoder

            +
            + + + + + + + + + +
            +Packages that use CounterCellDecoder
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of CounterCellDecoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return CounterCellDecoder
            +static CounterCellDecoderCounterCellDecoder.get() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/CounterCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/CounterCellEncoder.html new file mode 100644 index 00000000..ce1b7337 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/CounterCellEncoder.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.CounterCellEncoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.CounterCellEncoder

            +
            + + + + + + + + + +
            +Packages that use CounterCellEncoder
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of CounterCellEncoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return CounterCellEncoder
            +static CounterCellEncoderCounterCellEncoder.get() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultHBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultHBaseAdminFactory.html new file mode 100644 index 00000000..da2039ed --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultHBaseAdminFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultHBaseAdminFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultHBaseAdminFactory

            +
            +No usage of org.kiji.schema.impl.DefaultHBaseAdminFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultHBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultHBaseFactory.html new file mode 100644 index 00000000..58222b4d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultHBaseFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultHBaseFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultHBaseFactory

            +
            +No usage of org.kiji.schema.impl.DefaultHBaseFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultHTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultHTableInterfaceFactory.html new file mode 100644 index 00000000..52457fa7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultHTableInterfaceFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultHTableInterfaceFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultHTableInterfaceFactory

            +
            +No usage of org.kiji.schema.impl.DefaultHTableInterfaceFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultKijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultKijiCellEncoderFactory.html new file mode 100644 index 00000000..3a25d58b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultKijiCellEncoderFactory.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultKijiCellEncoderFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultKijiCellEncoderFactory

            +
            + + + + + + + + + +
            +Packages that use DefaultKijiCellEncoderFactory
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of DefaultKijiCellEncoderFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return DefaultKijiCellEncoderFactory
            +static DefaultKijiCellEncoderFactoryDefaultKijiCellEncoderFactory.get() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultKijiCounter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultKijiCounter.html new file mode 100644 index 00000000..83971619 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultKijiCounter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultKijiCounter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultKijiCounter

            +
            +No usage of org.kiji.schema.impl.DefaultKijiCounter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html new file mode 100644 index 00000000..206c7ae7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultKijiTableFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultKijiTableFactory

            +
            +No usage of org.kiji.schema.impl.DefaultKijiTableFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/GenericCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/GenericCellDecoder.html new file mode 100644 index 00000000..d91c1f70 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/GenericCellDecoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.GenericCellDecoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.GenericCellDecoder

            +
            +No usage of org.kiji.schema.impl.GenericCellDecoder +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseAdminFactory.html new file mode 100644 index 00000000..72f89683 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseAdminFactory.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Interface org.kiji.schema.impl.HBaseAdminFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.impl.HBaseAdminFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseAdminFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseAdminFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return HBaseAdminFactory
            + HBaseAdminFactoryHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            +  +

            + + + + + +
            +Uses of HBaseAdminFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement HBaseAdminFactory
            + classDefaultHBaseAdminFactory + +
            +          Factory for HBaseAdmin that creates concrete HBaseAdmin instances.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HBaseAdminFactory
            +static HBaseAdminFactoryDefaultHBaseAdminFactory.get() + +
            +           
            + HBaseAdminFactoryDefaultHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html new file mode 100644 index 00000000..3d237659 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseDataRequestAdapter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseDataRequestAdapter

            +
            +No usage of org.kiji.schema.impl.HBaseDataRequestAdapter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseEntityId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseEntityId.html new file mode 100644 index 00000000..6420e6fe --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseEntityId.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseEntityId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseEntityId

            +
            +No usage of org.kiji.schema.impl.HBaseEntityId +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiRowData.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiRowData.html new file mode 100644 index 00000000..64e6caf9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiRowData.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiRowData (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiRowData

            +
            + + + + + + + + + +
            +Packages that use HBaseKijiRowData
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseKijiRowData in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HBaseKijiRowData
            + voidHBaseKijiRowData.merge(HBaseKijiRowData kijiRowData) + +
            +          Merges in the data from another HBaseKijiRowData instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html new file mode 100644 index 00000000..2e189123 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html @@ -0,0 +1,219 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiRowScanner.Options (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiRowScanner.Options

            +
            + + + + + + + + + +
            +Packages that use HBaseKijiRowScanner.Options
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseKijiRowScanner.Options in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HBaseKijiRowScanner.Options
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory) + +
            +          Sets the cell decoder factory to use when reading cells from the scanner.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withDataRequest(KijiDataRequest dataRequest) + +
            +          Sets the data request used to generate the KijiRowScanner.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withHBaseResultScanner(ResultScanner hbaseResultScanner) + +
            +          Sets the HBase result scanner the KijiRowScanner will wrap.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withTable(HBaseKijiTable table) + +
            +          Sets the table being scanned.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type HBaseKijiRowScanner.Options
            HBaseKijiRowScanner(HBaseKijiRowScanner.Options options) + +
            +          Creates a new KijiRowScanner instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html new file mode 100644 index 00000000..62641965 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiRowScanner (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiRowScanner

            +
            +No usage of org.kiji.schema.impl.HBaseKijiRowScanner +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiTable.html new file mode 100644 index 00000000..e9445aa0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiTable.html @@ -0,0 +1,231 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiTable

            +
            + + + + + + + + + +
            +Packages that use HBaseKijiTable
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseKijiTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HBaseKijiTable
            +static HBaseKijiTableHBaseKijiTable.downcast(KijiTable kijiTable) + +
            +          We know that all KijiTables are really HBaseKijiTables + instances.
            + HBaseKijiTableHBaseKijiRowScanner.Options.getTable() + +
            +          Gets the table being scanned.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HBaseKijiTable
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withTable(HBaseKijiTable table) + +
            +          Sets the table being scanned.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type HBaseKijiTable
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html new file mode 100644 index 00000000..5ed36147 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiTableReader (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiTableReader

            +
            +No usage of org.kiji.schema.impl.HBaseKijiTableReader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html new file mode 100644 index 00000000..beea8c44 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiTableWriter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiTableWriter

            +
            +No usage of org.kiji.schema.impl.HBaseKijiTableWriter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseMetaTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseMetaTable.html new file mode 100644 index 00000000..79d1b0fa --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseMetaTable.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseMetaTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseMetaTable

            +
            +No usage of org.kiji.schema.impl.HBaseMetaTable +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseSchemaTable.html new file mode 100644 index 00000000..539883b0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseSchemaTable.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseSchemaTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseSchemaTable

            +
            +No usage of org.kiji.schema.impl.HBaseSchemaTable +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseSystemTable.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseSystemTable.html new file mode 100644 index 00000000..e856fc2f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseSystemTable.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseSystemTable (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseSystemTable

            +
            +No usage of org.kiji.schema.impl.HBaseSystemTable +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html new file mode 100644 index 00000000..49df59ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseTableKeyValueDatabase (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseTableKeyValueDatabase

            +
            +No usage of org.kiji.schema.impl.HBaseTableKeyValueDatabase +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseTableRecordReader.html new file mode 100644 index 00000000..eca62b1d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HBaseTableRecordReader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseTableRecordReader (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseTableRecordReader

            +
            +No usage of org.kiji.schema.impl.HBaseTableRecordReader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html new file mode 100644 index 00000000..c7593618 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HColumnDescriptorComparator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HColumnDescriptorComparator

            +
            +No usage of org.kiji.schema.impl.HColumnDescriptorComparator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html new file mode 100644 index 00000000..eab2839b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HTableDescriptorComparator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HTableDescriptorComparator

            +
            +No usage of org.kiji.schema.impl.HTableDescriptorComparator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HTableInterfaceFactory.html new file mode 100644 index 00000000..c92f3414 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HTableInterfaceFactory.html @@ -0,0 +1,364 @@ + + + + + + + +Uses of Interface org.kiji.schema.impl.HTableInterfaceFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.impl.HTableInterfaceFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use HTableInterfaceFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HTableInterfaceFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return HTableInterfaceFactory
            + HTableInterfaceFactoryHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type HTableInterfaceFactory
            Kiji(KijiConfiguration kijiConf, + boolean validateVersion, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Creates a new Kiji instance.
            +  +

            + + + + + +
            +Uses of HTableInterfaceFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement HTableInterfaceFactory
            + classDefaultHTableInterfaceFactory + +
            +          Factory for HTableInterface that creates concrete HTable instances.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HTableInterfaceFactory
            +static HTableInterfaceFactoryDefaultHTableInterfaceFactory.get() + +
            +           
            + HTableInterfaceFactoryDefaultHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HTableInterfaceFactory
            +static voidHBaseSystemTable.install(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Installs a Kiji system table into a running HBase instance.
            +static voidHBaseSchemaTable.install(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static HTableInterfaceHBaseMetaTable.newMetaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates an HTableInterface for the specified table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaHashTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema hash table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaIdTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema ID table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaV5Table(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema V5 table.
            +static HTableInterfaceHBaseSystemTable.newSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates a new HTableInterface for the Kiji system table.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type HTableInterfaceFactory
            HBaseKijiTable(Kiji kiji, + String name, + HTableInterfaceFactory htableFactory) + +
            +          Construct an opened Kiji table stored in HBase.
            HBaseMetaTable(KijiConfiguration kijiConf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseSchemaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            HBaseSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Connect to the HBase system table inside a Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html new file mode 100644 index 00000000..c8a573b4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HashPrefixedEntityId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HashPrefixedEntityId

            +
            + + + + + + + + + +
            +Packages that use HashPrefixedEntityId
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HashPrefixedEntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HashPrefixedEntityId
            +static HashPrefixedEntityIdHashPrefixedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified HBase row key.
            +static HashPrefixedEntityIdHashPrefixedEntityId.fromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HashedEntityId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HashedEntityId.html new file mode 100644 index 00000000..2860df73 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/HashedEntityId.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HashedEntityId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HashedEntityId

            +
            + + + + + + + + + +
            +Packages that use HashedEntityId
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HashedEntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HashedEntityId
            +static HashedEntityIdHashedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified HBase row key.
            +static HashedEntityIdHashedEntityId.fromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/InvalidColumnNameException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/InvalidColumnNameException.html new file mode 100644 index 00000000..042d93b0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/InvalidColumnNameException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.InvalidColumnNameException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.InvalidColumnNameException

            +
            +No usage of org.kiji.schema.impl.InvalidColumnNameException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/KijiDataBuffer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/KijiDataBuffer.html new file mode 100644 index 00000000..c364abea --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/KijiDataBuffer.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.KijiDataBuffer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.KijiDataBuffer

            +
            + + + + + + + + + +
            +Packages that use KijiDataBuffer
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiDataBuffer in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiDataBuffer
            + KijiDataBuffer<T>KijiDataBuffer.add(EntityId id, + T value) + +
            +          Adds a buffer element to the buffer and associates it with the specified entity.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/MetadataRestorer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/MetadataRestorer.html new file mode 100644 index 00000000..58b4fb56 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/MetadataRestorer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.MetadataRestorer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.MetadataRestorer

            +
            +No usage of org.kiji.schema.impl.MetadataRestorer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/RawEntityId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/RawEntityId.html new file mode 100644 index 00000000..d40cd673 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/RawEntityId.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.RawEntityId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.RawEntityId

            +
            + + + + + + + + + +
            +Packages that use RawEntityId
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of RawEntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return RawEntityId
            +static RawEntityIdRawEntityId.fromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates a RawEntityId from the specified HBase row key.
            +static RawEntityIdRawEntityId.fromKijiRowKey(byte[] kijiRowKey) + +
            +          Creates a RawEntityId from the specified Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/SpecificCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/SpecificCellDecoder.html new file mode 100644 index 00000000..0272921e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/class-use/SpecificCellDecoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.SpecificCellDecoder (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.SpecificCellDecoder

            +
            +No usage of org.kiji.schema.impl.SpecificCellDecoder +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-frame.html new file mode 100644 index 00000000..c2b303c1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-frame.html @@ -0,0 +1,121 @@ + + + + + + + +org.kiji.schema.impl (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.schema.impl + + + + +
            +Interfaces  + +
            +HBaseAdminFactory +
            +HTableInterfaceFactory
            + + + + + + +
            +Classes  + +
            +AbstractKijiTable +
            +AvroCellDecoder +
            +AvroCellEncoder +
            +CounterCellDecoder +
            +CounterCellEncoder +
            +DefaultHBaseAdminFactory +
            +DefaultHBaseFactory +
            +DefaultHTableInterfaceFactory +
            +DefaultKijiCellEncoderFactory +
            +DefaultKijiCounter +
            +DefaultKijiTableFactory +
            +GenericCellDecoder +
            +HashedEntityId +
            +HashPrefixedEntityId +
            +HBaseDataRequestAdapter +
            +HBaseEntityId +
            +HBaseKijiRowData +
            +HBaseKijiRowScanner +
            +HBaseKijiRowScanner.Options +
            +HBaseKijiTable +
            +HBaseKijiTableReader +
            +HBaseKijiTableWriter +
            +HBaseMetaTable +
            +HBaseSchemaTable +
            +HBaseSystemTable +
            +HBaseTableKeyValueDatabase +
            +HBaseTableRecordReader +
            +HColumnDescriptorComparator +
            +HTableDescriptorComparator +
            +KijiDataBuffer +
            +MetadataRestorer +
            +RawEntityId +
            +SpecificCellDecoder
            + + + + + + +
            +Exceptions  + +
            +InvalidColumnNameException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-summary.html new file mode 100644 index 00000000..073d94c6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-summary.html @@ -0,0 +1,343 @@ + + + + + + + +org.kiji.schema.impl (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.impl +

            +Implementations for the main KijiSchema classes and interfaces. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + +
            +Interface Summary
            HBaseAdminFactoryFactory for HBaseAdmin.
            HTableInterfaceFactoryFactory for HTableInterface instances.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AbstractKijiTableMain handle for a Kiji table with basic functionality.
            AvroCellDecoder<T>Base class for decoders that read Kiji cells encoded using Avro.
            AvroCellEncoderSerializes a KijiCell.
            CounterCellDecoderCell decoder for counters.
            CounterCellEncoderEncoder for Kiji counters.
            DefaultHBaseAdminFactoryFactory for HBaseAdmin that creates concrete HBaseAdmin instances.
            DefaultHBaseFactoryFactory for HBase instances based on URIs.
            DefaultHTableInterfaceFactoryFactory for HTableInterface that creates concrete HTable instances.
            DefaultKijiCellEncoderFactoryFactory for cell encoders.
            DefaultKijiCounterThe default implementation of a Kiji counter, which contains the data in a counter cell + of a column.
            DefaultKijiTableFactoryThe default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open().
            GenericCellDecoder<T>Decodes cells encoded using Avro into generic types.
            HashedEntityIdImplements the hashed row key format.
            HashPrefixedEntityIdImplements the hash-prefixed row key format.
            HBaseDataRequestAdapterWraps a KijiDataRequest to expose methods that generate meaningful objects in HBase + land, like Puts and Gets.
            HBaseEntityIdEntity ID encapsulating an HBase row key.
            HBaseKijiRowDataAn implementation of KijiRowData that wraps an HBase Result object.
            HBaseKijiRowScannerThe internal implementation of KijiRowScanner that reads from HTables.
            HBaseKijiRowScanner.OptionsA class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            HBaseKijiTableA KijiTable that exposes the underlying HBase implementation.
            HBaseKijiTableReaderReads from a kiji table by sending the requests directly to the HBase tables.
            HBaseKijiTableWriterMakes modifications to a Kiji table by sending requests directly to HBase from the local client.
            HBaseMetaTableAn implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            HBaseSchemaTable + Mapping between schema IDs, hashes and Avro schema objects.
            HBaseSystemTableThe Kiji system table that is stored in HBase.
            HBaseTableKeyValueDatabaseManages key-value pairs on a per table basis.
            HBaseTableRecordReaderA record reader that reads from a HBase table that reports progress correctly.
            HColumnDescriptorComparatorComparator for HColumnDescriptors.
            HTableDescriptorComparatorCompares HTableDescriptors.
            KijiDataBuffer<T>A buffer used to hold data entries waiting to be written to a KijiTable.
            MetadataRestorerMetadata restorer backups up meta info to MetadataBackup records and can restore metadata to the + meta and schema tables.
            RawEntityIdImplements the raw row key format.
            SpecificCellDecoder<T>Decodes cells encoded using Avro into specific types.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            InvalidColumnNameExceptionThrown when kiji encounters a column name that is not valid.
            +  + +

            +

            +Package org.kiji.schema.impl Description +

            + +

            +Implementations for the main KijiSchema classes and interfaces. + +

            + Users generally shouldn't need to reference any of these classes directly, but rather use the + classes presented by the org.kiji.schema package. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-tree.html new file mode 100644 index 00000000..a7e7322a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-tree.html @@ -0,0 +1,206 @@ + + + + + + + +org.kiji.schema.impl Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-use.html new file mode 100644 index 00000000..abdc7b3b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/impl/package-use.html @@ -0,0 +1,274 @@ + + + + + + + +Uses of Package org.kiji.schema.impl (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.impl

            +
            + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.impl
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.impl used by org.kiji.schema
            HBaseAdminFactory + +
            +          Factory for HBaseAdmin.
            HTableInterfaceFactory + +
            +          Factory for HTableInterface instances.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.impl used by org.kiji.schema.impl
            AbstractKijiTable + +
            +          Main handle for a Kiji table with basic functionality.
            AvroCellDecoder + +
            +          Base class for decoders that read Kiji cells encoded using Avro.
            CounterCellDecoder + +
            +          Cell decoder for counters.
            CounterCellEncoder + +
            +          Encoder for Kiji counters.
            DefaultKijiCellEncoderFactory + +
            +          Factory for cell encoders.
            HashedEntityId + +
            +          Implements the hashed row key format.
            HashPrefixedEntityId + +
            +          Implements the hash-prefixed row key format.
            HBaseAdminFactory + +
            +          Factory for HBaseAdmin.
            HBaseKijiRowData + +
            +          An implementation of KijiRowData that wraps an HBase Result object.
            HBaseKijiRowScanner.Options + +
            +          A class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            HBaseKijiTable + +
            +          A KijiTable that exposes the underlying HBase implementation.
            HTableInterfaceFactory + +
            +          Factory for HTableInterface instances.
            KijiDataBuffer + +
            +          A buffer used to hold data entries waiting to be written to a KijiTable.
            RawEntityId + +
            +          Implements the raw row key format.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/ColumnNameTranslator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/ColumnNameTranslator.html new file mode 100644 index 00000000..6f891c06 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/ColumnNameTranslator.html @@ -0,0 +1,354 @@ + + + + + + + +ColumnNameTranslator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class ColumnNameTranslator

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.ColumnNameTranslator
+
            +
            +
            +
            @ApiAudience.Public
+public final class ColumnNameTranslator
            extends Object
            + + +

            +Translates between HTable and Kiji table column names. + +

            This class defines a mapping between names of HBase HTable families/qualifiers and + Kiji table family/qualifiers.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static StringSEPARATOR + +
            +          Used to separate the Kiji family from the Kiji qualifier in an HBase qualifier.
            +  + + + + + + + + + + +
            +Constructor Summary
            ColumnNameTranslator(KijiTableLayout tableLayout) + +
            +          Creates a new ColumnNameTranslator instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiTableLayoutgetTableLayout() + +
            +           
            + HBaseColumnNametoHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            + KijiColumnNametoKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SEPARATOR

            +
            +public static final String SEPARATOR
            +
            +
            Used to separate the Kiji family from the Kiji qualifier in an HBase qualifier. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +ColumnNameTranslator

            +
            +public ColumnNameTranslator(KijiTableLayout tableLayout)
            +
            +
            Creates a new ColumnNameTranslator instance. +

            +

            +
            Parameters:
            tableLayout - The layout of the table to translate column names for.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toKijiColumnName

            +
            +public KijiColumnName toKijiColumnName(HBaseColumnName hbaseColumnName)
+                                throws NoSuchColumnException
            +
            +
            Translates an HBase column name to a Kiji column name. +

            +

            +
            Parameters:
            hbaseColumnName - The HBase column name. +
            Returns:
            The Kiji column name. +
            Throws: +
            NoSuchColumnException - If the column name cannot be found.
            +
            +
            +
            + +

            +toHBaseColumnName

            +
            +public HBaseColumnName toHBaseColumnName(KijiColumnName kijiColumnName)
+                                  throws NoSuchColumnException
            +
            +
            Translates a Kiji column name into an HBase column name. +

            +

            +
            Parameters:
            kijiColumnName - The Kiji column name. +
            Returns:
            The HBase column name. +
            Throws: +
            NoSuchColumnException - If the column name cannot be found.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout()
            +
            +
            + +
            Returns:
            the table layout.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/InvalidLayoutException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/InvalidLayoutException.html new file mode 100644 index 00000000..0f0ee017 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/InvalidLayoutException.html @@ -0,0 +1,280 @@ + + + + + + + +InvalidLayoutException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class InvalidLayoutException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.layout.InvalidLayoutException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Direct Known Subclasses:
            SchemaClassNotFoundException
            +
            +
            +
            +
            @ApiAudience.Public
+public class InvalidLayoutException
            extends IOException
            + + +

            +Thrown when an invalid Kiji layout is encountered. Possible reasons why a layout may be + invalid include: +

              +
            • Invalid data schemas.
              • +
            • Missing family or column names.
              • +
            • The family or column ids were not assigned.
              • +
            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            InvalidLayoutException(KijiTableLayout tableLayout, + String reason) + +
            +          Constructs an exception indicated a table layout is invalid.
            InvalidLayoutException(String reason) + +
            +          Creates a new InvalidLayoutException with the specified reason.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +InvalidLayoutException

            +
            +public InvalidLayoutException(String reason)
            +
            +
            Creates a new InvalidLayoutException with the specified reason. +

            +

            +
            Parameters:
            reason - A message describing the reason the layout is invalid.
            +
            +
            + +

            +InvalidLayoutException

            +
            +public InvalidLayoutException(KijiTableLayout tableLayout,
+                              String reason)
            +
            +
            Constructs an exception indicated a table layout is invalid. +

            +

            +
            Parameters:
            tableLayout - The table layout that is invalid.
            reason - A message describing the reason the layout is invalid.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html new file mode 100644 index 00000000..e40c0352 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html @@ -0,0 +1,351 @@ + + + + + + + +KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
+
            +
            +
            Enclosing class:
            KijiTableLayout.LocalityGroupLayout.FamilyLayout
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            extends Object
            + + +

            +Concrete layout of a column. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc desc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout reference) + +
            +          Builds a new column layout instance from a descriptor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + ColumnDescgetDesc() + +
            +           
            + KijiTableLayout.LocalityGroupLayout.FamilyLayoutgetFamily() + +
            +           
            + ColumnIdgetId() + +
            +           
            + StringgetName() + +
            +           
            + Set<String>getNames() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout

            +
            +public KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc desc,
+                                                                     KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout reference)
+                                                              throws InvalidLayoutException
            +
            +
            Builds a new column layout instance from a descriptor. +

            +

            +
            Parameters:
            desc - Column descriptor.
            reference - Optional reference layout, or null. +
            Throws: +
            InvalidLayoutException - if the layout is invalid or inconsistent.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDesc

            +
            +public ColumnDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this column.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the primary name for the column.
            +
            +
            +
            + +

            +getNames

            +
            +public Set<String> getNames()
            +
            +
            + +
            Returns:
            the name and aliases for the column.
            +
            +
            +
            + +

            +getId

            +
            +public ColumnId getId()
            +
            +
            + +
            Returns:
            the ID associated to this column.
            +
            +
            +
            + +

            +getFamily

            +
            +public KijiTableLayout.LocalityGroupLayout.FamilyLayout getFamily()
            +
            +
            + +
            Returns:
            the family this column belongs to.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html new file mode 100644 index 00000000..85610f06 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html @@ -0,0 +1,468 @@ + + + + + + + +KijiTableLayout.LocalityGroupLayout.FamilyLayout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout.LocalityGroupLayout.FamilyLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout
+
            +
            +
            Enclosing class:
            KijiTableLayout.LocalityGroupLayout
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout.LocalityGroupLayout.FamilyLayout
            extends Object
            + + +

            +Concrete layout of a family. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            + classKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout + +
            +          Concrete layout of a column.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc familyDesc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout reference) + +
            +          Builds a new family layout instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + com.google.common.collect.BiMap<ColumnId,String>getColumnIdNameMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>getColumnMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>getColumns() + +
            +           
            + FamilyDescgetDesc() + +
            +           
            + ColumnIdgetId() + +
            +           
            + KijiTableLayout.LocalityGroupLayoutgetLocalityGroup() + +
            +           
            + StringgetName() + +
            +           
            + Set<String>getNames() + +
            +           
            + booleanisGroupType() + +
            +           
            + booleanisMapType() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableLayout.LocalityGroupLayout.FamilyLayout

            +
            +public KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc familyDesc,
+                                                        KijiTableLayout.LocalityGroupLayout.FamilyLayout reference)
+                                                 throws InvalidLayoutException
            +
            +
            Builds a new family layout instance. +

            +

            +
            Parameters:
            familyDesc - Descriptor of the family.
            reference - Optional reference family layout, or null. +
            Throws: +
            InvalidLayoutException - if the layout is invalid or inconsistent.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDesc

            +
            +public FamilyDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this family.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the primary name for the family.
            +
            +
            +
            + +

            +getNames

            +
            +public Set<String> getNames()
            +
            +
            + +
            Returns:
            the family name and aliases.
            +
            +
            +
            + +

            +getId

            +
            +public ColumnId getId()
            +
            +
            + +
            Returns:
            the column ID assigned to this family.
            +
            +
            +
            + +

            +getColumns

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout> getColumns()
            +
            +
            + +
            Returns:
            the columns in this family.
            +
            +
            +
            + +

            +getColumnMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout> getColumnMap()
            +
            +
            + +
            Returns:
            the mapping from column names (no aliases) to column layouts.
            +
            +
            +
            + +

            +getColumnIdNameMap

            +
            +public com.google.common.collect.BiMap<ColumnId,String> getColumnIdNameMap()
            +
            +
            + +
            Returns:
            the bidirectional mapping between column names (no aliases) and IDs.
            +
            +
            +
            + +

            +getLocalityGroup

            +
            +public KijiTableLayout.LocalityGroupLayout getLocalityGroup()
            +
            +
            + +
            Returns:
            the locality group this family belongs to.
            +
            +
            +
            + +

            +isGroupType

            +
            +public boolean isGroupType()
            +
            +
            + +
            Returns:
            whether this is a group-type family.
            +
            +
            +
            + +

            +isMapType

            +
            +public boolean isMapType()
            +
            +
            + +
            Returns:
            whether this is a map-type family.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html new file mode 100644 index 00000000..f036013f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html @@ -0,0 +1,428 @@ + + + + + + + +KijiTableLayout.LocalityGroupLayout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout.LocalityGroupLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout
+
            +
            +
            Enclosing class:
            KijiTableLayout
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout.LocalityGroupLayout
            extends Object
            + + +

            +Concrete layout of a locality group. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            + classKijiTableLayout.LocalityGroupLayout.FamilyLayout + +
            +          Concrete layout of a family.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc lgDesc, + KijiTableLayout.LocalityGroupLayout reference) + +
            +          Constructs a locality group layout.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + LocalityGroupDescgetDesc() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilies() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>getFamilyIdNameMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilyMap() + +
            +           
            + ColumnIdgetId() + +
            +           
            + StringgetName() + +
            +           
            + Set<String>getNames() + +
            +           
            + KijiTableLayoutgetTableLayout() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableLayout.LocalityGroupLayout

            +
            +public KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc lgDesc,
+                                           KijiTableLayout.LocalityGroupLayout reference)
+                                    throws InvalidLayoutException
            +
            +
            Constructs a locality group layout. +

            +

            +
            Parameters:
            lgDesc - Locality group descriptor.
            reference - Optional reference locality group, or null. +
            Throws: +
            InvalidLayoutException - if the layout is invalid or inconsistent.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout()
            +
            +
            + +
            Returns:
            the table layout this locality group belongs to.
            +
            +
            +
            + +

            +getDesc

            +
            +public LocalityGroupDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this locality group.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the locality group primary name.
            +
            +
            +
            + +

            +getNames

            +
            +public Set<String> getNames()
            +
            +
            + +
            Returns:
            the locality group name and aliases.
            +
            +
            +
            + +

            +getId

            +
            +public ColumnId getId()
            +
            +
            + +
            Returns:
            the ID associated to this locality group.
            +
            +
            +
            + +

            +getFamilies

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilies()
            +
            +
            + +
            Returns:
            the families in this locality group, in no particular order.
            +
            +
            +
            + +

            +getFamilyMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilyMap()
            +
            +
            + +
            Returns:
            the mapping from family names and aliases to family layouts.
            +
            +
            +
            + +

            +getFamilyIdNameMap

            +
            +public com.google.common.collect.BiMap<ColumnId,String> getFamilyIdNameMap()
            +
            +
            + +
            Returns:
            the bidirectional mapping between family names (no alias) and IDs.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.html new file mode 100644 index 00000000..a8645358 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayout.html @@ -0,0 +1,872 @@ + + + + + + + +KijiTableLayout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout
            extends Object
            + + +

            +Layout of a Kiji table. + +

            + Kiji uses the term layout to describe the structure of a table. + Kiji does not use the term schema to avoid confusion with Avro schemas or XML schemas. +

            + +

            + KijiTableLayout wraps a layout descriptor represented as a + TableLayoutDesc Avro record. + KijiTableLayout provides strict validation and accessors to navigate through the layout. +

            + +

            Overall structure

            +

            At the top-level, a table contains: +

              +
            • the table name and description;
              • +
            • how row keys are encoded;
              • +
            • the table locality groups.
              • +
            +

            + +

            Each locality group has: +

              +
            • a primary name, unique within the table, a description and some name aliases;
              • +
            • whether the data is to be stored in memory or on disk;
              • +
            • data retention lifetime;
              • +
            • maximum number of versions to keep;
              • +
            • type of compression;
              • +
            • column families stored in this locality group
              • +
            +

            + +

            Each column family has: +

              +
            • a primary name, globally unique within the table, + a description and some name aliases;
              • +
            • for map-type families, the Avro schema of the cell values;
              • +
            • for group-type families, the collection of columns in the group.
              • +
            +

            + +

            Each column in a group-type family has: +

              +
            • a primary name, unique within the family, a description and some name aliases;
              • +
            • an Avro schema.
              • +
            +

            + +

            Layout descriptors

            + + Layout descriptors are represented using + TableLayoutDesc Avro records. + Layout descriptors come in two flavors: concrete layouts and layout updates. + +

            Concrete layout descriptors

            + A concrete layout descriptors is an absolute, standalone description of a table layout, which + does not reference or build upon any previous version of the table layout. Column IDs have + been assigned to all locality groups, families and columns. + +

            Layout update descriptors

            + A table layout update descriptor builds on a reference table layout, and describes layout + modification to apply on the reference layout. + The reference table layout is specified by writing the ID of the reference layout + (TableLayoutDesc.layout_id) into the TableLayoutDesc.reference_layout. + This mechanism prevents race conditions when updating the layout of a table. + The first layout of a newly created table has no reference layout. + +

            During a layout update, the user may delete or declare new locality groups, families and/or + columns. The user may also modify existing locality groups, families and/or columns. + +

            The result of applying a layout update on top of a concrete reference layout is a new + concrete layout. + +

            Names

            + +

            Layout entities are uniquely identified through their primary names. + Name aliases can be freely updated, as long as uniqueness requirements are met. + Primary name updates must be explicitly annotated by setting the renamedFrom field of + the entity being renamed. + The name of a table cannot be changed. + +

            Names of tables, locality groups, families and column qualifiers must be valid identifiers. + Name validation occurs in KijiNameValidator. + +

            Validation rules

            + +
              +
            • Table names, locality group names, family names, and column names in a group-type family + must be valid identifiers (no punctuation or symbols). + Note: map-type family qualifiers are free-form, but do never appear in a table layout. +
            • Locality group names and aliases must be unique within the table. +
            • Family names and aliases must be unique within the table. +
            • Group-type family qualifiers must be unique within the family. +
            • The type of a family (map-type or group-type) cannot be changed. +
            • A family cannot be moved into a different locality group. +
            • The encoding of Kiji cells (hash, UID, final) cannot be modified. +
            • The schema of a Kiji cell can only be changed to a schema that is compatible with + all the former schemas of the column. Schema compatibility requires that the new schema + allows decoding all former schemas associated to the column or the map-type family. +
            + +

            Row keys encoding

            + + A row in a Kiji table is identified by its Kiji row key. Kiji row keys are converted into HBase + row keys according to the row key encoding specified in the table layout: +
              +
            • Raw encoding: the user has direct control over the encoding of row keys in the HBase + table. In other words, the HBase row key is exactly the Kiji row key. + See RawEntityId. +
              • +
            • Hashed: the HBase row key is computed as a hash of the Kiji row key. + See HashedEntityId. +
              • +
            • Hash-prefixed: the HBase row key is computed as the concatenation of a hash of the + Kiji row key and the Kiji row key itself. + See HashPrefixedEntityId. +
              • +
            + + Hashing allows to spread the rows evenly across all the regions in the table. + +

            Cell schema

            + + Kiji cells are encoded according to a schema specified via + CellSchema Avro records. + Kiji provides various cell encoding schemes: +
              +
            • Hash: each Kiji cell is encoded as a hash of the Avro schema, followed by the binary + encoding of the Avro value. +
              • +
            • UID: each Kiji cell is encoded as the unique ID of the Avro schema, followed by the + binary encoding of the Avro value. +
              • +
            • Final: each Kiji cell is encoded as the binary encoding of the Avro value. +
              • +
            + See KijiCellEncoder + and KijiCellDecoder + for more implementation details. + +

            Column IDs

            + + For storage efficiency purposes, Kiji family and column names are translated into short + HBase column names. + The translation happens in + ColumnNameTranslator + and relies on + ColumnId. + Column IDs are assigned automatically by KijiTableLayout. + The user may specify column IDs manually. KijiTableLayout checks the consistency of column IDs. + +

            Column IDs cannot be changed (a column ID change is equivalent to deleting the existing column + and then re-creating it as a new empty column). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            + classKijiTableLayout.LocalityGroupLayout + +
            +          Concrete layout of a locality group.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableLayout(TableLayoutDesc desc, + KijiTableLayout reference) + +
            +          Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiTableLayoutcreateFromEffectiveJson(InputStream istream) + +
            +          Loads a table layout from the specified JSON text.
            +static KijiTableLayoutcreateFromEffectiveJsonResource(String resource) + +
            +          Loads a table layout from the specified resource as JSON.
            + booleanequals(Object other) + +
            +          
            + booleanexists(KijiColumnName column) + +
            +          Reports whether a column exists.
            + SchemaStoragegetCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            + CellSchemagetCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            + CellSpecgetCellSpec(KijiColumnName column) + +
            +           
            + Set<KijiColumnName>getColumnNames() + +
            +           
            + TableLayoutDescgetDesc() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilies() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilyMap() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>getLocalityGroupIdNameMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout>getLocalityGroupMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout>getLocalityGroups() + +
            +           
            + StringgetName() + +
            +           
            + org.apache.avro.SchemagetSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            + inthashCode() + +
            +          
            +static org.apache.avro.SchemareadAvroSchema(CellSchema avro) + +
            +          Reads the Avro schema from the table layout.
            +static TableLayoutDescreadTableLayoutDescFromJSON(InputStream istream) + +
            +          Reads a table layout descriptor from its JSON serialized form.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiTableLayout

            +
            +public KijiTableLayout(TableLayoutDesc desc,
+                       KijiTableLayout reference)
+                throws InvalidLayoutException
            +
            +
            Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout. +

            +

            +
            Parameters:
            desc - Avro layout descriptor (relative to the reference layout).
            reference - Optional reference layout, or null. +
            Throws: +
            InvalidLayoutException - if the descriptor is invalid or inconsistent wrt reference.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDesc

            +
            +public TableLayoutDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this table layout.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the table name.
            +
            +
            +
            + +

            +getLocalityGroups

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout> getLocalityGroups()
            +
            +
            + +
            Returns:
            the locality groups in the table, in no particular order.
            +
            +
            +
            + +

            +getLocalityGroupIdNameMap

            +
            +public com.google.common.collect.BiMap<ColumnId,String> getLocalityGroupIdNameMap()
            +
            +
            + +
            Returns:
            the bidirectional mapping between locality group names (no alias) and IDs.
            +
            +
            +
            + +

            +getLocalityGroupMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout> getLocalityGroupMap()
            +
            +
            + +
            Returns:
            the map from locality group names and aliases to layouts.
            +
            +
            +
            + +

            +getFamilyMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilyMap()
            +
            +
            + +
            Returns:
            the mapping from family names and aliases to family layouts in the table.
            +
            +
            +
            + +

            +getFamilies

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilies()
            +
            +
            + +
            Returns:
            all the families in the table, in no particular order.
            +
            +
            +
            + +

            +getColumnNames

            +
            +public Set<KijiColumnName> getColumnNames()
            +
            +
            + +
            Returns:
            all the primary column names in the table, including map-type families.
            +
            +
            +
            + +

            +getCellSchema

            +
            +public CellSchema getCellSchema(KijiColumnName columnName)
+                         throws NoSuchColumnException
            +
            +
            Gets the schema for a column. +

            +

            +
            Parameters:
            columnName - The name of the column to get the schema for. +
            Returns:
            the schema of the specified column. +
            Throws: +
            NoSuchColumnException - if the column does not exist.
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema(KijiColumnName columnName)
+                                 throws InvalidLayoutException,
+                                        NoSuchColumnException
            +
            +
            Reports the schema of the specified column. +

            +

            +
            Parameters:
            columnName - Column name. +
            Returns:
            the schema of the column. +
            Throws: +
            InvalidLayoutException - if the layout is invalid. +
            NoSuchColumnException - if the column does not exist.
            +
            +
            +
            + +

            +getCellFormat

            +
            +public SchemaStorage getCellFormat(KijiColumnName column)
+                            throws NoSuchColumnException
            +
            +
            Reports the cell format for the specified column. +

            +

            +
            Parameters:
            column - Column name. +
            Returns:
            the cell format for the column. +
            Throws: +
            NoSuchColumnException - if the column does not exist.
            +
            +
            +
            + +

            +getCellSpec

            +
            +public CellSpec getCellSpec(KijiColumnName column)
+                     throws IOException
            +
            +
            +
            Parameters:
            column - Column to look up. +
            Returns:
            the cell specification for a given column. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +exists

            +
            +public boolean exists(KijiColumnName column)
            +
            +
            Reports whether a column exists. +

            +

            +
            Parameters:
            column - Column name. +
            Returns:
            whether the specified column exists.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +readAvroSchema

            +
            +public static org.apache.avro.Schema readAvroSchema(CellSchema avro)
+                                             throws InvalidLayoutException
            +
            +
            Reads the Avro schema from the table layout. +

            +

            +
            Parameters:
            avro - The portion of the table layout record to read from. +
            Returns:
            The avro schema, or null if the schema is type "counter". +
            Throws: +
            InvalidLayoutException - if the table layout is invalid and the schema can't be read.
            +
            +
            +
            + +

            +createFromEffectiveJsonResource

            +
            +public static KijiTableLayout createFromEffectiveJsonResource(String resource)
+                                                       throws IOException
            +
            +
            Loads a table layout from the specified resource as JSON. +

            +

            +
            Parameters:
            resource - Path of the resource containing the JSON layout description. +
            Returns:
            the parsed table layout. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +createFromEffectiveJson

            +
            +public static KijiTableLayout createFromEffectiveJson(InputStream istream)
+                                               throws IOException
            +
            +
            Loads a table layout from the specified JSON text. +

            +

            +
            Parameters:
            istream - Input stream containing the JSON text. +
            Returns:
            the parsed table layout. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +readTableLayoutDescFromJSON

            +
            +public static TableLayoutDesc readTableLayoutDescFromJSON(InputStream istream)
+                                                   throws IOException
            +
            +
            Reads a table layout descriptor from its JSON serialized form. +

            +

            +
            Parameters:
            istream - JSON input stream. +
            Returns:
            the decoded table layout descriptor. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayoutDatabase.html new file mode 100644 index 00000000..b3c4a185 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/KijiTableLayoutDatabase.html @@ -0,0 +1,430 @@ + + + + + + + +KijiTableLayoutDatabase (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Interface KijiTableLayoutDatabase

            +
            +
            All Known Implementing Classes:
            HBaseMetaTable, HBaseTableLayoutDatabase, KijiMetaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+public interface KijiTableLayoutDatabase
            + + +

            +A database of Kiji table layouts. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiTableLayoutgetTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + List<KijiTableLayout>getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            + voidlayoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +          Restores a table layout history from a backup.
            + List<TableLayoutBackupEntry>layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            + List<String>listTables() + +
            +          Lists the tables in this Kiji instance.
            + voidremoveAllTableLayoutVersions(String table) + +
            +          Removes all layout information for a particular table.
            + voidremoveRecentTableLayoutVersions(String table, + int numVersions) + +
            +          Removes the most recent layout information for a given table.
            + KijiTableLayoutupdateTableLayout(String table, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +listTables

            +
            +List<String> listTables()
+                        throws IOException
            +
            +
            Lists the tables in this Kiji instance. +

            +

            + +
            Returns:
            The list of table names. +
            Throws: +
            IOException - If the list of tables cannot be retrieved.
            +
            +
            +
            + +

            +updateTableLayout

            +
            +KijiTableLayout updateTableLayout(String table,
+                                  TableLayoutDesc update)
+                                  throws IOException
            +
            +
            Sets a table's layout. Also calls validateAndAssignLayout(). +

            +

            +
            Parameters:
            table - The name of the Kiji table to affect.
            update - Descriptor for the layout update. +
            Returns:
            the new effective layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableLayout

            +
            +KijiTableLayout getTableLayout(String table)
+                               throws IOException
            +
            +
            Gets the most recent versions of the layout for a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            The table's layout. +
            Throws: +
            IOException - If there is an error or no such table.
            +
            +
            +
            + +

            +getTableLayoutVersions

            +
            +List<KijiTableLayout> getTableLayoutVersions(String table,
+                                             int numVersions)
+                                             throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the table layout. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the layout for the table, sorted by + most-recent-first. If there are no layouts, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedTableLayoutVersions

            +
            +NavigableMap<Long,KijiTableLayout> getTimedTableLayoutVersions(String table,
+                                                               int numVersions)
+                                                               throws IOException
            +
            +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values the most recent versions of the layout for the table, and + keys the corresponding timestamps, ordered from most recent first to least recent last. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +layoutsToBackup

            +
            +List<TableLayoutBackupEntry> layoutsToBackup(String table)
+                                             throws IOException
            +
            +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableLayoutBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllTableLayoutVersions

            +
            +void removeAllTableLayoutVersions(String table)
+                                  throws IOException
            +
            +
            Removes all layout information for a particular table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeRecentTableLayoutVersions

            +
            +void removeRecentTableLayoutVersions(String table,
+                                     int numVersions)
+                                     throws IOException
            +
            +
            Removes the most recent layout information for a given table. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +layoutsFromBackup

            +
            +void layoutsFromBackup(String tableName,
+                       List<TableLayoutBackupEntry> tableBackup)
+                       throws IOException
            +
            +
            Restores a table layout history from a backup. +

            +

            +
            Parameters:
            tableName - The name of the table to restore layouts for.
            tableBackup - Table layout backup entries to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/SchemaClassNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/SchemaClassNotFoundException.html new file mode 100644 index 00000000..5222d6b2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/SchemaClassNotFoundException.html @@ -0,0 +1,253 @@ + + + + + + + +SchemaClassNotFoundException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class SchemaClassNotFoundException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.layout.InvalidLayoutException
+                  extended by org.kiji.schema.layout.SchemaClassNotFoundException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class SchemaClassNotFoundException
            extends InvalidLayoutException
            + + +

            +Thrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path). +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            SchemaClassNotFoundException(String message) + +
            +          Creates a new SchemaClassNotFoundException with the specified detail message..
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +SchemaClassNotFoundException

            +
            +public SchemaClassNotFoundException(String message)
            +
            +
            Creates a new SchemaClassNotFoundException with the specified detail message.. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/TableLayoutSerializer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/TableLayoutSerializer.html new file mode 100644 index 00000000..4cf7d8f9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/TableLayoutSerializer.html @@ -0,0 +1,393 @@ + + + + + + + +TableLayoutSerializer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class TableLayoutSerializer

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.TableLayoutSerializer
+
            +
            +
            +
            @ApiAudience.Framework
+public final class TableLayoutSerializer
            extends Object
            + + +

            +Serialize TableLayout instances into job configurations. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_INPUT_TABLE_LAYOUT + +
            +          The configuration variable that stores the avro json-encoded input table layout.
            +static StringCONF_OUTPUT_TABLE_LAYOUT + +
            +          The configuration variable that stores output table layout.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiTableLayoutreadInputTableLayout(Configuration conf) + +
            +          Reads an input table layout from the configuration.
            +static KijiTableLayoutreadOutputTableLayout(Configuration conf) + +
            +          Reads an output table layout from the configuration.
            +static KijiTableLayoutreadTableLayout(String confKey, + Configuration conf) + +
            +          Reads a table layout from the configuration.
            +static voidserializeInputTableLayout(KijiTableLayout tableLayout, + Configuration conf) + +
            +          Serializes the table layout into a configuration object for input.
            +static voidserializeOutputTableLayout(KijiTableLayout tableLayout, + Configuration conf) + +
            +          Serializes the table layout into a configuration object for output.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +CONF_INPUT_TABLE_LAYOUT

            +
            +public static final String CONF_INPUT_TABLE_LAYOUT
            +
            +
            The configuration variable that stores the avro json-encoded input table layout. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_OUTPUT_TABLE_LAYOUT

            +
            +public static final String CONF_OUTPUT_TABLE_LAYOUT
            +
            +
            The configuration variable that stores output table layout. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +readTableLayout

            +
            +public static KijiTableLayout readTableLayout(String confKey,
+                                              Configuration conf)
+                                       throws IOException
            +
            +
            Reads a table layout from the configuration. +

            +

            +
            Parameters:
            confKey - The configuration key for the table layout.
            conf - The configuration storing the table layout. +
            Returns:
            the TableLayout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +serializeInputTableLayout

            +
            +public static void serializeInputTableLayout(KijiTableLayout tableLayout,
+                                             Configuration conf)
+                                      throws IOException
            +
            +
            Serializes the table layout into a configuration object for input. +

            +

            +
            Parameters:
            tableLayout - The table layout to serialize.
            conf - The configuration object to store the layout into. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +serializeOutputTableLayout

            +
            +public static void serializeOutputTableLayout(KijiTableLayout tableLayout,
+                                              Configuration conf)
+                                       throws IOException
            +
            +
            Serializes the table layout into a configuration object for output. +

            +

            +
            Parameters:
            tableLayout - The table layout to serialize.
            conf - The configuration object to store the layout into. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +readInputTableLayout

            +
            +public static KijiTableLayout readInputTableLayout(Configuration conf)
+                                            throws IOException
            +
            +
            Reads an input table layout from the configuration. +

            +

            +
            Parameters:
            conf - The configuration storing the table layout. +
            Returns:
            the TableLayout for the table being mapped over. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +readOutputTableLayout

            +
            +public static KijiTableLayout readOutputTableLayout(Configuration conf)
+                                             throws IOException
            +
            +
            Reads an output table layout from the configuration. +

            +

            +
            Parameters:
            conf - The configuration storing the table layout. +
            Returns:
            the TableLayout for the table being mapped over. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/ColumnNameTranslator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/ColumnNameTranslator.html new file mode 100644 index 00000000..cade25e6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/ColumnNameTranslator.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.ColumnNameTranslator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.ColumnNameTranslator

            +
            + + + + + + + + + +
            +Packages that use ColumnNameTranslator
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of ColumnNameTranslator in org.kiji.schema.filter
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type ColumnNameTranslator
            + FilterKijiColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + ColumnNameTranslator columnNameTranslator) + +
            +          Expresses a KijiColumnFilter in terms of an equivalent HBase filter, translating the + KijiColumnNames to the corresponding HBaseColumnName.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/InvalidLayoutException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/InvalidLayoutException.html new file mode 100644 index 00000000..db899e83 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/InvalidLayoutException.html @@ -0,0 +1,325 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.InvalidLayoutException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.InvalidLayoutException

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use InvalidLayoutException
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of InvalidLayoutException in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that throw InvalidLayoutException
            + voidKijiDataRequestValidator.validate(KijiTableLayout tableLayout) + +
            +          Validates the data request against the given table layout.
            +  +

            + + + + + +
            +Uses of InvalidLayoutException in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Subclasses of InvalidLayoutException in org.kiji.schema.layout
            + classSchemaClassNotFoundException + +
            +          Thrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path).
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that throw InvalidLayoutException
            + org.apache.avro.SchemaKijiTableLayout.getSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            +static org.apache.avro.SchemaKijiTableLayout.readAvroSchema(CellSchema avro) + +
            +          Reads the Avro schema from the table layout.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.layout that throw InvalidLayoutException
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc desc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout reference) + +
            +          Builds a new column layout instance from a descriptor.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc familyDesc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout reference) + +
            +          Builds a new family layout instance.
            KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc lgDesc, + KijiTableLayout.LocalityGroupLayout reference) + +
            +          Constructs a locality group layout.
            KijiTableLayout(TableLayoutDesc desc, + KijiTableLayout reference) + +
            +          Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout.
            +  +

            + + + + + +
            +Uses of InvalidLayoutException in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that throw InvalidLayoutException
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            +static org.apache.avro.SchemaCellSpec.readAvroSchema(CellSchema cellSchema) + +
            +          Reads the Avro schema from the table layout.
            + CellSpecCellSpec.setCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html new file mode 100644 index 00000000..8f17eba9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html @@ -0,0 +1,204 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>KijiTableLayout.LocalityGroupLayout.FamilyLayout.getColumnMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>KijiTableLayout.LocalityGroupLayout.FamilyLayout.getColumns() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc desc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout reference) + +
            +          Builds a new column layout instance from a descriptor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html new file mode 100644 index 00000000..65fdcd81 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html @@ -0,0 +1,236 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayout.LocalityGroupLayout.FamilyLayout
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout.LocalityGroupLayout.FamilyLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiTableLayout.LocalityGroupLayout.FamilyLayout
            + KijiTableLayout.LocalityGroupLayout.FamilyLayoutKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.getFamily() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout.LocalityGroupLayout.FamilyLayout
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.getFamilies() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.LocalityGroupLayout.getFamilies() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.getFamilyMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.LocalityGroupLayout.getFamilyMap() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type KijiTableLayout.LocalityGroupLayout.FamilyLayout
            KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc familyDesc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout reference) + +
            +          Builds a new family layout instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html new file mode 100644 index 00000000..82e4f849 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html @@ -0,0 +1,220 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayout.LocalityGroupLayout
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout.LocalityGroupLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiTableLayout.LocalityGroupLayout
            + KijiTableLayout.LocalityGroupLayoutKijiTableLayout.LocalityGroupLayout.FamilyLayout.getLocalityGroup() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout.LocalityGroupLayout
            + Map<String,KijiTableLayout.LocalityGroupLayout>KijiTableLayout.getLocalityGroupMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout>KijiTableLayout.getLocalityGroups() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type KijiTableLayout.LocalityGroupLayout
            KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc lgDesc, + KijiTableLayout.LocalityGroupLayout reference) + +
            +          Constructs a locality group layout.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.html new file mode 100644 index 00000000..d693eae5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayout.html @@ -0,0 +1,717 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiTableLayout
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableLayout
            + KijiTableLayoutKijiTable.getLayout() + +
            +           
            + KijiTableLayoutKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiTableLayout
            + voidKijiAdmin.createTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore) + +
            +          Creates a Kiji table in an HBase instance.
            + voidKijiAdmin.createTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + byte[][] splitKeys) + +
            +          Creates a Kiji table in an HBase instance.
            + voidKijiAdmin.createTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + int numRegions) + +
            +          Creates a Kiji table in an HBase instance.
            + voidKijiDataRequestValidator.validate(KijiTableLayout tableLayout) + +
            +          Validates the data request against the given table layout.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiTableLayout
            KijiColumnPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HTableInterface htable) + +
            +          Creates a new KijiColumnPager.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.filter
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.filter with parameters of type KijiTableLayout
            KijiRowFilterApplicator(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableLayout
            + KijiTableLayoutHBaseKijiTable.getLayout() + +
            +          
            + KijiTableLayoutHBaseKijiRowData.getTableLayout() + +
            +          Gets the layout of the table this row data belongs to.
            + KijiTableLayoutHBaseMetaTable.getTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + KijiTableLayoutHBaseMetaTable.updateTableLayout(String table, + TableLayoutDesc layoutUpdate) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KijiTableLayout
            + List<KijiTableLayout>HBaseMetaTable.getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>HBaseMetaTable.getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiTableLayout
            + voidHBaseDataRequestAdapter.applyToScan(Scan scan, + KijiTableLayout tableLayout) + +
            +          Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one.
            + GetHBaseDataRequestAdapter.toGet(EntityId entityId, + KijiTableLayout tableLayout) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + GetHBaseDataRequestAdapter.toGet(EntityId entityId, + KijiTableLayout tableLayout, + int pageIndex) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + ScanHBaseDataRequestAdapter.toScan(KijiTableLayout tableLayout) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            + ScanHBaseDataRequestAdapter.toScan(KijiTableLayout tableLayout, + HBaseScanOptions scanOptions) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTableLayout
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiTableLayout
            +static KijiTableLayoutKijiTableLayout.createFromEffectiveJson(InputStream istream) + +
            +          Loads a table layout from the specified JSON text.
            +static KijiTableLayoutKijiTableLayout.createFromEffectiveJsonResource(String resource) + +
            +          Loads a table layout from the specified resource as JSON.
            + KijiTableLayoutColumnNameTranslator.getTableLayout() + +
            +           
            + KijiTableLayoutKijiTableLayout.LocalityGroupLayout.getTableLayout() + +
            +           
            + KijiTableLayoutKijiTableLayoutDatabase.getTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            +static KijiTableLayoutTableLayoutSerializer.readInputTableLayout(Configuration conf) + +
            +          Reads an input table layout from the configuration.
            +static KijiTableLayoutTableLayoutSerializer.readOutputTableLayout(Configuration conf) + +
            +          Reads an output table layout from the configuration.
            +static KijiTableLayoutTableLayoutSerializer.readTableLayout(String confKey, + Configuration conf) + +
            +          Reads a table layout from the configuration.
            + KijiTableLayoutKijiTableLayoutDatabase.updateTableLayout(String table, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout
            + List<KijiTableLayout>KijiTableLayoutDatabase.getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>KijiTableLayoutDatabase.getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type KijiTableLayout
            +static voidTableLayoutSerializer.serializeInputTableLayout(KijiTableLayout tableLayout, + Configuration conf) + +
            +          Serializes the table layout into a configuration object for input.
            +static voidTableLayoutSerializer.serializeOutputTableLayout(KijiTableLayout tableLayout, + Configuration conf) + +
            +          Serializes the table layout into a configuration object for output.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type KijiTableLayout
            ColumnNameTranslator(KijiTableLayout tableLayout) + +
            +          Creates a new ColumnNameTranslator instance.
            InvalidLayoutException(KijiTableLayout tableLayout, + String reason) + +
            +          Constructs an exception indicated a table layout is invalid.
            KijiTableLayout(TableLayoutDesc desc, + KijiTableLayout reference) + +
            +          Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return KijiTableLayout
            + KijiTableLayoutHBaseTableLayoutDatabase.getTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + KijiTableLayoutHBaseTableLayoutDatabase.updateTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return types with arguments of type KijiTableLayout
            + List<KijiTableLayout>HBaseTableLayoutDatabase.getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>HBaseTableLayoutDatabase.getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type KijiTableLayout
            + HTableDescriptorHTableSchemaTranslator.toHTableDescriptor(String kijiInstanceName, + KijiTableLayout tableLayout) + +
            +          Translates a Kiji table layout into an HColumnDescriptor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html new file mode 100644 index 00000000..44ae12f4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html @@ -0,0 +1,257 @@ + + + + + + + +Uses of Interface org.kiji.schema.layout.KijiTableLayoutDatabase (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.layout.KijiTableLayoutDatabase

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiTableLayoutDatabase
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of KijiTableLayoutDatabase in org.kiji.schema
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema that implement KijiTableLayoutDatabase
            + classKijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            +  +

            + + + + + +
            +Uses of KijiTableLayoutDatabase in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableLayoutDatabase
            + classHBaseMetaTable + +
            +          An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTableLayoutDatabase
            HBaseMetaTable(HTableInterface htable, + KijiTableLayoutDatabase tableLayoutDatabase, + KijiTableKeyValueDatabase tableKeyValueDatabase) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  +

            + + + + + +
            +Uses of KijiTableLayoutDatabase in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.layout.impl that implement KijiTableLayoutDatabase
            + classHBaseTableLayoutDatabase + +
            +          Manages Kiji table layouts using a column family in an HBase table as a backing store.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html new file mode 100644 index 00000000..05da6a10 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.SchemaClassNotFoundException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.SchemaClassNotFoundException

            +
            +No usage of org.kiji.schema.layout.SchemaClassNotFoundException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/TableLayoutSerializer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/TableLayoutSerializer.html new file mode 100644 index 00000000..de8b4314 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/class-use/TableLayoutSerializer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.TableLayoutSerializer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.TableLayoutSerializer

            +
            +No usage of org.kiji.schema.layout.TableLayoutSerializer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/CellSpec.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/CellSpec.html new file mode 100644 index 00000000..6901658f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/CellSpec.html @@ -0,0 +1,557 @@ + + + + + + + +CellSpec (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class CellSpec

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.CellSpec
+
            +
            +
            +
            @ApiAudience.Private
+public final class CellSpec
            extends Object
            + + +

            +Specification of a Kiji cell. + + Contains everything needed to encode or decode a given column. + Wraps a CellSchema Avro record to avoid re-parsing JSON Avro schemas every time, and + associate it with a schema table to resolve schema IDs or hashes. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            CellSpec() + +
            +          Initializes a new, unspecified CellSpec.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static CellSpecfromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecfromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            + org.apache.avro.SchemagetAvroSchema() + +
            +           
            + CellSchemagetCellSchema() + +
            +           
            + KijiSchemaTablegetSchemaTable() + +
            +           
            + booleanisAvro() + +
            +           
            + booleanisCounter() + +
            +           
            +static CellSpecnewCounter() + +
            +           
            +static org.apache.avro.SchemareadAvroSchema(CellSchema cellSchema) + +
            +          Reads the Avro schema from the table layout.
            + CellSpecsetCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            + CellSpecsetReaderSchema(org.apache.avro.Schema readerSchema) + +
            +          Sets the Avro reader schema.
            + CellSpecsetSchemaStorage(SchemaStorage schemaStorage) + +
            +          Sets the schema storage.
            + CellSpecsetSchemaTable(KijiSchemaTable schemaTable) + +
            +          Sets the schema table.
            + CellSpecsetType(SchemaType schemaType) + +
            +          Sets the cell type.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +CellSpec

            +
            +public CellSpec()
            +
            +
            Initializes a new, unspecified CellSpec. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +newCounter

            +
            +public static CellSpec newCounter()
            +
            +
            + +
            Returns:
            a new CellSpec for a counter cell.
            +
            +
            +
            + +

            +fromCellSchema

            +
            +public static CellSpec fromCellSchema(CellSchema cellSchema,
+                                      KijiSchemaTable schemaTable)
+                               throws InvalidLayoutException
            +
            +
            +
            Parameters:
            cellSchema - CellSchema record to initialize the CellSpec from.
            schemaTable - Schema table to resolve schema hashes or UIDs. +
            Returns:
            a new CellSpec initialized from a CellSchema Avro descriptor. +
            Throws: +
            InvalidLayoutException - if the cell specification is invalid.
            +
            +
            +
            + +

            +fromCellSchema

            +
            +public static CellSpec fromCellSchema(CellSchema cellSchema)
+                               throws InvalidLayoutException
            +
            +
            Creates a CellSpec from a CellSchema record. +

            +

            +
            Parameters:
            cellSchema - CellSchema record. +
            Returns:
            a new CellSpec initialized from the given CellSchema. +
            Throws: +
            InvalidLayoutException - on layout error.
            +
            +
            +
            + +

            +setCellSchema

            +
            +public CellSpec setCellSchema(CellSchema cellSchema)
+                       throws InvalidLayoutException
            +
            +
            Sets the cell schema. +

            +

            +
            Parameters:
            cellSchema - CellSchema to initialize the CellSpec from. +
            Returns:
            this. +
            Throws: +
            InvalidLayoutException - on layout error.
            +
            +
            +
            + +

            +setSchemaStorage

            +
            +public CellSpec setSchemaStorage(SchemaStorage schemaStorage)
            +
            +
            Sets the schema storage. + + Does not make sense for counter cells. +

            +

            +
            Parameters:
            schemaStorage - Schema storage (hash, UID or final). +
            Returns:
            this.
            +
            +
            +
            + +

            +setType

            +
            +public CellSpec setType(SchemaType schemaType)
            +
            +
            Sets the cell type. +

            +

            +
            Parameters:
            schemaType - Cell type (counter, inline Avro or Avro class). +
            Returns:
            this.
            +
            +
            +
            + +

            +setReaderSchema

            +
            +public CellSpec setReaderSchema(org.apache.avro.Schema readerSchema)
            +
            +
            Sets the Avro reader schema. + + Does not make sense for counter cells. +

            +

            +
            Parameters:
            readerSchema - Avro reader schema. +
            Returns:
            this.
            +
            +
            +
            + +

            +setSchemaTable

            +
            +public CellSpec setSchemaTable(KijiSchemaTable schemaTable)
            +
            +
            Sets the schema table. +

            +

            +
            Parameters:
            schemaTable - Schema table. +
            Returns:
            this.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public KijiSchemaTable getSchemaTable()
            +
            +
            + +
            Returns:
            the schema table to resolve schema hashes or IDs.
            +
            +
            +
            + +

            +isCounter

            +
            +public boolean isCounter()
            +
            +
            + +
            Returns:
            whether this cell is a counter.
            +
            +
            +
            + +

            +isAvro

            +
            +public boolean isAvro()
            +
            +
            + +
            Returns:
            whether this cell is encoded with Avro.
            +
            +
            +
            + +

            +getCellSchema

            +
            +public CellSchema getCellSchema()
            +
            +
            + +
            Returns:
            the underlying CellSchema Avro record. May be null.
            +
            +
            +
            + +

            +getAvroSchema

            +
            +public org.apache.avro.Schema getAvroSchema()
            +
            +
            + +
            Returns:
            the cell Avro schema. Valid for Avro cells only.
            +
            +
            +
            + +

            +readAvroSchema

            +
            +public static org.apache.avro.Schema readAvroSchema(CellSchema cellSchema)
+                                             throws InvalidLayoutException
            +
            +
            Reads the Avro schema from the table layout. +

            +

            +
            Parameters:
            cellSchema - The portion of the table layout record to read from. +
            Returns:
            the Avro schema, or null for a counter. +
            Throws: +
            InvalidLayoutException - if the specification or the schema is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/ColumnId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/ColumnId.html new file mode 100644 index 00000000..b87631c1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/ColumnId.html @@ -0,0 +1,559 @@ + + + + + + + +ColumnId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class ColumnId

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.ColumnId
+
            +
            +
            +
            @ApiAudience.Private
+public final class ColumnId
            extends Object
            + + +

            +

            A very short physical identifier for a column family or qualifier to be used in HBase.

            + +

            Since HBase is a sparse storage system, every cell's data must be stored along with + its full address: its row key, family name, column qualifier, and timestamp. Because + of this, it is important to keep the names of families and qualifiers as short as + possible.

            + +

            A ColumnId is the physical byte[] that is used as a family or qualifier name in + HBase. It is an encoded number using a 64-character alphabet with the more significant + digits to the right. This class allows you to convert between the integers and the + UTF-8 encoded physical names. For example:

            + + + + + + + + + + + + + + + + + +
            idname
            1B
            1BA
            1BAA
            2C
            25Z
            26a
            51z
            520
            619
            62+
            63/
            64AB
            65BB
            66CB
            + +

            The benefit here is that until a user has defined at least 64 column names in their + layout, all of the names used in HBase will only be one byte. The next 64 names will + only be two bytes, and so on. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringALPHABET + +
            +          The alphabet used to generate the short physical names.
            +static intBITS_PER_DIGIT + +
            +          The base 2 logarithm of the size of the alphabet (64), which is the number of bits + we can encode with a single digit.
            +static intRADIX + +
            +          The size of the alphabet for a digit, which is the radix of our printed number.
            +static intUNASSIGNED + +
            +          The special value reserved to mean that a symbolic name has not been assigned a column id.
            +static Map<Character,Integer>VALUE_MAP + +
            +          A map from characters in the alphabet to the integer it represents.
            +  + + + + + + + + + + +
            +Constructor Summary
            ColumnId(int id) + +
            +          Constructs a column id that encodes the given integer.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            +static ColumnIdfromByteArray(byte[] encoded) + +
            +          Translates HBase column names to ColumnIds.
            +static ColumnIdfromString(String encoded) + +
            +          Translates HBase column names to ColumnIds.
            + intgetId() + +
            +           
            + inthashCode() + +
            +          
            + byte[]toByteArray() + +
            +          Translates ColumnIds to HBase column names.
            + StringtoString() + +
            +          Gets the id as a string of digits from our alphabet.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +UNASSIGNED

            +
            +public static final int UNASSIGNED
            +
            +
            The special value reserved to mean that a symbolic name has not been assigned a column id. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +ALPHABET

            +
            +public static final String ALPHABET
            +
            +
            The alphabet used to generate the short physical names. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +RADIX

            +
            +public static final int RADIX
            +
            +
            The size of the alphabet for a digit, which is the radix of our printed number. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +BITS_PER_DIGIT

            +
            +public static final int BITS_PER_DIGIT
            +
            +
            The base 2 logarithm of the size of the alphabet (64), which is the number of bits + we can encode with a single digit. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +VALUE_MAP

            +
            +public static final Map<Character,Integer> VALUE_MAP
            +
            +
            A map from characters in the alphabet to the integer it represents. +

            +

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

            +ColumnId

            +
            +public ColumnId(int id)
            +
            +
            Constructs a column id that encodes the given integer. +

            +

            +
            Parameters:
            id - The integer identifier for this column.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +fromByteArray

            +
            +public static ColumnId fromByteArray(byte[] encoded)
            +
            +
            Translates HBase column names to ColumnIds. The HBase byte arrays are UTF-8 encoded + numbers from our base-64 alphabet. +

            +

            +
            Parameters:
            encoded - The family or qualifier bytes from HBase. +
            Returns:
            A ColumnId from the byte array.
            +
            +
            +
            + +

            +fromString

            +
            +public static ColumnId fromString(String encoded)
            +
            +
            Translates HBase column names to ColumnIds. The HBase names are UTF-8 encoded + numbers from our base-64 alphabet. +

            +

            +
            Parameters:
            encoded - The family or qualifier bytes from HBase. +
            Returns:
            A ColumnId from the encoded name.
            +
            +
            +
            + +

            +getId

            +
            +public int getId()
            +
            +
            + +
            Returns:
            the column id.
            +
            +
            +
            + +

            +toByteArray

            +
            +public byte[] toByteArray()
            +
            +

            Translates ColumnIds to HBase column names.

            + +

            Encodes to a byte array making it as short as possible. We use characters that + HBase allows (no control characters and no colon).

            +

            +

            + +
            Returns:
            The column id encoded as an HBase-friendly byte array.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            Gets the id as a string of digits from our alphabet. +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            + +
            Returns:
            The digit string, with the significant digits on the right.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html new file mode 100644 index 00000000..72058f4e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html @@ -0,0 +1,638 @@ + + + + + + + +HBaseTableLayoutDatabase (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class HBaseTableLayoutDatabase

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.HBaseTableLayoutDatabase
+
            +
            +
            All Implemented Interfaces:
            KijiTableLayoutDatabase
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseTableLayoutDatabase
            extends Object
            implements KijiTableLayoutDatabase
            + + +

            +

            Manages Kiji table layouts using a column family in an HBase table as a backing store.

            + +

            + The HTable row key is the name of the table, and the row has 3 columns: +

          • the layout update, as specified by the user/submitter;
            • +
          • the effective layout after applying the update;
            • +
          • a hash of the effective layout.
            • +

            + +

            + Layouts and layout updates are encoded as Kiji cells, using Avro schema hashes, and as + TableLayoutDesc Avro records. +

            + +

            A static method, getHColumnDescriptor returns the description of an + HColumn that should be used to construct the HTable for the backing store.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringQUALIFIER_LAYOUT + +
            +          HBase column qualifier used to store absolute layouts.
            +static StringQUALIFIER_LAYOUT_ID + +
            +          HBase column qualifier used to store layout IDs.
            +static StringQUALIFIER_UPDATE + +
            +          HBase column qualifier used to store layout updates.
            +  + + + + + + + + + + +
            +Constructor Summary
            HBaseTableLayoutDatabase(HTableInterface htable, + String family, + KijiSchemaTable schemaTable) + +
            +          Creates a new HBaseTableLayoutDatabase instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static HColumnDescriptorgetHColumnDescriptor(String family) + +
            +          Gets the description of an HColumn suitable for storing the table layout database.
            + KijiTableLayoutgetTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + List<KijiTableLayout>getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            + voidlayoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> layoutBackup) + +
            +          Restores a table layout history from a backup.
            + List<TableLayoutBackupEntry>layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            + List<String>listTables() + +
            +          Lists the tables in this Kiji instance.
            + voidremoveAllTableLayoutVersions(String table) + +
            +          Removes all layout information for a particular table.
            + voidremoveRecentTableLayoutVersions(String table, + int numVersions) + +
            +          Removes the most recent layout information for a given table.
            + KijiTableLayoutupdateTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +QUALIFIER_UPDATE

            +
            +public static final String QUALIFIER_UPDATE
            +
            +
            HBase column qualifier used to store layout updates. + Layout updates are binary encoded TableLayoutDesc records. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +QUALIFIER_LAYOUT

            +
            +public static final String QUALIFIER_LAYOUT
            +
            +
            HBase column qualifier used to store absolute layouts. + Table layouts are binary encoded TableLayoutDesc records. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +QUALIFIER_LAYOUT_ID

            +
            +public static final String QUALIFIER_LAYOUT_ID
            +
            +
            HBase column qualifier used to store layout IDs. + Currently, IDs are assigned using a long counter starting at 1, and encoded as a string. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +HBaseTableLayoutDatabase

            +
            +public HBaseTableLayoutDatabase(HTableInterface htable,
+                                String family,
+                                KijiSchemaTable schemaTable)
+                         throws IOException
            +
            +
            Creates a new HBaseTableLayoutDatabase instance. + +

            This class does not take ownership of the HTable. The caller should close it when + it is no longer needed.

            +

            +

            +
            Parameters:
            htable - The HTable used to store the layout data.
            family - The name of the column family within the HTable used to store layout data.
            schemaTable - The Kiji schema table. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +updateTableLayout

            +
            +public KijiTableLayout updateTableLayout(String tableName,
+                                         TableLayoutDesc update)
+                                  throws IOException
            +
            +
            Sets a table's layout. Also calls validateAndAssignLayout(). +

            +

            +
            Specified by:
            updateTableLayout in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            tableName - The name of the Kiji table to affect.
            update - Descriptor for the layout update. +
            Returns:
            the new effective layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout(String table)
+                               throws IOException
            +
            +
            Gets the most recent versions of the layout for a table. +

            +

            +
            Specified by:
            getTableLayout in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            The table's layout. +
            Throws: +
            IOException - If there is an error or no such table.
            +
            +
            +
            + +

            +getTableLayoutVersions

            +
            +public List<KijiTableLayout> getTableLayoutVersions(String table,
+                                                    int numVersions)
+                                             throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the table layout. +

            +

            +
            Specified by:
            getTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the layout for the table, sorted by + most-recent-first. If there are no layouts, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedTableLayoutVersions

            +
            +public NavigableMap<Long,KijiTableLayout> getTimedTableLayoutVersions(String table,
+                                                                      int numVersions)
+                                                               throws IOException
            +
            +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +

            +

            +
            Specified by:
            getTimedTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values the most recent versions of the layout for the table, and + keys the corresponding timestamps, ordered from most recent first to least recent last. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllTableLayoutVersions

            +
            +public void removeAllTableLayoutVersions(String table)
+                                  throws IOException
            +
            +
            Removes all layout information for a particular table. +

            +

            +
            Specified by:
            removeAllTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeRecentTableLayoutVersions

            +
            +public void removeRecentTableLayoutVersions(String table,
+                                            int numVersions)
+                                     throws IOException
            +
            +
            Removes the most recent layout information for a given table. +

            +

            +
            Specified by:
            removeRecentTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +listTables

            +
            +public List<String> listTables()
+                        throws IOException
            +
            +
            Lists the tables in this Kiji instance. +

            +

            +
            Specified by:
            listTables in interface KijiTableLayoutDatabase
            +
            +
            + +
            Returns:
            The list of table names. +
            Throws: +
            IOException - If the list of tables cannot be retrieved.
            +
            +
            +
            + +

            +getHColumnDescriptor

            +
            +public static HColumnDescriptor getHColumnDescriptor(String family)
            +
            +
            Gets the description of an HColumn suitable for storing the table layout database. +

            +

            +
            +
            +
            +
            Parameters:
            family - The family within the HTable used to store layout data. +
            Returns:
            The HColumn descriptor.
            +
            +
            +
            + +

            +layoutsToBackup

            +
            +public List<TableLayoutBackupEntry> layoutsToBackup(String table)
+                                             throws IOException
            +
            +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +

            +

            +
            Specified by:
            layoutsToBackup in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableLayoutBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +layoutsFromBackup

            +
            +public void layoutsFromBackup(String tableName,
+                              List<TableLayoutBackupEntry> layoutBackup)
+                       throws IOException
            +
            +
            Restores a table layout history from a backup. +

            +

            +
            Specified by:
            layoutsFromBackup in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            tableName - The name of the table to restore layouts for.
            layoutBackup - Table layout backup entries to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/HTableSchemaTranslator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/HTableSchemaTranslator.html new file mode 100644 index 00000000..1eb95ef2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/HTableSchemaTranslator.html @@ -0,0 +1,269 @@ + + + + + + + +HTableSchemaTranslator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class HTableSchemaTranslator

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.HTableSchemaTranslator
+
            +
            +
            +
            @ApiAudience.Private
+public final class HTableSchemaTranslator
            extends Object
            + + +

            +Translates between KijiTableLayouts and HTableDescriptors. + +

            A Kiji table has a layout with locality groups, families, and columns. An HTable + only has HColumns. This classes maps between the Kiji layout components and the HTable + schema components, which ultimately determines how we map Kiji data onto an HTable.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HTableSchemaTranslator() + +
            +          Creates a new HTableSchemaTranslator instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + HTableDescriptortoHTableDescriptor(String kijiInstanceName, + KijiTableLayout tableLayout) + +
            +          Translates a Kiji table layout into an HColumnDescriptor.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HTableSchemaTranslator

            +
            +public HTableSchemaTranslator()
            +
            +
            Creates a new HTableSchemaTranslator instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +toHTableDescriptor

            +
            +public HTableDescriptor toHTableDescriptor(String kijiInstanceName,
+                                           KijiTableLayout tableLayout)
            +
            +
            Translates a Kiji table layout into an HColumnDescriptor. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance the table lives in.
            tableLayout - The Kiji table layout. +
            Returns:
            The HTableDescriptor to use for storing the Kiji table data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/CellSpec.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/CellSpec.html new file mode 100644 index 00000000..9f801df3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/CellSpec.html @@ -0,0 +1,388 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.CellSpec (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.CellSpec

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use CellSpec
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type CellSpec
            + KijiCellDecoder<?>GenericCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + KijiCellEncoderKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            + KijiCellDecoder<?>SpecificCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + + + + + +
            +<T> KijiCellDecoder<T>
            +            		KijiCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type CellSpec
            + KijiCellEncoderDefaultKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type CellSpec
            AvroCellDecoder(CellSpec cellSpec) + +
            +          Initializes an abstract KijiAvroCellDecoder.
            AvroCellEncoder(CellSpec cellSpec) + +
            +          Creates a new KijiCellEncoder instance.
            GenericCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates generic Avro types.
            SpecificCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates specific Avro types.
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return CellSpec
            + CellSpecKijiTableLayout.getCellSpec(KijiColumnName column) + +
            +           
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return CellSpec
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            +static CellSpecCellSpec.newCounter() + +
            +           
            + CellSpecCellSpec.setCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            + CellSpecCellSpec.setReaderSchema(org.apache.avro.Schema readerSchema) + +
            +          Sets the Avro reader schema.
            + CellSpecCellSpec.setSchemaStorage(SchemaStorage schemaStorage) + +
            +          Sets the schema storage.
            + CellSpecCellSpec.setSchemaTable(KijiSchemaTable schemaTable) + +
            +          Sets the schema table.
            + CellSpecCellSpec.setType(SchemaType schemaType) + +
            +          Sets the cell type.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/ColumnId.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/ColumnId.html new file mode 100644 index 00000000..9ad2f989 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/ColumnId.html @@ -0,0 +1,266 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.ColumnId (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.ColumnId

            +
            + + + + + + + + + + + + + +
            +Packages that use ColumnId
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of ColumnId in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return ColumnId
            + ColumnIdKijiTableLayout.LocalityGroupLayout.getId() + +
            +           
            + ColumnIdKijiTableLayout.LocalityGroupLayout.FamilyLayout.getId() + +
            +           
            + ColumnIdKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.getId() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type ColumnId
            + com.google.common.collect.BiMap<ColumnId,String>KijiTableLayout.LocalityGroupLayout.FamilyLayout.getColumnIdNameMap() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>KijiTableLayout.LocalityGroupLayout.getFamilyIdNameMap() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>KijiTableLayout.getLocalityGroupIdNameMap() + +
            +           
            +  +

            + + + + + +
            +Uses of ColumnId in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return ColumnId
            +static ColumnIdColumnId.fromByteArray(byte[] encoded) + +
            +          Translates HBase column names to ColumnIds.
            +static ColumnIdColumnId.fromString(String encoded) + +
            +          Translates HBase column names to ColumnIds.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html new file mode 100644 index 00000000..ae2fde62 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.HBaseTableLayoutDatabase

            +
            +No usage of org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html new file mode 100644 index 00000000..a765299b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.HTableSchemaTranslator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.HTableSchemaTranslator

            +
            +No usage of org.kiji.schema.layout.impl.HTableSchemaTranslator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-frame.html new file mode 100644 index 00000000..10535f4c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-frame.html @@ -0,0 +1,39 @@ + + + + + + + +org.kiji.schema.layout.impl (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.schema.layout.impl + + + + +
            +Classes  + +
            +CellSpec +
            +ColumnId +
            +HBaseTableLayoutDatabase +
            +HTableSchemaTranslator
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-summary.html new file mode 100644 index 00000000..1cba9463 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-summary.html @@ -0,0 +1,190 @@ + + + + + + + +org.kiji.schema.layout.impl (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.layout.impl +

            +Implementation for Kiji table layout management. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            CellSpecSpecification of a Kiji cell.
            ColumnIdA very short physical identifier for a column family or qualifier to be used in HBase.
            HBaseTableLayoutDatabaseManages Kiji table layouts using a column family in an HBase table as a backing store.
            HTableSchemaTranslatorTranslates between KijiTableLayouts and HTableDescriptors.
            +  + +

            +

            +Package org.kiji.schema.layout.impl Description +

            + +

            +Implementation for Kiji table layout management. + +

            + Users generally shouldn't need to reference any of these classes directly, but rather use the + classes presented by the org.kiji.schema package. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-tree.html new file mode 100644 index 00000000..5a4c9a0b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-tree.html @@ -0,0 +1,155 @@ + + + + + + + +org.kiji.schema.layout.impl Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.layout.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-use.html new file mode 100644 index 00000000..9e7387b0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/impl/package-use.html @@ -0,0 +1,240 @@ + + + + + + + +Uses of Package org.kiji.schema.layout.impl (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.layout.impl

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.layout.impl
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema
            CellSpec + +
            +          Specification of a Kiji cell.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema.impl
            CellSpec + +
            +          Specification of a Kiji cell.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema.layout
            CellSpec + +
            +          Specification of a Kiji cell.
            ColumnId + +
            +          A very short physical identifier for a column family or qualifier to be used in HBase.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema.layout.impl
            CellSpec + +
            +          Specification of a Kiji cell.
            ColumnId + +
            +          A very short physical identifier for a column family or qualifier to be used in HBase.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-frame.html new file mode 100644 index 00000000..a2a5f303 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-frame.html @@ -0,0 +1,61 @@ + + + + + + + +org.kiji.schema.layout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.schema.layout + + + + +
            +Interfaces  + +
            +KijiTableLayoutDatabase
            + + + + + + +
            +Classes  + +
            +ColumnNameTranslator +
            +KijiTableLayout +
            +TableLayoutSerializer
            + + + + + + +
            +Exceptions  + +
            +InvalidLayoutException +
            +SchemaClassNotFoundException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-summary.html new file mode 100644 index 00000000..57a4cde8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-summary.html @@ -0,0 +1,234 @@ + + + + + + + +org.kiji.schema.layout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.layout +

            +Kiji table layouts. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            KijiTableLayoutDatabaseA database of Kiji table layouts.
            +  + +

            + + + + + + + + + + + + + + + + + +
            +Class Summary
            ColumnNameTranslatorTranslates between HTable and Kiji table column names.
            KijiTableLayoutLayout of a Kiji table.
            TableLayoutSerializerSerialize TableLayout instances into job configurations.
            +  + +

            + + + + + + + + + + + + + +
            +Exception Summary
            InvalidLayoutExceptionThrown when an invalid Kiji layout is encountered.
            SchemaClassNotFoundExceptionThrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path).
            +  + +

            +

            +Package org.kiji.schema.layout Description +

            + +

            +Kiji table layouts. + +

            + A Kiji table has a layout that describes the locality groups, families, and + columns it contains. + + This package contains code for serializing the layout metadata to and from JSON or binary Avro + records, and persisting it into the Kiji system tables in HBase. + + Kiji table layouts are persisted in the KijiMetaTable. + Kiji records the history of the layouts of each table. + When updating the layout of a table, Kiji validates the new layout against the current layout + of the table. + + Kiji table layouts are serialized to descriptors as TableLayoutDesc + Avro records (see the Avro record definitions in src/main/avro/Layout.avdl). + + Kiji table layouts are internally represented as KijiTableLayout + instances. KijiTableLayout wraps layout + descriptors, validate layout updates, assigns column IDs and provides convenience accessors. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-tree.html new file mode 100644 index 00000000..373df336 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-tree.html @@ -0,0 +1,168 @@ + + + + + + + +org.kiji.schema.layout Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.layout +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-use.html new file mode 100644 index 00000000..fb042a14 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/layout/package-use.html @@ -0,0 +1,307 @@ + + + + + + + +Uses of Package org.kiji.schema.layout (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.layout

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.layout
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema
            InvalidLayoutException + +
            +          Thrown when an invalid Kiji layout is encountered.
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayoutDatabase + +
            +          A database of Kiji table layouts.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.filter
            ColumnNameTranslator + +
            +          Translates between HTable and Kiji table column names.
            KijiTableLayout + +
            +          Layout of a Kiji table.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.impl
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayoutDatabase + +
            +          A database of Kiji table layouts.
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.layout
            InvalidLayoutException + +
            +          Thrown when an invalid Kiji layout is encountered.
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayout.LocalityGroupLayout + +
            +          Concrete layout of a locality group.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout + +
            +          Concrete layout of a family.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout + +
            +          Concrete layout of a column.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.layout.impl
            InvalidLayoutException + +
            +          Thrown when an invalid Kiji layout is encountered.
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayoutDatabase + +
            +          A database of Kiji table layouts.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/DistributedCacheJars.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/DistributedCacheJars.html new file mode 100644 index 00000000..f72d57f4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/DistributedCacheJars.html @@ -0,0 +1,330 @@ + + + + + + + +DistributedCacheJars (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class DistributedCacheJars

            +
            +java.lang.Object
+  extended by org.kiji.schema.mapreduce.DistributedCacheJars
+
            +
            +Deprecated. +

            +

            +
            @ApiAudience.Public
+@Deprecated
+public final class DistributedCacheJars
            extends Object
            + + +

            +Utility class for dealing with Java JAR files and the hadoop distributed cache. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidaddJarsToDistributedCache(Job job, + File jarDirectory) + +
            +          Deprecated. Adds the jars from a directory into the distributed cache of a job.
            +static voidaddJarsToDistributedCache(Job job, + String jarDirectory) + +
            +          Deprecated. Adds the jars from a directory into the distributed cache of a job.
            +static List<String>deDuplicateJarNames(List<String> jarList) + +
            +          Deprecated. Takes a list of paths and returns a list of paths with unique filenames.
            +static List<String>getJarsFromConfiguration(Configuration conf) + +
            +          Deprecated. Lists all jars in the variable tmpjars of this Configuration.
            +static List<String>getJarsFromDirectory(Configuration conf, + File jarDirectory) + +
            +          Deprecated.  
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +addJarsToDistributedCache

            +
            +public static void addJarsToDistributedCache(Job job,
+                                             String jarDirectory)
+                                      throws IOException
            +
            +
            Deprecated. 
            Adds the jars from a directory into the distributed cache of a job. +

            +

            +
            Parameters:
            job - The job to configure.
            jarDirectory - A path to a directory of jar files. +
            Throws: +
            IOException - If there is a problem reading from the file system.
            +
            +
            +
            + +

            +addJarsToDistributedCache

            +
            +public static void addJarsToDistributedCache(Job job,
+                                             File jarDirectory)
+                                      throws IOException
            +
            +
            Deprecated. 
            Adds the jars from a directory into the distributed cache of a job. +

            +

            +
            Parameters:
            job - The job to configure.
            jarDirectory - A path to a directory of jar files. +
            Throws: +
            IOException - If there is a problem reading from the file system.
            +
            +
            +
            + +

            +getJarsFromConfiguration

            +
            +public static List<String> getJarsFromConfiguration(Configuration conf)
            +
            +
            Deprecated. 
            Lists all jars in the variable tmpjars of this Configuration. +

            +

            +
            Parameters:
            conf - The Configuration to get jar names from +
            Returns:
            A list of jars.
            +
            +
            +
            + +

            +getJarsFromDirectory

            +
            +public static List<String> getJarsFromDirectory(Configuration conf,
+                                                File jarDirectory)
+                                         throws IOException
            +
            +
            Deprecated. 
            +
            Parameters:
            conf - Configuration to get FileSystem from
            jarDirectory - The directory of jars to get. +
            Returns:
            A list of qualified paths to the jars in jarDirectory. +
            Throws: +
            IOException - if there's a problem.
            +
            +
            +
            + +

            +deDuplicateJarNames

            +
            +public static List<String> deDuplicateJarNames(List<String> jarList)
            +
            +
            Deprecated. 
            Takes a list of paths and returns a list of paths with unique filenames. +

            +

            +
            Parameters:
            jarList - A list of jars to de-dupe. +
            Returns:
            A de-duplicated list of jars.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/KijiConfKeys.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/KijiConfKeys.html new file mode 100644 index 00000000..d337fd2f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/KijiConfKeys.html @@ -0,0 +1,277 @@ + + + + + + + +KijiConfKeys (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class KijiConfKeys

            +
            +java.lang.Object
+  extended by org.kiji.schema.mapreduce.KijiConfKeys
+
            +
            +Deprecated. +

            +

            +
            @Deprecated
+public final class KijiConfKeys
            extends Object
            + + +

            +Configuration keys used by KijiMR in Hadoop Configuration objects. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringINPUT_DATA_REQUEST + +
            +          Deprecated. Serialized input data request.
            +static StringINPUT_TABLE_URI + +
            +          Deprecated. URI of the input table to read from.
            +static StringOUTPUT_KIJI_TABLE_URI + +
            +          Deprecated. URI of the output Kiji table to write to.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +INPUT_TABLE_URI

            +
            +public static final String INPUT_TABLE_URI
            +
            +
            Deprecated. 
            URI of the input table to read from. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +OUTPUT_KIJI_TABLE_URI

            +
            +public static final String OUTPUT_KIJI_TABLE_URI
            +
            +
            Deprecated. 
            URI of the output Kiji table to write to. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +INPUT_DATA_REQUEST

            +
            +public static final String INPUT_DATA_REQUEST
            +
            +
            Deprecated. 
            Serialized input data request. +

            +

            +
            See Also:
            Constant Field Values
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html new file mode 100644 index 00000000..a92474dd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html @@ -0,0 +1,472 @@ + + + + + + + +KijiTableInputFormat.KijiTableRecordReader (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class KijiTableInputFormat.KijiTableRecordReader

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.RecordReader<EntityId,KijiRowData>
+      extended by org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Enclosing class:
            KijiTableInputFormat
            +
            +
            +
            +
            public static class KijiTableInputFormat.KijiTableRecordReader
            extends RecordReader<EntityId,KijiRowData>
            + + +

            +Hadoop record reader for Kiji table rows. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +protected  ConfigurationmConf + +
            +          Hadoop Configuration object containing settings.
            +protected  KijiDataRequestmDataRequest + +
            +          Data request.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableInputFormat.KijiTableRecordReader(Configuration conf) + +
            +          Creates a new RecordReader for this input format.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + EntityIdgetCurrentKey() + +
            +          
            + KijiRowDatagetCurrentValue() + +
            +          
            + floatgetProgress() + +
            +          
            + voidinitialize(InputSplit split, + TaskAttemptContext context) + +
            +          
            + booleannextKeyValue() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +mDataRequest

            +
            +protected final KijiDataRequest mDataRequest
            +
            +
            Data request. +

            +

            +
            +
            +
            + +

            +mConf

            +
            +protected final Configuration mConf
            +
            +
            Hadoop Configuration object containing settings. +

            +

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

            +KijiTableInputFormat.KijiTableRecordReader

            +
            +public KijiTableInputFormat.KijiTableRecordReader(Configuration conf)
            +
            +
            Creates a new RecordReader for this input format. This RecordReader will perform the actual + reads from Kiji. +

            +

            +
            Parameters:
            conf - The configuration object for this Kiji.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(InputSplit split,
+                       TaskAttemptContext context)
+                throws IOException
            +
            +
            +

            +

            +
            Specified by:
            initialize in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getCurrentKey

            +
            +public EntityId getCurrentKey()
+                       throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getCurrentKey in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getCurrentValue

            +
            +public KijiRowData getCurrentValue()
+                            throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getCurrentValue in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getProgress

            +
            +public float getProgress()
+                  throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getProgress in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +nextKeyValue

            +
            +public boolean nextKeyValue()
+                     throws IOException
            +
            +
            +

            +

            +
            Specified by:
            nextKeyValue in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/KijiTableInputFormat.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/KijiTableInputFormat.html new file mode 100644 index 00000000..28313e71 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/KijiTableInputFormat.html @@ -0,0 +1,401 @@ + + + + + + + +KijiTableInputFormat (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class KijiTableInputFormat

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.InputFormat<EntityId,KijiRowData>
+      extended by org.kiji.schema.mapreduce.KijiTableInputFormat
+
            +
            +
            All Implemented Interfaces:
            Configurable
            +
            +
            +Deprecated. +

            +

            +
            @Deprecated
+public class KijiTableInputFormat
            extends InputFormat<EntityId,KijiRowData>
            implements Configurable
            + + +

            +InputFormat for Hadoop MapReduce jobs reading from a Kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTableInputFormat.KijiTableRecordReader + +
            +          Deprecated. Hadoop record reader for Kiji table rows.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableInputFormat() + +
            +          Deprecated.  
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidconfigureJob(Job job, + KijiURI tableURI, + KijiDataRequest dataRequest, + String startRow, + String endRow) + +
            +          Deprecated. Configures a Hadoop M/R job to read from a given table.
            + RecordReader<EntityId,KijiRowData>createRecordReader(InputSplit split, + TaskAttemptContext context) + +
            +          Deprecated. 
            + ConfigurationgetConf() + +
            +          Deprecated. 
            + List<InputSplit>getSplits(JobContext context) + +
            +          Deprecated. 
            + voidsetConf(Configuration conf) + +
            +          Deprecated. 
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableInputFormat

            +
            +public KijiTableInputFormat()
            +
            +
            Deprecated. 
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(Configuration conf)
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            setConf in interface Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public Configuration getConf()
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            getConf in interface Configurable
            +
            +
            +
            +
            +
            +
            + +

            +createRecordReader

            +
            +public RecordReader<EntityId,KijiRowData> createRecordReader(InputSplit split,
+                                                             TaskAttemptContext context)
+                                                      throws IOException
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            createRecordReader in class InputFormat<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getSplits

            +
            +public List<InputSplit> getSplits(JobContext context)
+                           throws IOException
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            getSplits in class InputFormat<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +configureJob

            +
            +public static void configureJob(Job job,
+                                KijiURI tableURI,
+                                KijiDataRequest dataRequest,
+                                String startRow,
+                                String endRow)
+                         throws IOException
            +
            +
            Deprecated. 
            Configures a Hadoop M/R job to read from a given table. +

            +

            +
            +
            +
            +
            Parameters:
            job - Job to configure.
            tableURI - URI of the table to read from.
            dataRequest - Data request.
            startRow - Minimum row key to process.
            endRow - Maximum row Key to process. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html new file mode 100644 index 00000000..88dad539 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.DistributedCacheJars (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.DistributedCacheJars

            +
            +No usage of org.kiji.schema.mapreduce.DistributedCacheJars +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/KijiConfKeys.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/KijiConfKeys.html new file mode 100644 index 00000000..48adc10d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/KijiConfKeys.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.KijiConfKeys (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.KijiConfKeys

            +
            +No usage of org.kiji.schema.mapreduce.KijiConfKeys +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html new file mode 100644 index 00000000..fa86f4e1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader

            +
            +No usage of org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html new file mode 100644 index 00000000..3876b556 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.KijiTableInputFormat (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.KijiTableInputFormat

            +
            +No usage of org.kiji.schema.mapreduce.KijiTableInputFormat +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-frame.html new file mode 100644 index 00000000..0b2c1709 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-frame.html @@ -0,0 +1,39 @@ + + + + + + + +org.kiji.schema.mapreduce (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.schema.mapreduce + + + + +
            +Classes  + +
            +DistributedCacheJars +
            +KijiConfKeys +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-summary.html new file mode 100644 index 00000000..c9ff142b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-summary.html @@ -0,0 +1,197 @@ + + + + + + + +org.kiji.schema.mapreduce (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +@Deprecated +

            +Package org.kiji.schema.mapreduce +

            +Kiji map-reduce utilities. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            DistributedCacheJarsDeprecated.
            KijiConfKeysDeprecated.
            KijiTableInputFormatDeprecated.
            KijiTableInputFormat.KijiTableRecordReaderHadoop record reader for Kiji table rows.
            +  + +

            +

            +Package org.kiji.schema.mapreduce Description +

            + +

            +Kiji map-reduce utilities. + +

            This package provides support for building map-reduce jobs that read from and/or write to + a Kiji table. For reading from Kiji, use KijiTableInputFormat. For writing to + kiji use org.kiji.schema.mapreduce.KijiTableOutputFormat.

            + +

            December 20, 2012: Note that this package is deprecated; the KijiMapReduce framework + (https://github.com/kijiproject/kiji-mapreduce) will contain revamped versions of these + and additional MapReduce integration points. Users investing heavily in MapReduce + should pay attention to development on this new project at https://jira.kiji.org and the + user and developer mailing lists user@ and dev@kiji.org. After KijiMapReduce is released, + this package will disappear.

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-tree.html new file mode 100644 index 00000000..4301f9c8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.schema.mapreduce Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.mapreduce +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-use.html new file mode 100644 index 00000000..c705a8f2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/mapreduce/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.schema.mapreduce (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.mapreduce

            +
            +No usage of org.kiji.schema.mapreduce +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-frame.html new file mode 100644 index 00000000..7d26da83 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-frame.html @@ -0,0 +1,168 @@ + + + + + + + +org.kiji.schema (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.schema + + + + +
            +Interfaces  + +
            +HBaseFactory +
            +KijiCellDecoder +
            +KijiCellDecoderFactory +
            +KijiCellEncoder +
            +KijiCellEncoderFactory +
            +KijiCounter +
            +KijiDeleter +
            +KijiIncrementer +
            +KijiPutter +
            +KijiRowData +
            +KijiRowScanner +
            +KijiTable +
            +KijiTableFactory +
            +KijiTableKeyValueDatabase +
            +KijiTableWriter
            + + + + + + +
            +Classes  + +
            +EntityId +
            +EntityIdFactory +
            +GenericCellDecoderFactory +
            +HBaseColumnName +
            +HBaseFactory.Provider +
            +HBaseScanOptions +
            +Kiji +
            +KijiAdmin +
            +KijiCell +
            +KijiColumnName +
            +KijiColumnPager +
            +KijiConfiguration +
            +KijiDataRequest +
            +KijiDataRequest.Column +
            +KijiDataRequestValidator +
            +KijiInstaller +
            +KijiManagedHBaseTableName +
            +KijiMetaTable +
            +KijiRowKeySplitter +
            +KijiSchemaTable +
            +KijiSchemaTable.SchemaEntry +
            +KijiSystemTable +
            +KijiTablePool +
            +KijiTablePool.Options +
            +KijiTableReader +
            +KijiURI +
            +SpecificCellDecoderFactory
            + + + + + + +
            +Exceptions  + +
            +IncompatibleKijiVersionException +
            +KijiColumnPagingNotEnabledException +
            +KijiDataRequestException +
            +KijiInvalidNameException +
            +KijiNotInstalledException +
            +KijiTableNotFoundException +
            +KijiTablePool.NoCapacityException +
            +KijiURIException +
            +NoCellDataException +
            +NoSuchColumnException +
            +NotAKijiManagedTableException +
            +TableKeyNotFoundException
            + + + + + + +
            +Errors  + +
            +InternalKijiError
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-summary.html new file mode 100644 index 00000000..a34acef5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-summary.html @@ -0,0 +1,465 @@ + + + + + + + +org.kiji.schema (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema +

            +The main package for users of KijiSchema. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Interface Summary
            HBaseFactoryFactory for HBase instances based on URIs.
            KijiCellDecoder<T>Interface for Kiji cell decoders.
            KijiCellDecoderFactoryInterface for factories of KijiCellDecoder instances.
            KijiCellEncoderInterface for Kiji cell encoders.
            KijiCellEncoderFactoryInterface for factories of KijiCellEncoder instances.
            KijiCounterDeprecated. KijiCounter will be merged into KijiCell.
            KijiDeleterInterface for performing deletes on a Kiji table.
            KijiIncrementerInterface for performing increments on a Kiji table.
            KijiPutterInterface for performing puts on a Kiji table.
            KijiRowDataThe input data for a single entity in Kiji.
            KijiRowScannerInterface for scanning over rows read from a Kiji table.
            KijiTableInterface for Kiji Tables.
            KijiTableFactoryFactory for KijiTable instances.
            KijiTableKeyValueDatabaseA database of per table key-value pairs.
            KijiTableWriterInterface for modifying a Kiji table.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            EntityIdEntityId is used to identify a particular row in a Kiji table.
            EntityIdFactoryFactory class for creating EntityIds.
            GenericCellDecoderFactoryFactory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas.
            HBaseColumnNameAn HBase column name.
            HBaseFactory.ProviderProvider for the default HBaseFactory.
            HBaseScanOptionsCustomizable parameters for KijiRowScanners backed by an HBase scan.
            KijiKiji instance class that contains configuration and table + information.
            KijiAdminAdministration API for managing a Kiji instance.
            KijiCell<T>The data held in one cell of a kiji table.
            KijiColumnNameA Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiColumnPagerFetches new pages of column data in Kiji, and maintains state for which page each column is on.
            KijiConfigurationThe configuration for a single instance of Kiji, as a cluster could + contain multiple instances.
            KijiDataRequestDescribes a request for columns of data to read from a Kiji table.
            KijiDataRequest.ColumnDescribes a request for a Kiji Table column.
            KijiDataRequestValidatorThis class validates a KijiDataRequest against the layout + of a Kiji table to make sure it contains all of the columns requested.
            KijiInstallerInstalls or uninstalls Kiji instances from an HBase cluster.
            KijiManagedHBaseTableNameMultiple instances of Kiji can be installed on a single HBase + cluster.
            KijiMetaTableThe kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiRowKeySplitterUtility class for splitting the Kiji row key space.
            KijiSchemaTableThe Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSchemaTable.SchemaEntryAssociation between a schema and its ID.
            KijiSystemTableThe Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiTablePoolMaintains a pool of opened KijiTables.
            KijiTablePool.OptionsDescribes the options that can be configured on the KijiTablePool.
            KijiTableReaderInterface for reading data from a kiji table.
            KijiURIURI that fully qualifies a Kiji instance/table/column.
            SpecificCellDecoderFactoryFactory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Exception Summary
            IncompatibleKijiVersionExceptionThrown when there is an attempt to operate on a Kiji instance whose data format version + is incompatible with the Kiji client version.
            KijiColumnPagingNotEnabledExceptionThrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column.
            KijiDataRequestExceptionThrown when there is an error validating a KijiDataRequest against a Kiji table.
            KijiInvalidNameExceptionThrown when a Kiji instance or table layout name is invalid.
            KijiNotInstalledExceptionThrown when attempting to open a non existing/not installed Kiji instance.
            KijiTableNotFoundExceptionThrown when an attempt to access a table fails because it does not exist.
            KijiTablePool.NoCapacityExceptionThrown when an attempt to get a table connection fails because there is no room in the pool.
            KijiURIExceptionThrown when parsing a bogus Kiji table URI.
            NoCellDataExceptionThrown when attempting to read data from a cell that doesn't exist.
            NoSuchColumnExceptionThrown when attempting to access a column that does not exist.
            NotAKijiManagedTableExceptionThrown when Kiji encounters an HBase table that is not managed by Kiji.
            TableKeyNotFoundExceptionThrown when a key is not found in a map-like API implemented by one of the + Kiji tables, the system or meta table for example.
            +  + +

            + + + + + + + + + +
            +Error Summary
            InternalKijiErrorThrown when there is something wrong with the internal Kiji + implementation.
            +  + +

            +

            +Package org.kiji.schema Description +

            + +

            +The main package for users of KijiSchema. + +

            + KijiSchema provides layout and schema management on top of HBase. KijiSchema also allows + for the use of both structured and unstructured data in HBase using Avro serialization. +

            + +

            + Classes of note: +

            + + +

            + Related Documentation: +

            + +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-tree.html new file mode 100644 index 00000000..fe35077b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-tree.html @@ -0,0 +1,218 @@ + + + + + + + +org.kiji.schema Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-use.html new file mode 100644 index 00000000..c3daa0a2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/package-use.html @@ -0,0 +1,759 @@ + + + + + + + +Uses of Package org.kiji.schema (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            org.kiji.schema.mapreduceKiji map-reduce utilities. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            EntityIdFactory + +
            +          Factory class for creating EntityIds.
            HBaseFactory + +
            +          Factory for HBase instances based on URIs.
            HBaseScanOptions + +
            +          Customizable parameters for KijiRowScanners backed by an HBase scan.
            Kiji + +
            +          Kiji instance class that contains configuration and table + information.
            KijiCell + +
            +          The data held in one cell of a kiji table.
            KijiCellDecoder + +
            +          Interface for Kiji cell decoders.
            KijiCellDecoderFactory + +
            +          Interface for factories of KijiCellDecoder instances.
            KijiCellEncoder + +
            +          Interface for Kiji cell encoders.
            KijiColumnName + +
            +          A Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiConfiguration + +
            +          The configuration for a single instance of Kiji, as a cluster could + contain multiple instances.
            KijiCounter + +
            +          Deprecated. KijiCounter will be merged into KijiCell.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiDataRequest.Column + +
            +          Describes a request for a Kiji Table column.
            KijiDeleter + +
            +          Interface for performing deletes on a Kiji table.
            KijiIncrementer + +
            +          Interface for performing increments on a Kiji table.
            KijiInvalidNameException + +
            +          Thrown when a Kiji instance or table layout name is invalid.
            KijiManagedHBaseTableName + +
            +          Multiple instances of Kiji can be installed on a single HBase + cluster.
            KijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiPutter + +
            +          Interface for performing puts on a Kiji table.
            KijiRowData + +
            +          The input data for a single entity in Kiji.
            KijiRowScanner + +
            +          Interface for scanning over rows read from a Kiji table.
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSystemTable + +
            +          The Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiTable + +
            +          Interface for Kiji Tables.
            KijiTableFactory + +
            +          Factory for KijiTable instances.
            KijiTableKeyValueDatabase + +
            +          A database of per table key-value pairs.
            KijiTablePool.Options + +
            +          Describes the options that can be configured on the KijiTablePool.
            KijiTableReader + +
            +          Interface for reading data from a kiji table.
            KijiTableWriter + +
            +          Interface for modifying a Kiji table.
            KijiURI + +
            +          URI that fully qualifies a Kiji instance/table/column.
            KijiURIException + +
            +          Thrown when parsing a bogus Kiji table URI.
            NotAKijiManagedTableException + +
            +          Thrown when Kiji encounters an HBase table that is not managed by Kiji.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.filter
            HBaseColumnName + +
            +          An HBase column name.
            KijiCell + +
            +          The data held in one cell of a kiji table.
            KijiColumnName + +
            +          A Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            NoSuchColumnException + +
            +          Thrown when attempting to access a column that does not exist.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.impl
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            EntityIdFactory + +
            +          Factory class for creating EntityIds.
            HBaseFactory + +
            +          Factory for HBase instances based on URIs.
            HBaseScanOptions + +
            +          Customizable parameters for KijiRowScanners backed by an HBase scan.
            Kiji + +
            +          Kiji instance class that contains configuration and table + information.
            KijiCell + +
            +          The data held in one cell of a kiji table.
            KijiCellDecoder + +
            +          Interface for Kiji cell decoders.
            KijiCellDecoderFactory + +
            +          Interface for factories of KijiCellDecoder instances.
            KijiCellEncoder + +
            +          Interface for Kiji cell encoders.
            KijiCellEncoderFactory + +
            +          Interface for factories of KijiCellEncoder instances.
            KijiConfiguration + +
            +          The configuration for a single instance of Kiji, as a cluster could + contain multiple instances.
            KijiCounter + +
            +          Deprecated. KijiCounter will be merged into KijiCell.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiDeleter + +
            +          Interface for performing deletes on a Kiji table.
            KijiIncrementer + +
            +          Interface for performing increments on a Kiji table.
            KijiManagedHBaseTableName + +
            +          Multiple instances of Kiji can be installed on a single HBase + cluster.
            KijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiPutter + +
            +          Interface for performing puts on a Kiji table.
            KijiRowData + +
            +          The input data for a single entity in Kiji.
            KijiRowScanner + +
            +          Interface for scanning over rows read from a Kiji table.
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSchemaTable.SchemaEntry + +
            +          Association between a schema and its ID.
            KijiSystemTable + +
            +          The Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiTable + +
            +          Interface for Kiji Tables.
            KijiTableFactory + +
            +          Factory for KijiTable instances.
            KijiTableKeyValueDatabase + +
            +          A database of per table key-value pairs.
            KijiTableReader + +
            +          Interface for reading data from a kiji table.
            KijiTableWriter + +
            +          Interface for modifying a Kiji table.
            KijiURI + +
            +          URI that fully qualifies a Kiji instance/table/column.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.layout
            HBaseColumnName + +
            +          An HBase column name.
            KijiColumnName + +
            +          A Kiji column name is composed of one or two parts: a family and a qualifier.
            NoSuchColumnException + +
            +          Thrown when attempting to access a column that does not exist.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.layout.impl
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            +  +

            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.mapreduce
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiRowData + +
            +          The input data for a single entity in Kiji.
            KijiURI + +
            +          URI that fully qualifies a Kiji instance/table/column.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.tools
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            Kiji + +
            +          Kiji instance class that contains configuration and table + information.
            KijiURI + +
            +          URI that fully qualifies a Kiji instance/table/column.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.util
            Kiji + +
            +          Kiji instance class that contains configuration and table + information.
            KijiInvalidNameException + +
            +          Thrown when a Kiji instance or table layout name is invalid.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/BaseTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/BaseTool.html new file mode 100644 index 00000000..99870599 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/BaseTool.html @@ -0,0 +1,570 @@ + + + + + + + +BaseTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class BaseTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            Direct Known Subclasses:
            InstallTool, UninstallTool, VersionTool, VersionValidatedTool
            +
            +
            +
            +
            @ApiAudience.Framework
+public abstract class BaseTool
            extends Configured
            implements KijiTool
            + + +

            +Base class for all command line tools. A kiji command line tool operates on a kiji instance, + specified through a KijiURI via the command-line (with a default value pointing to the + default kiji instance found in the hbase cluster specified by whatever hbase configuration is + on the classpath). If the kiji URI for the instance specifies more elements than the zookeeper + connection information and instance name they will be ignored. + + A command line tool, executed via KijiToolLauncher, will perform these steps when run: +

              +
            1. Parse command-line flags to the tool and set the appropriate fields. Subclasses + wishing to add flags to a tool should use the Flag annotation.
              2. +
            2. Use the kiji URI specified via the command line (or using the default + kiji://.env/default to initialize the instance's configuration with + hbase connection parameters and hbase resources.
              3. +
            3. Run the validateFlags() method. Subclasses wishing to validate custom + command-line arguments should override this method + but take care to call super.validateFlags()
              4. +
            4. Run the setup() method. Subclasses wishing to implement custom setup logic + should override this method but take care to call super.setup()
              5. +
            5. Run the run(java.util.List) method. Subclasses should implement their main + command logic here. The argument to run is a String list of + arguments passed that were not arguments to the Hadoop framework or flags specified via + Flag annotations.
              6. +
            6. Run the cleanup() method. Subclasses wishing to implement custom cleanup + logic should override this method but take care to call super.cleanup. + cleanup will run even if there is an exception while executing setup + or run. +
            + + Tools needing to prompt the user for a yes/no answer should use the yesNoPrompt() method. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            BaseTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + PrintStreamgetPrintStream() + +
            +          The output print stream the tool should be writing to.
            +protected  KijiURIgetURI() + +
            +          Returns the kiji URI of the target this tool operates on.
            +protected abstract  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            + voidsetPrintStream(PrintStream printStream) + +
            +          Set the output print stream the tool should write to.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidsetURI(KijiURI uri) + +
            +          Sets the kiji URI of the target this tool operates on.
            + inttoolMain(List<String> args) + +
            +          Invoke the functionality of this tool, as supplied through its + implementation of the abstract methods of this class.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +protected  booleanyesNoPrompt() + +
            +          Prompts the user for a yes or no answer until they provide a valid response + (y/n/yes/no case insensitive) and reports the result.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.tools.KijiTool
            getCategory, getDescription, getName
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +BaseTool

            +
            +public BaseTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +yesNoPrompt

            +
            +protected boolean yesNoPrompt()
+                       throws IOException
            +
            +
            Prompts the user for a yes or no answer until they provide a valid response + (y/n/yes/no case insensitive) and reports the result. +

            +

            +
            +
            +
            + +
            Returns:
            true if the user answer yes, false if the user answered no. +
            Throws: +
            IOException - if there is a problem reading from the terminal.
            +
            +
            +
            + +

            +toolMain

            +
            +public int toolMain(List<String> args)
+             throws Exception
            +
            +
            Invoke the functionality of this tool, as supplied through its + implementation of the abstract methods of this class. +

            +

            +
            Specified by:
            toolMain in interface KijiTool
            +
            +
            +
            Parameters:
            args - the command-line arguments to the tool not including the + tool name itself. +
            Returns:
            0 on success, non-zero on failure. +
            Throws: +
            Exception - if there's an error inside the tool.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected abstract int run(List<String> nonFlagArgs)
+                    throws Exception
            +
            +
            Runs the tool. +

            +

            +
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getURI

            +
            +protected KijiURI getURI()
            +
            +
            Returns the kiji URI of the target this tool operates on. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji URI of the target this tool operates on.
            +
            +
            +
            + +

            +setURI

            +
            +protected void setURI(KijiURI uri)
            +
            +
            Sets the kiji URI of the target this tool operates on. +

            +

            +
            +
            +
            +
            Parameters:
            uri - The kiji URI of the target this tool should operate on.
            +
            +
            +
            + +

            +setPrintStream

            +
            +public void setPrintStream(PrintStream printStream)
            +
            +
            Set the output print stream the tool should write to. If you don't set it, + it will default to STDOUT. +

            +

            +
            +
            +
            +
            Parameters:
            printStream - The output print stream to use.
            +
            +
            +
            + +

            +getPrintStream

            +
            +public PrintStream getPrintStream()
            +
            +
            The output print stream the tool should be writing to. +

            +

            +
            +
            +
            + +
            Returns:
            The print stream the tool should write to.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/CreateTableTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/CreateTableTool.html new file mode 100644 index 00000000..7379cc3b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/CreateTableTool.html @@ -0,0 +1,509 @@ + + + + + + + +CreateTableTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class CreateTableTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.CreateTableTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class CreateTableTool
            extends VersionValidatedTool
            + + +

            +Command-line tool for creating kiji tables in kiji instances. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            CreateTableTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, setPrintStream, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +CreateTableTool

            +
            +public CreateTableTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/DeleteTableTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/DeleteTableTool.html new file mode 100644 index 00000000..37bbf1a0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/DeleteTableTool.html @@ -0,0 +1,509 @@ + + + + + + + +DeleteTableTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class DeleteTableTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.DeleteTableTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DeleteTableTool
            extends VersionValidatedTool
            + + +

            +Command-line tool for deleting kiji tables from kiji instances. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DeleteTableTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, setPrintStream, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +DeleteTableTool

            +
            +public DeleteTableTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/FlushTableTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/FlushTableTool.html new file mode 100644 index 00000000..20e7f371 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/FlushTableTool.html @@ -0,0 +1,509 @@ + + + + + + + +FlushTableTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class FlushTableTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.FlushTableTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class FlushTableTool
            extends VersionValidatedTool
            + + +

            +Command-line tool for flushing kiji meta and user tables in hbase. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            FlushTableTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, setPrintStream, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +FlushTableTool

            +
            +public FlushTableTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/HelpTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/HelpTool.html new file mode 100644 index 00000000..8377db14 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/HelpTool.html @@ -0,0 +1,367 @@ + + + + + + + +HelpTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class HelpTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.HelpTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HelpTool
            extends Configured
            implements KijiTool
            + + +

            +Command-line tool for displaying help on available tools. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HelpTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            + inttoolMain(List<String> args) + +
            +          The main logic of your tool.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +HelpTool

            +
            +public HelpTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            Specified by:
            getName in interface KijiTool
            +
            +
            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            +
            Specified by:
            getDescription in interface KijiTool
            +
            +
            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            +
            Specified by:
            getCategory in interface KijiTool
            +
            +
            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +toolMain

            +
            +public int toolMain(List<String> args)
+             throws Exception
            +
            +
            The main logic of your tool. +

            +

            +
            Specified by:
            toolMain in interface KijiTool
            +
            +
            +
            Parameters:
            args - the arguments on the command line (excluding the tool name itself). +
            Returns:
            The program exit code. 0 should indicate success. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/IncrementTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/IncrementTool.html new file mode 100644 index 00000000..ee812e49 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/IncrementTool.html @@ -0,0 +1,482 @@ + + + + + + + +IncrementTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class IncrementTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.IncrementTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class IncrementTool
            extends VersionValidatedTool
            + + +

            +Command-line tool to increment a counter in a cell of a kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            IncrementTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, setPrintStream, setup, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +IncrementTool

            +
            +public IncrementTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/InstallTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/InstallTool.html new file mode 100644 index 00000000..a359e397 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/InstallTool.html @@ -0,0 +1,392 @@ + + + + + + + +InstallTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class InstallTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.InstallTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class InstallTool
            extends BaseTool
            + + +

            +A command-line tool for installing kiji instances on hbase clusters. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            InstallTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, getURI, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +InstallTool

            +
            +public InstallTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/KijiTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/KijiTool.html new file mode 100644 index 00000000..c438deac --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/KijiTool.html @@ -0,0 +1,317 @@ + + + + + + + +KijiTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Interface KijiTool

            +
            +
            All Superinterfaces:
            Configurable
            +
            +
            +
            All Known Implementing Classes:
            BaseTool, CreateTableTool, DeleteTableTool, FlushTableTool, HelpTool, IncrementTool, InstallTool, LayoutTool, LsTool, MetadataTool, PutTool, SynthesizeUserDataTool, UninstallTool, VersionTool, VersionValidatedTool
            +
            +
            +
            +
            @ApiAudience.Public
+public interface KijiTool
            extends Configurable
            + + +

            +Base interface to be implemented by command-line tools that are launched through + the bin/kiji script. These tools are instantiated and run by the + KijiToolLauncher. + +

            To register a tool to use with bin/kiji, you must also put the complete + name of the implementing class in a resource in your jar file at: + META-INF/services/org.kiji.schema.tools.KijiTool. You may publish multiple + tools in this way; put each class name on its own line in this file. You can put + this file in src/test/resources/ in your Maven project, and it will be + incorporated into your jar.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +           
            + StringgetDescription() + +
            +           
            + StringgetName() + +
            +           
            + inttoolMain(List<String> args) + +
            +          The main logic of your tool.
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +String getName()
            +
            +
            +
            +
            +
            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +String getDescription()
            +
            +
            +
            +
            +
            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +String getCategory()
            +
            +
            +
            +
            +
            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +toolMain

            +
            +int toolMain(List<String> args)
+             throws Exception
            +
            +
            The main logic of your tool. +

            +

            +
            +
            +
            +
            Parameters:
            args - the arguments on the command line (excluding the tool name itself). +
            Returns:
            The program exit code. 0 should indicate success. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/KijiToolLauncher.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/KijiToolLauncher.html new file mode 100644 index 00000000..fbf9b775 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/KijiToolLauncher.html @@ -0,0 +1,342 @@ + + + + + + + +KijiToolLauncher (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class KijiToolLauncher

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.KijiToolLauncher
+
            +
            +
            All Implemented Interfaces:
            Configurable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiToolLauncher
            extends Configured
            + + +

            +Main entry point to launch Kiji tools. + +

            All tools launched through bin/kiji <tool> are detected and + instantiated through this module. Tools should implement the KijiTool + interface. In addition, each tool must advertise itself by adding a line to + a resource file contained in its jar at + META-INF/services/org.kiji.schema.tools.KijiTool. + This path can be added to your build by providing it under src/main/resources.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiToolLauncher() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidmain(String[] args) + +
            +          Program entry point.
            + intrun(KijiTool tool, + String[] args) + +
            +          Programmatic entry point to the tool launcher if a tool is already selected.
            + intrun(String[] args) + +
            +          Programmatic entry point to the tool launcher.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiToolLauncher

            +
            +public KijiToolLauncher()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +run

            +
            +public int run(String[] args)
+        throws Exception
            +
            +
            Programmatic entry point to the tool launcher. Locates a tool to run + based on the name provided as the first argument, then invokes it. + Hadoop property-based arguments will be parsed by KijiToolLauncher.run() + in a manner similar to Hadoop's ToolRunner. +

            +

            +
            Parameters:
            args - The command-line arguments. The first one should be the + name of the tool to run. +
            Returns:
            0 on program success, non-zero on error. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +public int run(KijiTool tool,
+               String[] args)
+        throws Exception
            +
            +
            Programmatic entry point to the tool launcher if a tool is already selected. + Hadoop property-based arguments will be parsed by KijiToolLauncher.run() + in a manner similar to Hadoop's ToolRunner. +

            +

            +
            Parameters:
            tool - The KijiTool to run.
            args - The command-line arguments, excluding the name of the tool to run. +
            Returns:
            0 on program success, non-zero on error. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. This method does not return; it calls System.exit() with the + return code from the called tool. +

            +

            +
            Parameters:
            args - The command-line arguments, starting with the name of the tool to run. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/LayoutTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/LayoutTool.html new file mode 100644 index 00000000..36f074e7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/LayoutTool.html @@ -0,0 +1,533 @@ + + + + + + + +LayoutTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class LayoutTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.LayoutTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class LayoutTool
            extends VersionValidatedTool
            + + +

            +Command-line tool for interacting with table layouts. Actions include reading a layout, + setting a table layout, and viewing a table's layout history. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            LayoutTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            +protected static booleanfileSystemSpecified(Path path) + +
            +          Determines whether a path has its filesystem explicitly specified.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, setPrintStream, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +LayoutTool

            +
            +public LayoutTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +fileSystemSpecified

            +
            +protected static boolean fileSystemSpecified(Path path)
            +
            +
            Determines whether a path has its filesystem explicitly specified. Did it start + with "hdfs://" or "file://"? +

            +

            +
            Parameters:
            path - The path to check. +
            Returns:
            Whether a file system was explicitly specified in the path.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/LsTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/LsTool.html new file mode 100644 index 00000000..c8b99dc2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/LsTool.html @@ -0,0 +1,545 @@ + + + + + + + +LsTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class LsTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.LsTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class LsTool
            extends VersionValidatedTool
            + + +

            +Command-line tool to explore kiji table data like the 'ls' command of a unix shell. + + List all kiji tables: + kiji ls + + List all kiji instances: + kiji ls --instances + + List all families in a kiji table foo: + kiji ls --table=foo + + List all data in the info:email and derived:domain columns of a table foo: + kiji ls --table=foo --columns=info:email,derived:domain + + List all data in the info:email and derived:domain columns of a table foo in row bar: + kiji ls --table=foo --columns=info:email,derived:domain --entity=bar +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            LsTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  Set<String>getInstanceNames() + +
            +          Returns a set of instance names.
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected static StringparseInstanceName(String kijiTableName) + +
            +          Parses a table name for a kiji instance name.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, setPrintStream, setup, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +LsTool

            +
            +public LsTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +getInstanceNames

            +
            +protected Set<String> getInstanceNames()
+                                throws IOException
            +
            +
            Returns a set of instance names. +

            +

            + +
            Returns:
            The set of instance names +
            Throws: +
            IOException - if there is an error retrieving the HBase tables
            +
            +
            +
            + +

            +parseInstanceName

            +
            +protected static String parseInstanceName(String kijiTableName)
            +
            +
            Parses a table name for a kiji instance name. +

            +

            +
            Parameters:
            kijiTableName - The table name to parse +
            Returns:
            instance name (or null if none found)
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Description copied from class: BaseTool
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/MetadataTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/MetadataTool.html new file mode 100644 index 00000000..2f6d67d1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/MetadataTool.html @@ -0,0 +1,454 @@ + + + + + + + +MetadataTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class MetadataTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.MetadataTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            public class MetadataTool
            extends VersionValidatedTool
            + + +

            +A tool to backup and restore Metadata. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            MetadataTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +MetadataTool

            +
            +public MetadataTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/PutTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/PutTool.html new file mode 100644 index 00000000..6f51e6ff --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/PutTool.html @@ -0,0 +1,457 @@ + + + + + + + +PutTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class PutTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.PutTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class PutTool
            extends VersionValidatedTool
            + + +

            +Command-line tool for putting an Avro value into a kiji cell. The value is specified by the + user as a JSON string that matches the Avro-JSON-encoding of a piece of Avro data. The user + must also specify an Avro schema (as a JSON string) when writing a value with this tool. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            PutTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +PutTool

            +
            +public PutTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/RequiredFlagException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/RequiredFlagException.html new file mode 100644 index 00000000..e937273f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/RequiredFlagException.html @@ -0,0 +1,250 @@ + + + + + + + +RequiredFlagException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class RequiredFlagException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.tools.RequiredFlagException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class RequiredFlagException
            extends Exception
            + + +

            +Thrown to indicate that a flag is required but not supplied. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            RequiredFlagException(String flagName) + +
            +          Creates a new RequiredFlagException for the specified flag name.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +RequiredFlagException

            +
            +public RequiredFlagException(String flagName)
            +
            +
            Creates a new RequiredFlagException for the specified flag name. +

            +

            +
            Parameters:
            flagName - The name of the flag without the '--'.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/SynthesizeUserDataTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/SynthesizeUserDataTool.html new file mode 100644 index 00000000..e52e55ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/SynthesizeUserDataTool.html @@ -0,0 +1,482 @@ + + + + + + + +SynthesizeUserDataTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class SynthesizeUserDataTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.SynthesizeUserDataTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class SynthesizeUserDataTool
            extends VersionValidatedTool
            + + +

            +Synthesize some user data into a kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            SynthesizeUserDataTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, setPrintStream, setup, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +SynthesizeUserDataTool

            +
            +public SynthesizeUserDataTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/ToolUtils.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/ToolUtils.html new file mode 100644 index 00000000..cfba152d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/ToolUtils.html @@ -0,0 +1,272 @@ + + + + + + + +ToolUtils (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class ToolUtils

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.ToolUtils
+
            +
            +
            +
            @ApiAudience.Framework
+public final class ToolUtils
            extends Object
            + + +

            +Utility class providing static methods used by command-line tools. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static EntityIdcreateEntityIdFromUserInputs(String entityId, + String entityHash, + RowKeyFormat format) + +
            +          Create an EntityId from the --entity-id and --entity-hash arguments to a kiji tool.
            +static byte[]parseRowKeyFlag(String flag) + +
            +          Parses a flag describing a row key.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +createEntityIdFromUserInputs

            +
            +public static EntityId createEntityIdFromUserInputs(String entityId,
+                                                    String entityHash,
+                                                    RowKeyFormat format)
+                                             throws IOException
            +
            +
            Create an EntityId from the --entity-id and --entity-hash arguments to a kiji tool. + It is an error for both (or neither) of these to be specified. + + It is also an error to specify entityHash for a table where hashRowKeys is false. + "Unspecified" means null or the empty string (""). + "Specified" means a non-null, non-empty string. +

            +

            +
            Parameters:
            entityId - The unhashed entity name which should be turned into an EntityId.
            entityHash - The hashed entity name which should be used directly.
            format - Format used to encode row keys. +
            Returns:
            the entity id as specified in the flags. +
            Throws: +
            RuntimeException - if arguments are invalid. +
            IOException - on I/O error.
            +
            +
            +
            + +

            +parseRowKeyFlag

            +
            +public static byte[] parseRowKeyFlag(String flag)
+                              throws IOException
            +
            +
            Parses a flag describing a row key. + + Row keys can be specified as: +
              +
            • a sequence of bytes, in hexadecimal representation, e.g. "hex:00dead00beef" +
            • a UTF8 encoded text row key, e.g. "row-key" or "utf8:row-key". +
            +

            +

            +
            Parameters:
            flag - Row key description. +
            Returns:
            the byte array as specified in the flag. +
            Throws: +
            IOException - if unable to decode the flag.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/UninstallTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/UninstallTool.html new file mode 100644 index 00000000..1740cf5f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/UninstallTool.html @@ -0,0 +1,392 @@ + + + + + + + +UninstallTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class UninstallTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.UninstallTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class UninstallTool
            extends BaseTool
            + + +

            +A command-line tool for uninstalling kiji instances from an hbase cluster. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            UninstallTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, getURI, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +UninstallTool

            +
            +public UninstallTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/VersionTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/VersionTool.html new file mode 100644 index 00000000..99d69cd6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/VersionTool.html @@ -0,0 +1,474 @@ + + + + + + + +VersionTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class VersionTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class VersionTool
            extends BaseTool
            + + +

            +Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            VersionTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  KijiopenKiji() + +
            +          Opens a kiji instance.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +VersionTool

            +
            +public VersionTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +openKiji

            +
            +protected Kiji openKiji()
+                 throws IOException
            +
            +
            Opens a kiji instance. + Subclasses should override this method with validation logic as needed. + Subclasses should write a useful message to getPrintStream() if they generate + an IOException. +

            +

            + +
            Returns:
            The opened kiji. +
            Throws: +
            IOException - if there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/VersionValidatedTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/VersionValidatedTool.html new file mode 100644 index 00000000..7cd41a19 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/VersionValidatedTool.html @@ -0,0 +1,374 @@ + + + + + + + +VersionValidatedTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class VersionValidatedTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            Direct Known Subclasses:
            CreateTableTool, DeleteTableTool, FlushTableTool, IncrementTool, LayoutTool, LsTool, MetadataTool, PutTool, SynthesizeUserDataTool
            +
            +
            +
            +
            @ApiAudience.Framework
+public abstract class VersionValidatedTool
            extends BaseTool
            + + +

            +Base class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool. Subclasses of this tool will first check that the data format + version of the kiji instance in hbase matches that of the client. If not, the tool + will exit early. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected VersionValidatedTool() + +
            +          Constructor.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            +protected  KijiopenKiji() + +
            +          Opens a kiji instance.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, run, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.tools.KijiTool
            getCategory, getDescription, getName
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +VersionValidatedTool

            +
            +protected VersionValidatedTool()
            +
            +
            Constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +openKiji

            +
            +protected Kiji openKiji()
+                 throws IOException
            +
            +
            Opens a kiji instance. + Subclasses should override this method with validation logic as needed. + Subclasses should write a useful message to getPrintStream() if they generate + an IOException. +

            +

            +
            +
            +
            + +
            Returns:
            The opened kiji. +
            Throws: +
            IOException - if there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/BaseTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/BaseTool.html new file mode 100644 index 00000000..081f0d1b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/BaseTool.html @@ -0,0 +1,280 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.BaseTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.BaseTool

            +
            + + + + + + + + + +
            +Packages that use BaseTool
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of BaseTool in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of BaseTool in org.kiji.schema.tools
            + classCreateTableTool + +
            +          Command-line tool for creating kiji tables in kiji instances.
            + classDeleteTableTool + +
            +          Command-line tool for deleting kiji tables from kiji instances.
            + classFlushTableTool + +
            +          Command-line tool for flushing kiji meta and user tables in hbase.
            + classIncrementTool + +
            +          Command-line tool to increment a counter in a cell of a kiji table.
            + classInstallTool + +
            +          A command-line tool for installing kiji instances on hbase clusters.
            + classLayoutTool + +
            +          Command-line tool for interacting with table layouts.
            + classLsTool + +
            +          Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            + classMetadataTool + +
            +          A tool to backup and restore Metadata.
            + classPutTool + +
            +          Command-line tool for putting an Avro value into a kiji cell.
            + classSynthesizeUserDataTool + +
            +          Synthesize some user data into a kiji table.
            + classUninstallTool + +
            +          A command-line tool for uninstalling kiji instances from an hbase cluster.
            + classVersionTool + +
            +          Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            + classVersionValidatedTool + +
            +          Base class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/CreateTableTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/CreateTableTool.html new file mode 100644 index 00000000..3102bb90 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/CreateTableTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.CreateTableTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.CreateTableTool

            +
            +No usage of org.kiji.schema.tools.CreateTableTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/DeleteTableTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/DeleteTableTool.html new file mode 100644 index 00000000..a21e2cec --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/DeleteTableTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.DeleteTableTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.DeleteTableTool

            +
            +No usage of org.kiji.schema.tools.DeleteTableTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/FlushTableTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/FlushTableTool.html new file mode 100644 index 00000000..25099f13 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/FlushTableTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.FlushTableTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.FlushTableTool

            +
            +No usage of org.kiji.schema.tools.FlushTableTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/HelpTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/HelpTool.html new file mode 100644 index 00000000..fee0639f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/HelpTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.HelpTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.HelpTool

            +
            +No usage of org.kiji.schema.tools.HelpTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/IncrementTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/IncrementTool.html new file mode 100644 index 00000000..d438460b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/IncrementTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.IncrementTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.IncrementTool

            +
            +No usage of org.kiji.schema.tools.IncrementTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/InstallTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/InstallTool.html new file mode 100644 index 00000000..dec58093 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/InstallTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.InstallTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.InstallTool

            +
            +No usage of org.kiji.schema.tools.InstallTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/KijiTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/KijiTool.html new file mode 100644 index 00000000..dfc0fdf3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/KijiTool.html @@ -0,0 +1,313 @@ + + + + + + + +Uses of Interface org.kiji.schema.tools.KijiTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.tools.KijiTool

            +
            + + + + + + + + + +
            +Packages that use KijiTool
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of KijiTool in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.schema.tools that implement KijiTool
            + classBaseTool + +
            +          Base class for all command line tools.
            + classCreateTableTool + +
            +          Command-line tool for creating kiji tables in kiji instances.
            + classDeleteTableTool + +
            +          Command-line tool for deleting kiji tables from kiji instances.
            + classFlushTableTool + +
            +          Command-line tool for flushing kiji meta and user tables in hbase.
            + classHelpTool + +
            +          Command-line tool for displaying help on available tools.
            + classIncrementTool + +
            +          Command-line tool to increment a counter in a cell of a kiji table.
            + classInstallTool + +
            +          A command-line tool for installing kiji instances on hbase clusters.
            + classLayoutTool + +
            +          Command-line tool for interacting with table layouts.
            + classLsTool + +
            +          Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            + classMetadataTool + +
            +          A tool to backup and restore Metadata.
            + classPutTool + +
            +          Command-line tool for putting an Avro value into a kiji cell.
            + classSynthesizeUserDataTool + +
            +          Synthesize some user data into a kiji table.
            + classUninstallTool + +
            +          A command-line tool for uninstalling kiji instances from an hbase cluster.
            + classVersionTool + +
            +          Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            + classVersionValidatedTool + +
            +          Base class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type KijiTool
            + intKijiToolLauncher.run(KijiTool tool, + String[] args) + +
            +          Programmatic entry point to the tool launcher if a tool is already selected.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/KijiToolLauncher.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/KijiToolLauncher.html new file mode 100644 index 00000000..359216d7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/KijiToolLauncher.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.KijiToolLauncher (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.KijiToolLauncher

            +
            +No usage of org.kiji.schema.tools.KijiToolLauncher +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/LayoutTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/LayoutTool.html new file mode 100644 index 00000000..d2ebb81d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/LayoutTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.LayoutTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.LayoutTool

            +
            +No usage of org.kiji.schema.tools.LayoutTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/LsTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/LsTool.html new file mode 100644 index 00000000..6f069cb6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/LsTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.LsTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.LsTool

            +
            +No usage of org.kiji.schema.tools.LsTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/MetadataTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/MetadataTool.html new file mode 100644 index 00000000..ba9063cb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/MetadataTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.MetadataTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.MetadataTool

            +
            +No usage of org.kiji.schema.tools.MetadataTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/PutTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/PutTool.html new file mode 100644 index 00000000..2f63a789 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/PutTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.PutTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.PutTool

            +
            +No usage of org.kiji.schema.tools.PutTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/RequiredFlagException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/RequiredFlagException.html new file mode 100644 index 00000000..0a9734c1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/RequiredFlagException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.RequiredFlagException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.RequiredFlagException

            +
            +No usage of org.kiji.schema.tools.RequiredFlagException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html new file mode 100644 index 00000000..3617d4a3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.SynthesizeUserDataTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.SynthesizeUserDataTool

            +
            +No usage of org.kiji.schema.tools.SynthesizeUserDataTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/ToolUtils.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/ToolUtils.html new file mode 100644 index 00000000..5bd31669 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/ToolUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.ToolUtils (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.ToolUtils

            +
            +No usage of org.kiji.schema.tools.ToolUtils +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/UninstallTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/UninstallTool.html new file mode 100644 index 00000000..9ff66cf3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/UninstallTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.UninstallTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.UninstallTool

            +
            +No usage of org.kiji.schema.tools.UninstallTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/VersionTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/VersionTool.html new file mode 100644 index 00000000..797a16f6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/VersionTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.VersionTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.VersionTool

            +
            +No usage of org.kiji.schema.tools.VersionTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/VersionValidatedTool.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/VersionValidatedTool.html new file mode 100644 index 00000000..ea0ed550 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/class-use/VersionValidatedTool.html @@ -0,0 +1,246 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.VersionValidatedTool (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.VersionValidatedTool

            +
            + + + + + + + + + +
            +Packages that use VersionValidatedTool
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of VersionValidatedTool in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of VersionValidatedTool in org.kiji.schema.tools
            + classCreateTableTool + +
            +          Command-line tool for creating kiji tables in kiji instances.
            + classDeleteTableTool + +
            +          Command-line tool for deleting kiji tables from kiji instances.
            + classFlushTableTool + +
            +          Command-line tool for flushing kiji meta and user tables in hbase.
            + classIncrementTool + +
            +          Command-line tool to increment a counter in a cell of a kiji table.
            + classLayoutTool + +
            +          Command-line tool for interacting with table layouts.
            + classLsTool + +
            +          Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            + classMetadataTool + +
            +          A tool to backup and restore Metadata.
            + classPutTool + +
            +          Command-line tool for putting an Avro value into a kiji cell.
            + classSynthesizeUserDataTool + +
            +          Synthesize some user data into a kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-frame.html new file mode 100644 index 00000000..0ffa190e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-frame.html @@ -0,0 +1,87 @@ + + + + + + + +org.kiji.schema.tools (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.schema.tools + + + + +
            +Interfaces  + +
            +KijiTool
            + + + + + + +
            +Classes  + +
            +BaseTool +
            +CreateTableTool +
            +DeleteTableTool +
            +FlushTableTool +
            +HelpTool +
            +IncrementTool +
            +InstallTool +
            +KijiToolLauncher +
            +LayoutTool +
            +LsTool +
            +MetadataTool +
            +PutTool +
            +SynthesizeUserDataTool +
            +ToolUtils +
            +UninstallTool +
            +VersionTool +
            +VersionValidatedTool
            + + + + + + +
            +Exceptions  + +
            +RequiredFlagException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-summary.html new file mode 100644 index 00000000..15c64077 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-summary.html @@ -0,0 +1,270 @@ + + + + + + + +org.kiji.schema.tools (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.tools +

            +Package containing implementations, abstract base classes, + and exceptions for kiji command-line tools. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            KijiToolBase interface to be implemented by command-line tools that are launched through + the bin/kiji script.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            BaseToolBase class for all command line tools.
            CreateTableToolCommand-line tool for creating kiji tables in kiji instances.
            DeleteTableToolCommand-line tool for deleting kiji tables from kiji instances.
            FlushTableToolCommand-line tool for flushing kiji meta and user tables in hbase.
            HelpToolCommand-line tool for displaying help on available tools.
            IncrementToolCommand-line tool to increment a counter in a cell of a kiji table.
            InstallToolA command-line tool for installing kiji instances on hbase clusters.
            KijiToolLauncherMain entry point to launch Kiji tools.
            LayoutToolCommand-line tool for interacting with table layouts.
            LsToolCommand-line tool to explore kiji table data like the 'ls' command of a unix shell.
            MetadataToolA tool to backup and restore Metadata.
            PutToolCommand-line tool for putting an Avro value into a kiji cell.
            SynthesizeUserDataToolSynthesize some user data into a kiji table.
            ToolUtilsUtility class providing static methods used by command-line tools.
            UninstallToolA command-line tool for uninstalling kiji instances from an hbase cluster.
            VersionToolCommand-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            VersionValidatedToolBase class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            RequiredFlagExceptionThrown to indicate that a flag is required but not supplied.
            +  + +

            +

            +Package org.kiji.schema.tools Description +

            + +

            +Package containing implementations, abstract base classes, + and exceptions for kiji command-line tools. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-tree.html new file mode 100644 index 00000000..ab86cab7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-tree.html @@ -0,0 +1,175 @@ + + + + + + + +org.kiji.schema.tools Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.tools +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-use.html new file mode 100644 index 00000000..e614e420 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/package-use.html @@ -0,0 +1,186 @@ + + + + + + + +Uses of Package org.kiji.schema.tools (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.tools

            +
            + + + + + + + + + +
            +Packages that use org.kiji.schema.tools
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.tools used by org.kiji.schema.tools
            BaseTool + +
            +          Base class for all command line tools.
            KijiTool + +
            +          Base interface to be implemented by command-line tools that are launched through + the bin/kiji script.
            VersionValidatedTool + +
            +          Base class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/DictionaryLoader.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/DictionaryLoader.html new file mode 100644 index 00000000..163368ca --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/DictionaryLoader.html @@ -0,0 +1,291 @@ + + + + + + + +DictionaryLoader (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class DictionaryLoader

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.DictionaryLoader
+
            +
            +
            +
            @ApiAudience.Private
+public final class DictionaryLoader
            extends Object
            + + +

            +Loads a dictionary file, which is simply a list of words, one per line. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DictionaryLoader() + +
            +          Creates a new DictionaryLoader instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + List<String>load(InputStream inputStream) + +
            +          Loads the dictionary from an input stream.
            + List<String>load(String filename) + +
            +          Loads the dictionary from a file.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DictionaryLoader

            +
            +public DictionaryLoader()
            +
            +
            Creates a new DictionaryLoader instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +load

            +
            +public List<String> load(String filename)
+                  throws IOException
            +
            +
            Loads the dictionary from a file. +

            +

            +
            Parameters:
            filename - The path to a file of words, one per line. +
            Returns:
            The list of words from the file. +
            Throws: +
            IOException - If there is an error reading the words from the file.
            +
            +
            +
            + +

            +load

            +
            +public List<String> load(InputStream inputStream)
+                  throws IOException
            +
            +
            Loads the dictionary from an input stream. +

            +

            +
            Parameters:
            inputStream - The input stream of words, one per line. +
            Returns:
            The list of words from the stream. +
            Throws: +
            IOException - If there is an error reading the words from the stream.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/EmailSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/EmailSynthesizer.html new file mode 100644 index 00000000..6e71c058 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/EmailSynthesizer.html @@ -0,0 +1,326 @@ + + + + + + + +EmailSynthesizer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class EmailSynthesizer

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.EmailSynthesizer
+
            +
            +
            All Implemented Interfaces:
            Synthesizer<String>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class EmailSynthesizer
            extends Object
            implements Synthesizer<String>
            + + +

            +Synthesizes a random email address. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EmailSynthesizer(Random random, + List<String> nameDictionary) + +
            +          Creates a new email synthesizer.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static StringformatEmail(String username, + String domain) + +
            +          Construct an email address string.
            + Stringsynthesize() + +
            +          Synthesizes a piece of data.
            + StringsynthesizeDomain() + +
            +          Synthesize a random domain using the market share probabilities.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EmailSynthesizer

            +
            +public EmailSynthesizer(Random random,
+                        List<String> nameDictionary)
            +
            +
            Creates a new email synthesizer. +

            +

            +
            Parameters:
            random - A random number generator.
            nameDictionary - A dictionary of names for the email addresses.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +public String synthesize()
            +
            +
            Description copied from interface: Synthesizer
            +
            Synthesizes a piece of data. +

            +

            +
            Specified by:
            synthesize in interface Synthesizer<String>
            +
            +
            + +
            Returns:
            The synthesized data.
            +
            +
            +
            + +

            +synthesizeDomain

            +
            +public String synthesizeDomain()
            +
            +
            Synthesize a random domain using the market share probabilities. +

            +

            +
            +
            +
            + +
            Returns:
            A synthesized domain string.
            +
            +
            +
            + +

            +formatEmail

            +
            +public static String formatEmail(String username,
+                                 String domain)
            +
            +
            Construct an email address string. +

            +

            +
            +
            +
            +
            Parameters:
            username - The part before the '@' symbol.
            domain - The part after the '@' symbol. +
            Returns:
            An email address (<username>@<domain>).
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/NGramSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/NGramSynthesizer.html new file mode 100644 index 00000000..ff363743 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/NGramSynthesizer.html @@ -0,0 +1,274 @@ + + + + + + + +NGramSynthesizer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class NGramSynthesizer

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.NGramSynthesizer
+
            +
            +
            All Implemented Interfaces:
            Synthesizer<String>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class NGramSynthesizer
            extends Object
            implements Synthesizer<String>
            + + +

            +Generates n-grams. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NGramSynthesizer(WordSynthesizer wordSynthesizer, + int n) + +
            +          Constructs a new n-gram synthesizer.
            +  + + + + + + + + + + + +
            +Method Summary
            + Stringsynthesize() + +
            +          Synthesizes a piece of data.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +NGramSynthesizer

            +
            +public NGramSynthesizer(WordSynthesizer wordSynthesizer,
+                        int n)
            +
            +
            Constructs a new n-gram synthesizer. +

            +

            +
            Parameters:
            wordSynthesizer - A synthesizer to generate the words in the n-grams.
            n - The number of words in the n-gram.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +public String synthesize()
            +
            +
            Description copied from interface: Synthesizer
            +
            Synthesizes a piece of data. +

            +

            +
            Specified by:
            synthesize in interface Synthesizer<String>
            +
            +
            + +
            Returns:
            The synthesized data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/Synthesizer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/Synthesizer.html new file mode 100644 index 00000000..16296fc5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/Synthesizer.html @@ -0,0 +1,220 @@ + + + + + + + +Synthesizer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Interface Synthesizer<T>

            +
            +
            Type Parameters:
            T - The type of data to be synthesized.
            +
            +
            All Known Implementing Classes:
            EmailSynthesizer, NGramSynthesizer, WordSynthesizer
            +
            +
            +
            +
            @ApiAudience.Private
+public interface Synthesizer<T>
            + + +

            +Synthesizers create objects from nothing. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + Tsynthesize() + +
            +          Synthesizes a piece of data.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +T synthesize()
            +
            +
            Synthesizes a piece of data. +

            +

            + +
            Returns:
            The synthesized data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/WordSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/WordSynthesizer.html new file mode 100644 index 00000000..eb377e50 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/WordSynthesizer.html @@ -0,0 +1,273 @@ + + + + + + + +WordSynthesizer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class WordSynthesizer

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.WordSynthesizer
+
            +
            +
            All Implemented Interfaces:
            Synthesizer<String>
            +
            +
            +
            +
            public class WordSynthesizer
            extends Object
            implements Synthesizer<String>
            + + +

            +Synthesizes random words from a dictionary. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            WordSynthesizer(Random random, + List<String> dictionary) + +
            +          Constructs a word synthesizer.
            +  + + + + + + + + + + + +
            +Method Summary
            + Stringsynthesize() + +
            +          Synthesizes a piece of data.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +WordSynthesizer

            +
            +public WordSynthesizer(Random random,
+                       List<String> dictionary)
            +
            +
            Constructs a word synthesizer. +

            +

            +
            Parameters:
            random - A random number generator.
            dictionary - A vocabulary of words to use when synthesizing.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +public String synthesize()
            +
            +
            Description copied from interface: Synthesizer
            +
            Synthesizes a piece of data. +

            +

            +
            Specified by:
            synthesize in interface Synthesizer<String>
            +
            +
            + +
            Returns:
            The synthesized data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html new file mode 100644 index 00000000..9a63de38 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.DictionaryLoader (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.DictionaryLoader

            +
            +No usage of org.kiji.schema.tools.synth.DictionaryLoader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html new file mode 100644 index 00000000..baea2c6f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.EmailSynthesizer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.EmailSynthesizer

            +
            +No usage of org.kiji.schema.tools.synth.EmailSynthesizer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html new file mode 100644 index 00000000..d3cd5e3c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.NGramSynthesizer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.NGramSynthesizer

            +
            +No usage of org.kiji.schema.tools.synth.NGramSynthesizer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/Synthesizer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/Synthesizer.html new file mode 100644 index 00000000..8037c212 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/Synthesizer.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Interface org.kiji.schema.tools.synth.Synthesizer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.tools.synth.Synthesizer

            +
            + + + + + + + + + +
            +Packages that use Synthesizer
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables. 
            +  +

            + + + + + +
            +Uses of Synthesizer in org.kiji.schema.tools.synth
            +  +

            + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.schema.tools.synth that implement Synthesizer
            + classEmailSynthesizer + +
            +          Synthesizes a random email address.
            + classNGramSynthesizer + +
            +          Generates n-grams.
            + classWordSynthesizer + +
            +          Synthesizes random words from a dictionary.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html new file mode 100644 index 00000000..f6df1597 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html @@ -0,0 +1,180 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.WordSynthesizer (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.WordSynthesizer

            +
            + + + + + + + + + +
            +Packages that use WordSynthesizer
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables. 
            +  +

            + + + + + +
            +Uses of WordSynthesizer in org.kiji.schema.tools.synth
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.tools.synth with parameters of type WordSynthesizer
            NGramSynthesizer(WordSynthesizer wordSynthesizer, + int n) + +
            +          Constructs a new n-gram synthesizer.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-frame.html new file mode 100644 index 00000000..e1d3db39 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-frame.html @@ -0,0 +1,50 @@ + + + + + + + +org.kiji.schema.tools.synth (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.schema.tools.synth + + + + +
            +Interfaces  + +
            +Synthesizer
            + + + + + + +
            +Classes  + +
            +DictionaryLoader +
            +EmailSynthesizer +
            +NGramSynthesizer +
            +WordSynthesizer
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-summary.html new file mode 100644 index 00000000..5fac610b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-summary.html @@ -0,0 +1,199 @@ + + + + + + + +org.kiji.schema.tools.synth (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.tools.synth +

            +Classes to assist when synthesizing sample data for use in kiji tables. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            Synthesizer<T>Synthesizers create objects from nothing.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            DictionaryLoaderLoads a dictionary file, which is simply a list of words, one per line.
            EmailSynthesizerSynthesizes a random email address.
            NGramSynthesizerGenerates n-grams.
            WordSynthesizerSynthesizes random words from a dictionary.
            +  + +

            +

            +Package org.kiji.schema.tools.synth Description +

            + +

            +Classes to assist when synthesizing sample data for use in kiji tables. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-tree.html new file mode 100644 index 00000000..dca1466b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.schema.tools.synth Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.tools.synth +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-use.html new file mode 100644 index 00000000..4e8fff93 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/tools/synth/package-use.html @@ -0,0 +1,177 @@ + + + + + + + +Uses of Package org.kiji.schema.tools.synth (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.tools.synth

            +
            + + + + + + + + + +
            +Packages that use org.kiji.schema.tools.synth
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.tools.synth used by org.kiji.schema.tools.synth
            Synthesizer + +
            +          Synthesizers create objects from nothing.
            WordSynthesizer + +
            +          Synthesizes random words from a dictionary.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/AvroUtils.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/AvroUtils.html new file mode 100644 index 00000000..708d3b2f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/AvroUtils.html @@ -0,0 +1,228 @@ + + + + + + + +AvroUtils (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class AvroUtils

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.AvroUtils
+
            +
            +
            +
            @ApiAudience.Private
+public final class AvroUtils
            extends Object
            + + +

            +General purpose Avro utilities. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static org.apache.avro.SchemagetOptionalType(org.apache.avro.Schema schema) + +
            +          Reports whether the given schema is an optional type (ie.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getOptionalType

            +
            +public static org.apache.avro.Schema getOptionalType(org.apache.avro.Schema schema)
            +
            +
            Reports whether the given schema is an optional type (ie. a union { null, Type }). +

            +

            +
            Parameters:
            schema - The schema to test. +
            Returns:
            the optional type, if the specified schema describes an optional type, null otherwise.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ByteArrayFormatter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ByteArrayFormatter.html new file mode 100644 index 00000000..d9380062 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ByteArrayFormatter.html @@ -0,0 +1,326 @@ + + + + + + + +ByteArrayFormatter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ByteArrayFormatter

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ByteArrayFormatter
+
            +
            +
            +
            @ApiAudience.Private
+public final class ByteArrayFormatter
            extends Object
            + + +

            +Utility class to format byte arrays. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static byte[]parseHex(String hex) + +
            +          Parses a string hexadecimal representation of a byte array.
            +static byte[]parseHex(String hex, + char separator) + +
            +          Parses a string hexadecimal representation of a byte array with separator.
            +static StringtoHex(byte[] bytes) + +
            +          Formats a byte array as a sequence of hex-digits with no separator.
            +static StringtoHex(byte[] bytes, + char separator) + +
            +          Formats a byte array as a sequence of 2 hex-digits bytes with the specified separator.
            +static StringtoURL(byte[] bytes) + +
            +          Formats a byte array as a URL.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +toHex

            +
            +public static String toHex(byte[] bytes)
            +
            +
            Formats a byte array as a sequence of hex-digits with no separator. +

            +

            +
            Parameters:
            bytes - Byte array to format. +
            Returns:
            the hex string representation of the byte array.
            +
            +
            +
            + +

            +toHex

            +
            +public static String toHex(byte[] bytes,
+                           char separator)
            +
            +
            Formats a byte array as a sequence of 2 hex-digits bytes with the specified separator. +

            +

            +
            Parameters:
            bytes - Byte array to format.
            separator - Separator used between each byte. +
            Returns:
            string the hex representation of the byte array.
            +
            +
            +
            + +

            +toURL

            +
            +public static String toURL(byte[] bytes)
            +
            +
            Formats a byte array as a URL. +

            +

            +
            Parameters:
            bytes - Byte array to format; +
            Returns:
            the URL encoding of the byte array.
            +
            +
            +
            + +

            +parseHex

            +
            +public static byte[] parseHex(String hex,
+                              char separator)
+                       throws IOException
            +
            +
            Parses a string hexadecimal representation of a byte array with separator. +

            +

            +
            Parameters:
            hex - String hexadecimal representation of the byte array to parse.
            separator - Separator used in the string. +
            Returns:
            the parsed byte array. +
            Throws: +
            IOException - on parse error.
            +
            +
            +
            + +

            +parseHex

            +
            +public static byte[] parseHex(String hex)
+                       throws IOException
            +
            +
            Parses a string hexadecimal representation of a byte array. +

            +

            +
            Parameters:
            hex - String hexadecimal representation of the byte array to parse. +
            Returns:
            the parsed byte array. +
            Throws: +
            IOException - on parse error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ByteStreamArray.EncodingException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ByteStreamArray.EncodingException.html new file mode 100644 index 00000000..c2206e88 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ByteStreamArray.EncodingException.html @@ -0,0 +1,250 @@ + + + + + + + +ByteStreamArray.EncodingException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ByteStreamArray.EncodingException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.util.ByteStreamArray.EncodingException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Enclosing class:
            ByteStreamArray
            +
            +
            +
            +
            @ApiAudience.Private
+public static final class ByteStreamArray.EncodingException
            extends IOException
            + + +

            +Raised when decoding some data fails (eg. a variable-length integer). +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            ByteStreamArray.EncodingException() + +
            +           
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +ByteStreamArray.EncodingException

            +
            +public ByteStreamArray.EncodingException()
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ByteStreamArray.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ByteStreamArray.html new file mode 100644 index 00000000..791187fb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ByteStreamArray.html @@ -0,0 +1,483 @@ + + + + + + + +ByteStreamArray (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ByteStreamArray

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ByteStreamArray
+
            +
            +
            +
            @ApiAudience.Private
+public final class ByteStreamArray
            extends Object
            + + +

            +Wraps a byte array of binary-encoded data into a byte stream. + + Provides various binary decoding functions. + Heavily inspired from protocol buffer's CodedOutputStream and Avro's BinaryDecoder. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classByteStreamArray.EncodingException + +
            +          Raised when decoding some data fails (eg.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            ByteStreamArray(byte[] bytes) + +
            +          Constructs a new stream of byte.
            ByteStreamArray(byte[] bytes, + int offset) + +
            +          Constructs a new stream of byte.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]getBytes() + +
            +           
            + intgetOffset() + +
            +           
            +static byte[]longToVarInt64(long number) + +
            +          Serializes a long integer into bytes using the zig-zag variable-length encoding scheme.
            +static byte[]longToZigZagVarInt64(long number) + +
            +          Serializes a long integer into bytes using the zig-zag variable-length encoding scheme.
            + byte[]readBytes(int nbytes) + +
            +          Reads the specified number of bytes in the stream.
            + longreadVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            + longreadZigZagVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            +static intsizeOfLongAsVarInt64(long number) + +
            +          Reports the size of the zig-zag encoding of the specified long integer.
            + voidskip(int nbytes) + +
            +          Skips some bytes.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ByteStreamArray

            +
            +public ByteStreamArray(byte[] bytes,
+                       int offset)
            +
            +
            Constructs a new stream of byte. +

            +

            +
            Parameters:
            bytes - Array of byte to wrap into a stream.
            offset - Offset of the stream head.
            +
            +
            + +

            +ByteStreamArray

            +
            +public ByteStreamArray(byte[] bytes)
            +
            +
            Constructs a new stream of byte. +

            +

            +
            Parameters:
            bytes - Array of byte to wrap into a stream.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +sizeOfLongAsVarInt64

            +
            +public static int sizeOfLongAsVarInt64(long number)
            +
            +
            Reports the size of the zig-zag encoding of the specified long integer. +

            +

            +
            Parameters:
            number - Long integer to encode. +
            Returns:
            Number of bytes required to encode the long using the zig-zag var-int64 encoding. + Between 1 and 10 bytes.
            +
            +
            +
            + +

            +longToVarInt64

            +
            +public static byte[] longToVarInt64(long number)
            +
            +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +

            +

            +
            Parameters:
            number - Long integer to encode. +
            Returns:
            Zig-zag encoded long, as an array of up to 10 bytes.
            +
            +
            +
            + +

            +longToZigZagVarInt64

            +
            +public static byte[] longToZigZagVarInt64(long number)
            +
            +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +

            +

            +
            Parameters:
            number - Long integer to encode. +
            Returns:
            Zig-zag encoded long, as an array of up to 10 bytes.
            +
            +
            +
            + +

            +readVarInt64

            +
            +public long readVarInt64()
+                  throws ByteStreamArray.EncodingException
            +
            +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +

            +

            + +
            Returns:
            the read integer as a long. +
            Throws: +
            ByteStreamArray.EncodingException - on decoding error.
            +
            +
            +
            + +

            +readZigZagVarInt64

            +
            +public long readZigZagVarInt64()
+                        throws ByteStreamArray.EncodingException
            +
            +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +

            +

            + +
            Returns:
            the read integer as a long. +
            Throws: +
            ByteStreamArray.EncodingException - on decoding error.
            +
            +
            +
            + +

            +skip

            +
            +public void skip(int nbytes)
            +
            +
            Skips some bytes. +

            +

            +
            Parameters:
            nbytes - Number of bytes to skip.
            +
            +
            +
            + +

            +readBytes

            +
            +public byte[] readBytes(int nbytes)
            +
            +
            Reads the specified number of bytes in the stream. +

            +

            +
            Parameters:
            nbytes - Number of bytes to read. +
            Returns:
            Bytes read.
            +
            +
            +
            + +

            +getBytes

            +
            +public byte[] getBytes()
            +
            +
            + +
            Returns:
            a copy of the wrapped byte array.
            +
            +
            +
            + +

            +getOffset

            +
            +public int getOffset()
            +
            +
            + +
            Returns:
            the current offset in the wrapped byte array.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/BytesKey.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/BytesKey.html new file mode 100644 index 00000000..e98cffb5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/BytesKey.html @@ -0,0 +1,330 @@ + + + + + + + +BytesKey (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class BytesKey

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.BytesKey
+
            +
            +
            +
            @ApiAudience.Framework
+public final class BytesKey
            extends Object
            + + +

            +Wraps an array of bytes into an object that can be used as key in a hash map. + The wrapper assumes the byte array is immutable (ie. does not copy the byte array). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            BytesKey(byte[] bytes) + +
            +          Wraps the given byte array.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +           
            + byte[]getBytes() + +
            +           
            + inthashCode() + +
            +           
            + StringtoString() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +BytesKey

            +
            +public BytesKey(byte[] bytes)
            +
            +
            Wraps the given byte array. +

            +

            +
            Parameters:
            bytes - Byte array to wrap.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getBytes

            +
            +public byte[] getBytes()
            +
            +
            + +
            Returns:
            The byte array.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Clock.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Clock.html new file mode 100644 index 00000000..e4c795d6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Clock.html @@ -0,0 +1,248 @@ + + + + + + + +Clock (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Clock

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Clock
+
            +
            +
            +
            @ApiAudience.Public
+public abstract class Clock
            extends Object
            + + +

            +An interface for a wall clock. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static ClockgetDefaultClock() + +
            +           
            +abstract  longgetTime() + +
            +          Gets the current time.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTime

            +
            +public abstract long getTime()
            +
            +
            Gets the current time. +

            +

            + +
            Returns:
            The current time.
            +
            +
            +
            + +

            +getDefaultClock

            +
            +public static Clock getDefaultClock()
            +
            +
            + +
            Returns:
            a default clock instance that uses the system clock.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/CounterManager.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/CounterManager.html new file mode 100644 index 00000000..4726c4c3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/CounterManager.html @@ -0,0 +1,215 @@ + + + + + + + +CounterManager (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Interface CounterManager

            +
            +
            +
            @ApiAudience.Private
+public interface CounterManager
            + + +

            +Interface for for objects that hold a collection of MapReduce counters. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + CountergetCounter(Enum<?> name) + +
            +          Gets a counter by name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getCounter

            +
            +Counter getCounter(Enum<?> name)
            +
            +
            Gets a counter by name. +

            +

            +
            Parameters:
            name - The name of the counter. +
            Returns:
            A counter.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/FromJson.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/FromJson.html new file mode 100644 index 00000000..cecae095 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/FromJson.html @@ -0,0 +1,289 @@ + + + + + + + +FromJson (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class FromJson

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.FromJson
+
            +
            +
            +
            @ApiAudience.Private
+public final class FromJson
            extends Object
            + + +

            +Decode a JSON string into an Avro record. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static ObjectfromAvroJsonString(String json, + org.apache.avro.Schema schema) + +
            +          Standard Avro JSON decoder.
            +static ObjectfromJsonNode(org.codehaus.jackson.JsonNode json, + org.apache.avro.Schema schema) + +
            +          Decodes a JSON node as an Avro value.
            +static ObjectfromJsonString(String json, + org.apache.avro.Schema schema) + +
            +          Decodes a JSON encoded record.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +fromJsonNode

            +
            +public static Object fromJsonNode(org.codehaus.jackson.JsonNode json,
+                                  org.apache.avro.Schema schema)
+                           throws IOException
            +
            +
            Decodes a JSON node as an Avro value. + + Comply with specified default values when decoding records with missing fields. +

            +

            +
            Parameters:
            json - JSON node to decode.
            schema - Avro schema of the value to decode. +
            Returns:
            the decoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +fromJsonString

            +
            +public static Object fromJsonString(String json,
+                                    org.apache.avro.Schema schema)
+                             throws IOException
            +
            +
            Decodes a JSON encoded record. +

            +

            +
            Parameters:
            json - JSON tree to decode, encoded as a string.
            schema - Avro schema of the value to decode. +
            Returns:
            the decoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +fromAvroJsonString

            +
            +public static Object fromAvroJsonString(String json,
+                                        org.apache.avro.Schema schema)
+                                 throws IOException
            +
            +
            Standard Avro JSON decoder. +

            +

            +
            Parameters:
            json - JSON string to decode.
            schema - Schema of the value to decode. +
            Returns:
            the decoded value. +
            Throws: +
            IOException - on error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Functions.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Functions.html new file mode 100644 index 00000000..f604918d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Functions.html @@ -0,0 +1,235 @@ + + + + + + + +Functions (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Functions

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Functions
+
            +
            +
            +
            @ApiAudience.Private
+public final class Functions
            extends Object
            + + +

            +A collection of useful functions. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<K,V> com.google.common.base.Function<Map<? extends K,? extends V>,Map<K,V>>
            +            		unmodifiableMap() + +
            +          Returns a function that makes a map immutable.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +unmodifiableMap

            +
            +public static <K,V> com.google.common.base.Function<Map<? extends K,? extends V>,Map<K,V>> unmodifiableMap()
            +
            +
            Returns a function that makes a map immutable. +

            +

            +
            Type Parameters:
            K - The map key type.
            V - The map value type. +
            Returns:
            A function returns an immutable version of a map.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Hasher.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Hasher.html new file mode 100644 index 00000000..fead95bc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Hasher.html @@ -0,0 +1,288 @@ + + + + + + + +Hasher (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Hasher

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Hasher
+
            +
            +
            +
            @ApiAudience.Private
+public final class Hasher
            extends Object
            + + +

            +A thread-safe utility for computing hashes of strings. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static intHASH_SIZE_BYTES + +
            +          The number of bytes in a hash.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static byte[]hash(byte[] input) + +
            +          Hashes the input byte array.
            +static byte[]hash(String input) + +
            +          Hashes the input string.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +HASH_SIZE_BYTES

            +
            +public static final int HASH_SIZE_BYTES
            +
            +
            The number of bytes in a hash. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +hash

            +
            +public static byte[] hash(String input)
            +
            +
            Hashes the input string. +

            +

            +
            Parameters:
            input - The string to hash. +
            Returns:
            The 128-bit MD5 hash of the input.
            +
            +
            +
            + +

            +hash

            +
            +public static byte[] hash(byte[] input)
            +
            +
            Hashes the input byte array. +

            +

            +
            Parameters:
            input - The bytes to hash. +
            Returns:
            The 128-bit MD5 hash of the input.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/JavaIdentifiers.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/JavaIdentifiers.html new file mode 100644 index 00000000..78ef0bf3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/JavaIdentifiers.html @@ -0,0 +1,260 @@ + + + + + + + +JavaIdentifiers (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class JavaIdentifiers

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.JavaIdentifiers
+
            +
            +
            +
            @ApiAudience.Private
+public final class JavaIdentifiers
            extends Object
            + + +

            +A utility class for dealing with identifiers in the Java language. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static booleanisValidClassName(String className) + +
            +          Determines whether a string could be the name of a Java class.
            +static booleanisValidIdentifier(String identifier) + +
            +          Determines whether a string is a valid Java identifier.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +isValidIdentifier

            +
            +public static boolean isValidIdentifier(String identifier)
            +
            +
            Determines whether a string is a valid Java identifier. + +

            A valid Java identifier may not start with a number, but may contain any + combination of letters, digits, underscores, or dollar signs.

            + +

            See the + Java Language Specification

            +

            +

            +
            Parameters:
            identifier - The identifier to test for validity. +
            Returns:
            Whether the identifier was valid.
            +
            +
            +
            + +

            +isValidClassName

            +
            +public static boolean isValidClassName(String className)
            +
            +
            Determines whether a string could be the name of a Java class. + +

            If this method returns true, it does not necessarily mean that the Java class with + className exists; it only means that one could write a Java class with + that fully-qualified name.

            +

            +

            +
            Parameters:
            className - A string to test. +
            Returns:
            Whether the class name was valid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/KijiNameValidator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/KijiNameValidator.html new file mode 100644 index 00000000..31228874 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/KijiNameValidator.html @@ -0,0 +1,424 @@ + + + + + + + +KijiNameValidator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class KijiNameValidator

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.KijiNameValidator
+
            +
            +
            +
            @ApiAudience.Private
+public final class KijiNameValidator
            extends Object
            + + +

            +A utility class for validating layout names, + (including table names, locality group names, family names, and column names) + and Kiji instance names. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static PatternVALID_ALIAS_PATTERN + +
            +          Regular expression that defines a valid alias for a layout name.
            +static PatternVALID_INSTANCE_PATTERN + +
            +          Regular expression that defines a valid instance name.
            +static PatternVALID_LAYOUT_NAME_PATTERN + +
            +          Regular expression that defines a valid layout name (family, qualifier, table, etc).
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static booleanisValidAlias(CharSequence name) + +
            +           
            +static booleanisValidKijiName(CharSequence name) + +
            +           
            +static booleanisValidLayoutName(CharSequence name) + +
            +           
            +static voidvalidateAlias(CharSequence name) + +
            +          Validates characters that may be used in an alias for a qualifier, family, or + locality group.
            +static voidvalidateKijiName(CharSequence name) + +
            +          Determines whether a string is a valid Kiji instance name.
            +static voidvalidateLayoutName(CharSequence name) + +
            +          Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +VALID_INSTANCE_PATTERN

            +
            +public static final Pattern VALID_INSTANCE_PATTERN
            +
            +
            Regular expression that defines a valid instance name. +

            +

            +
            +
            +
            + +

            +VALID_LAYOUT_NAME_PATTERN

            +
            +public static final Pattern VALID_LAYOUT_NAME_PATTERN
            +
            +
            Regular expression that defines a valid layout name (family, qualifier, table, etc). +

            +

            +
            +
            +
            + +

            +VALID_ALIAS_PATTERN

            +
            +public static final Pattern VALID_ALIAS_PATTERN
            +
            +
            Regular expression that defines a valid alias for a layout name. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +isValidLayoutName

            +
            +public static boolean isValidLayoutName(CharSequence name)
            +
            +
            +
            Parameters:
            name - the name to check. +
            Returns:
            true if name is a valid name for a table, locality group, family, + or column name, and false otherwise.
            +
            +
            +
            + +

            +validateLayoutName

            +
            +public static void validateLayoutName(CharSequence name)
+                               throws KijiInvalidNameException
            +
            +
            Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names. +

            +

            +
            Parameters:
            name - The string to validate as a layout name. +
            Throws: +
            KijiInvalidNameException - If the name is invalid.
            +
            +
            +
            + +

            +isValidAlias

            +
            +public static boolean isValidAlias(CharSequence name)
            +
            +
            +
            Parameters:
            name - the name to check. +
            Returns:
            true if name is a valid alias for a table, locality group, family, + or column name, and false otherwise.
            +
            +
            +
            + +

            +validateAlias

            +
            +public static void validateAlias(CharSequence name)
+                          throws KijiInvalidNameException
            +
            +
            Validates characters that may be used in an alias for a qualifier, family, or + locality group. This is a superset of valid characters for a layout name. +

            +

            +
            Parameters:
            name - The string to validate as a layout name alias. +
            Throws: +
            KijiInvalidNameException - If the name is invalid.
            +
            +
            +
            + +

            +isValidKijiName

            +
            +public static boolean isValidKijiName(CharSequence name)
            +
            +
            +
            Parameters:
            name - the name to check. +
            Returns:
            true if name is a valid name for a Kiji instance and false otherwise.
            +
            +
            +
            + +

            +validateKijiName

            +
            +public static void validateKijiName(CharSequence name)
+                             throws KijiInvalidNameException
            +
            +
            Determines whether a string is a valid Kiji instance name. +

            +

            +
            Parameters:
            name - The string to validate as a Kiji instance name. +
            Throws: +
            KijiInvalidNameException - If the name is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Lock.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Lock.html new file mode 100644 index 00000000..222fa5d8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Lock.html @@ -0,0 +1,290 @@ + + + + + + + +Lock (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Interface Lock

            +
            +
            All Superinterfaces:
            Closeable
            +
            +
            +
            All Known Implementing Classes:
            ZooKeeperLock
            +
            +
            +
            +
            @ApiAudience.Private
+public interface Lock
            extends Closeable
            + + +

            +Lock interface. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidlock() + +
            +          Unconditionally acquires the lock.
            + booleanlock(double timeout) + +
            +          Acquires the lock.
            + voidunlock() + +
            +          Releases the lock.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +lock

            +
            +void lock()
+          throws IOException
            +
            +
            Unconditionally acquires the lock. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +lock

            +
            +boolean lock(double timeout)
+             throws IOException
            +
            +
            Acquires the lock. +

            +

            +
            +
            +
            +
            Parameters:
            timeout - Deadline, in seconds, to acquire the lock. 0 means no timeout. +
            Returns:
            whether the lock is acquired (ie. false means timeout). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +unlock

            +
            +void unlock()
+            throws IOException
            +
            +
            Releases the lock. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/LockFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/LockFactory.html new file mode 100644 index 00000000..94cd75d8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/LockFactory.html @@ -0,0 +1,221 @@ + + + + + + + +LockFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Interface LockFactory

            +
            +
            All Known Implementing Classes:
            ZooKeeperLockFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public interface LockFactory
            + + +

            +Factory for Lock instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + Lockcreate(String name) + +
            +          Creates a new lock with the specified name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +Lock create(String name)
+            throws IOException
            +
            +
            Creates a new lock with the specified name. +

            +

            +
            Parameters:
            name - Lock name (eg. a ZooKeeper node path). +
            Returns:
            the lock with the specified name. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/NumberParser.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/NumberParser.html new file mode 100644 index 00000000..bd61a868 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/NumberParser.html @@ -0,0 +1,273 @@ + + + + + + + +NumberParser (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class NumberParser

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.NumberParser
+
            +
            +
            +
            @ApiAudience.Private
+public final class NumberParser
            extends Object
            + + +

            +Utility for parsing strings to numbers. It allows certain numbers to be + represented by easy-to-write strings. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static intparseInt(String intToParse) + +
            +          This parseInt allows Integer.MAX_VALUE to be written as a convenient string.
            +static longparseLong(String longToParse) + +
            +          This parseLong allows Long.MAX_VALUE to be written as a convenient string.
            +static StringprintInt(int intToPrint) + +
            +          Converts an integer to a string that uses "infinity" as Integer.MAX_VALUE.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +parseInt

            +
            +public static int parseInt(String intToParse)
            +
            +
            This parseInt allows Integer.MAX_VALUE to be written as a convenient string. +

            +

            +
            Parameters:
            intToParse - The string representation of an int to parse. +
            Returns:
            The parsed int.
            +
            +
            +
            + +

            +printInt

            +
            +public static String printInt(int intToPrint)
            +
            +
            Converts an integer to a string that uses "infinity" as Integer.MAX_VALUE. +

            +

            +
            Parameters:
            intToPrint - The integer to print. +
            Returns:
            The integer as a string, or "infinity".
            +
            +
            +
            + +

            +parseLong

            +
            +public static long parseLong(String longToParse)
            +
            +
            This parseLong allows Long.MAX_VALUE to be written as a convenient string. +

            +

            +
            Parameters:
            longToParse - The string representation of a long to parse. +
            Returns:
            The parsed long.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Resources.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Resources.html new file mode 100644 index 00000000..46b6c2da --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/Resources.html @@ -0,0 +1,252 @@ + + + + + + + +Resources (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Resources

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Resources
+
            +
            +
            +
            @ApiAudience.Private
+public final class Resources
            extends Object
            + + +

            +Utility for getting access to system resources. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static InputStreamopenSystemResource(String resourceFileName) + +
            +          Gets the named resource using the classloader, or null if it can not be found.
            +static BufferedReaderopenSystemTextResource(String resourceFileName) + +
            +          Gets the named resource using the classloader, or null if it can not be found.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +openSystemResource

            +
            +public static InputStream openSystemResource(String resourceFileName)
            +
            +
            Gets the named resource using the classloader, or null if it can not be found. + Clients should close streams returned by this method. +

            +

            +
            Parameters:
            resourceFileName - The resource to load from the classpath. +
            Returns:
            The loaded resource as an InputStream. If not found, returns null.
            +
            +
            +
            + +

            +openSystemTextResource

            +
            +public static BufferedReader openSystemTextResource(String resourceFileName)
            +
            +
            Gets the named resource using the classloader, or null if it can not be found. + Clients should close streams returned by this method. +

            +

            +
            Parameters:
            resourceFileName - The resource to load from the classpath. +
            Returns:
            The loaded resource as a BufferedReader. If not found, returns null.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/SplitKeyFile.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/SplitKeyFile.html new file mode 100644 index 00000000..067c82cd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/SplitKeyFile.html @@ -0,0 +1,267 @@ + + + + + + + +SplitKeyFile (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class SplitKeyFile

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.SplitKeyFile
+
            +
            +
            +
            @ApiAudience.Private
+public final class SplitKeyFile
            extends Object
            + + +

            +Parses region boundaries split files. + +

          • The file contains one row key per line. +
          • Row keys are encoded in ASCII. +
          • Non printable characters must be escaped in hexadecimal "\x??". +
          • Backslash must be escaped (doubled) "\\" + +

            + If a file contains N split keys, N+1 regions will be created, since the first region will contain + everything before the first split key, and the last region will contain everything after the last + split key. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static List<byte[]>decodeRegionSplitList(InputStream inputStream) + +
            +          Constructs a split key file from an input stream.
            +static byte[]decodeRowKey(String encoded) + +
            +          Decodes a string encoded row key.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +decodeRegionSplitList

            +
            +public static List<byte[]> decodeRegionSplitList(InputStream inputStream)
+                                          throws IOException
            +
            +
            Constructs a split key file from an input stream. This object will take ownership of + the inputStream, which you should clean up by calling close(). +

            +

            +
            Parameters:
            inputStream - The file contents. +
            Returns:
            the region boundaries, as a list of row keys. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeRowKey

            +
            +public static byte[] decodeRowKey(String encoded)
+                           throws IOException
            +
            +
            Decodes a string encoded row key. +

            +

            +
            Parameters:
            encoded - Encoded row key. +
            Returns:
            the row key, as a byte array. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/TimestampComparator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/TimestampComparator.html new file mode 100644 index 00000000..fa2cd2d7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/TimestampComparator.html @@ -0,0 +1,280 @@ + + + + + + + +TimestampComparator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class TimestampComparator

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.TimestampComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator<Long>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class TimestampComparator
            extends Object
            implements Comparator<Long>
            + + +

            +A comparator that sorts Longs in reverse chronological order. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static TimestampComparatorINSTANCE + +
            +          A singleton instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + intcompare(Long left, + Long right) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +INSTANCE

            +
            +public static final TimestampComparator INSTANCE
            +
            +
            A singleton instance. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(Long left,
+                   Long right)
            +
            +
            +
            Specified by:
            compare in interface Comparator<Long>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ToJson.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ToJson.html new file mode 100644 index 00000000..a79c7785 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ToJson.html @@ -0,0 +1,341 @@ + + + + + + + +ToJson (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ToJson

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ToJson
+
            +
            +
            +
            @ApiAudience.Private
+public final class ToJson
            extends Object
            + + +

            +Encode an Avro record into JSON. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static StringtoAvroJsonString(org.apache.avro.generic.IndexedRecord record) + +
            +          Standard Avro/JSON encoder.
            +static StringtoAvroJsonString(Object value, + org.apache.avro.Schema schema) + +
            +          Standard Avro/JSON encoder.
            +static org.codehaus.jackson.JsonNodetoJsonNode(Object value, + org.apache.avro.Schema schema) + +
            +          Serializes a Java Avro value into JSON.
            +static StringtoJsonString(org.apache.avro.generic.IndexedRecord record) + +
            +          Encodes an Avro record into JSON.
            +static StringtoJsonString(Object value, + org.apache.avro.Schema schema) + +
            +          Encodes an Avro value into a JSON string.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +toJsonNode

            +
            +public static org.codehaus.jackson.JsonNode toJsonNode(Object value,
+                                                       org.apache.avro.Schema schema)
+                                                throws IOException
            +
            +
            Serializes a Java Avro value into JSON. + + When serializing records, fields whose value matches the fields' default value are omitted. +

            +

            +
            Parameters:
            value - the Java value to serialize.
            schema - Avro schema of the value to serialize. +
            Returns:
            the value encoded as a JSON tree. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toJsonString

            +
            +public static String toJsonString(Object value,
+                                  org.apache.avro.Schema schema)
+                           throws IOException
            +
            +
            Encodes an Avro value into a JSON string. + + Fields with default values are omitted. +

            +

            +
            Parameters:
            value - Avro value to encode.
            schema - Avro schema of the value. +
            Returns:
            Pretty string representation of the JSON-encoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toJsonString

            +
            +public static String toJsonString(org.apache.avro.generic.IndexedRecord record)
+                           throws IOException
            +
            +
            Encodes an Avro record into JSON. +

            +

            +
            Parameters:
            record - Avro record to encode. +
            Returns:
            Pretty JSON representation of the record. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toAvroJsonString

            +
            +public static String toAvroJsonString(Object value,
+                                      org.apache.avro.Schema schema)
+                               throws IOException
            +
            +
            Standard Avro/JSON encoder. +

            +

            +
            Parameters:
            value - Avro value to encode.
            schema - Avro schema of the value. +
            Returns:
            JSON-encoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toAvroJsonString

            +
            +public static String toAvroJsonString(org.apache.avro.generic.IndexedRecord record)
+                               throws IOException
            +
            +
            Standard Avro/JSON encoder. +

            +

            +
            Parameters:
            record - Avro record to encode. +
            Returns:
            JSON-encoded value. +
            Throws: +
            IOException - on error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/VersionInfo.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/VersionInfo.html new file mode 100644 index 00000000..df5fe875 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/VersionInfo.html @@ -0,0 +1,341 @@ + + + + + + + +VersionInfo (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class VersionInfo

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.VersionInfo
+
            +
            +
            +
            @ApiAudience.Public
+public final class VersionInfo
            extends Object
            + + +

            +Reads the version info from the jar manifest for this version of Kiji. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static StringDEFAULT_DEVELOPMENT_VERSION + +
            +          Fallback software version ID, in case the properties file is not generated/reachable.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static StringgetClientDataVersion() + +
            +          Gets the version of the Kiji data format assumed by the client.
            +static StringgetClusterDataVersion(Kiji kiji) + +
            +          Gets the version of the Kiji data format installed in the instance of the HBase cluster.
            +static StringgetSoftwareVersion() + +
            +          Gets the version of the Kiji client software.
            +static voidvalidateVersion(Kiji kiji) + +
            +          Validates that the client data version matches the data version installed on a Kiji instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +DEFAULT_DEVELOPMENT_VERSION

            +
            +public static final String DEFAULT_DEVELOPMENT_VERSION
            +
            +
            Fallback software version ID, in case the properties file is not generated/reachable. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getSoftwareVersion

            +
            +public static String getSoftwareVersion()
+                                 throws IOException
            +
            +
            Gets the version of the Kiji client software. +

            +

            + +
            Returns:
            The version string. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getClientDataVersion

            +
            +public static String getClientDataVersion()
            +
            +
            Gets the version of the Kiji data format assumed by the client. +

            +

            + +
            Returns:
            The version string.
            +
            +
            +
            + +

            +getClusterDataVersion

            +
            +public static String getClusterDataVersion(Kiji kiji)
+                                    throws IOException
            +
            +
            Gets the version of the Kiji data format installed in the instance of the HBase cluster. +

            +

            +
            Parameters:
            kiji - The kiji instance. +
            Returns:
            The version string. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +validateVersion

            +
            +public static void validateVersion(Kiji kiji)
+                            throws IOException
            +
            +
            Validates that the client data version matches the data version installed on a Kiji instance. +

            +

            +
            Parameters:
            kiji - The kiji instance. +
            Throws: +
            IOException - on I/O error, and in particular IncompatibleKijiVersionException + if the versions are incompatible.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ZooKeeperLock.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ZooKeeperLock.html new file mode 100644 index 00000000..f26a83b3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ZooKeeperLock.html @@ -0,0 +1,357 @@ + + + + + + + +ZooKeeperLock (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ZooKeeperLock

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ZooKeeperLock
+
            +
            +
            All Implemented Interfaces:
            Closeable, Lock
            +
            +
            +
            +
            @ApiAudience.Private
+public final class ZooKeeperLock
            extends Object
            implements Lock, Closeable
            + + +

            +Distributed lock on top of ZooKeeper. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            ZooKeeperLock(org.apache.zookeeper.ZooKeeper zookeeper, + File lockDir) + +
            +          Constructs a ZooKeeper lock object.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + voidlock() + +
            +          Unconditionally acquires the lock.
            + booleanlock(double timeout) + +
            +          Acquires the lock.
            + voidunlock() + +
            +          Releases the lock.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ZooKeeperLock

            +
            +public ZooKeeperLock(org.apache.zookeeper.ZooKeeper zookeeper,
+                     File lockDir)
            +
            +
            Constructs a ZooKeeper lock object. +

            +

            +
            Parameters:
            zookeeper - ZooKeeper client.
            lockDir - Path of the directory node to use for the lock.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +lock

            +
            +public void lock()
+          throws IOException
            +
            +
            Unconditionally acquires the lock. +

            +

            +
            Specified by:
            lock in interface Lock
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +lock

            +
            +public boolean lock(double timeout)
+             throws IOException
            +
            +
            Acquires the lock. +

            +

            +
            Specified by:
            lock in interface Lock
            +
            +
            +
            Parameters:
            timeout - Deadline, in seconds, to acquire the lock. 0 means no timeout. +
            Returns:
            whether the lock is acquired (ie. false means timeout). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +unlock

            +
            +public void unlock()
+            throws IOException
            +
            +
            Releases the lock. +

            +

            +
            Specified by:
            unlock in interface Lock
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ZooKeeperLockFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ZooKeeperLockFactory.html new file mode 100644 index 00000000..99cbbfc5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/ZooKeeperLockFactory.html @@ -0,0 +1,320 @@ + + + + + + + +ZooKeeperLockFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ZooKeeperLockFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ZooKeeperLockFactory
+
            +
            +
            All Implemented Interfaces:
            LockFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class ZooKeeperLockFactory
            extends Object
            implements LockFactory
            + + +

            +Factory for ZooKeeperLock instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            ZooKeeperLockFactory(Configuration conf) + +
            +          Creates a factory for ZooKeeperLock.
            ZooKeeperLockFactory(org.apache.zookeeper.ZooKeeper zkClient) + +
            +          Creates a factory for ZooKeeperLock.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + Lockcreate(String name) + +
            +          Creates a new lock with the specified name.
            +static org.apache.zookeeper.ZooKeepernewZooKeeper(Configuration conf) + +
            +          Creates a ZooKeeper client.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ZooKeeperLockFactory

            +
            +public ZooKeeperLockFactory(org.apache.zookeeper.ZooKeeper zkClient)
            +
            +
            Creates a factory for ZooKeeperLock. +

            +

            +
            Parameters:
            zkClient - ZooKeeper client
            +
            +
            + +

            +ZooKeeperLockFactory

            +
            +public ZooKeeperLockFactory(Configuration conf)
+                     throws IOException
            +
            +
            Creates a factory for ZooKeeperLock. +

            +

            +
            Parameters:
            conf - ZooKeeper configuration. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newZooKeeper

            +
            +public static org.apache.zookeeper.ZooKeeper newZooKeeper(Configuration conf)
+                                                   throws IOException
            +
            +
            Creates a ZooKeeper client. +

            +

            +
            +
            +
            +
            Parameters:
            conf - Configuration. +
            Returns:
            a new ZooKeeper client. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +create

            +
            +public Lock create(String name)
            +
            +
            Creates a new lock with the specified name. +

            +

            +
            Specified by:
            create in interface LockFactory
            +
            +
            +
            Parameters:
            name - Lock name (eg. a ZooKeeper node path). +
            Returns:
            the lock with the specified name.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/AvroUtils.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/AvroUtils.html new file mode 100644 index 00000000..2b58e4b0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/AvroUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.AvroUtils (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.AvroUtils

            +
            +No usage of org.kiji.schema.util.AvroUtils +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ByteArrayFormatter.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ByteArrayFormatter.html new file mode 100644 index 00000000..cec0784e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ByteArrayFormatter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ByteArrayFormatter (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ByteArrayFormatter

            +
            +No usage of org.kiji.schema.util.ByteArrayFormatter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html new file mode 100644 index 00000000..a53cfd70 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ByteStreamArray.EncodingException (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ByteStreamArray.EncodingException

            +
            + + + + + + + + + +
            +Packages that use ByteStreamArray.EncodingException
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of ByteStreamArray.EncodingException in org.kiji.schema.util
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util that throw ByteStreamArray.EncodingException
            + longByteStreamArray.readVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            + longByteStreamArray.readZigZagVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ByteStreamArray.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ByteStreamArray.html new file mode 100644 index 00000000..12073b69 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ByteStreamArray.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ByteStreamArray (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ByteStreamArray

            +
            +No usage of org.kiji.schema.util.ByteStreamArray +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/BytesKey.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/BytesKey.html new file mode 100644 index 00000000..0e3c2daf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/BytesKey.html @@ -0,0 +1,274 @@ + + + + + + + +Uses of Class org.kiji.schema.util.BytesKey (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.BytesKey

            +
            + + + + + + + + + + + + + +
            +Packages that use BytesKey
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of BytesKey in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return BytesKey
            + BytesKeyKijiSchemaTable.SchemaEntry.getHash() + +
            +           
            +abstract  BytesKeyKijiSchemaTable.getOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            + BytesKeyKijiSchemaTable.getSchemaHash(org.apache.avro.Schema schema) + +
            +          Computes a schema hash.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type BytesKey
            +abstract  org.apache.avro.SchemaKijiSchemaTable.getSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type BytesKey
            KijiSchemaTable.SchemaEntry(long id, + BytesKey hash, + org.apache.avro.Schema schema) + +
            +          Creates a new schema entry.
            +  +

            + + + + + +
            +Uses of BytesKey in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return BytesKey
            + BytesKeyHBaseSchemaTable.getOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type BytesKey
            + org.apache.avro.SchemaHBaseSchemaTable.getSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Clock.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Clock.html new file mode 100644 index 00000000..2f928f7b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Clock.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Clock (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Clock

            +
            + + + + + + + + + + + + + +
            +Packages that use Clock
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of Clock in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return Clock
            + ClockKijiTablePool.Options.getClock() + +
            +          Gets a clock.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type Clock
            + KijiTablePool.OptionsKijiTablePool.Options.withClock(Clock clock) + +
            +          Sets a clock.
            +  +

            + + + + + +
            +Uses of Clock in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.util that return Clock
            +static ClockClock.getDefaultClock() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/CounterManager.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/CounterManager.html new file mode 100644 index 00000000..57d8dbed --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/CounterManager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface org.kiji.schema.util.CounterManager (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.util.CounterManager

            +
            +No usage of org.kiji.schema.util.CounterManager +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/FromJson.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/FromJson.html new file mode 100644 index 00000000..1f4f4afb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/FromJson.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.FromJson (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.FromJson

            +
            +No usage of org.kiji.schema.util.FromJson +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Functions.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Functions.html new file mode 100644 index 00000000..22401164 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Functions.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Functions (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Functions

            +
            +No usage of org.kiji.schema.util.Functions +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Hasher.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Hasher.html new file mode 100644 index 00000000..c054e1e4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Hasher.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Hasher (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Hasher

            +
            +No usage of org.kiji.schema.util.Hasher +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/JavaIdentifiers.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/JavaIdentifiers.html new file mode 100644 index 00000000..80695ace --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/JavaIdentifiers.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.JavaIdentifiers (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.JavaIdentifiers

            +
            +No usage of org.kiji.schema.util.JavaIdentifiers +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/KijiNameValidator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/KijiNameValidator.html new file mode 100644 index 00000000..ea35edfe --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/KijiNameValidator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.KijiNameValidator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.KijiNameValidator

            +
            +No usage of org.kiji.schema.util.KijiNameValidator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Lock.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Lock.html new file mode 100644 index 00000000..8c5e881b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Lock.html @@ -0,0 +1,251 @@ + + + + + + + +Uses of Interface org.kiji.schema.util.Lock (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.util.Lock

            +
            + + + + + + + + + + + + + +
            +Packages that use Lock
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of Lock in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return Lock
            +static LockHBaseSchemaTable.newLock(KijiConfiguration conf, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type Lock
            HBaseSchemaTable(HTableInterface hashTable, + HTableInterface idTable, + Lock zkLock) + +
            +          Wrap an existing HBase table assumed to be where the schema data is stored.
            +  +

            + + + + + +
            +Uses of Lock in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.util that implement Lock
            + classZooKeeperLock + +
            +          Distributed lock on top of ZooKeeper.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util that return Lock
            + LockZooKeeperLockFactory.create(String name) + +
            +          Creates a new lock with the specified name.
            + LockLockFactory.create(String name) + +
            +          Creates a new lock with the specified name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/LockFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/LockFactory.html new file mode 100644 index 00000000..62c3ef92 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/LockFactory.html @@ -0,0 +1,302 @@ + + + + + + + +Uses of Interface org.kiji.schema.util.LockFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.util.LockFactory

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use LockFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of LockFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return LockFactory
            + LockFactoryHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type LockFactory
            Kiji(KijiConfiguration kijiConf, + boolean validateVersion, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Creates a new Kiji instance.
            +  +

            + + + + + +
            +Uses of LockFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return LockFactory
            + LockFactoryDefaultHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type LockFactory
            +static voidHBaseSchemaTable.install(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static LockHBaseSchemaTable.newLock(KijiConfiguration conf, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type LockFactory
            HBaseSchemaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            +  +

            + + + + + +
            +Uses of LockFactory in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.util that implement LockFactory
            + classZooKeeperLockFactory + +
            +          Factory for ZooKeeperLock instances.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/NumberParser.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/NumberParser.html new file mode 100644 index 00000000..3a880c3a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/NumberParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.NumberParser (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.NumberParser

            +
            +No usage of org.kiji.schema.util.NumberParser +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Resources.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Resources.html new file mode 100644 index 00000000..36672143 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/Resources.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Resources (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Resources

            +
            +No usage of org.kiji.schema.util.Resources +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/SplitKeyFile.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/SplitKeyFile.html new file mode 100644 index 00000000..28b8b243 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/SplitKeyFile.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.SplitKeyFile (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.SplitKeyFile

            +
            +No usage of org.kiji.schema.util.SplitKeyFile +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/TimestampComparator.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/TimestampComparator.html new file mode 100644 index 00000000..2064ddb1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/TimestampComparator.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.util.TimestampComparator (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.TimestampComparator

            +
            + + + + + + + + + +
            +Packages that use TimestampComparator
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of TimestampComparator in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.util declared as TimestampComparator
            +static TimestampComparatorTimestampComparator.INSTANCE + +
            +          A singleton instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ToJson.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ToJson.html new file mode 100644 index 00000000..9807ef64 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ToJson.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ToJson (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ToJson

            +
            +No usage of org.kiji.schema.util.ToJson +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/VersionInfo.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/VersionInfo.html new file mode 100644 index 00000000..2e37dc08 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/VersionInfo.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.VersionInfo (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.VersionInfo

            +
            +No usage of org.kiji.schema.util.VersionInfo +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ZooKeeperLock.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ZooKeeperLock.html new file mode 100644 index 00000000..cdd28300 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ZooKeeperLock.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ZooKeeperLock (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ZooKeeperLock

            +
            +No usage of org.kiji.schema.util.ZooKeeperLock +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ZooKeeperLockFactory.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ZooKeeperLockFactory.html new file mode 100644 index 00000000..b7e1a206 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/class-use/ZooKeeperLockFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ZooKeeperLockFactory (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ZooKeeperLockFactory

            +
            +No usage of org.kiji.schema.util.ZooKeeperLockFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-frame.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-frame.html new file mode 100644 index 00000000..cf118395 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-frame.html @@ -0,0 +1,93 @@ + + + + + + + +org.kiji.schema.util (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + +org.kiji.schema.util + + + + +
            +Interfaces  + +
            +CounterManager +
            +Lock +
            +LockFactory
            + + + + + + +
            +Classes  + +
            +AvroUtils +
            +ByteArrayFormatter +
            +BytesKey +
            +ByteStreamArray +
            +Clock +
            +FromJson +
            +Functions +
            +Hasher +
            +JavaIdentifiers +
            +KijiNameValidator +
            +NumberParser +
            +Resources +
            +SplitKeyFile +
            +TimestampComparator +
            +ToJson +
            +VersionInfo +
            +ZooKeeperLock +
            +ZooKeeperLockFactory
            + + + + + + +
            +Exceptions  + +
            +ByteStreamArray.EncodingException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-summary.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-summary.html new file mode 100644 index 00000000..db202801 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-summary.html @@ -0,0 +1,279 @@ + + + + + + + +org.kiji.schema.util (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.util +

            +Package containing utility classes used throughout Kiji. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + +
            +Interface Summary
            CounterManagerInterface for for objects that hold a collection of MapReduce counters.
            LockLock interface.
            LockFactoryFactory for Lock instances.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AvroUtilsGeneral purpose Avro utilities.
            ByteArrayFormatterUtility class to format byte arrays.
            BytesKeyWraps an array of bytes into an object that can be used as key in a hash map.
            ByteStreamArrayWraps a byte array of binary-encoded data into a byte stream.
            ClockAn interface for a wall clock.
            FromJsonDecode a JSON string into an Avro record.
            FunctionsA collection of useful functions.
            HasherA thread-safe utility for computing hashes of strings.
            JavaIdentifiersA utility class for dealing with identifiers in the Java language.
            KijiNameValidatorA utility class for validating layout names, + (including table names, locality group names, family names, and column names) + and Kiji instance names.
            NumberParserUtility for parsing strings to numbers.
            ResourcesUtility for getting access to system resources.
            SplitKeyFileParses region boundaries split files.
            TimestampComparatorA comparator that sorts Longs in reverse chronological order.
            ToJsonEncode an Avro record into JSON.
            VersionInfoReads the version info from the jar manifest for this version of Kiji.
            ZooKeeperLockDistributed lock on top of ZooKeeper.
            ZooKeeperLockFactoryFactory for ZooKeeperLock instances.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            ByteStreamArray.EncodingExceptionRaised when decoding some data fails (eg.
            +  + +

            +

            +Package org.kiji.schema.util Description +

            + +

            +Package containing utility classes used throughout Kiji. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-tree.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-tree.html new file mode 100644 index 00000000..5feba940 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-tree.html @@ -0,0 +1,171 @@ + + + + + + + +org.kiji.schema.util Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.util +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-use.html b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-use.html new file mode 100644 index 00000000..12ada9b4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/org/kiji/schema/util/package-use.html @@ -0,0 +1,257 @@ + + + + + + + +Uses of Package org.kiji.schema.util (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.util

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.util
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema
            BytesKey + +
            +          Wraps an array of bytes into an object that can be used as key in a hash map.
            Clock + +
            +          An interface for a wall clock.
            LockFactory + +
            +          Factory for Lock instances.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema.impl
            BytesKey + +
            +          Wraps an array of bytes into an object that can be used as key in a hash map.
            Lock + +
            +          Lock interface.
            LockFactory + +
            +          Factory for Lock instances.
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema.util
            ByteStreamArray.EncodingException + +
            +          Raised when decoding some data fails (eg.
            Clock + +
            +          An interface for a wall clock.
            Lock + +
            +          Lock interface.
            LockFactory + +
            +          Factory for Lock instances.
            TimestampComparator + +
            +          A comparator that sorts Longs in reverse chronological order.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/overview-frame.html b/apidocs/kiji-schema/1.0.0-rc2/overview-frame.html new file mode 100644 index 00000000..3ec3940f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/overview-frame.html @@ -0,0 +1,63 @@ + + + + + + + +Overview List (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + + + + +
            +
            + + + + + +
            All Classes +

            + +Packages +
            +org.apache.hadoop.hbase.mapreduce +
            +org.kiji.schema +
            +org.kiji.schema.avro +
            +org.kiji.schema.filter +
            +org.kiji.schema.impl +
            +org.kiji.schema.layout +
            +org.kiji.schema.layout.impl +
            +org.kiji.schema.mapreduce +
            +org.kiji.schema.tools +
            +org.kiji.schema.tools.synth +
            +org.kiji.schema.util +
            +

            + +

            +  + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/overview-summary.html b/apidocs/kiji-schema/1.0.0-rc2/overview-summary.html new file mode 100644 index 00000000..765de146 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/overview-summary.html @@ -0,0 +1,198 @@ + + + + + + + +Overview (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +kiji-schema 1.0.0-rc2 API +

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages
            org.apache.hadoop.hbase.mapreduce 
            org.kiji.schemaThe main package for users of KijiSchema.
            org.kiji.schema.avro 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables.
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces.
            org.kiji.schema.layoutKiji table layouts.
            org.kiji.schema.layout.implImplementation for Kiji table layout management.
            org.kiji.schema.mapreduceKiji map-reduce utilities.
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools.
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables.
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji.
            + +

            + 

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/overview-tree.html b/apidocs/kiji-schema/1.0.0-rc2/overview-tree.html new file mode 100644 index 00000000..6027410c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/overview-tree.html @@ -0,0 +1,331 @@ + + + + + + + +Class Hierarchy (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.apache.hadoop.hbase.mapreduce, org.kiji.schema, org.kiji.schema.avro, org.kiji.schema.filter, org.kiji.schema.impl, org.kiji.schema.layout, org.kiji.schema.layout.impl, org.kiji.schema.mapreduce, org.kiji.schema.tools, org.kiji.schema.tools.synth, org.kiji.schema.util
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/package-list b/apidocs/kiji-schema/1.0.0-rc2/package-list new file mode 100644 index 00000000..13b707ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/package-list @@ -0,0 +1,11 @@ +org.apache.hadoop.hbase.mapreduce +org.kiji.schema +org.kiji.schema.avro +org.kiji.schema.filter +org.kiji.schema.impl +org.kiji.schema.layout +org.kiji.schema.layout.impl +org.kiji.schema.mapreduce +org.kiji.schema.tools +org.kiji.schema.tools.synth +org.kiji.schema.util diff --git a/apidocs/kiji-schema/1.0.0-rc2/resources/inherit.gif b/apidocs/kiji-schema/1.0.0-rc2/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/kiji-schema/1.0.0-rc2/resources/inherit.gif differ diff --git a/apidocs/kiji-schema/1.0.0-rc2/serialized-form.html b/apidocs/kiji-schema/1.0.0-rc2/serialized-form.html new file mode 100644 index 00000000..145ebdc6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/serialized-form.html @@ -0,0 +1,621 @@ + + + + + + + +Serialized Form (kiji-schema 1.0.0-rc2 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Serialized Form

            +
            +
            + + + + + +
            +Package org.apache.hadoop.hbase.mapreduce
            + +

            + + + + + +
            +Class org.apache.hadoop.hbase.mapreduce.ImportTsv.TsvParser.BadTsvLineException extends Exception implements Serializable
            + +

            +serialVersionUID: 1L + +

            +

            + + + + + +
            +Package org.kiji.schema
            + +

            + + + + + +
            +Class org.kiji.schema.IncompatibleKijiVersionException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.InternalKijiError extends Error implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiColumnPagingNotEnabledException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiDataRequest extends Object implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mColumns

            +
            +HashMap<K,V> mColumns
            +
            +
            Map from full column name to Column describing the request. This is not a java.util.Map + because java.util.map isn't serializable. +

            +

            +
            +
            +
            +

            +mMinTimestamp

            +
            +long mMinTimestamp
            +
            +
            The minimum timestamp of cells to be read (inclusive). +

            +

            +
            +
            +
            +

            +mMaxTimestamp

            +
            +long mMaxTimestamp
            +
            +
            The maximum timestamp of cells to be read (exclusive). +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiDataRequest.Column extends Object implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mFamily

            +
            +String mFamily
            +
            +
            The column family requested. +

            +

            +
            +
            +
            +

            +mKey

            +
            +String mKey
            +
            +
            The column qualifier requested (may be null, which means any qualifier). +

            +

            +
            +
            +
            +

            +mMaxVersions

            +
            +int mMaxVersions
            +
            +
            The maximum number of versions from the column to read (of the most recent). +

            +

            +
            +
            +
            +

            +mFilter

            +
            +KijiColumnFilter mFilter
            +
            +
            A column filter (may be null). +

            +

            +
            +
            +
            +

            +mPageSize

            +
            +int mPageSize
            +
            +
            The number of cells per page (zero means no paging). +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiDataRequestException extends RuntimeException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiInvalidNameException extends Exception implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiNotInstalledException extends RuntimeException implements Serializable
            + +

            + + + + + +
            +Serialized Fields
            + +

            +mInstanceName

            +
            +String mInstanceName
            +
            +
            The instance name of the missing Kiji instance. +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiTableNotFoundException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiTablePool.NoCapacityException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiURIException extends Exception implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.NoCellDataException extends Exception implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.NoSuchColumnException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.NotAKijiManagedTableException extends Exception implements Serializable
            + +

            + + + + + +
            +Serialized Fields
            + +

            +mHBaseTableName

            +
            +String mHBaseTableName
            +
            +
            The name of the HBase table. +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.TableKeyNotFoundException extends RuntimeException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.filter
            + +

            + + + + + +
            +Class org.kiji.schema.filter.KijiColumnFilter extends Object implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.filter.RegexQualifierColumnFilter extends KijiColumnFilter implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mRegularExpression

            +
            +String mRegularExpression
            +
            +
            +
            +
            +
            + + + + + +
            +Package org.kiji.schema.impl
            + +

            + + + + + +
            +Class org.kiji.schema.impl.InvalidColumnNameException extends RuntimeException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.layout
            + +

            + + + + + +
            +Class org.kiji.schema.layout.InvalidLayoutException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.layout.SchemaClassNotFoundException extends InvalidLayoutException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.tools
            + +

            + + + + + +
            +Class org.kiji.schema.tools.RequiredFlagException extends Exception implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.util
            + +

            + + + + + +
            +Class org.kiji.schema.util.ByteStreamArray.EncodingException extends IOException implements Serializable
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc2/stylesheet.css b/apidocs/kiji-schema/1.0.0-rc2/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc2/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/kiji-schema/1.0.0-rc3/allclasses-frame.html b/apidocs/kiji-schema/1.0.0-rc3/allclasses-frame.html new file mode 100644 index 00000000..103baf35 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/allclasses-frame.html @@ -0,0 +1,440 @@ + + + + + + + +All Classes (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            AbstractKijiTable +
            +AndRowFilter +
            +AvroCellDecoder +
            +AvroCellEncoder +
            +AvroUtils +
            +BaseTool +
            +ByteArrayFormatter +
            +BytesKey +
            +ByteStreamArray +
            +ByteStreamArray.EncodingException +
            +CellSchema +
            +CellSchema.Builder +
            +CellSpec +
            +Clock +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +ColumnId +
            +ColumnNameTranslator +
            +ColumnValueEqualsRowFilter +
            +CompressionType +
            +CounterCellDecoder +
            +CounterCellEncoder +
            +CounterManager +
            +CreateTableTool +
            +Debug +
            +DefaultHBaseAdminFactory +
            +DefaultHBaseFactory +
            +DefaultHTableInterfaceFactory +
            +DefaultKijiCellEncoderFactory +
            +DefaultKijiCounter +
            +DefaultKijiTableFactory +
            +DeleteTool +
            +DictionaryLoader +
            +DistributedCacheJars +
            +EmailSynthesizer +
            +EntityId +
            +EntityIdFactory +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +FlushTableTool +
            +FromJson +
            +Functions +
            +GenericCellDecoder +
            +GenericCellDecoderFactory +
            +GenericTableMapReduceUtil +
            +HasColumnDataRowFilter +
            +HashedEntityId +
            +Hasher +
            +HashPrefixedEntityId +
            +HashType +
            +HBaseAdminFactory +
            +HBaseColumnName +
            +HBaseDataRequestAdapter +
            +HBaseEntityId +
            +HBaseFactory +
            +HBaseFactory.Provider +
            +HBaseKiji +
            +HBaseKijiAdmin +
            +HBaseKijiFactory +
            +HBaseKijiRowData +
            +HBaseKijiRowScanner +
            +HBaseKijiRowScanner.Options +
            +HBaseKijiTable +
            +HBaseKijiTableReader +
            +HBaseKijiTableWriter +
            +HBaseMetaTable +
            +HBaseScanOptions +
            +HBaseSchemaTable +
            +HBaseSystemTable +
            +HBaseTableKeyValueDatabase +
            +HBaseTableLayoutDatabase +
            +HColumnDescriptorComparator +
            +HelpTool +
            +HTableDescriptorComparator +
            +HTableInterfaceFactory +
            +HTableSchemaTranslator +
            +IncompatibleKijiVersionException +
            +IncrementTool +
            +InstallTool +
            +InternalKijiError +
            +InvalidColumnNameException +
            +InvalidLayoutException +
            +JavaIdentifiers +
            +KeyValueBackupEntry +
            +KeyValueBackupEntry.Builder +
            +Kiji +
            +Kiji.Factory +
            +KijiAdmin +
            +KijiAlreadyExistsException +
            +KijiCell +
            +KijiCellDecoder +
            +KijiCellDecoderFactory +
            +KijiCellEncoder +
            +KijiCellEncoderFactory +
            +KijiColumnFilter +
            +KijiColumnFilter.Context +
            +KijiColumnName +
            +KijiColumnPager +
            +KijiColumnPagingNotEnabledException +
            +KijiConfiguration +
            +KijiConfKeys +
            +KijiCounter +
            +KijiDataBuffer +
            +KijiDataRequest +
            +KijiDataRequest.Column +
            +KijiDataRequestException +
            +KijiDataRequestValidator +
            +KijiDeleter +
            +KijiEncodingException +
            +KijiFactory +
            +KijiIncrementer +
            +KijiInstaller +
            +KijiInvalidNameException +
            +KijiManagedHBaseTableName +
            +KijiMetaTable +
            +KijiNameValidator +
            +KijiNotInstalledException +
            +KijiPutter +
            +KijiRowData +
            +KijiRowFilter +
            +KijiRowFilter.Context +
            +KijiRowFilterApplicator +
            +KijiRowKeySplitter +
            +KijiRowScanner +
            +KijiSchemaTable +
            +KijiSchemaTable.SchemaEntry +
            +KijiSystemTable +
            +KijiTable +
            +KijiTableFactory +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader +
            +KijiTableKeyValueDatabase +
            +KijiTableLayout +
            +KijiTableLayoutDatabase +
            +KijiTableLayoutRecords +
            +KijiTableLayoutRecords.Callback +
            +KijiTableNotFoundException +
            +KijiTablePool +
            +KijiTablePool.NoCapacityException +
            +KijiTablePool.Options +
            +KijiTableReader +
            +KijiTableReader.KijiScannerOptions +
            +KijiTableWriter +
            +KijiTool +
            +KijiToolLauncher +
            +KijiURI +
            +KijiURIException +
            +LayoutTool +
            +LocalityGroupDesc +
            +LocalityGroupDesc.Builder +
            +Lock +
            +LockFactory +
            +LsTool +
            +MD5Hash +
            +MetadataBackup +
            +MetadataBackup.Builder +
            +MetadataRestorer +
            +MetadataTool +
            +NGramSynthesizer +
            +NoCellDataException +
            +NoSuchColumnException +
            +NotAKijiManagedTableException +
            +NumberParser +
            +OperatorRowFilter +
            +OperatorRowFilter.Operator +
            +OrRowFilter +
            +PutTool +
            +RawEntityId +
            +ReferenceCountable +
            +ReferenceCountableUtils +
            +RegexQualifierColumnFilter +
            +RequiredFlagException +
            +Resources +
            +RowKeyEncoding +
            +RowKeyFormat +
            +RowKeyFormat.Builder +
            +SchemaClassNotFoundException +
            +SchemaStorage +
            +SchemaTableEntry +
            +SchemaTableEntry.Builder +
            +SchemaType +
            +SpecificCellDecoder +
            +SpecificCellDecoderFactory +
            +SplitKeyFile +
            +StripValueRowFilter +
            +Synthesizer +
            +SynthesizeUserDataTool +
            +TableBackup +
            +TableBackup.Builder +
            +TableKeyNotFoundException +
            +TableLayoutBackupEntry +
            +TableLayoutBackupEntry.Builder +
            +TableLayoutDesc +
            +TableLayoutDesc.Builder +
            +TableLayoutSerializer +
            +TimestampComparator +
            +ToJson +
            +ToolUtils +
            +UninstallTool +
            +VersionInfo +
            +VersionTool +
            +VersionValidatedTool +
            +WordSynthesizer +
            +ZooKeeperLock +
            +ZooKeeperLockFactory +
            +
            + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/allclasses-noframe.html b/apidocs/kiji-schema/1.0.0-rc3/allclasses-noframe.html new file mode 100644 index 00000000..687fcd94 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/allclasses-noframe.html @@ -0,0 +1,440 @@ + + + + + + + +All Classes (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            AbstractKijiTable +
            +AndRowFilter +
            +AvroCellDecoder +
            +AvroCellEncoder +
            +AvroUtils +
            +BaseTool +
            +ByteArrayFormatter +
            +BytesKey +
            +ByteStreamArray +
            +ByteStreamArray.EncodingException +
            +CellSchema +
            +CellSchema.Builder +
            +CellSpec +
            +Clock +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +ColumnId +
            +ColumnNameTranslator +
            +ColumnValueEqualsRowFilter +
            +CompressionType +
            +CounterCellDecoder +
            +CounterCellEncoder +
            +CounterManager +
            +CreateTableTool +
            +Debug +
            +DefaultHBaseAdminFactory +
            +DefaultHBaseFactory +
            +DefaultHTableInterfaceFactory +
            +DefaultKijiCellEncoderFactory +
            +DefaultKijiCounter +
            +DefaultKijiTableFactory +
            +DeleteTool +
            +DictionaryLoader +
            +DistributedCacheJars +
            +EmailSynthesizer +
            +EntityId +
            +EntityIdFactory +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +FlushTableTool +
            +FromJson +
            +Functions +
            +GenericCellDecoder +
            +GenericCellDecoderFactory +
            +GenericTableMapReduceUtil +
            +HasColumnDataRowFilter +
            +HashedEntityId +
            +Hasher +
            +HashPrefixedEntityId +
            +HashType +
            +HBaseAdminFactory +
            +HBaseColumnName +
            +HBaseDataRequestAdapter +
            +HBaseEntityId +
            +HBaseFactory +
            +HBaseFactory.Provider +
            +HBaseKiji +
            +HBaseKijiAdmin +
            +HBaseKijiFactory +
            +HBaseKijiRowData +
            +HBaseKijiRowScanner +
            +HBaseKijiRowScanner.Options +
            +HBaseKijiTable +
            +HBaseKijiTableReader +
            +HBaseKijiTableWriter +
            +HBaseMetaTable +
            +HBaseScanOptions +
            +HBaseSchemaTable +
            +HBaseSystemTable +
            +HBaseTableKeyValueDatabase +
            +HBaseTableLayoutDatabase +
            +HColumnDescriptorComparator +
            +HelpTool +
            +HTableDescriptorComparator +
            +HTableInterfaceFactory +
            +HTableSchemaTranslator +
            +IncompatibleKijiVersionException +
            +IncrementTool +
            +InstallTool +
            +InternalKijiError +
            +InvalidColumnNameException +
            +InvalidLayoutException +
            +JavaIdentifiers +
            +KeyValueBackupEntry +
            +KeyValueBackupEntry.Builder +
            +Kiji +
            +Kiji.Factory +
            +KijiAdmin +
            +KijiAlreadyExistsException +
            +KijiCell +
            +KijiCellDecoder +
            +KijiCellDecoderFactory +
            +KijiCellEncoder +
            +KijiCellEncoderFactory +
            +KijiColumnFilter +
            +KijiColumnFilter.Context +
            +KijiColumnName +
            +KijiColumnPager +
            +KijiColumnPagingNotEnabledException +
            +KijiConfiguration +
            +KijiConfKeys +
            +KijiCounter +
            +KijiDataBuffer +
            +KijiDataRequest +
            +KijiDataRequest.Column +
            +KijiDataRequestException +
            +KijiDataRequestValidator +
            +KijiDeleter +
            +KijiEncodingException +
            +KijiFactory +
            +KijiIncrementer +
            +KijiInstaller +
            +KijiInvalidNameException +
            +KijiManagedHBaseTableName +
            +KijiMetaTable +
            +KijiNameValidator +
            +KijiNotInstalledException +
            +KijiPutter +
            +KijiRowData +
            +KijiRowFilter +
            +KijiRowFilter.Context +
            +KijiRowFilterApplicator +
            +KijiRowKeySplitter +
            +KijiRowScanner +
            +KijiSchemaTable +
            +KijiSchemaTable.SchemaEntry +
            +KijiSystemTable +
            +KijiTable +
            +KijiTableFactory +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader +
            +KijiTableKeyValueDatabase +
            +KijiTableLayout +
            +KijiTableLayoutDatabase +
            +KijiTableLayoutRecords +
            +KijiTableLayoutRecords.Callback +
            +KijiTableNotFoundException +
            +KijiTablePool +
            +KijiTablePool.NoCapacityException +
            +KijiTablePool.Options +
            +KijiTableReader +
            +KijiTableReader.KijiScannerOptions +
            +KijiTableWriter +
            +KijiTool +
            +KijiToolLauncher +
            +KijiURI +
            +KijiURIException +
            +LayoutTool +
            +LocalityGroupDesc +
            +LocalityGroupDesc.Builder +
            +Lock +
            +LockFactory +
            +LsTool +
            +MD5Hash +
            +MetadataBackup +
            +MetadataBackup.Builder +
            +MetadataRestorer +
            +MetadataTool +
            +NGramSynthesizer +
            +NoCellDataException +
            +NoSuchColumnException +
            +NotAKijiManagedTableException +
            +NumberParser +
            +OperatorRowFilter +
            +OperatorRowFilter.Operator +
            +OrRowFilter +
            +PutTool +
            +RawEntityId +
            +ReferenceCountable +
            +ReferenceCountableUtils +
            +RegexQualifierColumnFilter +
            +RequiredFlagException +
            +Resources +
            +RowKeyEncoding +
            +RowKeyFormat +
            +RowKeyFormat.Builder +
            +SchemaClassNotFoundException +
            +SchemaStorage +
            +SchemaTableEntry +
            +SchemaTableEntry.Builder +
            +SchemaType +
            +SpecificCellDecoder +
            +SpecificCellDecoderFactory +
            +SplitKeyFile +
            +StripValueRowFilter +
            +Synthesizer +
            +SynthesizeUserDataTool +
            +TableBackup +
            +TableBackup.Builder +
            +TableKeyNotFoundException +
            +TableLayoutBackupEntry +
            +TableLayoutBackupEntry.Builder +
            +TableLayoutDesc +
            +TableLayoutDesc.Builder +
            +TableLayoutSerializer +
            +TimestampComparator +
            +ToJson +
            +ToolUtils +
            +UninstallTool +
            +VersionInfo +
            +VersionTool +
            +VersionValidatedTool +
            +WordSynthesizer +
            +ZooKeeperLock +
            +ZooKeeperLockFactory +
            +
            + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/constant-values.html b/apidocs/kiji-schema/1.0.0-rc3/constant-values.html new file mode 100644 index 00000000..ec03b9d1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/constant-values.html @@ -0,0 +1,493 @@ + + + + + + + +Constant Field Values (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents + + + + + + +
            +org.kiji.*
            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.KijiConfiguration
            +public static final StringCONF_KIJI_INSTANCE_NAME"kiji.instance.name"
            +public static final StringDEFAULT_CONF_FILE"/etc/kiji/kiji.conf"
            +public static final StringDEFAULT_INSTANCE_NAME"default"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.KijiManagedHBaseTableName
            +public static final StringKIJI_COMPONENT"kiji"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.KijiRowKeySplitter
            +public static final intHBASE_ROW_KEY_RESOLUTION16
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.KijiURI
            +public static final intDEFAULT_ZOOKEEPER_CLIENT_PORT2181
            +public static final StringENV_URI_STRING".env"
            +public static final StringKIJI_SCHEME"kiji"
            +public static final StringUNSET_URI_STRING".unset"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.impl.HBaseSchemaTable
            +public static final StringSCHEMA_COLUMN_FAMILY"schema"
            +public static final StringSCHEMA_COLUMN_QUALIFIER""
            +public static final StringSCHEMA_COUNTER_ROW_NAME"counter"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.impl.HBaseSystemTable
            +public static final StringDEFAULTS_PROPERTIES_FILE"org/kiji/schema/system-default.properties"
            +public static final StringKEY_DATA_VERSION"data-version"
            +public static final StringVALUE_COLUMN_FAMILY"value"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.layout.ColumnNameTranslator
            +public static final StringSEPARATOR":"
            + +

            + +

            + + + + + + + + + + + + + + + + + +
            org.kiji.schema.layout.TableLayoutSerializer
            +public static final StringCONF_INPUT_TABLE_LAYOUT"kiji.input.table.layout"
            +public static final StringCONF_OUTPUT_TABLE_LAYOUT"kiji.output.table.layout"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.layout.impl.ColumnId
            +public static final StringALPHABET"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
            +public static final intBITS_PER_DIGIT6
            +public static final intRADIX64
            +public static final intUNASSIGNED0
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.layout.impl.HBaseTableLayoutDatabase
            +public static final StringQUALIFIER_LAYOUT"layout"
            +public static final StringQUALIFIER_LAYOUT_ID"layout_id"
            +public static final StringQUALIFIER_UPDATE"update"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.mapreduce.KijiConfKeys
            +public static final StringINPUT_DATA_REQUEST"kiji.input.request"
            +public static final StringINPUT_TABLE_URI"kiji.input.table.uri"
            +public static final StringOUTPUT_KIJI_TABLE_URI"kiji.output.table.uri"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.util.Hasher
            +public static final intHASH_SIZE_BYTES16
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.util.VersionInfo
            +public static final StringDEFAULT_DEVELOPMENT_VERSION"development"
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/deprecated-list.html b/apidocs/kiji-schema/1.0.0-rc3/deprecated-list.html new file mode 100644 index 00000000..f79c8c0c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/deprecated-list.html @@ -0,0 +1,542 @@ + + + + + + + +Deprecated List (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents + + + + + + + + + +
            +Deprecated Interfaces
            org.kiji.schema.KijiCounter +
            +          KijiCounter will be merged into KijiCell. 
            +  +

            + + + + + + + + + + + + + + + + + +
            +Deprecated Classes
            org.kiji.schema.mapreduce.DistributedCacheJars +
            +           
            org.kiji.schema.KijiConfiguration +
            +           
            org.kiji.schema.mapreduce.KijiConfKeys +
            +           
            org.kiji.schema.mapreduce.KijiTableInputFormat +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Deprecated Fields
            org.kiji.schema.avro.FamilyDesc.aliases +
            +           
            org.kiji.schema.avro.ColumnDesc.aliases +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.aliases +
            +           
            org.kiji.schema.avro.SchemaTableEntry.avro_schema +
            +           
            org.kiji.schema.avro.ColumnDesc.column_schema +
            +           
            org.kiji.schema.avro.FamilyDesc.columns +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.compression_type +
            +           
            org.kiji.schema.avro.FamilyDesc.delete +
            +           
            org.kiji.schema.avro.ColumnDesc.delete +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.delete +
            +           
            org.kiji.schema.avro.FamilyDesc.description +
            +           
            org.kiji.schema.avro.TableLayoutDesc.description +
            +           
            org.kiji.schema.avro.ColumnDesc.description +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.description +
            +           
            org.kiji.schema.avro.FamilyDesc.enabled +
            +           
            org.kiji.schema.avro.ColumnDesc.enabled +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.enabled +
            +           
            org.kiji.schema.avro.RowKeyFormat.encoding +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.families +
            +           
            org.kiji.schema.avro.SchemaTableEntry.hash +
            +           
            org.kiji.schema.avro.RowKeyFormat.hash_size +
            +           
            org.kiji.schema.avro.RowKeyFormat.hash_type +
            +           
            org.kiji.schema.avro.FamilyDesc.id +
            +           
            org.kiji.schema.avro.ColumnDesc.id +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.id +
            +           
            org.kiji.schema.avro.SchemaTableEntry.id +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.in_memory +
            +           
            org.kiji.schema.avro.KeyValueBackupEntry.key +
            +           
            org.kiji.schema.avro.TableBackup.key_values +
            +           
            org.kiji.schema.avro.TableLayoutDesc.keys_format +
            +           
            org.kiji.schema.avro.TableLayoutBackupEntry.layout +
            +           
            org.kiji.schema.avro.TableLayoutDesc.layout_id +
            +           
            org.kiji.schema.avro.MetadataBackup.layout_version +
            +           
            org.kiji.schema.avro.TableBackup.layouts +
            +           
            org.kiji.schema.avro.TableLayoutDesc.locality_groups +
            +           
            org.kiji.schema.avro.FamilyDesc.map_schema +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.max_versions +
            +           
            org.kiji.schema.avro.MetadataBackup.meta_table +
            +           
            org.kiji.schema.avro.FamilyDesc.name +
            +           
            org.kiji.schema.avro.TableBackup.name +
            +           
            org.kiji.schema.avro.TableLayoutDesc.name +
            +           
            org.kiji.schema.avro.ColumnDesc.name +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.name +
            +           
            org.kiji.schema.avro.TableLayoutDesc.reference_layout +
            +           
            org.kiji.schema.avro.FamilyDesc.renamed_from +
            +           
            org.kiji.schema.avro.ColumnDesc.renamed_from +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.renamed_from +
            +           
            org.kiji.schema.avro.MetadataBackup.schema_table +
            +           
            org.kiji.schema.avro.CellSchema.storage +
            +           
            org.kiji.schema.avro.TableLayoutBackupEntry.timestamp +
            +           
            org.kiji.schema.avro.KeyValueBackupEntry.timestamp +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.ttl_seconds +
            +           
            org.kiji.schema.avro.CellSchema.type +
            +           
            org.kiji.schema.avro.TableLayoutBackupEntry.update +
            +           
            org.kiji.schema.avro.CellSchema.value +
            +           
            org.kiji.schema.avro.KeyValueBackupEntry.value +
            +           
            org.kiji.schema.avro.TableLayoutDesc.version +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Deprecated Methods
            org.kiji.schema.Kiji.getConf() +
            +           
            org.kiji.schema.impl.HBaseKijiRowData.getCounter(String, String) +
            +           
            org.kiji.schema.impl.HBaseKijiRowData.getCounter(String, String, long) +
            +           
            org.kiji.schema.KijiFactory.open(KijiConfiguration) +
            +           
            org.kiji.schema.Kiji.Factory.open(KijiConfiguration) +
            +           
            +  +

            + + + + + + + + + + + +
            +Deprecated Constructors
            org.kiji.schema.impl.HBaseKijiRowData(EntityId, KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) +
            +           
            org.kiji.schema.impl.HBaseKijiRowData(KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/help-doc.html b/apidocs/kiji-schema/1.0.0-rc3/help-doc.html new file mode 100644 index 00000000..4f621e11 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/help-doc.html @@ -0,0 +1,224 @@ + + + + + + + +API Help (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Overview

            +
            + +

            +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

            +

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/index-all.html b/apidocs/kiji-schema/1.0.0-rc3/index-all.html new file mode 100644 index 00000000..e49e7f11 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/index-all.html @@ -0,0 +1,4814 @@ + + + + + + + +Index (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +A B C D E F G H I J K L M N O P Q R S T U V W Y Z
            +

            +A

            +
            +
            AbstractKijiTable - Class in org.kiji.schema.impl
            Main handle for a Kiji table with basic functionality.
            AbstractKijiTable(Kiji, String) - +Constructor for class org.kiji.schema.impl.AbstractKijiTable +
            Creates a new KijiTable instance. +
            add(EntityId, T) - +Method in class org.kiji.schema.impl.KijiDataBuffer +
            Adds a buffer element to the buffer and associates it with the specified entity. +
            addAllDependencyJars(Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            Like TableMapReduceUtil.addDependencyJars() but this catches some + missing ones like google's guava library. +
            addColumn(KijiDataRequest.Column) - +Method in class org.kiji.schema.KijiDataRequest +
            Add a request for a column to this data request. +
            addJarsToDistributedCache(Job, String) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Adds the jars from a directory into the distributed cache of a job. +
            addJarsToDistributedCache(Job, File) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Adds the jars from a directory into the distributed cache of a job. +
            aliases - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            aliases - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            aliases - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            ALPHABET - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The alphabet used to generate the short physical names. +
            AndRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter for a conjunction (AND operator) of other filters.
            AndRowFilter(List<? extends KijiRowFilter>) - +Constructor for class org.kiji.schema.filter.AndRowFilter +
            Creates a new AndRowFilter instance. +
            applyTo(Scan) - +Method in class org.kiji.schema.filter.KijiRowFilterApplicator +
            Applies the row filter to an HBase scan object. +
            applyToScan(Scan, KijiTableLayout) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one. +
            avro_schema - +Variable in class org.kiji.schema.avro.SchemaTableEntry +
            Deprecated.  +
            AvroCellDecoder<T> - Class in org.kiji.schema.impl
            Base class for decoders that read Kiji cells encoded using Avro.
            AvroCellDecoder(CellSpec) - +Constructor for class org.kiji.schema.impl.AvroCellDecoder +
            Initializes an abstract KijiAvroCellDecoder. +
            AvroCellEncoder - Class in org.kiji.schema.impl
            Serializes a KijiCell.
            AvroCellEncoder(CellSpec) - +Constructor for class org.kiji.schema.impl.AvroCellEncoder +
            Creates a new KijiCellEncoder instance. +
            AvroUtils - Class in org.kiji.schema.util
            General purpose Avro utilities.
            +
            +

            +B

            +
            +
            BaseTool - Class in org.kiji.schema.tools
            Base class for all command line tools.
            BaseTool() - +Constructor for class org.kiji.schema.tools.BaseTool +
              +
            BITS_PER_DIGIT - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The base 2 logarithm of the size of the alphabet (64), which is the number of bits + we can encode with a single digit. +
            build() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
              +
            bulkGet(List<EntityId>, KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Retrieves data from a list of rows in the kiji table. +
            bulkGet(List<EntityId>, KijiDataRequest) - +Method in interface org.kiji.schema.KijiTableReader +
            Retrieves data from a list of rows in the kiji table. +
            ByteArrayFormatter - Class in org.kiji.schema.util
            Utility class to format byte arrays.
            BytesKey - Class in org.kiji.schema.util
            Wraps an array of bytes into an object that can be used as key in a hash map.
            BytesKey(byte[]) - +Constructor for class org.kiji.schema.util.BytesKey +
            Wraps the given byte array. +
            ByteStreamArray - Class in org.kiji.schema.util
            Wraps a byte array of binary-encoded data into a byte stream.
            ByteStreamArray(byte[], int) - +Constructor for class org.kiji.schema.util.ByteStreamArray +
            Constructs a new stream of byte. +
            ByteStreamArray(byte[]) - +Constructor for class org.kiji.schema.util.ByteStreamArray +
            Constructs a new stream of byte. +
            ByteStreamArray.EncodingException - Exception in org.kiji.schema.util
            Raised when decoding some data fails (eg.
            ByteStreamArray.EncodingException() - +Constructor for exception org.kiji.schema.util.ByteStreamArray.EncodingException +
              +
            +
            +

            +C

            +
            +
            CellSchema - Class in org.kiji.schema.avro
             
            CellSchema() - +Constructor for class org.kiji.schema.avro.CellSchema +
            Default constructor. +
            CellSchema(SchemaStorage, SchemaType, String) - +Constructor for class org.kiji.schema.avro.CellSchema +
            All-args constructor. +
            CellSchema.Builder - Class in org.kiji.schema.avro
            RecordBuilder for CellSchema instances.
            CellSpec - Class in org.kiji.schema.layout.impl
            Specification of a Kiji cell.
            CellSpec() - +Constructor for class org.kiji.schema.layout.impl.CellSpec +
            Initializes a new, unspecified CellSpec. +
            cleanup() - +Method in class org.kiji.schema.tools.BaseTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.DeleteTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.FlushTableTool +
            Cleans up any open file handles, connections, etc. +
            clear() - +Method in class org.kiji.schema.impl.KijiDataBuffer +
            Clears the buffer by removing all elements stored in it. +
            clearAliases() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'aliases' field +
            clearAliases() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'aliases' field +
            clearAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'aliases' field +
            clearAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Clears the value of the 'avro_schema' field +
            clearColumns() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'columns' field +
            clearColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'column_schema' field +
            clearCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'compression_type' field +
            clearDelete() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'delete' field +
            clearDelete() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'delete' field +
            clearDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'delete' field +
            clearDescription() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'description' field +
            clearDescription() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'description' field +
            clearDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'description' field +
            clearDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'description' field +
            clearEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'enabled' field +
            clearEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'enabled' field +
            clearEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'enabled' field +
            clearEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Clears the value of the 'encoding' field +
            clearFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'families' field +
            clearHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Clears the value of the 'hash' field +
            clearHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Clears the value of the 'hash_size' field +
            clearHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Clears the value of the 'hash_type' field +
            clearId() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'id' field +
            clearId() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'id' field +
            clearId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'id' field +
            clearId() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Clears the value of the 'id' field +
            clearInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'in_memory' field +
            clearKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Clears the value of the 'key' field +
            clearKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'keys_format' field +
            clearKeyValues() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Clears the value of the 'key_values' field +
            clearLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Clears the value of the 'layout' field +
            clearLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'layout_id' field +
            clearLayouts() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Clears the value of the 'layouts' field +
            clearLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Clears the value of the 'layout_version' field +
            clearLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'locality_groups' field +
            clearMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'map_schema' field +
            clearMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'max_versions' field +
            clearMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Clears the value of the 'meta_table' field +
            clearName() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'name' field +
            clearReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'reference_layout' field +
            clearRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'renamed_from' field +
            clearRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'renamed_from' field +
            clearRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'renamed_from' field +
            clearSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Clears the value of the 'schema_table' field +
            clearStorage() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Clears the value of the 'storage' field +
            clearTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Clears the value of the 'timestamp' field +
            clearTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Clears the value of the 'timestamp' field +
            clearTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'ttl_seconds' field +
            clearType() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Clears the value of the 'type' field +
            clearUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Clears the value of the 'update' field +
            clearValue() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Clears the value of the 'value' field +
            clearValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Clears the value of the 'value' field +
            clearVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'version' field +
            Clock - Class in org.kiji.schema.util
            An interface for a wall clock.
            close() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiAdmin +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner +
            Closes this scanner and releases any system resources associated with it. +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
              +
            close() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Flushes and closes the KijiSchemaTable. +
            close() - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            +
            close() - +Method in class org.kiji.schema.KijiMetaTable +
            +
            close() - +Method in interface org.kiji.schema.KijiRowScanner +
            Closes this scanner and releases any system resources associated with it. +
            close() - +Method in class org.kiji.schema.KijiSchemaTable +
            Flushes and closes the KijiSchemaTable. +
            close() - +Method in class org.kiji.schema.KijiTablePool +
            Closes the tables in the pool. +
            close() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            close() - +Method in class org.kiji.schema.util.ZooKeeperLock +
            +
            column_schema - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            ColumnDesc - Class in org.kiji.schema.avro
             
            ColumnDesc() - +Constructor for class org.kiji.schema.avro.ColumnDesc +
            Default constructor. +
            ColumnDesc(Integer, String, List<String>, Boolean, String, CellSchema, Boolean, String) - +Constructor for class org.kiji.schema.avro.ColumnDesc +
            All-args constructor. +
            ColumnDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for ColumnDesc instances.
            ColumnId - Class in org.kiji.schema.layout.impl
            A very short physical identifier for a column family or qualifier to be used in HBase.
            ColumnId(int) - +Constructor for class org.kiji.schema.layout.impl.ColumnId +
            Constructs a column id that encodes the given integer. +
            ColumnNameTranslator - Class in org.kiji.schema.layout
            Translates between HTable and Kiji table column names.
            ColumnNameTranslator(KijiTableLayout) - +Constructor for class org.kiji.schema.layout.ColumnNameTranslator +
            Creates a new ColumnNameTranslator instance. +
            columns - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            ColumnValueEqualsRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value.
            ColumnValueEqualsRowFilter(String, String, KijiCell<?>) - +Constructor for class org.kiji.schema.filter.ColumnValueEqualsRowFilter +
            Creates a new ColumnValueEqualsRowFilter instance. +
            compare(HColumnDescriptor, HColumnDescriptor) - +Method in class org.kiji.schema.impl.HColumnDescriptorComparator +
              +
            compare(HTableDescriptor, HTableDescriptor) - +Method in class org.kiji.schema.impl.HTableDescriptorComparator +
              +
            compare(Long, Long) - +Method in class org.kiji.schema.util.TimestampComparator +
              +
            compareTo(KijiColumnName) - +Method in class org.kiji.schema.KijiColumnName +
            +
            compression_type - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            CompressionType - Enum in org.kiji.schema.avro
             
            CONF_INPUT_TABLE_LAYOUT - +Static variable in class org.kiji.schema.layout.TableLayoutSerializer +
            The configuration variable that stores the avro json-encoded input table layout. +
            CONF_KIJI_INSTANCE_NAME - +Static variable in class org.kiji.schema.KijiConfiguration +
            Deprecated. The Configuration variable to store the kiji instance name. +
            CONF_OUTPUT_TABLE_LAYOUT - +Static variable in class org.kiji.schema.layout.TableLayoutSerializer +
            The configuration variable that stores output table layout. +
            configureJob(Job, KijiURI, KijiDataRequest, String, String) - +Static method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated. Configures a Hadoop M/R job to read from a given table. +
            containsColumn(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Determines whether a particular column has data in this row. +
            containsColumn(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Determines whether a particular column family has any data in this row. +
            containsColumn(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Determines whether a particular column has data in this row. +
            containsColumn(String) - +Method in interface org.kiji.schema.KijiRowData +
            Determines whether a particular column family has any data in this row. +
            convertStringToScan(String) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            This method is just like the package-private version in TableMapReduceUtil, + except that it disables block caching by default. +
            CounterCellDecoder - Class in org.kiji.schema.impl
            Cell decoder for counters.
            CounterCellEncoder - Class in org.kiji.schema.impl
            Encoder for Kiji counters.
            CounterManager - Interface in org.kiji.schema.util
            Interface for for objects that hold a collection of MapReduce counters.
            create(RowKeyFormat) - +Static method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID factory for the specified row key format. +
            create(CellSpec) - +Method in class org.kiji.schema.GenericCellDecoderFactory +
            Creates a new Kiji cell decoder. +
            create(Configuration) - +Method in class org.kiji.schema.impl.DefaultHBaseAdminFactory +
            Creates a new HBaseAdmin instance. +
            create(Configuration, String) - +Method in class org.kiji.schema.impl.DefaultHTableInterfaceFactory +
            Creates a new HTableInterface instance. +
            create(CellSpec) - +Method in class org.kiji.schema.impl.DefaultKijiCellEncoderFactory +
            Creates a new Kiji cell encoder. +
            create(Configuration) - +Method in interface org.kiji.schema.impl.HBaseAdminFactory +
            Creates a new HBaseAdmin instance. +
            create(Configuration, String) - +Method in interface org.kiji.schema.impl.HTableInterfaceFactory +
            Creates a new HTableInterface instance. +
            create(CellSpec) - +Method in interface org.kiji.schema.KijiCellDecoderFactory +
            Creates a new Kiji cell decoder. +
            create(CellSpec) - +Method in interface org.kiji.schema.KijiCellEncoderFactory +
            Creates a new Kiji cell encoder. +
            create(String, String) - +Static method in class org.kiji.schema.KijiConfiguration +
            Deprecated. Gets a handle to a Kiji instance. +
            create(String) - +Static method in class org.kiji.schema.KijiConfiguration +
            Deprecated. Gets a handle to a Kiji instance using the default Kiji configuration file. +
            create(CellSpec) - +Method in class org.kiji.schema.SpecificCellDecoderFactory +
            Creates a new Kiji cell decoder. +
            create(String) - +Method in interface org.kiji.schema.util.LockFactory +
            Creates a new lock with the specified name. +
            create(String) - +Method in class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a new lock with the specified name. +
            createDatumReader(Schema, Schema) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Factory for DatumReader instances. +
            createDatumReader(Schema, Schema) - +Method in class org.kiji.schema.impl.GenericCellDecoder +
            Factory for DatumReader instances. +
            createDatumReader(Schema, Schema) - +Method in class org.kiji.schema.impl.SpecificCellDecoder +
            Factory for DatumReader instances. +
            createEntityIdFromUserInputs(String, String, RowKeyFormat) - +Static method in class org.kiji.schema.tools.ToolUtils +
            Create an EntityId from the --entity-id and --entity-hash arguments to a kiji tool. +
            createFromEffectiveJson(InputStream) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Loads a table layout from the specified JSON text. +
            createFromEffectiveJsonResource(String) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Loads a table layout from the specified resource as JSON. +
            createRecordReader(InputSplit, TaskAttemptContext) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            createTable(String, KijiTableLayout, boolean) - +Method in class org.kiji.schema.impl.HBaseKijiAdmin +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, boolean, int) - +Method in class org.kiji.schema.impl.HBaseKijiAdmin +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, boolean, byte[][]) - +Method in class org.kiji.schema.impl.HBaseKijiAdmin +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, boolean) - +Method in interface org.kiji.schema.KijiAdmin +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, boolean, int) - +Method in interface org.kiji.schema.KijiAdmin +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, boolean, byte[][]) - +Method in interface org.kiji.schema.KijiAdmin +
            Creates a Kiji table in an HBase instance. +
            CreateTableTool - Class in org.kiji.schema.tools
            Command-line tool for creating kiji tables in kiji instances.
            CreateTableTool() - +Constructor for class org.kiji.schema.tools.CreateTableTool +
              +
            +
            +

            +D

            +
            +
            Debug - Class in org.kiji.schema.util
            Debugging utilities.
            decodeAvro(ByteBuffer, Schema, Schema, T) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Decodes the data payload given the reader and writer schema. +
            decodeCell(byte[]) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeCell(byte[]) - +Method in class org.kiji.schema.impl.CounterCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeCell(byte[]) - +Method in interface org.kiji.schema.KijiCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeRegionSplitList(InputStream) - +Static method in class org.kiji.schema.util.SplitKeyFile +
            Constructs a split key file from an input stream. +
            decodeRowKey(String) - +Static method in class org.kiji.schema.util.SplitKeyFile +
            Decodes a string encoded row key. +
            decodeSchemaEntry(byte[]) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Decodes a binary-encoded Avro schema entry. +
            decodeValue(byte[]) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeValue(byte[]) - +Method in class org.kiji.schema.impl.CounterCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeValue(byte[]) - +Method in interface org.kiji.schema.KijiCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            deDuplicateJarNames(List<String>) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Takes a list of paths and returns a list of paths with unique filenames. +
            DEFAULT_CONF_FILE - +Static variable in class org.kiji.schema.KijiConfiguration +
            Deprecated. The default Kiji configuration file. +
            DEFAULT_DEVELOPMENT_VERSION - +Static variable in class org.kiji.schema.util.VersionInfo +
            Fallback software version ID, in case the properties file is not generated/reachable. +
            DEFAULT_INSTANCE_NAME - +Static variable in class org.kiji.schema.KijiConfiguration +
            Deprecated. The default kiji instance name. +
            DEFAULT_ZOOKEEPER_CLIENT_PORT - +Static variable in class org.kiji.schema.KijiURI +
            Default Zookeeper port. +
            DefaultHBaseAdminFactory - Class in org.kiji.schema.impl
            Factory for HBaseAdmin that creates concrete HBaseAdmin instances.
            DefaultHBaseFactory - Class in org.kiji.schema.impl
            Factory for HBase instances based on URIs.
            DefaultHBaseFactory() - +Constructor for class org.kiji.schema.impl.DefaultHBaseFactory +
            Public constructor for use by the service loader. +
            DefaultHTableInterfaceFactory - Class in org.kiji.schema.impl
            Factory for HTableInterface that creates concrete HTable instances.
            DefaultKijiCellEncoderFactory - Class in org.kiji.schema.impl
            Factory for cell encoders.
            DefaultKijiCounter - Class in org.kiji.schema.impl
            The default implementation of a Kiji counter, which contains the data in a counter cell + of a column.
            DefaultKijiCounter(long, long) - +Constructor for class org.kiji.schema.impl.DefaultKijiCounter +
            Creates a new DefaultKijiCounter instance. +
            DefaultKijiTableFactory - Class in org.kiji.schema.impl
            The default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open().
            DefaultKijiTableFactory(Kiji) - +Constructor for class org.kiji.schema.impl.DefaultKijiTableFactory +
            Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance. +
            DEFAULTS_PROPERTIES_FILE - +Static variable in class org.kiji.schema.impl.HBaseSystemTable +
            The name of the file that stores the current system table defaults that are loaded + at installation time. +
            delete - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            delete - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            delete - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            deleteCell(EntityId, String, String) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes the most recent version of the cell in a column. +
            deleteCell(EntityId, String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes a single cell with a specified timestamp. +
            deleteCell(EntityId, String, String) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes the most recent version of the cell in a column. +
            deleteCell(EntityId, String, String, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes a single cell with a specified timestamp. +
            deleteColumn(EntityId, String, String) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all versions of all cells in a column. +
            deleteColumn(EntityId, String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +
            deleteColumn(EntityId, String, String) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all versions of all cells in a column. +
            deleteColumn(EntityId, String, String, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +
            deleteFamily(EntityId, String) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all versions of all cells in a family. +
            deleteFamily(EntityId, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +
            deleteFamily(EntityId, String) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all versions of all cells in a family. +
            deleteFamily(EntityId, String, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +
            deleteRow(EntityId) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes an entire row. +
            deleteRow(EntityId, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +
            deleteRow(EntityId) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes an entire row. +
            deleteRow(EntityId, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +
            deleteTable(String) - +Method in class org.kiji.schema.impl.HBaseKijiAdmin +
            Deletes a Kiji table. +
            deleteTable(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Remove all metadata, including layouts, for a particular table. +
            deleteTable(String) - +Method in interface org.kiji.schema.KijiAdmin +
            Deletes a Kiji table. +
            deleteTable(String) - +Method in class org.kiji.schema.KijiMetaTable +
            Remove all metadata, including layouts, for a particular table. +
            DeleteTool - Class in org.kiji.schema.tools
            Command-line tool to delete kiji tables, rows, and cells.
            DeleteTool() - +Constructor for class org.kiji.schema.tools.DeleteTool +
              +
            description - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            description - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            description - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            description - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            DictionaryLoader - Class in org.kiji.schema.tools.synth
            Loads a dictionary file, which is simply a list of words, one per line.
            DictionaryLoader() - +Constructor for class org.kiji.schema.tools.synth.DictionaryLoader +
            Creates a new DictionaryLoader instance. +
            DistributedCacheJars - Class in org.kiji.schema.mapreduce
            Deprecated. 
            downcast(KijiTable) - +Static method in class org.kiji.schema.impl.HBaseKijiTable +
            We know that all KijiTables are really HBaseKijiTables + instances. +
            +
            +

            +E

            +
            +
            EmailSynthesizer - Class in org.kiji.schema.tools.synth
            Synthesizes a random email address.
            EmailSynthesizer(Random, List<String>) - +Constructor for class org.kiji.schema.tools.synth.EmailSynthesizer +
            Creates a new email synthesizer. +
            enabled - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            enabled - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            enabled - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            encode(KijiCell<?>) - +Method in class org.kiji.schema.impl.AvroCellEncoder +
            Encodes the specified Kiji cell. +
            encode(T) - +Method in class org.kiji.schema.impl.AvroCellEncoder +
            Encodes the specified value. +
            encode(KijiCell<?>) - +Method in class org.kiji.schema.impl.CounterCellEncoder +
            Encodes the specified Kiji cell. +
            encode(T) - +Method in class org.kiji.schema.impl.CounterCellEncoder +
            Encodes the specified value. +
            encode(KijiCell<?>) - +Method in interface org.kiji.schema.KijiCellEncoder +
            Encodes the specified Kiji cell. +
            encode(T) - +Method in interface org.kiji.schema.KijiCellEncoder +
            Encodes the specified value. +
            encodeSchemaEntry(SchemaTableEntry) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Encodes an Avro schema entry into binary. +
            encoding - +Variable in class org.kiji.schema.avro.RowKeyFormat +
            Deprecated.  +
            EntityId - Class in org.kiji.schema
            EntityId is used to identify a particular row in a Kiji table.
            EntityId() - +Constructor for class org.kiji.schema.EntityId +
              +
            EntityIdFactory - Class in org.kiji.schema
            Factory class for creating EntityIds.
            EntityIdFactory(RowKeyFormat) - +Constructor for class org.kiji.schema.EntityIdFactory +
            Creates an entity ID factory. +
            ENV_URI_STRING - +Static variable in class org.kiji.schema.KijiURI +
            String to specify a value through the local environment. +
            equals(Object) - +Method in class org.kiji.schema.EntityId +
            +
            equals(Object) - +Method in class org.kiji.schema.HBaseColumnName +
            +
            equals(Object) - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiCell +
            Determines whether this KijiCell is equivalent to another. +
            equals(Object) - +Method in class org.kiji.schema.KijiColumnName +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiDataRequest.Column +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiDataRequest +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
              +
            equals(Object) - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiURI +
            +
            equals(Object) - +Method in class org.kiji.schema.layout.impl.ColumnId +
            +
            equals(Object) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            +
            equals(Object) - +Method in class org.kiji.schema.util.BytesKey +
              +
            exists() - +Method in class org.kiji.schema.KijiConfiguration +
            Deprecated. Determines whether this named Kiji instance exists. +
            exists(HBaseAdmin) - +Method in class org.kiji.schema.KijiConfiguration +
            Deprecated. Determines whether the Kiji instance exists according to the + given HBase admin interface. +
            exists(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Reports whether a column exists. +
            exportMetadata(String, Kiji) - +Method in class org.kiji.schema.impl.MetadataRestorer +
            Exports all Kiji metadata to an Avro file with the specified filename. +
            +
            +

            +F

            +
            +
            families - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            FamilyDesc - Class in org.kiji.schema.avro
             
            FamilyDesc() - +Constructor for class org.kiji.schema.avro.FamilyDesc +
            Default constructor. +
            FamilyDesc(Integer, String, List<String>, Boolean, String, CellSchema, List<ColumnDesc>, Boolean, String) - +Constructor for class org.kiji.schema.avro.FamilyDesc +
            All-args constructor. +
            FamilyDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for FamilyDesc instances.
            fileSystemSpecified(Path) - +Static method in class org.kiji.schema.tools.LayoutTool +
            Determines whether a path has its filesystem explicitly specified. +
            finalize() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            finalize() - +Method in class org.kiji.schema.impl.HBaseKiji +
            +
            finalize() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner +
            +
            finalize() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            +
            finalize() - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            +
            finalize() - +Method in class org.kiji.schema.KijiMetaTable +
            +
            finalize() - +Method in class org.kiji.schema.KijiTablePool +
              +
            flush() - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
              +
            flush() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Commits any pending additions to the schema table. +
            flush() - +Method in class org.kiji.schema.KijiSchemaTable +
            Commits any pending additions to the schema table. +
            FlushTableTool - Class in org.kiji.schema.tools
            Command-line tool for flushing kiji meta and user tables in hbase.
            FlushTableTool() - +Constructor for class org.kiji.schema.tools.FlushTableTool +
              +
            formatEmail(String, String) - +Static method in class org.kiji.schema.tools.synth.EmailSynthesizer +
            Construct an email address string. +
            fromAvroEntry(SchemaTableEntry) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Converts an Avro SchemaTableEntry into a SchemaEntry. +
            fromAvroJsonString(String, Schema) - +Static method in class org.kiji.schema.util.FromJson +
            Standard Avro JSON decoder. +
            fromBackup(Map<String, TableBackup>) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Restores metadata from a backup record. +
            fromBackup(List<SchemaTableEntry>) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Restores the schema entries from the specified backup record. +
            fromBackup(Map<String, TableBackup>) - +Method in class org.kiji.schema.KijiMetaTable +
            Restores metadata from a backup record. +
            fromBackup(List<SchemaTableEntry>) - +Method in class org.kiji.schema.KijiSchemaTable +
            Restores the schema entries from the specified backup record. +
            fromByteArray(byte[]) - +Static method in class org.kiji.schema.layout.impl.ColumnId +
            Translates HBase column names to ColumnIds. +
            fromCellSchema(CellSchema, KijiSchemaTable) - +Static method in class org.kiji.schema.layout.impl.CellSpec +
              +
            fromCellSchema(CellSchema) - +Static method in class org.kiji.schema.layout.impl.CellSpec +
            Creates a CellSpec from a CellSchema record. +
            fromHBaseRowKey(byte[]) - +Method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID from an HBase row key. +
            fromHBaseRowKey(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashedEntityId +
            Creates a HashedEntityId from the specified HBase row key. +
            fromHBaseRowKey(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Creates a HashPrefixedEntityId from the specified HBase row key. +
            fromHBaseRowKey(byte[]) - +Static method in class org.kiji.schema.impl.RawEntityId +
            Creates a RawEntityId from the specified HBase row key. +
            FromJson - Class in org.kiji.schema.util
            Decode a JSON string into an Avro record.
            fromJsonNode(JsonNode, Schema) - +Static method in class org.kiji.schema.util.FromJson +
            Decodes a JSON node as an Avro value. +
            fromJsonString(String, Schema) - +Static method in class org.kiji.schema.util.FromJson +
            Decodes a JSON encoded record. +
            fromKijiRowKey(byte[]) - +Method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID from a Kiji row key. +
            fromKijiRowKey(String) - +Method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID from a UTF8 text Kiji row key. +
            fromKijiRowKey(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashedEntityId +
            Creates a HashedEntityId from the specified Kiji row key. +
            fromKijiRowKey(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Creates a HashPrefixedEntityId from the specified Kiji row key. +
            fromKijiRowKey(byte[]) - +Static method in class org.kiji.schema.impl.RawEntityId +
            Creates a RawEntityId from the specified Kiji row key. +
            fromString(String) - +Static method in class org.kiji.schema.layout.impl.ColumnId +
            Translates HBase column names to ColumnIds. +
            Functions - Class in org.kiji.schema.util
            A collection of useful functions.
            +
            +

            +G

            +
            +
            GenericCellDecoder<T> - Class in org.kiji.schema.impl
            Decodes cells encoded using Avro into generic types.
            GenericCellDecoder(CellSpec) - +Constructor for class org.kiji.schema.impl.GenericCellDecoder +
            Initializes a cell decoder that creates generic Avro types. +
            GenericCellDecoderFactory - Class in org.kiji.schema
            Factory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas.
            GenericTableMapReduceUtil - Class in org.apache.hadoop.hbase.mapreduce
            Just like TableMapReduceUtil but fixes some missing dependency jars.
            GenericTableMapReduceUtil() - +Constructor for class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
              +
            get(int) - +Method in class org.kiji.schema.avro.CellSchema +
              +
            get(int) - +Method in class org.kiji.schema.avro.ColumnDesc +
              +
            get(int) - +Method in class org.kiji.schema.avro.FamilyDesc +
              +
            get(int) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            get(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            get(int) - +Method in class org.kiji.schema.avro.MetadataBackup +
              +
            get(int) - +Method in class org.kiji.schema.avro.RowKeyFormat +
              +
            get(int) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
              +
            get(int) - +Method in class org.kiji.schema.avro.TableBackup +
              +
            get(int) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            get(int) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
              +
            get() - +Static method in class org.kiji.schema.GenericCellDecoderFactory +
              +
            get() - +Static method in class org.kiji.schema.HBaseFactory.Provider +
              +
            get() - +Static method in class org.kiji.schema.impl.CounterCellDecoder +
              +
            get() - +Static method in class org.kiji.schema.impl.CounterCellEncoder +
              +
            get() - +Static method in class org.kiji.schema.impl.DefaultHBaseAdminFactory +
              +
            get() - +Static method in class org.kiji.schema.impl.DefaultHTableInterfaceFactory +
              +
            get() - +Static method in class org.kiji.schema.impl.DefaultKijiCellEncoderFactory +
              +
            get(EntityId, KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Retrieves data from a single row in the kiji table. +
            get() - +Static method in class org.kiji.schema.Kiji.Factory +
              +
            get(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Constructs using an HBase HTable name. +
            get(String) - +Method in class org.kiji.schema.KijiTablePool +
            Gets a previously opened table from the pool, or open a new connection. +
            get(EntityId, KijiDataRequest) - +Method in interface org.kiji.schema.KijiTableReader +
            Retrieves data from a single row in the kiji table. +
            get() - +Static method in class org.kiji.schema.SpecificCellDecoderFactory +
              +
            getAdmin() - +Method in class org.kiji.schema.impl.HBaseKiji +
            +
            getAdmin() - +Method in interface org.kiji.schema.Kiji +
              +
            getAliases() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'aliases' field +
            getAliases() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'aliases' field. +
            getAliases() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'aliases' field +
            getAliases() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'aliases' field. +
            getAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'aliases' field +
            getAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'aliases' field. +
            getAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Gets the value of the 'avro_schema' field +
            getAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Gets the value of the 'avro_schema' field. +
            getAvroSchema() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            getBuffer(EntityId) - +Method in class org.kiji.schema.impl.KijiDataBuffer +
            Gets the list of buffer elements associated with the specified entity. +
            getBuffers() - +Method in class org.kiji.schema.impl.KijiDataBuffer +
              +
            getBytes() - +Method in class org.kiji.schema.util.BytesKey +
              +
            getBytes() - +Method in class org.kiji.schema.util.ByteStreamArray +
              +
            getCacheBlocks() - +Method in class org.kiji.schema.HBaseScanOptions +
            Returns whether requested rows are cached server-side, + or null if using the HBase default. +
            getCategory() - +Method in class org.kiji.schema.tools.CreateTableTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.DeleteTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.FlushTableTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.HelpTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.IncrementTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.InstallTool +
            +
            getCategory() - +Method in interface org.kiji.schema.tools.KijiTool +
              +
            getCategory() - +Method in class org.kiji.schema.tools.LayoutTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.LsTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.MetadataTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.PutTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.UninstallTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.VersionTool +
            +
            getCell(String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the specified cell. +
            getCell(String, String, long) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the specified cell. +
            getCellDecoderFactory() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the cell decoder factory. +
            getCellFormat(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Reports the cell format for the specified column. +
            getCells(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all the timestamp-cell pairs stored within the specified cell. +
            getCells(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all the timestamp-cell pairs stored within the specified family. +
            getCells(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all the timestamp-cell pairs stored within the specified family. +
            getCells(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all the timestamp-cell pairs stored within the specified cell. +
            getCellSchema() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            getCellSchema(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Gets the schema for a column. +
            getCellSpec(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getClientBufferSize() - +Method in class org.kiji.schema.HBaseScanOptions +
            Returns the number of rows to request with each RPC, + or null if using the HBase default. +
            getClientDataVersion() - +Static method in class org.kiji.schema.util.VersionInfo +
            Gets the version of the Kiji data format assumed by the client. +
            getClock() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets a clock. +
            getClusterDataVersion(Kiji) - +Static method in class org.kiji.schema.util.VersionInfo +
            Gets the version of the Kiji data format installed in the instance of the HBase cluster. +
            getColumn(String, String) - +Method in class org.kiji.schema.KijiDataRequest +
            Gets a Column requested named "family:key", or + null if none exists. +
            getColumn() - +Method in class org.kiji.schema.KijiURI +
              +
            getColumnIdNameMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getColumnMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getColumnName() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the column name. +
            getColumnNames() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getColumnOrdered() - +Method in class org.kiji.schema.KijiURI +
              +
            getColumns() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'columns' field +
            getColumns() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'columns' field. +
            getColumns() - +Method in class org.kiji.schema.KijiDataRequest +
            Gets the collection of requested columns. +
            getColumns() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'column_schema' field +
            getColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'column_schema' field. +
            getCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'compression_type' field +
            getCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'compression_type' field. +
            getConf() - +Method in class org.kiji.schema.impl.HBaseKiji +
            +
            getConf() - +Method in interface org.kiji.schema.Kiji +
            Deprecated.  +
            getConf() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            getCounter(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Deprecated.  +
            getCounter(String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Deprecated.  +
            getCounter(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the most recent counter from a column. +
            getCounter(String, String, long) - +Method in interface org.kiji.schema.KijiRowData +
            Reads a counter as it was at a particular timestamp. +
            getCounter(Enum<?>) - +Method in interface org.kiji.schema.util.CounterManager +
            Gets a counter by name. +
            getCurrentKey() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            getCurrentValue() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            getData() - +Method in class org.kiji.schema.KijiCell +
            Gets the data in the cell. +
            getDataRequest() - +Method in class org.kiji.schema.filter.ColumnValueEqualsRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.HasColumnDataRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.KijiRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.OperatorRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.StripValueRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the data request. +
            getDataVersion() - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Gets the version of kiji installed. +
            getDataVersion() - +Method in class org.kiji.schema.KijiSystemTable +
            Gets the version of kiji installed. +
            getDefaultClock() - +Static method in class org.kiji.schema.util.Clock +
              +
            getDelete() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'delete' field +
            getDelete() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'delete' field. +
            getDelete() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'delete' field +
            getDelete() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'delete' field. +
            getDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'delete' field +
            getDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'delete' field. +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getDescription() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.tools.CreateTableTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.DeleteTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.FlushTableTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.HelpTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.IncrementTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.InstallTool +
            +
            getDescription() - +Method in interface org.kiji.schema.tools.KijiTool +
              +
            getDescription() - +Method in class org.kiji.schema.tools.LayoutTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.LsTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.MetadataTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.PutTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.UninstallTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.VersionTool +
            +
            getEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'enabled' field +
            getEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'enabled' field. +
            getEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'enabled' field +
            getEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'enabled' field. +
            getEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'enabled' field +
            getEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'enabled' field. +
            getEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Gets the value of the 'encoding' field +
            getEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Gets the value of the 'encoding' field. +
            getEntityId(String) - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            Creates an entity ID for the specified UTF8 encoded Kiji row key. +
            getEntityId() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the entity id for this row of kiji data. +
            getEntityId() - +Method in interface org.kiji.schema.KijiRowData +
            Gets the entity id for this row of kiji data. +
            getEntityId(String) - +Method in interface org.kiji.schema.KijiTable +
            Creates an entity ID for the specified UTF8 encoded Kiji row key. +
            getEntityIdFactory() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            +
            getEntityIdFactory() - +Method in interface org.kiji.schema.KijiTable +
              +
            getEntries() - +Method in class org.kiji.schema.impl.KijiDataBuffer +
              +
            getFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'families' field +
            getFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'families' field. +
            getFamilies() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getFamilies() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getFamily() - +Method in class org.kiji.schema.HBaseColumnName +
            Gets the HBase column family. +
            getFamily() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column family. +
            getFamily() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the name of the requested column family. +
            getFamily() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getFamilyAsString() - +Method in class org.kiji.schema.HBaseColumnName +
            Gets the HBase column family as a string. +
            getFamilyBytes() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column family as a byte array. +
            getFamilyIdNameMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getFamilyMap() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getFamilyMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getFilter() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the column filter, or null if no filter was specified. +
            getFormat() - +Method in class org.kiji.schema.EntityId +
              +
            getFormat() - +Method in class org.kiji.schema.EntityIdFactory +
              +
            getFormat() - +Method in class org.kiji.schema.impl.HashedEntityId +
            +
            getFormat() - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
            +
            getFormat() - +Method in class org.kiji.schema.impl.HBaseEntityId +
            +
            getFormat() - +Method in class org.kiji.schema.impl.RawEntityId +
            +
            getHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Gets the value of the 'hash' field +
            getHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Gets the value of the 'hash' field. +
            getHash() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
              +
            getHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Gets the value of the 'hash_size' field +
            getHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Gets the value of the 'hash_size' field. +
            getHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Gets the value of the 'hash_type' field +
            getHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Gets the value of the 'hash_type' field. +
            getHBaseAdmin() - +Method in class org.kiji.schema.impl.HBaseKijiAdmin +
              +
            getHBaseAdminFactory(KijiURI) - +Method in interface org.kiji.schema.HBaseFactory +
            Reports a factory for HBaseAdmin for a given HBase instance. +
            getHBaseAdminFactory(KijiURI) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            Reports a factory for HBaseAdmin for a given HBase instance. +
            getHBaseCellValue(KijiColumnName, KijiCell<?>) - +Method in class org.kiji.schema.filter.KijiRowFilter.Context +
            Converts a Kiji cell value into an HBase cell value. +
            getHBaseColumnName(KijiColumnName) - +Method in interface org.kiji.schema.filter.KijiColumnFilter.Context +
            Converts a Kiji column name to an HBase column name. +
            getHBaseColumnName(KijiColumnName) - +Method in class org.kiji.schema.filter.KijiRowFilter.Context +
            Converts a Kiji column name to an HBase column family name. +
            getHBaseResult() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the HBase result backing this KijiRowData. +
            getHBaseResultScanner() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the HBase result scanner. +
            getHBaseRowKey() - +Method in class org.kiji.schema.EntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey(String) - +Method in class org.kiji.schema.filter.KijiRowFilter.Context +
            Converts a Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.HashedEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.HBaseEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.RawEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseScanOptions() - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Gets the HBaseScanOptions set in these options. +
            getHBaseTableName() - +Method in exception org.kiji.schema.NotAKijiManagedTableException +
            Gets the name of the HBase table that is not managed by Kiji. +
            getHColumnDescriptor(String) - +Static method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets the description of an HColumn suitable for storing the table layout database. +
            getHTable() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
              +
            getHTableInterfaceFactory(KijiURI) - +Method in interface org.kiji.schema.HBaseFactory +
            Reports a factory for HTableInterface for a given HBase instance. +
            getHTableInterfaceFactory(KijiURI) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            Reports a factory for HTableInterface for a given HBase instance. +
            getId() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
              +
            getId() - +Method in class org.kiji.schema.layout.impl.ColumnId +
              +
            getId() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getId() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getId() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getIdlePollPeriod() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the amount of time between sweeps of the pool for removing idle connections. +
            getIdleTimeout() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the amount of time a connection may be idle before being removed from the pool. +
            getInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'in_memory' field +
            getInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'in_memory' field. +
            getInstance() - +Method in class org.kiji.schema.KijiURI +
              +
            getInstanceName() - +Method in exception org.kiji.schema.KijiNotInstalledException +
              +
            getInstanceNames() - +Method in class org.kiji.schema.tools.LsTool +
            Returns a set of instance names. +
            getJarsFromConfiguration(Configuration) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Lists all jars in the variable tmpjars of this Configuration. +
            getJarsFromDirectory(Configuration, File) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated.   +
            getKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Gets the value of the 'key' field +
            getKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Gets the value of the 'key' field. +
            getKey() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the name of the requested column qualifier, which may be null if any qualifier + should be included. +
            getKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'keys_format' field +
            getKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'keys_format' field. +
            getKeyValues() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Gets the value of the 'key_values' field +
            getKeyValues() - +Method in class org.kiji.schema.avro.TableBackup +
            Gets the value of the 'key_values' field. +
            getKiji() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            getKiji() - +Method in interface org.kiji.schema.KijiTable +
              +
            getKijiInstanceName() - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets the name of the Kiji instance this named table belongs to. +
            getKijiRowFilter() - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Gets the row filter set in these options. +
            getKijiRowKey() - +Method in class org.kiji.schema.EntityId +
              +
            getKijiRowKey() - +Method in class org.kiji.schema.impl.HashedEntityId +
            +
            getKijiRowKey() - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
            +
            getKijiRowKey() - +Method in class org.kiji.schema.impl.HBaseEntityId +
            +
            getKijiRowKey() - +Method in class org.kiji.schema.impl.RawEntityId +
            +
            getKijiTableName(String, String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table. +
            getKijiTableName() - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets the name of the Kiji table. +
            getLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Gets the value of the 'layout' field +
            getLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Gets the value of the 'layout' field. +
            getLayout() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            +
            getLayout() - +Method in interface org.kiji.schema.KijiTable +
              +
            getLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'layout_id' field +
            getLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'layout_id' field. +
            getLayouts() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Gets the value of the 'layouts' field +
            getLayouts() - +Method in class org.kiji.schema.avro.TableBackup +
            Gets the value of the 'layouts' field. +
            getLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Gets the value of the 'layout_version' field +
            getLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup +
            Gets the value of the 'layout_version' field. +
            getLocalityGroup() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getLocalityGroupIdNameMap() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getLocalityGroupMap() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'locality_groups' field +
            getLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'locality_groups' field. +
            getLocalityGroups() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getLockFactory(KijiURI, Configuration) - +Method in interface org.kiji.schema.HBaseFactory +
            Creates a lock factory for a given Kiji instance. +
            getLockFactory(KijiURI, Configuration) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            Creates a lock factory for a given Kiji instance. +
            getMap() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets a map from kiji family to qualifier to timestamp to raw kiji-encoded bytes of a cell. +
            getMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'map_schema' field +
            getMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'map_schema' field. +
            getMaxSize() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the maximum number of connections to keep per table. +
            getMaxTimestamp() - +Method in class org.kiji.schema.KijiDataRequest +
            Gets the maximum timestamp for versions in this request (exclusive). +
            getMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'max_versions' field +
            getMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'max_versions' field. +
            getMaxVersions() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the max number of most recent versions in this request. +
            getMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Gets the value of the 'meta_table' field +
            getMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup +
            Gets the value of the 'meta_table' field. +
            getMetaTable() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Gets the meta table for this Kiji instance. +
            getMetaTable() - +Method in interface org.kiji.schema.Kiji +
            Gets the meta table for this Kiji instance. +
            getMetaTableName(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table. +
            getMinSize() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the minimum number of connections to keep per table. +
            getMinTimestamp() - +Method in class org.kiji.schema.KijiDataRequest +
            Gets the minimum timestamp for versions in this request (inclusive). +
            getMostRecentCell(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the latest version of the specified cell. +
            getMostRecentCell(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the latest version of the specified cell. +
            getMostRecentCells(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the latest version of the specified cell. +
            getMostRecentCells(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the latest version of the specified cell. +
            getMostRecentValue(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the value with the latest timestamp stored within the specified cell. +
            getMostRecentValue(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the value with the latest timestamp stored within the specified cell. +
            getMostRecentValues(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the value with the latest timestamp stored within the specified cell. +
            getMostRecentValues(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the value with the latest timestamp stored within the specified cell. +
            getName() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.TableBackup +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            getName() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the full name of the column. +
            getName() - +Method in class org.kiji.schema.KijiConfiguration +
            Deprecated. Gets the name of this Kiji instance. +
            getName() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the full name of the requested column. +
            getName() - +Method in interface org.kiji.schema.KijiTable +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getName() - +Method in class org.kiji.schema.tools.CreateTableTool +
            +
            getName() - +Method in class org.kiji.schema.tools.DeleteTool +
            +
            getName() - +Method in class org.kiji.schema.tools.FlushTableTool +
            +
            getName() - +Method in class org.kiji.schema.tools.HelpTool +
            +
            getName() - +Method in class org.kiji.schema.tools.IncrementTool +
            +
            getName() - +Method in class org.kiji.schema.tools.InstallTool +
            +
            getName() - +Method in interface org.kiji.schema.tools.KijiTool +
              +
            getName() - +Method in class org.kiji.schema.tools.LayoutTool +
            +
            getName() - +Method in class org.kiji.schema.tools.LsTool +
            +
            getName() - +Method in class org.kiji.schema.tools.MetadataTool +
            +
            getName() - +Method in class org.kiji.schema.tools.PutTool +
            +
            getName() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            +
            getName() - +Method in class org.kiji.schema.tools.UninstallTool +
            +
            getName() - +Method in class org.kiji.schema.tools.VersionTool +
            +
            getNames() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getNames() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getNames() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getNextPage(String, String) - +Method in class org.kiji.schema.impl.KijiColumnPager +
            Gets the next page of data in a column with paging enabled. +
            getNextPage(String) - +Method in class org.kiji.schema.impl.KijiColumnPager +
            Gets the next page of data in a family with paging enabled. +
            getOffset() - +Method in class org.kiji.schema.util.ByteStreamArray +
              +
            getOptionalType(Schema) - +Static method in class org.kiji.schema.util.AvroUtils +
            Reports whether the given schema is an optional type (ie. +
            getOrCreateSchemaHash(Schema) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema hash given an Avro schema object. +
            getOrCreateSchemaHash(Schema) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema hash given an Avro schema object. +
            getOrCreateSchemaId(Schema) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema ID given an Avro schema object. +
            getOrCreateSchemaId(Schema) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema ID given an Avro schema object. +
            getPageSize() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the number of cells to return per page of results. +
            getPayload(byte[]) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Gets the portion of the encoded byte array from an HBase table cell that has the avro-encoded + data payload. +
            getPoolSize(String) - +Method in class org.kiji.schema.KijiTablePool +
            Gets the total number of connections, active and cached, for the specified table. +
            getPrintStream() - +Method in class org.kiji.schema.tools.BaseTool +
            The output print stream the tool should be writing to. +
            getPriority(Map<String, String>) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            +
            getPriority(Map<String, String>) - +Method in class org.kiji.schema.impl.HBaseKijiFactory +
            +
            getProgress() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            getQualifier() - +Method in class org.kiji.schema.HBaseColumnName +
            Gets the HBase column qualifier. +
            getQualifier() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column qualifier, which may be null or empty. +
            getQualifierAsString() - +Method in class org.kiji.schema.HBaseColumnName +
            Gets the HBase column qualifier as a string. +
            getQualifierBytes() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column qualifier as a byte array. +
            getQualifiers(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the set of column qualifiers that exist in a family. +
            getQualifiers(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the set of column qualifiers that exist in a family. +
            getReaderSchema(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +
            getReaderSchema(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +
            getReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'reference_layout' field +
            getReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'reference_layout' field. +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'renamed_from' field +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'renamed_from' field. +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'renamed_from' field +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'renamed_from' field. +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'renamed_from' field +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'renamed_from' field. +
            getScanner(KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Gets a KijiRowScanner with the specified data request. +
            getScanner(KijiDataRequest, KijiTableReader.KijiScannerOptions) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Gets a KijiRowScanner using the specified data request and options. +
            getScanner(KijiDataRequest) - +Method in interface org.kiji.schema.KijiTableReader +
            Gets a KijiRowScanner with the specified data request. +
            getScanner(KijiDataRequest, KijiTableReader.KijiScannerOptions) - +Method in interface org.kiji.schema.KijiTableReader +
            Gets a KijiRowScanner using the specified data request and options. +
            getSchema() - +Method in class org.kiji.schema.avro.CellSchema +
              +
            getSchema() - +Method in class org.kiji.schema.avro.ColumnDesc +
              +
            getSchema() - +Method in class org.kiji.schema.avro.FamilyDesc +
              +
            getSchema() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            getSchema() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            getSchema() - +Method in class org.kiji.schema.avro.MetadataBackup +
              +
            getSchema() - +Method in class org.kiji.schema.avro.RowKeyFormat +
              +
            getSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
              +
            getSchema() - +Method in class org.kiji.schema.avro.TableBackup +
              +
            getSchema() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            getSchema() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
              +
            getSchema(long) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema given an ID. +
            getSchema(BytesKey) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema given a hash. +
            getSchema(long) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema given an ID. +
            getSchema(BytesKey) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema given a hash. +
            getSchema() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
              +
            getSchema(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Reports the schema of the specified column. +
            getSchemaHash(Schema) - +Method in class org.kiji.schema.KijiSchemaTable +
            Computes a schema hash. +
            getSchemaHashTableName(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table. +
            getSchemaIdTableName(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table. +
            getSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Gets the value of the 'schema_table' field +
            getSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup +
            Gets the value of the 'schema_table' field. +
            getSchemaTable() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Gets the schema table for this Kiji instance. +
            getSchemaTable() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the schema table this kiji row data uses for decoding. +
            getSchemaTable() - +Method in interface org.kiji.schema.Kiji +
            Gets the schema table for this Kiji instance. +
            getSchemaTable() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            getSchemaV5TableName(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table. +
            getServerPrefetchSize() - +Method in class org.kiji.schema.HBaseScanOptions +
            Returns the number of rows for servers to prefetch, + or null if using the HBase default. +
            getSoftwareVersion() - +Static method in class org.kiji.schema.util.VersionInfo +
            Gets the version of the Kiji client software. +
            getSplitKeys(int) - +Static method in class org.kiji.schema.KijiRowKeySplitter +
            Returns the split keys for the given number of regions. +
            getSplits(JobContext) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            getStackTrace() - +Static method in class org.kiji.schema.util.Debug +
              +
            getStartRow() - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Gets the start row set in these options. +
            getStopRow() - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Gets the stop row set in these options. +
            getStorage() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Gets the value of the 'storage' field +
            getStorage() - +Method in class org.kiji.schema.avro.CellSchema +
            Gets the value of the 'storage' field. +
            getSystemTable() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Gets the system table for this Kiji instance. +
            getSystemTable() - +Method in interface org.kiji.schema.Kiji +
            Gets the system table for this Kiji instance. +
            getSystemTableName(String) - +Static method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table. +
            getTable() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the table being scanned. +
            getTable() - +Method in class org.kiji.schema.KijiURI +
              +
            getTableLayout() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the layout of the table this row data belongs to. +
            getTableLayout(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets the most recent versions of the layout for a table. +
            getTableLayout() - +Method in class org.kiji.schema.layout.ColumnNameTranslator +
              +
            getTableLayout(String) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets the most recent versions of the layout for a table. +
            getTableLayout() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getTableLayout(String) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets the most recent versions of the layout for a table. +
            getTableLayoutVersions(String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the most recent specified number of versions of the table layout. +
            getTableLayoutVersions(String, int) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets a list of the most recent specified number of versions of the table layout. +
            getTableLayoutVersions(String, int) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets a list of the most recent specified number of versions of the table layout. +
            getTableNames() - +Method in class org.kiji.schema.impl.HBaseKijiAdmin +
            Gets the list of Kiji table names. +
            getTableNames() - +Method in interface org.kiji.schema.KijiAdmin +
            Gets the list of Kiji table names. +
            getTime() - +Method in class org.kiji.schema.util.Clock +
            Gets the current time. +
            getTimedTableLayoutVersions(String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +
            getTimedTableLayoutVersions(String, int) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +
            getTimedTableLayoutVersions(String, int) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +
            getTimedValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns a map of values associated with the specified table and key. +
            getTimedValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns a map of values associated with the specified table and key. +
            getTimedValues(String, String, int) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns a map of values associated with the specified table and key. +
            getTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Gets the value of the 'timestamp' field +
            getTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Gets the value of the 'timestamp' field. +
            getTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Gets the value of the 'timestamp' field +
            getTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Gets the value of the 'timestamp' field. +
            getTimestamp() - +Method in class org.kiji.schema.impl.DefaultKijiCounter +
            Gets the timestamp at which the counter was incremented. +
            getTimestamp() - +Method in interface org.kiji.schema.KijiCounter +
            Deprecated. Gets the timestamp at which the counter was incremented. +
            getTimestamps(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the set of timestamps on cells that exist in a column. +
            getTimestamps(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the set of timestamps on cells that exist in a column. +
            getTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'ttl_seconds' field +
            getTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'ttl_seconds' field. +
            getType() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Gets the value of the 'type' field +
            getType() - +Method in class org.kiji.schema.avro.CellSchema +
            Gets the value of the 'type' field. +
            getUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Gets the value of the 'update' field +
            getUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Gets the value of the 'update' field. +
            getURI() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            getURI() - +Method in class org.kiji.schema.impl.HBaseKiji +
            +
            getURI() - +Method in interface org.kiji.schema.Kiji +
              +
            getURI() - +Method in exception org.kiji.schema.KijiAlreadyExistsException +
              +
            getURI() - +Method in interface org.kiji.schema.KijiTable +
              +
            getURI() - +Method in class org.kiji.schema.tools.BaseTool +
            Returns the kiji URI of the target this tool operates on. +
            getValue() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Gets the value of the 'value' field +
            getValue() - +Method in class org.kiji.schema.avro.CellSchema +
            Gets the value of the 'value' field. +
            getValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Gets the value of the 'value' field +
            getValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Gets the value of the 'value' field. +
            getValue() - +Method in class org.kiji.schema.impl.DefaultKijiCounter +
            Gets the value of the counter. +
            getValue(String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the value stored within the specified cell. +
            getValue(String, String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns the most recent value associated with the specified table and key. +
            getValue(String) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Gets the value associated with a property key. +
            getValue(String, String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns the most recent value associated with the specified table and key. +
            getValue() - +Method in interface org.kiji.schema.KijiCounter +
            Deprecated. Gets the value of the counter. +
            getValue(String, String, long) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the value stored within the specified cell. +
            getValue(String) - +Method in class org.kiji.schema.KijiSystemTable +
            Gets the value associated with a property key. +
            getValue(String, String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns the most recent value associated with the specified table and key. +
            getValues(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all the timestamp-value pairs stored within the specified cell. +
            getValues(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all the timestamp-value pairs stored within the specified family. +
            getValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +
            getValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +
            getValues(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all the timestamp-value pairs stored within the specified family. +
            getValues(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all the timestamp-value pairs stored within the specified cell. +
            getValues(String, String, int) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +
            getVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'version' field +
            getVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'version' field. +
            getWriterSchema() - +Method in class org.kiji.schema.KijiCell +
            Gets the schema used to write data in the cell. +
            getZookeeperClientPort() - +Method in class org.kiji.schema.KijiURI +
              +
            getZookeeperQuorum() - +Method in class org.kiji.schema.KijiURI +
              +
            getZookeeperQuorumOrdered() - +Method in class org.kiji.schema.KijiURI +
              +
            +
            +

            +H

            +
            +
            hasAliases() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'aliases' field has been set +
            hasAliases() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'aliases' field has been set +
            hasAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'aliases' field has been set +
            hasAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Checks whether the 'avro_schema' field has been set +
            HasColumnDataRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter that excludes rows that have no data for some column columnName.
            HasColumnDataRowFilter(String, String) - +Constructor for class org.kiji.schema.filter.HasColumnDataRowFilter +
            Constructs a row filter that excludes rows that have no data in columnName. +
            HasColumnDataRowFilter(String) - +Constructor for class org.kiji.schema.filter.HasColumnDataRowFilter +
            Constructs a row filter that excludes rows that have no data in columnName. +
            hasColumns() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'columns' field has been set +
            hasColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'column_schema' field has been set +
            hasCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'compression_type' field has been set +
            hasDelete() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'delete' field has been set +
            hasDelete() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'delete' field has been set +
            hasDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'delete' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'description' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'description' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'description' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'description' field has been set +
            hasEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'enabled' field has been set +
            hasEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'enabled' field has been set +
            hasEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'enabled' field has been set +
            hasEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Checks whether the 'encoding' field has been set +
            hasFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'families' field has been set +
            hash - +Variable in class org.kiji.schema.avro.SchemaTableEntry +
            Deprecated.  +
            hash(String) - +Static method in class org.kiji.schema.util.Hasher +
            Hashes the input string. +
            hash(byte[]) - +Static method in class org.kiji.schema.util.Hasher +
            Hashes the input byte array. +
            hash_size - +Variable in class org.kiji.schema.avro.RowKeyFormat +
            Deprecated.  +
            HASH_SIZE_BYTES - +Static variable in class org.kiji.schema.util.Hasher +
            The number of bytes in a hash. +
            hash_type - +Variable in class org.kiji.schema.avro.RowKeyFormat +
            Deprecated.  +
            hasHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Checks whether the 'hash' field has been set +
            hasHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Checks whether the 'hash_size' field has been set +
            hasHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Checks whether the 'hash_type' field has been set +
            hashCode() - +Method in class org.kiji.schema.EntityId +
            +
            hashCode() - +Method in class org.kiji.schema.HBaseColumnName +
            +
            hashCode() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            hashCode() - +Method in class org.kiji.schema.KijiCell +
            This operation is not supported. +
            hashCode() - +Method in class org.kiji.schema.KijiColumnName +
            +
            hashCode() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            +
            hashCode() - +Method in class org.kiji.schema.KijiDataRequest +
            +
            hashCode() - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
              +
            hashCode() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            +
            hashCode() - +Method in class org.kiji.schema.KijiURI +
            +
            hashCode() - +Method in class org.kiji.schema.layout.impl.ColumnId +
            +
            hashCode() - +Method in class org.kiji.schema.layout.KijiTableLayout +
            +
            hashCode() - +Method in class org.kiji.schema.util.BytesKey +
              +
            HashedEntityId - Class in org.kiji.schema.impl
            Implements the hashed row key format.
            Hasher - Class in org.kiji.schema.util
            A thread-safe utility for computing hashes of strings.
            hashKijiRowKey(RowKeyFormat, byte[]) - +Static method in class org.kiji.schema.impl.HashedEntityId +
            Hashes a Kiji row key. +
            hashKijiRowKey(RowKeyFormat, byte[]) - +Static method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Hashes a Kiji row key. +
            HashPrefixedEntityId - Class in org.kiji.schema.impl
            Implements the hash-prefixed row key format.
            hashSchema(Schema) - +Static method in class org.kiji.schema.KijiSchemaTable +
            Computes a hash of the specified Avro schema. +
            HashType - Enum in org.kiji.schema.avro
             
            hasId() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'id' field has been set +
            hasId() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'id' field has been set +
            hasId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'id' field has been set +
            hasId() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Checks whether the 'id' field has been set +
            hasInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'in_memory' field has been set +
            hasKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Checks whether the 'key' field has been set +
            hasKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'keys_format' field has been set +
            hasKeyValues() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Checks whether the 'key_values' field has been set +
            hasLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Checks whether the 'layout' field has been set +
            hasLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'layout_id' field has been set +
            hasLayouts() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Checks whether the 'layouts' field has been set +
            hasLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Checks whether the 'layout_version' field has been set +
            hasLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'locality_groups' field has been set +
            hasMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'map_schema' field has been set +
            hasMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'max_versions' field has been set +
            hasMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Checks whether the 'meta_table' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'name' field has been set +
            hasReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'reference_layout' field has been set +
            hasRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'renamed_from' field has been set +
            hasRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'renamed_from' field has been set +
            hasRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'renamed_from' field has been set +
            hasSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Checks whether the 'schema_table' field has been set +
            hasStorage() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Checks whether the 'storage' field has been set +
            hasTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Checks whether the 'timestamp' field has been set +
            hasTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Checks whether the 'timestamp' field has been set +
            hasTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'ttl_seconds' field has been set +
            hasType() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Checks whether the 'type' field has been set +
            hasUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Checks whether the 'update' field has been set +
            hasValue() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Checks whether the 'value' field has been set +
            hasValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Checks whether the 'value' field has been set +
            hasVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'version' field has been set +
            HBASE_ROW_KEY_RESOLUTION - +Static variable in class org.kiji.schema.KijiRowKeySplitter +
            Resolution (in number of bytes) when generating evenly spaced HBase row keys. +
            HBaseAdminFactory - Interface in org.kiji.schema.impl
            Factory for HBaseAdmin.
            HBaseColumnName - Class in org.kiji.schema
            An HBase column name.
            HBaseColumnName(byte[], byte[]) - +Constructor for class org.kiji.schema.HBaseColumnName +
            Creates a new HBaseColumnName instance. +
            HBaseDataRequestAdapter - Class in org.kiji.schema.impl
            Wraps a KijiDataRequest to expose methods that generate meaningful objects in HBase + land, like Puts and Gets.
            HBaseDataRequestAdapter(KijiDataRequest) - +Constructor for class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Wraps a KijiDataRequest. +
            HBaseEntityId - Class in org.kiji.schema.impl
            Entity ID encapsulating an HBase row key.
            HBaseEntityId(byte[]) - +Constructor for class org.kiji.schema.impl.HBaseEntityId +
            Creates an HBaseEntityId from the specified HBase row key. +
            HBaseFactory - Interface in org.kiji.schema
            Factory for HBase instances based on URIs.
            HBaseFactory.Provider - Class in org.kiji.schema
            Provider for the default HBaseFactory.
            HBaseKiji - Class in org.kiji.schema.impl
            Kiji instance class that contains configuration and table + information.
            HBaseKijiAdmin - Class in org.kiji.schema.impl
            Administration API for managing a Kiji instance that uses HBase as its underlying data store.
            HBaseKijiFactory - Class in org.kiji.schema.impl
            Factory for constructing instances of HBaseKiji.
            HBaseKijiFactory() - +Constructor for class org.kiji.schema.impl.HBaseKijiFactory +
              +
            HBaseKijiRowData - Class in org.kiji.schema.impl
            An implementation of KijiRowData that wraps an HBase Result object.
            HBaseKijiRowData(EntityId, KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Deprecated.  +
            HBaseKijiRowData(KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Deprecated.  +
            HBaseKijiRowData(EntityId, KijiDataRequest, HBaseKijiTable, Result) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Initializes a row data. +
            HBaseKijiRowData(KijiDataRequest, HBaseKijiTable, Result) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Initializes a row data. +
            HBaseKijiRowScanner - Class in org.kiji.schema.impl
            The internal implementation of KijiRowScanner that reads from HTables.
            HBaseKijiRowScanner(HBaseKijiRowScanner.Options) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowScanner +
            Creates a new KijiRowScanner instance. +
            HBaseKijiRowScanner.Options - Class in org.kiji.schema.impl
            A class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            HBaseKijiRowScanner.Options() - +Constructor for class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
              +
            HBaseKijiTable - Class in org.kiji.schema.impl
            A KijiTable that exposes the underlying HBase implementation.
            HBaseKijiTableReader - Class in org.kiji.schema.impl
            Reads from a kiji table by sending the requests directly to the HBase tables.
            HBaseKijiTableReader(HBaseKijiTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiTableReader +
            Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase. +
            HBaseKijiTableWriter - Class in org.kiji.schema.impl
            Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            HBaseKijiTableWriter(HBaseKijiTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiTableWriter +
            Creates a non-buffered kiji table writer that sends modifications directly to Kiji. +
            HBaseMetaTable - Class in org.kiji.schema.impl
            An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            HBaseMetaTable(KijiConfiguration, KijiSchemaTable, HTableInterfaceFactory) - +Constructor for class org.kiji.schema.impl.HBaseMetaTable +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +
            HBaseMetaTable(HTableInterface, KijiSchemaTable) - +Constructor for class org.kiji.schema.impl.HBaseMetaTable +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +
            HBaseMetaTable(HTableInterface, KijiTableLayoutDatabase, KijiTableKeyValueDatabase) - +Constructor for class org.kiji.schema.impl.HBaseMetaTable +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +
            HBaseScanOptions - Class in org.kiji.schema
            Customizable parameters for KijiRowScanners backed by an HBase scan.
            HBaseScanOptions() - +Constructor for class org.kiji.schema.HBaseScanOptions +
            Creates a new HBaseScanOptions where all parameters will default to HBase values. +
            HBaseSchemaTable - Class in org.kiji.schema.impl
            + Mapping between schema IDs, hashes and Avro schema objects.
            HBaseSchemaTable(KijiConfiguration, HTableInterfaceFactory, LockFactory) - +Constructor for class org.kiji.schema.impl.HBaseSchemaTable +
            Open a connection to the HBase schema table for a Kiji instance. +
            HBaseSchemaTable(HTableInterface, HTableInterface, Lock) - +Constructor for class org.kiji.schema.impl.HBaseSchemaTable +
            Wrap an existing HBase table assumed to be where the schema data is stored. +
            HBaseSystemTable - Class in org.kiji.schema.impl
            The Kiji system table that is stored in HBase.
            HBaseSystemTable(KijiConfiguration, HTableInterfaceFactory) - +Constructor for class org.kiji.schema.impl.HBaseSystemTable +
            Connect to the HBase system table inside a Kiji instance. +
            HBaseSystemTable(HTableInterface) - +Constructor for class org.kiji.schema.impl.HBaseSystemTable +
            Wrap an existing HTable connection that is assumed to be the table that stores the + Kiji instance properties. +
            HBaseTableKeyValueDatabase - Class in org.kiji.schema.impl
            Manages key-value pairs on a per table basis.
            HBaseTableKeyValueDatabase(HTableInterface, String) - +Constructor for class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            This class manages the storage and retrieval of key-value pairs on a per table basis. +
            HBaseTableLayoutDatabase - Class in org.kiji.schema.layout.impl
            Manages Kiji table layouts using a column family in an HBase table as a backing store.
            HBaseTableLayoutDatabase(HTableInterface, String, KijiSchemaTable) - +Constructor for class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Creates a new HBaseTableLayoutDatabase instance. +
            HColumnDescriptorComparator - Class in org.kiji.schema.impl
            Comparator for HColumnDescriptors.
            HColumnDescriptorComparator() - +Constructor for class org.kiji.schema.impl.HColumnDescriptorComparator +
              +
            HelpTool - Class in org.kiji.schema.tools
            Command-line tool for displaying help on available tools.
            HelpTool() - +Constructor for class org.kiji.schema.tools.HelpTool +
              +
            HTableDescriptorComparator - Class in org.kiji.schema.impl
            Compares HTableDescriptors.
            HTableDescriptorComparator() - +Constructor for class org.kiji.schema.impl.HTableDescriptorComparator +
              +
            HTableInterfaceFactory - Interface in org.kiji.schema.impl
            Factory for HTableInterface instances.
            HTableSchemaTranslator - Class in org.kiji.schema.layout.impl
            Translates between KijiTableLayouts and HTableDescriptors.
            HTableSchemaTranslator() - +Constructor for class org.kiji.schema.layout.impl.HTableSchemaTranslator +
            Creates a new HTableSchemaTranslator instance. +
            +
            +

            +I

            +
            +
            id - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            id - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            id - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            id - +Variable in class org.kiji.schema.avro.SchemaTableEntry +
            Deprecated.  +
            in_memory - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            IncompatibleKijiVersionException - Exception in org.kiji.schema
            Thrown when there is an attempt to operate on a Kiji instance whose data format version + is incompatible with the Kiji client version.
            IncompatibleKijiVersionException(String) - +Constructor for exception org.kiji.schema.IncompatibleKijiVersionException +
            Creates a new IncompatibleKijiVersionException with the specified + detail message. +
            increment(EntityId, String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Atomically increments a counter in a kiji table. +
            increment(EntityId, String, String, long) - +Method in interface org.kiji.schema.KijiIncrementer +
            Atomically increments a counter in a kiji table. +
            IncrementTool - Class in org.kiji.schema.tools
            Command-line tool to increment a counter in a cell of a kiji table.
            IncrementTool() - +Constructor for class org.kiji.schema.tools.IncrementTool +
              +
            initGenericTableMapperJob(String, Scan, Class<? extends TableMapper>, Class<?>, Class<?>, Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            This is just like the TableMapReduceUtil.initTableMapperJob but + it takes any classes for input and output keys instead of just + Writables. +
            initialize(InputSplit, TaskAttemptContext) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            initTableInput(String, Scan, Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            Configures the job with an HBase scan over a table as input. +
            initTableScan(Scan, Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            Configures the job with an HBase scan. +
            INPUT_DATA_REQUEST - +Static variable in class org.kiji.schema.mapreduce.KijiConfKeys +
            Deprecated. Serialized input data request. +
            INPUT_TABLE_URI - +Static variable in class org.kiji.schema.mapreduce.KijiConfKeys +
            Deprecated. URI of the input table to read from. +
            install(HBaseAdmin, KijiURI) - +Static method in class org.kiji.schema.impl.HBaseMetaTable +
            Install the meta table into a Kiji instance. +
            install(HBaseAdmin, KijiConfiguration, HTableInterfaceFactory, LockFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Install the schema table into a Kiji instance. +
            install(HBaseAdmin, KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSystemTable +
            Installs a Kiji system table into a running HBase instance. +
            install(KijiURI, Configuration) - +Static method in class org.kiji.schema.KijiInstaller +
            Installs the specified Kiji instance. +
            install(KijiURI, HBaseFactory, Configuration) - +Static method in class org.kiji.schema.KijiInstaller +
            Installs a Kiji instance. +
            InstallTool - Class in org.kiji.schema.tools
            A command-line tool for installing kiji instances on hbase clusters.
            InstallTool() - +Constructor for class org.kiji.schema.tools.InstallTool +
              +
            INSTANCE - +Static variable in class org.kiji.schema.util.TimestampComparator +
            A singleton instance. +
            InternalKijiError - Error in org.kiji.schema
            Thrown when there is something wrong with the internal Kiji + implementation.
            InternalKijiError(Throwable) - +Constructor for error org.kiji.schema.InternalKijiError +
            Creates a new InternalKijiError with the specified cause. +
            InternalKijiError(String) - +Constructor for error org.kiji.schema.InternalKijiError +
            Creates a new InternalKijiError with the specified detail message. +
            InvalidColumnNameException - Exception in org.kiji.schema.impl
            Thrown when kiji encounters a column name that is not valid.
            InvalidColumnNameException(String) - +Constructor for exception org.kiji.schema.impl.InvalidColumnNameException +
            Creates a new InvalidColumnNameException with the specified detail message. +
            InvalidLayoutException - Exception in org.kiji.schema.layout
            Thrown when an invalid Kiji layout is encountered.
            InvalidLayoutException(String) - +Constructor for exception org.kiji.schema.layout.InvalidLayoutException +
            Creates a new InvalidLayoutException with the specified reason. +
            InvalidLayoutException(KijiTableLayout, String) - +Constructor for exception org.kiji.schema.layout.InvalidLayoutException +
            Constructs an exception indicated a table layout is invalid. +
            isAvro() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            isCounter() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            isEmpty() - +Method in class org.kiji.schema.KijiDataRequest +
            Determines whether this data request has any columns. +
            isFullyQualified() - +Method in class org.kiji.schema.KijiColumnName +
            Determines whether the name refers to a qualified family (vs. +
            isGroupType() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            isInteractive() - +Method in class org.kiji.schema.tools.BaseTool +
            Whether or not this tool is being run interactively. +
            isMapType() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            isPagingEnabled() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Determines whether paging is enabled for this column. +
            isPagingEnabled() - +Method in class org.kiji.schema.KijiDataRequest +
            Determines whether paging is enabled on any of the columns in this request. +
            isTimestampInRange(long) - +Method in class org.kiji.schema.KijiDataRequest +
            Determines whether a timestamp ts is within the time range for this + request. +
            isValidAlias(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
              +
            isValidClassName(String) - +Static method in class org.kiji.schema.util.JavaIdentifiers +
            Determines whether a string could be the name of a Java class. +
            isValidIdentifier(String) - +Static method in class org.kiji.schema.util.JavaIdentifiers +
            Determines whether a string is a valid Java identifier. +
            isValidKijiName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
              +
            isValidLayoutName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
              +
            iterator() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner +
            +
            +
            +

            +J

            +
            +
            JavaIdentifiers - Class in org.kiji.schema.util
            A utility class for dealing with identifiers in the Java language.
            +
            +

            +K

            +
            +
            key - +Variable in class org.kiji.schema.avro.KeyValueBackupEntry +
            Deprecated.  +
            KEY_DATA_VERSION - +Static variable in class org.kiji.schema.impl.HBaseSystemTable +
            The HBase row key that stores the installed Kiji data format version. +
            key_values - +Variable in class org.kiji.schema.avro.TableBackup +
            Deprecated.  +
            keys_format - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            keySet(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns a set view of keys contained in the map for the specified table. +
            keySet(String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns a set view of keys contained in the map for the specified table. +
            keySet(String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns a set view of keys contained in the map for the specified table. +
            KeyValueBackupEntry - Class in org.kiji.schema.avro
             
            KeyValueBackupEntry() - +Constructor for class org.kiji.schema.avro.KeyValueBackupEntry +
            Default constructor. +
            KeyValueBackupEntry(Long, String, ByteBuffer) - +Constructor for class org.kiji.schema.avro.KeyValueBackupEntry +
            All-args constructor. +
            KeyValueBackupEntry.Builder - Class in org.kiji.schema.avro
            RecordBuilder for KeyValueBackupEntry instances.
            keyValuesFromBackup(String, List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Restores all table's key value history from a backup. +
            keyValuesFromBackup(String, List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Restores all table's key value history from a backup. +
            keyValuesFromBackup(String, List<KeyValueBackupEntry>) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Restores all table's key value history from a backup. +
            keyValuesToBackup(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the TableKeyValueBackupEntries. +
            keyValuesToBackup(String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Gets a list of the TableKeyValueBackupEntries. +
            keyValuesToBackup(String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Gets a list of the TableKeyValueBackupEntries. +
            Kiji - Interface in org.kiji.schema
            Provides a handle to a Kiji instance that contains configuration and + table information.
            Kiji.Factory - Class in org.kiji.schema
            Provider for the default Kiji factory.
            KIJI_COMPONENT - +Static variable in class org.kiji.schema.KijiManagedHBaseTableName +
            The first component of all HBase table names managed by Kiji. +
            KIJI_SCHEME - +Static variable in class org.kiji.schema.KijiURI +
            URI/URL scheme used to fully qualify a Kiji table. +
            KIJI_SYSTEM_TABLES_REGEX - +Static variable in class org.kiji.schema.KijiManagedHBaseTableName +
            Regexp matching Kiji system tables. +
            KijiAdmin - Interface in org.kiji.schema
            Administration API for managing a Kiji instance.
            KijiAlreadyExistsException - Exception in org.kiji.schema
            Thrown when installing an instance or creating a table that already exists.
            KijiAlreadyExistsException(String, KijiURI) - +Constructor for exception org.kiji.schema.KijiAlreadyExistsException +
            Initializes a new exception object. +
            KijiCell<T> - Class in org.kiji.schema
            The data held in one cell of a kiji table.
            KijiCell(Schema, T) - +Constructor for class org.kiji.schema.KijiCell +
            Constructs a single cell of kiji data. +
            KijiCellDecoder<T> - Interface in org.kiji.schema
            Interface for Kiji cell decoders.
            KijiCellDecoderFactory - Interface in org.kiji.schema
            Interface for factories of KijiCellDecoder instances.
            KijiCellEncoder - Interface in org.kiji.schema
            Interface for Kiji cell encoders.
            KijiCellEncoderFactory - Interface in org.kiji.schema
            Interface for factories of KijiCellEncoder instances.
            KijiColumnFilter - Class in org.kiji.schema.filter
            A column filter provides a means of filtering cells from a column on the server side.
            KijiColumnFilter() - +Constructor for class org.kiji.schema.filter.KijiColumnFilter +
              +
            KijiColumnFilter.Context - Interface in org.kiji.schema.filter
            An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            KijiColumnName - Class in org.kiji.schema
            A Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiColumnName(String) - +Constructor for class org.kiji.schema.KijiColumnName +
            Constructs a column name from a string "family" or "family:qualifier". +
            KijiColumnName(String, String) - +Constructor for class org.kiji.schema.KijiColumnName +
            Constructs a column name from the two-part family:qualifier. +
            KijiColumnPager - Class in org.kiji.schema.impl
            Fetches new pages of column data in Kiji, and maintains state for which page each column is on.
            KijiColumnPager(EntityId, KijiDataRequest, KijiTableLayout, HTableInterface) - +Constructor for class org.kiji.schema.impl.KijiColumnPager +
            Creates a new KijiColumnPager. +
            KijiColumnPagingNotEnabledException - Exception in org.kiji.schema.impl
            Thrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column.
            KijiColumnPagingNotEnabledException(String) - +Constructor for exception org.kiji.schema.impl.KijiColumnPagingNotEnabledException +
            Creates a new KijiColumnPagingNotEnabledException with the specified + detail message. +
            KijiConfiguration - Class in org.kiji.schema
            Deprecated. 
            KijiConfiguration(Configuration, String) - +Constructor for class org.kiji.schema.KijiConfiguration +
            Deprecated. Constructs a handle to a Kiji instance. +
            KijiConfiguration(Configuration, KijiURI) - +Constructor for class org.kiji.schema.KijiConfiguration +
            Deprecated. Initializes a Kiji configuration from a Hadoop configuration and a Kiji URI. +
            KijiConfiguration(KijiConfiguration) - +Constructor for class org.kiji.schema.KijiConfiguration +
            Deprecated. Constructs a deep copy of an existing Kiji configuration. +
            KijiConfKeys - Class in org.kiji.schema.mapreduce
            Deprecated. 
            KijiCounter - Interface in org.kiji.schema
            Deprecated. KijiCounter will be merged into KijiCell.
            KijiDataBuffer<T> - Class in org.kiji.schema.impl
            A buffer used to hold data entries waiting to be written to a KijiTable.
            KijiDataBuffer() - +Constructor for class org.kiji.schema.impl.KijiDataBuffer +
            Creates an instance. +
            KijiDataRequest - Class in org.kiji.schema
            Describes a request for columns of data to read from a Kiji table.
            KijiDataRequest() - +Constructor for class org.kiji.schema.KijiDataRequest +
            Constructor. +
            KijiDataRequest(KijiDataRequest) - +Constructor for class org.kiji.schema.KijiDataRequest +
            Creates a new KijiDataRequest from a copy. +
            KijiDataRequest.Column - Class in org.kiji.schema
            Describes a request for a Kiji Table column.
            KijiDataRequest.Column(KijiColumnName) - +Constructor for class org.kiji.schema.KijiDataRequest.Column +
            Creates a new requested Column. +
            KijiDataRequest.Column(String) - +Constructor for class org.kiji.schema.KijiDataRequest.Column +
            Creates a new request for the latest version of the cells in family. +
            KijiDataRequest.Column(String, String) - +Constructor for class org.kiji.schema.KijiDataRequest.Column +
            Creates a new request for the latest version of the cell in family:key. +
            KijiDataRequest.Column(String, byte[]) - +Constructor for class org.kiji.schema.KijiDataRequest.Column +
            Creates a new request for the latest version of the cell in family:key. +
            KijiDataRequestException - Exception in org.kiji.schema
            Thrown when there is an error validating a KijiDataRequest against a Kiji table.
            KijiDataRequestException(String) - +Constructor for exception org.kiji.schema.KijiDataRequestException +
            Creates a new KijiDataRequestException with the specified detail message. +
            KijiDataRequestValidator - Class in org.kiji.schema
            This class validates a KijiDataRequest against the layout + of a Kiji table to make sure it contains all of the columns requested.
            KijiDataRequestValidator(KijiDataRequest) - +Constructor for class org.kiji.schema.KijiDataRequestValidator +
            Construct a validator for a data request. +
            KijiDeleter - Interface in org.kiji.schema
            Interface for performing deletes on a Kiji table.
            KijiEncodingException - Exception in org.kiji.schema
            Runtime exception thrown when encoding a cell's content fails.
            KijiEncodingException(String) - +Constructor for exception org.kiji.schema.KijiEncodingException +
            Initializes an encoding exception. +
            KijiEncodingException(String, Throwable) - +Constructor for exception org.kiji.schema.KijiEncodingException +
            Initializes an encoding exception. +
            KijiEncodingException(Throwable) - +Constructor for exception org.kiji.schema.KijiEncodingException +
            Initializes an encoding exception. +
            KijiFactory - Interface in org.kiji.schema
            Factory for Kiji instances.
            KijiIncrementer - Interface in org.kiji.schema
            Interface for performing increments on a Kiji table.
            KijiInstaller - Class in org.kiji.schema
            Installs or uninstalls Kiji instances from an HBase cluster.
            KijiInvalidNameException - Exception in org.kiji.schema
            Thrown when a Kiji instance or table layout name is invalid.
            KijiInvalidNameException(String) - +Constructor for exception org.kiji.schema.KijiInvalidNameException +
            Creates a new KijiInvalidNameException with the specified detail message. +
            KijiManagedHBaseTableName - Class in org.kiji.schema
            Multiple instances of Kiji can be installed on a single HBase + cluster.
            KijiMetaTable - Class in org.kiji.schema
            The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiMetaTable() - +Constructor for class org.kiji.schema.KijiMetaTable +
            Creates a new KijiMetaTable instance. +
            KijiNameValidator - Class in org.kiji.schema.util
            A utility class for validating layout names, + (including table names, locality group names, family names, and column names) + and Kiji instance names.
            KijiNotInstalledException - Exception in org.kiji.schema
            Thrown when attempting to open a non existing/not installed Kiji instance.
            KijiNotInstalledException(String, String) - +Constructor for exception org.kiji.schema.KijiNotInstalledException +
            Creates a new KijiNotInstalledException with the specified + detail message. +
            KijiPutter - Interface in org.kiji.schema
            Interface for performing puts on a Kiji table.
            KijiRowData - Interface in org.kiji.schema
            The input data for a single entity in Kiji.
            KijiRowFilter - Class in org.kiji.schema.filter
            The abstract base class for filters that exclude data from KijiRows.
            KijiRowFilter() - +Constructor for class org.kiji.schema.filter.KijiRowFilter +
              +
            KijiRowFilter.Context - Class in org.kiji.schema.filter
            A helper class for converting between Kiji objects and their HBase counterparts.
            KijiRowFilter.Context() - +Constructor for class org.kiji.schema.filter.KijiRowFilter.Context +
              +
            KijiRowFilterApplicator - Class in org.kiji.schema.filter
            Applies a KijiRowFilter to various row-savvy objects.
            KijiRowFilterApplicator(KijiRowFilter, KijiTableLayout, KijiSchemaTable) - +Constructor for class org.kiji.schema.filter.KijiRowFilterApplicator +
            Creates a new KijiRowFilterApplicator instance. +
            KijiRowKeySplitter - Class in org.kiji.schema
            Utility class for splitting the Kiji row key space.
            KijiRowScanner - Interface in org.kiji.schema
            Interface for scanning over rows read from a Kiji table.
            KijiSchemaTable - Class in org.kiji.schema
            The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSchemaTable() - +Constructor for class org.kiji.schema.KijiSchemaTable +
              +
            KijiSchemaTable.SchemaEntry - Class in org.kiji.schema
            Association between a schema and its ID.
            KijiSchemaTable.SchemaEntry(long, BytesKey, Schema) - +Constructor for class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            Creates a new schema entry. +
            KijiSystemTable - Class in org.kiji.schema
            The Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiSystemTable() - +Constructor for class org.kiji.schema.KijiSystemTable +
              +
            KijiTable - Interface in org.kiji.schema
            Interface for Kiji Tables.
            KijiTableFactory - Interface in org.kiji.schema
            Factory for KijiTable instances.
            KijiTableInputFormat - Class in org.kiji.schema.mapreduce
            Deprecated. 
            KijiTableInputFormat() - +Constructor for class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.   +
            KijiTableInputFormat.KijiTableRecordReader - Class in org.kiji.schema.mapreduce
            Deprecated. Hadoop record reader for Kiji table rows.
            KijiTableInputFormat.KijiTableRecordReader(Configuration) - +Constructor for class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated. Creates a new RecordReader for this input format. +
            KijiTableKeyValueDatabase - Interface in org.kiji.schema
            A database of per table key-value pairs.
            KijiTableLayout - Class in org.kiji.schema.layout
            Layout of a Kiji table.
            KijiTableLayout(TableLayoutDesc, KijiTableLayout) - +Constructor for class org.kiji.schema.layout.KijiTableLayout +
            Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout. +
            KijiTableLayout.LocalityGroupLayout - Class in org.kiji.schema.layout
            Concrete layout of a locality group.
            KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc, KijiTableLayout.LocalityGroupLayout) - +Constructor for class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
            Constructs a locality group layout. +
            KijiTableLayout.LocalityGroupLayout.FamilyLayout - Class in org.kiji.schema.layout
            Concrete layout of a family.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc, KijiTableLayout.LocalityGroupLayout.FamilyLayout) - +Constructor for class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
            Builds a new family layout instance. +
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout - Class in org.kiji.schema.layout
            Concrete layout of a column.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc, KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout) - +Constructor for class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
            Builds a new column layout instance from a descriptor. +
            KijiTableLayoutDatabase - Interface in org.kiji.schema.layout
            A database of Kiji table layouts.
            KijiTableLayoutRecords - Interface in org.kiji.schema.avro
             
            KijiTableLayoutRecords.Callback - Interface in org.kiji.schema.avro
             
            KijiTableNotFoundException - Exception in org.kiji.schema
            Thrown when an attempt to access a table fails because it does not exist.
            KijiTableNotFoundException(String) - +Constructor for exception org.kiji.schema.KijiTableNotFoundException +
            Creates a new KijiTableNotFoundException for the specified table. +
            KijiTablePool - Class in org.kiji.schema
            Maintains a pool of opened KijiTables.
            KijiTablePool(Kiji) - +Constructor for class org.kiji.schema.KijiTablePool +
            Constructs a new pool of Kiji tables. +
            KijiTablePool(KijiTableFactory) - +Constructor for class org.kiji.schema.KijiTablePool +
            Constructs a new pool of Kiji tables. +
            KijiTablePool(KijiTableFactory, KijiTablePool.Options) - +Constructor for class org.kiji.schema.KijiTablePool +
            Constructs a new pool of Kiji tables. +
            KijiTablePool.NoCapacityException - Exception in org.kiji.schema
            Thrown when an attempt to get a table connection fails because there is no room in the pool.
            KijiTablePool.NoCapacityException(String) - +Constructor for exception org.kiji.schema.KijiTablePool.NoCapacityException +
            Creates a new NoCapacityException with the specified detail message. +
            KijiTablePool.Options - Class in org.kiji.schema
            Describes the options that can be configured on the KijiTablePool.
            KijiTablePool.Options() - +Constructor for class org.kiji.schema.KijiTablePool.Options +
            Creates options with default values. +
            KijiTableReader - Interface in org.kiji.schema
            Interface for reading data from a kiji table.
            KijiTableReader.KijiScannerOptions - Class in org.kiji.schema
            Options for KijiRowScanners.
            KijiTableReader.KijiScannerOptions() - +Constructor for class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Creates KijiScannerOptions with uninitialized options + and default HBaseScanOptions. +
            KijiTableWriter - Interface in org.kiji.schema
            Interface for modifying a Kiji table.
            KijiTool - Interface in org.kiji.schema.tools
            Base interface to be implemented by command-line tools that are launched through + the bin/kiji script.
            KijiToolLauncher - Class in org.kiji.schema.tools
            Main entry point to launch Kiji tools.
            KijiToolLauncher() - +Constructor for class org.kiji.schema.tools.KijiToolLauncher +
              +
            KijiURI - Class in org.kiji.schema
            URI that fully qualifies a Kiji instance/table/column.
            KijiURI(URI) - +Constructor for class org.kiji.schema.KijiURI +
            Constructs a URI that fully qualifies a Kiji table. +
            KijiURI(Iterable<String>, int, String, String, Iterable<KijiColumnName>) - +Constructor for class org.kiji.schema.KijiURI +
            Constructs a new KijiURI with the given parameters. +
            KijiURIException - Exception in org.kiji.schema
            Thrown when parsing a bogus Kiji URI.
            KijiURIException(String) - +Constructor for exception org.kiji.schema.KijiURIException +
            Creates a new KijiURIException. +
            KijiURIException(String, String) - +Constructor for exception org.kiji.schema.KijiURIException +
            Creates a new KijiURIException for the specified uri and detail message. +
            +
            +

            +L

            +
            +
            layout - +Variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Deprecated.  +
            layout_id - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            layout_version - +Variable in class org.kiji.schema.avro.MetadataBackup +
            Deprecated.  +
            layouts - +Variable in class org.kiji.schema.avro.TableBackup +
            Deprecated.  +
            layoutsFromBackup(String, List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
              +
            layoutsFromBackup(String, List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Restores a table layout history from a backup. +
            layoutsFromBackup(String, List<TableLayoutBackupEntry>) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Restores a table layout history from a backup. +
            layoutsToBackup(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +
            layoutsToBackup(String) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +
            layoutsToBackup(String) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +
            LayoutTool - Class in org.kiji.schema.tools
            Command-line tool for interacting with table layouts.
            LayoutTool() - +Constructor for class org.kiji.schema.tools.LayoutTool +
              +
            listTables() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Lists the tables in this Kiji instance. +
            listTables() - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Lists the tables in this Kiji instance. +
            listTables() - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Lists the tables in this Kiji instance. +
            load(String) - +Method in class org.kiji.schema.tools.synth.DictionaryLoader +
            Loads the dictionary from a file. +
            load(InputStream) - +Method in class org.kiji.schema.tools.synth.DictionaryLoader +
            Loads the dictionary from an input stream. +
            loadDefaults(String) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Load the system table with the key/value pairs from the properties file named by resource. +
            locality_groups - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            LocalityGroupDesc - Class in org.kiji.schema.avro
             
            LocalityGroupDesc() - +Constructor for class org.kiji.schema.avro.LocalityGroupDesc +
            Default constructor. +
            LocalityGroupDesc(Integer, String, List<String>, Boolean, String, Boolean, Integer, Integer, CompressionType, List<FamilyDesc>, Boolean, String) - +Constructor for class org.kiji.schema.avro.LocalityGroupDesc +
            All-args constructor. +
            LocalityGroupDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for LocalityGroupDesc instances.
            Lock - Interface in org.kiji.schema.util
            Lock interface.
            lock() - +Method in interface org.kiji.schema.util.Lock +
            Unconditionally acquires the lock. +
            lock(double) - +Method in interface org.kiji.schema.util.Lock +
            Acquires the lock. +
            lock() - +Method in class org.kiji.schema.util.ZooKeeperLock +
            Unconditionally acquires the lock. +
            lock(double) - +Method in class org.kiji.schema.util.ZooKeeperLock +
            Acquires the lock. +
            LockFactory - Interface in org.kiji.schema.util
            Factory for Lock instances.
            LOG - +Static variable in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
              +
            longToVarInt64(long) - +Static method in class org.kiji.schema.util.ByteStreamArray +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +
            longToZigZagVarInt64(long) - +Static method in class org.kiji.schema.util.ByteStreamArray +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +
            LsTool - Class in org.kiji.schema.tools
            Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            LsTool() - +Constructor for class org.kiji.schema.tools.LsTool +
              +
            +
            +

            +M

            +
            +
            main(String[]) - +Static method in class org.kiji.schema.tools.CreateTableTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.DeleteTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.FlushTableTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.IncrementTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.InstallTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.KijiToolLauncher +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.LayoutTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.LsTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.MetadataTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.PutTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.UninstallTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.VersionTool +
            Program entry point. +
            makeEmptyTableDescriptor(KijiManagedHBaseTableName) - +Static method in class org.kiji.schema.impl.HTableDescriptorComparator +
            Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout(). +
            map_schema - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            max_versions - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            mConf - +Variable in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated. Hadoop Configuration object containing settings. +
            MD5Hash - Class in org.kiji.schema.avro
             
            MD5Hash() - +Constructor for class org.kiji.schema.avro.MD5Hash +
            Creates a new MD5Hash +
            MD5Hash(byte[]) - +Constructor for class org.kiji.schema.avro.MD5Hash +
            Creates a new MD5Hash with the given bytes +
            mDataRequest - +Variable in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated. Data request. +
            merge(HBaseKijiRowData) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Merges in the data from another HBaseKijiRowData instance. +
            merge(Put) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Merges in the data an HBase Put object. +
            merge(Collection<KeyValue>) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Merges in the data from a collection of KeyValues. +
            merge(KijiDataRequest) - +Method in class org.kiji.schema.KijiDataRequest +
            Merges the requested columns in other into this data request. +
            meta_table - +Variable in class org.kiji.schema.avro.MetadataBackup +
            Deprecated.  +
            MetadataBackup - Class in org.kiji.schema.avro
             
            MetadataBackup() - +Constructor for class org.kiji.schema.avro.MetadataBackup +
            Default constructor. +
            MetadataBackup(String, List<SchemaTableEntry>, Map<String, TableBackup>) - +Constructor for class org.kiji.schema.avro.MetadataBackup +
            All-args constructor. +
            MetadataBackup.Builder - Class in org.kiji.schema.avro
            RecordBuilder for MetadataBackup instances.
            MetadataRestorer - Class in org.kiji.schema.impl
            Metadata restorer backups up meta info to MetadataBackup records and can restore metadata to the + meta and schema tables.
            MetadataRestorer() - +Constructor for class org.kiji.schema.impl.MetadataRestorer +
              +
            MetadataTool - Class in org.kiji.schema.tools
            A tool to backup and restore Metadata.
            MetadataTool() - +Constructor for class org.kiji.schema.tools.MetadataTool +
              +
            +
            +

            +N

            +
            +
            name - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.TableBackup +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            newBuilder() - +Static method in class org.kiji.schema.avro.CellSchema +
            Creates a new CellSchema RecordBuilder +
            newBuilder(CellSchema.Builder) - +Static method in class org.kiji.schema.avro.CellSchema +
            Creates a new CellSchema RecordBuilder by copying an existing Builder +
            newBuilder(CellSchema) - +Static method in class org.kiji.schema.avro.CellSchema +
            Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder +
            newBuilder(ColumnDesc.Builder) - +Static method in class org.kiji.schema.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder by copying an existing Builder +
            newBuilder(ColumnDesc) - +Static method in class org.kiji.schema.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder +
            newBuilder(FamilyDesc.Builder) - +Static method in class org.kiji.schema.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder by copying an existing Builder +
            newBuilder(FamilyDesc) - +Static method in class org.kiji.schema.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Creates a new KeyValueBackupEntry RecordBuilder +
            newBuilder(KeyValueBackupEntry.Builder) - +Static method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder +
            newBuilder(KeyValueBackupEntry) - +Static method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.LocalityGroupDesc +
            Creates a new LocalityGroupDesc RecordBuilder +
            newBuilder(LocalityGroupDesc.Builder) - +Static method in class org.kiji.schema.avro.LocalityGroupDesc +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder +
            newBuilder(LocalityGroupDesc) - +Static method in class org.kiji.schema.avro.LocalityGroupDesc +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.MetadataBackup +
            Creates a new MetadataBackup RecordBuilder +
            newBuilder(MetadataBackup.Builder) - +Static method in class org.kiji.schema.avro.MetadataBackup +
            Creates a new MetadataBackup RecordBuilder by copying an existing Builder +
            newBuilder(MetadataBackup) - +Static method in class org.kiji.schema.avro.MetadataBackup +
            Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.RowKeyFormat +
            Creates a new RowKeyFormat RecordBuilder +
            newBuilder(RowKeyFormat.Builder) - +Static method in class org.kiji.schema.avro.RowKeyFormat +
            Creates a new RowKeyFormat RecordBuilder by copying an existing Builder +
            newBuilder(RowKeyFormat) - +Static method in class org.kiji.schema.avro.RowKeyFormat +
            Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.SchemaTableEntry +
            Creates a new SchemaTableEntry RecordBuilder +
            newBuilder(SchemaTableEntry.Builder) - +Static method in class org.kiji.schema.avro.SchemaTableEntry +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder +
            newBuilder(SchemaTableEntry) - +Static method in class org.kiji.schema.avro.SchemaTableEntry +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.TableBackup +
            Creates a new TableBackup RecordBuilder +
            newBuilder(TableBackup.Builder) - +Static method in class org.kiji.schema.avro.TableBackup +
            Creates a new TableBackup RecordBuilder by copying an existing Builder +
            newBuilder(TableBackup) - +Static method in class org.kiji.schema.avro.TableBackup +
            Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Creates a new TableLayoutBackupEntry RecordBuilder +
            newBuilder(TableLayoutBackupEntry.Builder) - +Static method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder +
            newBuilder(TableLayoutBackupEntry) - +Static method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.TableLayoutDesc +
            Creates a new TableLayoutDesc RecordBuilder +
            newBuilder(TableLayoutDesc.Builder) - +Static method in class org.kiji.schema.avro.TableLayoutDesc +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder +
            newBuilder(TableLayoutDesc) - +Static method in class org.kiji.schema.avro.TableLayoutDesc +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance +
            newCounter() - +Static method in class org.kiji.schema.layout.impl.CellSpec +
              +
            newLock(KijiConfiguration, LockFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates a lock for a given Kiji instance. +
            newMetaTable(KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseMetaTable +
            Creates an HTableInterface for the specified table. +
            newSchemaHashTable(KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates an HTable handle to the schema hash table. +
            newSchemaIdTable(KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates an HTable handle to the schema ID table. +
            newSchemaV5Table(KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates an HTable handle to the schema V5 table. +
            newSystemTable(KijiConfiguration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSystemTable +
            Creates a new HTableInterface for the Kiji system table. +
            newZooKeeper(Configuration) - +Static method in class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a ZooKeeper client. +
            nextKeyValue() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            nextPage(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Populates the next page of cells for a column. +
            nextPage(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Populates the next page of cells for a requested column family. +
            nextPage(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Populates the next page of cells for a column. +
            nextPage(String) - +Method in interface org.kiji.schema.KijiRowData +
            Populates the next page of cells for a requested column family. +
            NGramSynthesizer - Class in org.kiji.schema.tools.synth
            Generates n-grams.
            NGramSynthesizer(WordSynthesizer, int) - +Constructor for class org.kiji.schema.tools.synth.NGramSynthesizer +
            Constructs a new n-gram synthesizer. +
            NoCellDataException - Exception in org.kiji.schema
            Thrown when attempting to read data from a cell that doesn't exist.
            NoCellDataException(String) - +Constructor for exception org.kiji.schema.NoCellDataException +
            Creates a new NoCellDataException with the specified detail message. +
            NoSuchColumnException - Exception in org.kiji.schema
            Thrown when attempting to access a column that does not exist.
            NoSuchColumnException(String) - +Constructor for exception org.kiji.schema.NoSuchColumnException +
            Creates a new NoSuchColumnException with the specified detail message. +
            NotAKijiManagedTableException - Exception in org.kiji.schema
            Thrown when Kiji encounters an HBase table that is not managed by Kiji.
            NotAKijiManagedTableException(String, String) - +Constructor for exception org.kiji.schema.NotAKijiManagedTableException +
            Creates a new NotAKijiManagedTableException for the specified + table with the specified detail message. +
            NumberParser - Class in org.kiji.schema.util
            Utility for parsing strings to numbers.
            +
            +

            +O

            +
            +
            open(KijiURI) - +Method in class org.kiji.schema.impl.HBaseKijiFactory +
            Opens a Kiji instance by URI. +
            open(KijiURI, Configuration) - +Method in class org.kiji.schema.impl.HBaseKijiFactory +
            Opens a Kiji instance by URI. +
            open(KijiConfiguration) - +Method in class org.kiji.schema.impl.HBaseKijiFactory +
            Opens a Kiji instance. +
            open(KijiURI) - +Static method in class org.kiji.schema.Kiji.Factory +
            Opens a Kiji instance by URI. +
            open(KijiURI, Configuration) - +Static method in class org.kiji.schema.Kiji.Factory +
            Opens a Kiji instance by URI. +
            open(KijiConfiguration) - +Static method in class org.kiji.schema.Kiji.Factory +
            Deprecated.  +
            open(KijiURI) - +Method in interface org.kiji.schema.KijiFactory +
            Opens a Kiji instance by URI. +
            open(KijiURI, Configuration) - +Method in interface org.kiji.schema.KijiFactory +
            Opens a Kiji instance by URI. +
            open(KijiConfiguration) - +Method in interface org.kiji.schema.KijiFactory +
            Deprecated.  +
            openKiji() - +Method in class org.kiji.schema.tools.VersionValidatedTool +
            Opens a kiji instance. +
            openSystemResource(String) - +Static method in class org.kiji.schema.util.Resources +
            Gets the named resource using the classloader, or null if it can not be found. +
            openSystemTextResource(String) - +Static method in class org.kiji.schema.util.Resources +
            Gets the named resource using the classloader, or null if it can not be found. +
            openTable(String) - +Method in class org.kiji.schema.impl.DefaultKijiTableFactory +
            Opens a KijiTable by name. +
            openTable(String) - +Method in class org.kiji.schema.impl.HBaseKiji +
            Opens a KijiTable by name. +
            openTable(String) - +Method in interface org.kiji.schema.KijiTableFactory +
            Opens a KijiTable by name. +
            openTableReader() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            Opens an appropriate implementation of KijiTableReader for this table. +
            openTableReader() - +Method in interface org.kiji.schema.KijiTable +
            Opens an appropriate implementation of KijiTableReader for this table. +
            openTableWriter() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            Opens an appropriate implementation of KijiTableWriter for this table. +
            openTableWriter() - +Method in interface org.kiji.schema.KijiTable +
            Opens an appropriate implementation of KijiTableWriter for this table. +
            OperatorRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter for a logical operator of composed of other filters.
            OperatorRowFilter.Operator - Enum in org.kiji.schema.filter
            Available logical operators.
            org.apache.hadoop.hbase.mapreduce - package org.apache.hadoop.hbase.mapreduce
             
            org.kiji.schema - package org.kiji.schema
            The main package for users of KijiSchema.
            org.kiji.schema.avro - package org.kiji.schema.avro
             
            org.kiji.schema.filter - package org.kiji.schema.filter
            Row level filters used when reading data from Kiji tables.
            org.kiji.schema.impl - package org.kiji.schema.impl
            Implementations for the main KijiSchema classes and interfaces.
            org.kiji.schema.layout - package org.kiji.schema.layout
            Kiji table layouts.
            org.kiji.schema.layout.impl - package org.kiji.schema.layout.impl
            Implementation for Kiji table layout management.
            org.kiji.schema.mapreduce - package org.kiji.schema.mapreduce
            Kiji map-reduce utilities.
            org.kiji.schema.tools - package org.kiji.schema.tools
            Package containing implementations, abstract base classes, + and exceptions for kiji command-line tools.
            org.kiji.schema.tools.synth - package org.kiji.schema.tools.synth
            Classes to assist when synthesizing sample data for use in kiji tables.
            org.kiji.schema.util - package org.kiji.schema.util
            Package containing utility classes used throughout Kiji.
            OrRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter for a disjunction (OR operator) of other filters.
            OrRowFilter(List<? extends KijiRowFilter>) - +Constructor for class org.kiji.schema.filter.OrRowFilter +
            Creates a new OrRowFilter instance. +
            OUTPUT_KIJI_TABLE_URI - +Static variable in class org.kiji.schema.mapreduce.KijiConfKeys +
            Deprecated. URI of the output Kiji table to write to. +
            +
            +

            +P

            +
            +
            parse(String) - +Static method in class org.kiji.schema.KijiURI +
            Constructs a fully qualified Kiji table URI from a string. +
            parseHex(String, char) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Parses a string hexadecimal representation of a byte array with separator. +
            parseHex(String) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Parses a string hexadecimal representation of a byte array. +
            parseInstanceName(String) - +Static method in class org.kiji.schema.tools.LsTool +
            Parses a table name for a kiji instance name. +
            parseInt(String) - +Static method in class org.kiji.schema.util.NumberParser +
            This parseInt allows Integer.MAX_VALUE to be written as a convenient string. +
            parseLong(String) - +Static method in class org.kiji.schema.util.NumberParser +
            This parseLong allows Long.MAX_VALUE to be written as a convenient string. +
            parseRowKeyFlag(String) - +Static method in class org.kiji.schema.tools.ToolUtils +
            Parses a flag describing a row key. +
            PRE_REGISTERED_SCHEMA_COUNT - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            Number of pre-allocated schemas. +
            printInt(int) - +Static method in class org.kiji.schema.util.NumberParser +
            Converts an integer to a string that uses "infinity" as Integer.MAX_VALUE. +
            PROTOCOL - +Static variable in interface org.kiji.schema.avro.KijiTableLayoutRecords.Callback +
              +
            PROTOCOL - +Static variable in interface org.kiji.schema.avro.KijiTableLayoutRecords +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.CellSchema +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.ColumnDesc +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.FamilyDesc +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.MetadataBackup +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.RowKeyFormat +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.TableBackup +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
              +
            put(EntityId, String, String, T) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Puts data into a kiji table. +
            put(EntityId, String, String, long, T) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Puts data into a kiji table. +
            put(EntityId, String, String, T) - +Method in interface org.kiji.schema.KijiPutter +
            Puts data into a kiji table. +
            put(EntityId, String, String, long, T) - +Method in interface org.kiji.schema.KijiPutter +
            Puts data into a kiji table. +
            PutTool - Class in org.kiji.schema.tools
            Command-line tool for putting an Avro value into a kiji cell.
            PutTool() - +Constructor for class org.kiji.schema.tools.PutTool +
              +
            putValue(String, String, byte[]) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +
            putValue(String, byte[]) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Sets a value for a property key, which creates it if it doesn't exist. +
            putValue(String, String, byte[]) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +
            putValue(String, byte[]) - +Method in class org.kiji.schema.KijiSystemTable +
            Sets a value for a property key, which creates it if it doesn't exist. +
            putValue(String, String, byte[]) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +
            +
            +

            +Q

            +
            +
            QUALIFIER_LAYOUT - +Static variable in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            HBase column qualifier used to store absolute layouts. +
            QUALIFIER_LAYOUT_ID - +Static variable in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            HBase column qualifier used to store layout IDs. +
            QUALIFIER_UPDATE - +Static variable in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            HBase column qualifier used to store layout updates. +
            +
            +

            +R

            +
            +
            RADIX - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The size of the alphabet for a digit, which is the radix of our printed number. +
            RawEntityId - Class in org.kiji.schema.impl
            Implements the raw row key format.
            RawEntityId(byte[]) - +Constructor for class org.kiji.schema.impl.RawEntityId +
            Creates a raw entity ID. +
            RE_AUTHORITY_GROUP - +Static variable in class org.kiji.schema.KijiURI +
            Pattern matching "(host1,host2,host3):port". +
            readAvroSchema(CellSchema) - +Static method in class org.kiji.schema.layout.impl.CellSpec +
            Reads the Avro schema from the table layout. +
            readAvroSchema(CellSchema) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Reads the Avro schema from the table layout. +
            readBytes(int) - +Method in class org.kiji.schema.util.ByteStreamArray +
            Reads the specified number of bytes in the stream. +
            readInputTableLayout(Configuration) - +Static method in class org.kiji.schema.layout.TableLayoutSerializer +
            Reads an input table layout from the configuration. +
            readOutputTableLayout(Configuration) - +Static method in class org.kiji.schema.layout.TableLayoutSerializer +
            Reads an output table layout from the configuration. +
            readTableLayout(String, Configuration) - +Static method in class org.kiji.schema.layout.TableLayoutSerializer +
            Reads a table layout from the configuration. +
            readTableLayoutDescFromJSON(InputStream) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Reads a table layout descriptor from its JSON serialized form. +
            readVarInt64() - +Method in class org.kiji.schema.util.ByteStreamArray +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +
            readZigZagVarInt64() - +Method in class org.kiji.schema.util.ByteStreamArray +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +
            reference_layout - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            ReferenceCountable<T> - Interface in org.kiji.schema.util
            Interface for reference-countable resources.
            ReferenceCountableUtils - Class in org.kiji.schema.util
            Utilities to work with ReferenceCountable resources.
            RegexQualifierColumnFilter - Class in org.kiji.schema.filter
            A KijiColumnFilter that only allows qualifiers that match a given regular expression.
            RegexQualifierColumnFilter(String) - +Constructor for class org.kiji.schema.filter.RegexQualifierColumnFilter +
            Constructor. +
            release() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Notifies this resource that we are no longer interested in it. +
            release(KijiTable) - +Method in class org.kiji.schema.KijiTablePool +
            Releases a table back to the pool. +
            release() - +Method in interface org.kiji.schema.util.ReferenceCountable +
            Notifies this resource that we are no longer interested in it. +
            releaseQuietly(ReferenceCountable<T>) - +Static method in class org.kiji.schema.util.ReferenceCountableUtils +
            Releases a given resource, logging and swallowing I/O errors if needed. +
            removeAllTableLayoutVersions(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes all layout information for a particular table. +
            removeAllTableLayoutVersions(String) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Removes all layout information for a particular table. +
            removeAllTableLayoutVersions(String) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Removes all layout information for a particular table. +
            removeAllValues(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Deletes all key-value pairs associated with the specified table. +
            removeAllValues(String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Deletes all key-value pairs associated with the specified table. +
            removeAllValues(String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Deletes all key-value pairs associated with the specified table. +
            removeRecentTableLayoutVersions(String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes the most recent layout information for a given table. +
            removeRecentTableLayoutVersions(String, int) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Removes the most recent layout information for a given table. +
            removeRecentTableLayoutVersions(String, int) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Removes the most recent layout information for a given table. +
            removeValues(String, String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes all values associated with the specified table and key. +
            removeValues(String, String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Removes all values associated with the specified table and key. +
            removeValues(String, String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Removes all values associated with the specified table and key. +
            renamed_from - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            renamed_from - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            renamed_from - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            RequiredFlagException - Exception in org.kiji.schema.tools
            Thrown to indicate that a flag is required but not supplied.
            RequiredFlagException(String) - +Constructor for exception org.kiji.schema.tools.RequiredFlagException +
            Creates a new RequiredFlagException for the specified flag name. +
            resolve(String) - +Method in class org.kiji.schema.KijiURI +
            Resolve the path relative to this KijiURI. +
            Resources - Class in org.kiji.schema.util
            Utility for getting access to system resources.
            restoreSchemas(MetadataBackup, Kiji) - +Method in class org.kiji.schema.impl.MetadataRestorer +
            Restores all SchemaTable entries from the metadata backup. +
            restoreTables(MetadataBackup, Kiji) - +Method in class org.kiji.schema.impl.MetadataRestorer +
            Restores all tables from the metadata backup into the running Kiji instance. +
            retain() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Expresses interest in retaining this resource. +
            retain() - +Method in interface org.kiji.schema.util.ReferenceCountable +
            Expresses interest in retaining this resource. +
            RowKeyEncoding - Enum in org.kiji.schema.avro
             
            RowKeyFormat - Class in org.kiji.schema.avro
             
            RowKeyFormat() - +Constructor for class org.kiji.schema.avro.RowKeyFormat +
            Default constructor. +
            RowKeyFormat(RowKeyEncoding, HashType, Integer) - +Constructor for class org.kiji.schema.avro.RowKeyFormat +
            All-args constructor. +
            RowKeyFormat.Builder - Class in org.kiji.schema.avro
            RecordBuilder for RowKeyFormat instances.
            run(List<String>) - +Method in class org.kiji.schema.tools.BaseTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.CreateTableTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.DeleteTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.FlushTableTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.IncrementTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.InstallTool +
            Runs the tool. +
            run(String[]) - +Method in class org.kiji.schema.tools.KijiToolLauncher +
            Programmatic entry point to the tool launcher. +
            run(KijiTool, String[]) - +Method in class org.kiji.schema.tools.KijiToolLauncher +
            Programmatic entry point to the tool launcher if a tool is already selected. +
            run(List<String>) - +Method in class org.kiji.schema.tools.LayoutTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.LsTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.MetadataTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.PutTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.UninstallTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.VersionTool +
            Runs the tool. +
            +
            +

            +S

            +
            +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.CellSchema +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.ColumnDesc +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.CompressionType +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.FamilyDesc +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.HashType +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.MD5Hash +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.MetadataBackup +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.RowKeyEncoding +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.RowKeyFormat +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.SchemaStorage +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.SchemaTableEntry +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.SchemaType +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.TableBackup +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.TableLayoutDesc +
              +
            SCHEMA_COLUMN_FAMILY - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            The column family in HBase used to store schema entries. +
            SCHEMA_COLUMN_QUALIFIER - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            The column qualifier in HBase used to store schema entries. +
            SCHEMA_COUNTER_ROW_NAME - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            Schema IDs are generated using a counter. +
            schema_table - +Variable in class org.kiji.schema.avro.MetadataBackup +
            Deprecated.  +
            SchemaClassNotFoundException - Exception in org.kiji.schema.layout
            Thrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path).
            SchemaClassNotFoundException(String) - +Constructor for exception org.kiji.schema.layout.SchemaClassNotFoundException +
            Creates a new SchemaClassNotFoundException with the specified detail message.. +
            SchemaStorage - Enum in org.kiji.schema.avro
             
            SchemaTableEntry - Class in org.kiji.schema.avro
             
            SchemaTableEntry() - +Constructor for class org.kiji.schema.avro.SchemaTableEntry +
            Default constructor. +
            SchemaTableEntry(Long, MD5Hash, String) - +Constructor for class org.kiji.schema.avro.SchemaTableEntry +
            All-args constructor. +
            SchemaTableEntry.Builder - Class in org.kiji.schema.avro
            RecordBuilder for SchemaTableEntry instances.
            SchemaType - Enum in org.kiji.schema.avro
             
            SEPARATOR - +Static variable in class org.kiji.schema.layout.ColumnNameTranslator +
            Used to separate the Kiji family from the Kiji qualifier in an HBase qualifier. +
            serializeInputTableLayout(KijiTableLayout, Configuration) - +Static method in class org.kiji.schema.layout.TableLayoutSerializer +
            Serializes the table layout into a configuration object for input. +
            serializeOutputTableLayout(KijiTableLayout, Configuration) - +Static method in class org.kiji.schema.layout.TableLayoutSerializer +
            Serializes the table layout into a configuration object for output. +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'aliases' field +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'aliases' field. +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'aliases' field +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'aliases' field. +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'aliases' field +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'aliases' field. +
            setAvroSchema(String) - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Sets the value of the 'avro_schema' field +
            setAvroSchema(String) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Sets the value of the 'avro_schema' field. +
            setCacheBlocks(Boolean) - +Method in class org.kiji.schema.HBaseScanOptions +
            Sets whether rows requested are cached server-side for future use. +
            setCellSchema(CellSchema) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the cell schema. +
            setClientBufferSize(Integer) - +Method in class org.kiji.schema.HBaseScanOptions +
            Sets the number of rows that will be returned with each RPC when iterating + through a KijiRowScanner. +
            setColumnNames(Collection<String>) - +Method in class org.kiji.schema.KijiURI +
            Creates a KijiURI with these column names added. +
            setColumns(List<ColumnDesc>) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'columns' field +
            setColumns(List<ColumnDesc>) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'columns' field. +
            setColumnSchema(CellSchema) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'column_schema' field +
            setColumnSchema(CellSchema) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'column_schema' field. +
            setCompressionType(CompressionType) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'compression_type' field +
            setCompressionType(CompressionType) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'compression_type' field. +
            setConf(Configuration) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            setDataVersion(String) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Sets the version of kiji installed. +
            setDataVersion(String) - +Method in class org.kiji.schema.KijiSystemTable +
            Sets the version of kiji installed. +
            setDelete(boolean) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'delete' field +
            setDelete(Boolean) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'delete' field. +
            setDelete(boolean) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'delete' field +
            setDelete(Boolean) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'delete' field. +
            setDelete(boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'delete' field +
            setDelete(Boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'delete' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'description' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'description' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'description' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'description' field. +
            setEnabled(boolean) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'enabled' field +
            setEnabled(Boolean) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'enabled' field. +
            setEnabled(boolean) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'enabled' field +
            setEnabled(Boolean) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'enabled' field. +
            setEnabled(boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'enabled' field +
            setEnabled(Boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'enabled' field. +
            setEncoding(RowKeyEncoding) - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Sets the value of the 'encoding' field +
            setEncoding(RowKeyEncoding) - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Sets the value of the 'encoding' field. +
            setFamilies(List<FamilyDesc>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'families' field +
            setFamilies(List<FamilyDesc>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'families' field. +
            setHash(MD5Hash) - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Sets the value of the 'hash' field +
            setHash(MD5Hash) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Sets the value of the 'hash' field. +
            setHashSize(int) - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Sets the value of the 'hash_size' field +
            setHashSize(Integer) - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Sets the value of the 'hash_size' field. +
            setHashType(HashType) - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Sets the value of the 'hash_type' field +
            setHashType(HashType) - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Sets the value of the 'hash_type' field. +
            setHBaseScanOptions(HBaseScanOptions) - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Sets the HBaseScanOptions used by a HBase backed scanner. +
            setId(int) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'id' field +
            setId(Integer) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'id' field. +
            setId(int) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'id' field +
            setId(Integer) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'id' field. +
            setId(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'id' field +
            setId(Integer) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'id' field. +
            setId(long) - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Sets the value of the 'id' field +
            setId(Long) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Sets the value of the 'id' field. +
            setInMemory(boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'in_memory' field +
            setInMemory(Boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'in_memory' field. +
            setInstanceName(String) - +Method in class org.kiji.schema.KijiURI +
            Creates a new KijiURI with this instance name added. +
            setKey(String) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Sets the value of the 'key' field +
            setKey(String) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Sets the value of the 'key' field. +
            setKeysFormat(RowKeyFormat) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'keys_format' field +
            setKeysFormat(RowKeyFormat) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'keys_format' field. +
            setKeyValues(List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Sets the value of the 'key_values' field +
            setKeyValues(List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup +
            Sets the value of the 'key_values' field. +
            setKijiRowFilter(KijiRowFilter) - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Sets the row filter used by the scanner, + and returns this KijiScannerOptions to allow chaining. +
            setLayout(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Sets the value of the 'layout' field +
            setLayout(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Sets the value of the 'layout' field. +
            setLayoutId(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'layout_id' field +
            setLayoutId(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'layout_id' field. +
            setLayouts(List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Sets the value of the 'layouts' field +
            setLayouts(List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup +
            Sets the value of the 'layouts' field. +
            setLayoutVersion(String) - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Sets the value of the 'layout_version' field +
            setLayoutVersion(String) - +Method in class org.kiji.schema.avro.MetadataBackup +
            Sets the value of the 'layout_version' field. +
            setLocalityGroups(List<LocalityGroupDesc>) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'locality_groups' field +
            setLocalityGroups(List<LocalityGroupDesc>) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'locality_groups' field. +
            setMapSchema(CellSchema) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'map_schema' field +
            setMapSchema(CellSchema) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'map_schema' field. +
            setMaxVersions(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'max_versions' field +
            setMaxVersions(Integer) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'max_versions' field. +
            setMetaTable(Map<String, TableBackup>) - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Sets the value of the 'meta_table' field +
            setMetaTable(Map<String, TableBackup>) - +Method in class org.kiji.schema.avro.MetadataBackup +
            Sets the value of the 'meta_table' field. +
            setName(String) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.TableBackup +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'name' field. +
            setPrintStream(PrintStream) - +Method in class org.kiji.schema.tools.BaseTool +
            Set the output print stream the tool should write to. +
            setReaderSchema(Schema) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the Avro reader schema. +
            setReferenceLayout(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'reference_layout' field +
            setReferenceLayout(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'reference_layout' field. +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'renamed_from' field +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'renamed_from' field. +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'renamed_from' field +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'renamed_from' field. +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'renamed_from' field +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'renamed_from' field. +
            setSchemaStorage(SchemaStorage) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the schema storage. +
            setSchemaTable(List<SchemaTableEntry>) - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Sets the value of the 'schema_table' field +
            setSchemaTable(List<SchemaTableEntry>) - +Method in class org.kiji.schema.avro.MetadataBackup +
            Sets the value of the 'schema_table' field. +
            setSchemaTable(KijiSchemaTable) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the schema table. +
            setServerPrefetchSize(Integer) - +Method in class org.kiji.schema.HBaseScanOptions +
            Sets the number of rows for servers to prefetch. +
            setStartRow(EntityId) - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Sets the start row used by the scanner, + and returns this KijiScannerOptions to allow chaining. +
            setStopRow(EntityId) - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Sets the stop row used by the scanner, + and returns this KijiScannerOptions to allow chaining. +
            setStorage(SchemaStorage) - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Sets the value of the 'storage' field +
            setStorage(SchemaStorage) - +Method in class org.kiji.schema.avro.CellSchema +
            Sets the value of the 'storage' field. +
            setTableLayout(String, TableLayoutDesc) - +Method in class org.kiji.schema.impl.HBaseKijiAdmin +
            Sets the layout of a table. +
            setTableLayout(String, TableLayoutDesc, boolean, PrintStream) - +Method in class org.kiji.schema.impl.HBaseKijiAdmin +
            Sets the layout of a table, or print the results of setting the table layout if + dryRun is true. +
            setTableLayout(String, TableLayoutDesc) - +Method in interface org.kiji.schema.KijiAdmin +
            Sets the layout of a table. +
            setTableLayout(String, TableLayoutDesc, boolean, PrintStream) - +Method in interface org.kiji.schema.KijiAdmin +
            Sets the layout of a table, or print the results of setting the table layout if + dryRun is true. +
            setTableName(String) - +Method in class org.kiji.schema.KijiURI +
            Creates a KijiURI with this table name added. +
            setTimestamp(long) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Sets the value of the 'timestamp' field +
            setTimestamp(Long) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Sets the value of the 'timestamp' field. +
            setTimestamp(long) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Sets the value of the 'timestamp' field +
            setTimestamp(Long) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Sets the value of the 'timestamp' field. +
            setTtlSeconds(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'ttl_seconds' field +
            setTtlSeconds(Integer) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'ttl_seconds' field. +
            setType(SchemaType) - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Sets the value of the 'type' field +
            setType(SchemaType) - +Method in class org.kiji.schema.avro.CellSchema +
            Sets the value of the 'type' field. +
            setType(SchemaType) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the cell type. +
            setup() - +Method in class org.kiji.schema.tools.BaseTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.DeleteTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.FlushTableTool +
            Called to initialize the tool just before running. +
            setUpdate(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Sets the value of the 'update' field +
            setUpdate(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Sets the value of the 'update' field. +
            setURI(KijiURI) - +Method in class org.kiji.schema.tools.BaseTool +
            Sets the kiji URI of the target this tool operates on. +
            setValue(String) - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Sets the value of the 'value' field +
            setValue(String) - +Method in class org.kiji.schema.avro.CellSchema +
            Sets the value of the 'value' field. +
            setValue(ByteBuffer) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Sets the value of the 'value' field +
            setValue(ByteBuffer) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Sets the value of the 'value' field. +
            setVersion(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'version' field +
            setVersion(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'version' field. +
            setZookeeperQuorum(String[]) - +Method in class org.kiji.schema.KijiURI +
            Creates a new KijiURI with this zookeeper quorum. +
            size() - +Method in class org.kiji.schema.impl.KijiDataBuffer +
              +
            sizeOfLongAsVarInt64(long) - +Static method in class org.kiji.schema.util.ByteStreamArray +
            Reports the size of the zig-zag encoding of the specified long integer. +
            skip(int) - +Method in class org.kiji.schema.util.ByteStreamArray +
            Skips some bytes. +
            SpecificCellDecoder<T> - Class in org.kiji.schema.impl
            Decodes cells encoded using Avro into specific types.
            SpecificCellDecoder(CellSpec) - +Constructor for class org.kiji.schema.impl.SpecificCellDecoder +
            Initializes a cell decoder that creates specific Avro types. +
            SpecificCellDecoderFactory - Class in org.kiji.schema
            Factory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas.
            SplitKeyFile - Class in org.kiji.schema.util
            Parses region boundaries split files.
            storage - +Variable in class org.kiji.schema.avro.CellSchema +
            Deprecated.  +
            StripValueRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest.
            StripValueRowFilter() - +Constructor for class org.kiji.schema.filter.StripValueRowFilter +
              +
            synthesize() - +Method in class org.kiji.schema.tools.synth.EmailSynthesizer +
              +
            synthesize() - +Method in class org.kiji.schema.tools.synth.NGramSynthesizer +
              +
            synthesize() - +Method in interface org.kiji.schema.tools.synth.Synthesizer +
            Synthesizes a piece of data. +
            synthesize() - +Method in class org.kiji.schema.tools.synth.WordSynthesizer +
              +
            synthesizeDomain() - +Method in class org.kiji.schema.tools.synth.EmailSynthesizer +
            Synthesize a random domain using the market share probabilities. +
            Synthesizer<T> - Interface in org.kiji.schema.tools.synth
            Synthesizers create objects from nothing.
            SynthesizeUserDataTool - Class in org.kiji.schema.tools
            Synthesize some user data into a kiji table.
            SynthesizeUserDataTool() - +Constructor for class org.kiji.schema.tools.SynthesizeUserDataTool +
              +
            +
            +

            +T

            +
            +
            TableBackup - Class in org.kiji.schema.avro
             
            TableBackup() - +Constructor for class org.kiji.schema.avro.TableBackup +
            Default constructor. +
            TableBackup(String, List<TableLayoutBackupEntry>, List<KeyValueBackupEntry>) - +Constructor for class org.kiji.schema.avro.TableBackup +
            All-args constructor. +
            TableBackup.Builder - Class in org.kiji.schema.avro
            RecordBuilder for TableBackup instances.
            TableKeyNotFoundException - Exception in org.kiji.schema
            Thrown when a key is not found in a map-like API implemented by one of the + Kiji tables, the system or meta table for example.
            TableKeyNotFoundException(String) - +Constructor for exception org.kiji.schema.TableKeyNotFoundException +
            Constructor. +
            TableLayoutBackupEntry - Class in org.kiji.schema.avro
             
            TableLayoutBackupEntry() - +Constructor for class org.kiji.schema.avro.TableLayoutBackupEntry +
            Default constructor. +
            TableLayoutBackupEntry(Long, TableLayoutDesc, TableLayoutDesc) - +Constructor for class org.kiji.schema.avro.TableLayoutBackupEntry +
            All-args constructor. +
            TableLayoutBackupEntry.Builder - Class in org.kiji.schema.avro
            RecordBuilder for TableLayoutBackupEntry instances.
            TableLayoutDesc - Class in org.kiji.schema.avro
             
            TableLayoutDesc() - +Constructor for class org.kiji.schema.avro.TableLayoutDesc +
            Default constructor. +
            TableLayoutDesc(String, String, RowKeyFormat, List<LocalityGroupDesc>, String, String, String) - +Constructor for class org.kiji.schema.avro.TableLayoutDesc +
            All-args constructor. +
            TableLayoutDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for TableLayoutDesc instances.
            TableLayoutSerializer - Class in org.kiji.schema.layout
            Serialize TableLayout instances into job configurations.
            tableSet() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns a set view of the tables that have key-value pairs defined. +
            tableSet() - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns a set view of the tables that have key-value pairs defined. +
            tableSet() - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns a set view of the tables that have key-value pairs defined. +
            timestamp - +Variable in class org.kiji.schema.avro.KeyValueBackupEntry +
            Deprecated.  +
            timestamp - +Variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Deprecated.  +
            TimestampComparator - Class in org.kiji.schema.util
            A comparator that sorts Longs in reverse chronological order.
            toAvroEntry(KijiSchemaTable.SchemaEntry) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Converts a SchemaEntry into an Avro SchemaTableEntry. +
            toAvroJsonString(Object, Schema) - +Static method in class org.kiji.schema.util.ToJson +
            Standard Avro/JSON encoder. +
            toAvroJsonString(IndexedRecord) - +Static method in class org.kiji.schema.util.ToJson +
            Standard Avro/JSON encoder. +
            toBackup() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. +
            toBackup() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. +
            toBackup() - +Method in class org.kiji.schema.KijiMetaTable +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. +
            toBackup() - +Method in class org.kiji.schema.KijiSchemaTable +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. +
            toByteArray() - +Method in class org.kiji.schema.layout.impl.ColumnId +
            Translates ColumnIds to HBase column names. +
            toBytes() - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
            Gets the name of the HBase table that stores the data for this Kiji table. +
            toGet(EntityId, KijiTableLayout) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row. +
            toGet(EntityId, KijiTableLayout, int) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row. +
            toHBaseColumnName(KijiColumnName) - +Method in class org.kiji.schema.layout.ColumnNameTranslator +
            Translates a Kiji column name into an HBase column name. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.ColumnValueEqualsRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.HasColumnDataRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiColumnName, KijiColumnFilter.Context) - +Method in class org.kiji.schema.filter.KijiColumnFilter +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +
            toHBaseFilter(KijiColumnName, ColumnNameTranslator) - +Method in class org.kiji.schema.filter.KijiColumnFilter +
            Expresses a KijiColumnFilter in terms of an equivalent HBase filter, translating the + KijiColumnNames to the corresponding HBaseColumnName. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.KijiRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.OperatorRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiColumnName, KijiColumnFilter.Context) - +Method in class org.kiji.schema.filter.RegexQualifierColumnFilter +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.StripValueRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHex(byte[]) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Formats a byte array as a sequence of hex-digits with no separator. +
            toHex(byte[], char) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Formats a byte array as a sequence of 2 hex-digits bytes with the specified separator. +
            toHTableDescriptor(String, KijiTableLayout) - +Method in class org.kiji.schema.layout.impl.HTableSchemaTranslator +
            Translates a Kiji table layout into an HColumnDescriptor. +
            ToJson - Class in org.kiji.schema.util
            Encode an Avro record into JSON.
            toJsonNode(Object, Schema) - +Static method in class org.kiji.schema.util.ToJson +
            Serializes a Java Avro value into JSON. +
            toJsonString(Object, Schema) - +Static method in class org.kiji.schema.util.ToJson +
            Encodes an Avro value into a JSON string. +
            toJsonString(IndexedRecord) - +Static method in class org.kiji.schema.util.ToJson +
            Encodes an Avro record into JSON. +
            toKijiColumnName(HBaseColumnName) - +Method in class org.kiji.schema.layout.ColumnNameTranslator +
            Translates an HBase column name to a Kiji column name. +
            toolMain(List<String>) - +Method in class org.kiji.schema.tools.BaseTool +
            Invoke the functionality of this tool, as supplied through its + implementation of the abstract methods of this class. +
            toolMain(List<String>) - +Method in class org.kiji.schema.tools.HelpTool +
            The main logic of your tool. +
            toolMain(List<String>) - +Method in interface org.kiji.schema.tools.KijiTool +
            The main logic of your tool. +
            ToolUtils - Class in org.kiji.schema.tools
            Utility class providing static methods used by command-line tools.
            toOrderedString() - +Method in class org.kiji.schema.KijiURI +
            Returns a string representation of this URI that preserves ordering of lists in fields, + such as the Zookeeper quorum and Kiji columns. +
            toScan(KijiTableLayout) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +
            toScan(KijiTableLayout, HBaseScanOptions) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +
            toString() - +Method in class org.kiji.schema.HBaseColumnName +
            +
            toString() - +Method in class org.kiji.schema.KijiColumnName +
            +
            toString() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            +
            toString() - +Method in class org.kiji.schema.KijiDataRequest +
            +
            toString() - +Method in class org.kiji.schema.KijiManagedHBaseTableName +
              +
            toString() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            +
            toString() - +Method in class org.kiji.schema.KijiURI +
            +
            toString() - +Method in class org.kiji.schema.layout.impl.ColumnId +
            Gets the id as a string of digits from our alphabet. +
            toString() - +Method in class org.kiji.schema.layout.KijiTableLayout +
            +
            toString() - +Method in class org.kiji.schema.util.BytesKey +
              +
            toURL(byte[]) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Formats a byte array as a URL. +
            ttl_seconds - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            type - +Variable in class org.kiji.schema.avro.CellSchema +
            Deprecated.  +
            +
            +

            +U

            +
            +
            UNASSIGNED - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The special value reserved to mean that a symbolic name has not been assigned a column id. +
            uninstall(HBaseAdmin, KijiURI) - +Static method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes the meta table from HBase. +
            uninstall(HBaseAdmin, KijiConfiguration) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Disables and removes the schema table from HBase. +
            uninstall(HBaseAdmin, KijiConfiguration) - +Static method in class org.kiji.schema.impl.HBaseSystemTable +
            Disables and delete the system table from HBase. +
            uninstall(KijiURI, Configuration) - +Static method in class org.kiji.schema.KijiInstaller +
            Uninstalls the specified Kiji instance. +
            uninstall(KijiURI, HBaseFactory, Configuration) - +Static method in class org.kiji.schema.KijiInstaller +
            Removes a kiji instance from the HBase cluster including any user tables. +
            UninstallTool - Class in org.kiji.schema.tools
            A command-line tool for uninstalling kiji instances from an hbase cluster.
            UninstallTool() - +Constructor for class org.kiji.schema.tools.UninstallTool +
              +
            unlock() - +Method in interface org.kiji.schema.util.Lock +
            Releases the lock. +
            unlock() - +Method in class org.kiji.schema.util.ZooKeeperLock +
            Releases the lock. +
            unmodifiableMap() - +Static method in class org.kiji.schema.util.Functions +
            Returns a function that makes a map immutable. +
            UNSET_URI_STRING - +Static variable in class org.kiji.schema.KijiURI +
            String to specify an unset KijiURI field. +
            update - +Variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Deprecated.  +
            updateTableLayout(String, TableLayoutDesc) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Sets a table's layout. +
            updateTableLayout(String, TableLayoutDesc) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Sets a table's layout. +
            updateTableLayout(String, TableLayoutDesc) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Sets a table's layout. +
            +
            +

            +V

            +
            +
            VALID_ALIAS_PATTERN - +Static variable in class org.kiji.schema.util.KijiNameValidator +
            Regular expression that defines a valid alias for a layout name. +
            VALID_INSTANCE_PATTERN - +Static variable in class org.kiji.schema.util.KijiNameValidator +
            Regular expression that defines a valid instance name. +
            VALID_LAYOUT_NAME_PATTERN - +Static variable in class org.kiji.schema.util.KijiNameValidator +
            Regular expression that defines a valid layout name (family, qualifier, table, etc). +
            validate(KijiTableLayout) - +Method in class org.kiji.schema.KijiDataRequestValidator +
            Validates the data request against the given table layout. +
            validateAlias(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
            Validates characters that may be used in an alias for a qualifier, family, or + locality group. +
            validateFlags() - +Method in class org.kiji.schema.tools.BaseTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.CreateTableTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.DeleteTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.FlushTableTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.IncrementTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.LayoutTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.LsTool +
              +
            validateFlags() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Validates the command-line flags. +
            validateKijiName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
            Determines whether a string is a valid Kiji instance name. +
            validateLayoutName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
            Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names. +
            validateVersion(Kiji) - +Static method in class org.kiji.schema.util.VersionInfo +
            Validates that the client data version matches the data version installed on a Kiji instance. +
            value - +Variable in class org.kiji.schema.avro.CellSchema +
            Deprecated.  +
            value - +Variable in class org.kiji.schema.avro.KeyValueBackupEntry +
            Deprecated.  +
            VALUE_COLUMN_FAMILY - +Static variable in class org.kiji.schema.impl.HBaseSystemTable +
            The HBase column family that stores the value of the properties. +
            VALUE_MAP - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            A map from characters in the alphabet to the integer it represents. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.CompressionType +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.HashType +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.RowKeyEncoding +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.SchemaStorage +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.SchemaType +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.filter.OperatorRowFilter.Operator +
            Returns the enum constant of this type with the specified name. +
            values() - +Static method in enum org.kiji.schema.avro.CompressionType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.HashType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.RowKeyEncoding +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.SchemaStorage +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.SchemaType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.filter.OperatorRowFilter.Operator +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            version - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            VersionInfo - Class in org.kiji.schema.util
            Reads the version info from the jar manifest for this version of Kiji.
            VersionTool - Class in org.kiji.schema.tools
            Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            VersionTool() - +Constructor for class org.kiji.schema.tools.VersionTool +
              +
            VersionValidatedTool - Class in org.kiji.schema.tools
            Base class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool.
            VersionValidatedTool() - +Constructor for class org.kiji.schema.tools.VersionValidatedTool +
            Constructor. +
            +
            +

            +W

            +
            +
            withCellDecoderFactory(KijiCellDecoderFactory) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the cell decoder factory to use when reading cells from the scanner. +
            withClock(Clock) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets a clock. +
            withDataRequest(KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the data request used to generate the KijiRowScanner. +
            withFilter(KijiColumnFilter) - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Sets a filter to use on the column. +
            withHBaseResultScanner(ResultScanner) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the HBase result scanner the KijiRowScanner will wrap. +
            withIdlePollPeriod(long) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the amount of time between sweeps of the pool for removing idle connections. +
            withIdleTimeout(long) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the amount of time a connection may be idle before being removed from the pool. +
            withMaxSize(int) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the maximum number of connections to keep per table. +
            withMaxVersions(int) - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Sets the maximum number of the most recent versions to return. +
            withMinSize(int) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the minimum number of connections to keep per table. +
            withPageSize(int) - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Sets the number of cells per page (defaults to zero, which means paging is disabled). +
            withTable(HBaseKijiTable) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the table being scanned. +
            withTimeRange(long, long) - +Method in class org.kiji.schema.KijiDataRequest +
            Sets the time range of cells to return: [minTimestamp, + maxTimestamp). +
            WordSynthesizer - Class in org.kiji.schema.tools.synth
            Synthesizes random words from a dictionary.
            WordSynthesizer(Random, List<String>) - +Constructor for class org.kiji.schema.tools.synth.WordSynthesizer +
            Constructs a word synthesizer. +
            +
            +

            +Y

            +
            +
            yesNoPrompt() - +Method in class org.kiji.schema.tools.BaseTool +
            Prompts the user for a yes or no answer until they provide a valid response + (y/n/yes/no case insensitive) and reports the result. +
            +
            +

            +Z

            +
            +
            ZooKeeperLock - Class in org.kiji.schema.util
            Distributed lock on top of ZooKeeper.
            ZooKeeperLock(ZooKeeper, File) - +Constructor for class org.kiji.schema.util.ZooKeeperLock +
            Constructs a ZooKeeper lock object. +
            ZooKeeperLockFactory - Class in org.kiji.schema.util
            Factory for ZooKeeperLock instances.
            ZooKeeperLockFactory(ZooKeeper) - +Constructor for class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a factory for ZooKeeperLock. +
            ZooKeeperLockFactory(Configuration) - +Constructor for class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a factory for ZooKeeperLock. +
            +
            +A B C D E F G H I J K L M N O P Q R S T U V W Y Z + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/index.html b/apidocs/kiji-schema/1.0.0-rc3/index.html new file mode 100644 index 00000000..a050068a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/index.html @@ -0,0 +1,40 @@ + + + + + + + +kiji-schema 1.0.0-rc3 API + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html new file mode 100644 index 00000000..60ca143d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html @@ -0,0 +1,393 @@ + + + + + + + +GenericTableMapReduceUtil (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.hbase.mapreduce +
            +Class GenericTableMapReduceUtil

            +
            +java.lang.Object
+  extended by org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil
+      extended by org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil
+
            +
            +
            +
            public class GenericTableMapReduceUtil
            extends TableMapReduceUtil
            + + +

            +Just like TableMapReduceUtil but fixes some missing dependency jars. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            GenericTableMapReduceUtil() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidaddAllDependencyJars(Job job) + +
            +          Like TableMapReduceUtil.addDependencyJars() but this catches some + missing ones like google's guava library.
            +static ScanconvertStringToScan(String base64) + +
            +          This method is just like the package-private version in TableMapReduceUtil, + except that it disables block caching by default.
            +static voidinitGenericTableMapperJob(String table, + Scan scan, + Class<? extends TableMapper> mapper, + Class<?> outputKeyClass, + Class<?> outputValueClass, + Job job) + +
            +          This is just like the TableMapReduceUtil.initTableMapperJob but + it takes any classes for input and output keys instead of just + Writables.
            +static voidinitTableInput(String table, + Scan scan, + Job job) + +
            +          Configures the job with an HBase scan over a table as input.
            +static voidinitTableScan(Scan scan, + Job job) + +
            +          Configures the job with an HBase scan.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil
            addDependencyJars, addDependencyJars, initCredentials, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableReducerJob, initTableReducerJob, initTableReducerJob, initTableReducerJob, limitNumReduceTasks, setNumReduceTasks, setScannerCaching
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +GenericTableMapReduceUtil

            +
            +public GenericTableMapReduceUtil()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initTableScan

            +
            +public static void initTableScan(Scan scan,
+                                 Job job)
+                          throws IOException
            +
            +
            Configures the job with an HBase scan. +

            +

            +
            Parameters:
            scan - The scan to set in the job configuration.
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +initTableInput

            +
            +public static void initTableInput(String table,
+                                  Scan scan,
+                                  Job job)
+                           throws IOException
            +
            +
            Configures the job with an HBase scan over a table as input. +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +convertStringToScan

            +
            +public static Scan convertStringToScan(String base64)
+                                throws IOException
            +
            +
            This method is just like the package-private version in TableMapReduceUtil, + except that it disables block caching by default. +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +initGenericTableMapperJob

            +
            +public static void initGenericTableMapperJob(String table,
+                                             Scan scan,
+                                             Class<? extends TableMapper> mapper,
+                                             Class<?> outputKeyClass,
+                                             Class<?> outputValueClass,
+                                             Job job)
+                                      throws IOException
            +
            +
            This is just like the TableMapReduceUtil.initTableMapperJob but + it takes any classes for input and output keys instead of just + Writables. This way we can work with AvroSerialization instead + of just WritableSerialization. +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +addAllDependencyJars

            +
            +public static void addAllDependencyJars(Job job)
+                                 throws IOException
            +
            +
            Like TableMapReduceUtil.addDependencyJars() but this catches some + missing ones like google's guava library. +

            +

            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html new file mode 100644 index 00000000..d66e06d2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil

            +
            +No usage of org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-frame.html new file mode 100644 index 00000000..87bcc8e4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.apache.hadoop.hbase.mapreduce (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.apache.hadoop.hbase.mapreduce + + + + +
            +Classes  + +
            +GenericTableMapReduceUtil
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-summary.html new file mode 100644 index 00000000..d368b8d7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +org.apache.hadoop.hbase.mapreduce (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.apache.hadoop.hbase.mapreduce +

            + + + + + + + + + +
            +Class Summary
            GenericTableMapReduceUtilJust like TableMapReduceUtil but fixes some missing dependency jars.
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-tree.html new file mode 100644 index 00000000..91441464 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-tree.html @@ -0,0 +1,156 @@ + + + + + + + +org.apache.hadoop.hbase.mapreduce Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.apache.hadoop.hbase.mapreduce +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-use.html new file mode 100644 index 00000000..b4fff10f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/apache/hadoop/hbase/mapreduce/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.apache.hadoop.hbase.mapreduce (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.apache.hadoop.hbase.mapreduce

            +
            +No usage of org.apache.hadoop.hbase.mapreduce +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/EntityId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/EntityId.html new file mode 100644 index 00000000..46150931 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/EntityId.html @@ -0,0 +1,370 @@ + + + + + + + +EntityId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class EntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+
            +
            +
            Direct Known Subclasses:
            HashedEntityId, HashPrefixedEntityId, HBaseEntityId, RawEntityId
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract class EntityId
            extends Object
            + + +

            +EntityId is used to identify a particular row in a Kiji table. + + There are two name-spaces for rows: +

              +
            • Kiji rows are primarily indexed by Kiji row keys (arbitrary byte arrays). +
            • Under the hood, rows are indexed by HBase row keys (arbitrary byte arrays). +
            + + The translation between Kiji row keys and HBase row keys depends on the layout of the table + the row belongs to. + + There are multiple translation schemes: +
              +
            • Raw: Kiji row keys and HBase row keys are identical (identity translation). +
            • MD5: HBase row keys are MD5 hashes of the Kiji row key (non reversible transform). +
            • Hash-prefix: HBase row keys are Kiji row keys prefixed by a hash of the Kiji row key. +
            • Composite: to be determined. +
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EntityId() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object obj) + +
            +          
            +abstract  RowKeyFormatgetFormat() + +
            +           
            +abstract  byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            +abstract  byte[]getKijiRowKey() + +
            +           
            + inthashCode() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EntityId

            +
            +public EntityId()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getFormat

            +
            +public abstract RowKeyFormat getFormat()
            +
            +
            + +
            Returns:
            the format of this row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public abstract byte[] getKijiRowKey()
            +
            +
            + +
            Returns:
            the Kiji row key as a byte array.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public abstract byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            + +
            Returns:
            the HBase row key.
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object obj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/EntityIdFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/EntityIdFactory.html new file mode 100644 index 00000000..dfa5782d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/EntityIdFactory.html @@ -0,0 +1,354 @@ + + + + + + + +EntityIdFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class EntityIdFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityIdFactory
+
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract class EntityIdFactory
            extends Object
            + + +

            +Factory class for creating EntityIds. + + Light-weight object, so as many can be created as needed. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EntityIdFactory(RowKeyFormat format) + +
            +          Creates an entity ID factory.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static EntityIdFactorycreate(RowKeyFormat format) + +
            +          Creates an entity ID factory for the specified row key format.
            +abstract  EntityIdfromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates an entity ID from an HBase row key.
            +abstract  EntityIdfromKijiRowKey(byte[] kijiRowKey) + +
            +          Creates an entity ID from a Kiji row key.
            + EntityIdfromKijiRowKey(String text) + +
            +          Creates an entity ID from a UTF8 text Kiji row key.
            + RowKeyFormatgetFormat() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EntityIdFactory

            +
            +public EntityIdFactory(RowKeyFormat format)
            +
            +
            Creates an entity ID factory. +

            +

            +
            Parameters:
            format - Format of the row keys.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static EntityIdFactory create(RowKeyFormat format)
            +
            +
            Creates an entity ID factory for the specified row key format. +

            +

            +
            Parameters:
            format - Row key format that determines the type of EntityIdFactory that's created +
            Returns:
            a new entity ID factory for the specified row key format.
            +
            +
            +
            + +

            +getFormat

            +
            +public RowKeyFormat getFormat()
            +
            +
            + +
            Returns:
            the format of the row keys generated by this factory.
            +
            +
            +
            + +

            +fromKijiRowKey

            +
            +public abstract EntityId fromKijiRowKey(byte[] kijiRowKey)
            +
            +
            Creates an entity ID from a Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key. +
            Returns:
            a new EntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromKijiRowKey

            +
            +public EntityId fromKijiRowKey(String text)
            +
            +
            Creates an entity ID from a UTF8 text Kiji row key. +

            +

            +
            Parameters:
            text - UTF8 encoded Kiji row key. +
            Returns:
            a new EntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public abstract EntityId fromHBaseRowKey(byte[] hbaseRowKey)
            +
            +
            Creates an entity ID from an HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key. +
            Returns:
            a new EntityId with the specified HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/GenericCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/GenericCellDecoderFactory.html new file mode 100644 index 00000000..0af34002 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/GenericCellDecoderFactory.html @@ -0,0 +1,260 @@ + + + + + + + +GenericCellDecoderFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class GenericCellDecoderFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.GenericCellDecoderFactory
+
            +
            +
            All Implemented Interfaces:
            KijiCellDecoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class GenericCellDecoderFactory
            extends Object
            implements KijiCellDecoderFactory
            + + +

            +Factory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellDecoder<?>create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +static KijiCellDecoderFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiCellDecoderFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            an instance of the GenericCellDecoderFactory.
            +
            +
            +
            + +

            +create

            +
            +public KijiCellDecoder<?> create(CellSpec cellSpec)
+                          throws IOException
            +
            +
            Creates a new Kiji cell decoder. +

            +

            +
            Specified by:
            create in interface KijiCellDecoderFactory
            +
            +
            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell decoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseColumnName.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseColumnName.html new file mode 100644 index 00000000..3fdfde92 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseColumnName.html @@ -0,0 +1,405 @@ + + + + + + + +HBaseColumnName (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class HBaseColumnName

            +
            +java.lang.Object
+  extended by org.kiji.schema.HBaseColumnName
+
            +
            +
            +
            @ApiAudience.Public
+public final class HBaseColumnName
            extends Object
            + + +

            +An HBase column name. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseColumnName(byte[] family, + byte[] qualifier) + +
            +          Creates a new HBaseColumnName instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            + byte[]getFamily() + +
            +          Gets the HBase column family.
            + StringgetFamilyAsString() + +
            +          Gets the HBase column family as a string.
            + byte[]getQualifier() + +
            +          Gets the HBase column qualifier.
            + StringgetQualifierAsString() + +
            +          Gets the HBase column qualifier as a string.
            + inthashCode() + +
            +          
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +HBaseColumnName

            +
            +public HBaseColumnName(byte[] family,
+                       byte[] qualifier)
            +
            +
            Creates a new HBaseColumnName instance. +

            +

            +
            Parameters:
            family - The column family.
            qualifier - The column qualifier.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getFamily

            +
            +public byte[] getFamily()
            +
            +
            Gets the HBase column family. +

            +

            + +
            Returns:
            The family.
            +
            +
            +
            + +

            +getFamilyAsString

            +
            +public String getFamilyAsString()
            +
            +
            Gets the HBase column family as a string. +

            +

            + +
            Returns:
            The family as a string.
            +
            +
            +
            + +

            +getQualifier

            +
            +public byte[] getQualifier()
            +
            +
            Gets the HBase column qualifier. +

            +

            + +
            Returns:
            The qualifier.
            +
            +
            +
            + +

            +getQualifierAsString

            +
            +public String getQualifierAsString()
            +
            +
            Gets the HBase column qualifier as a string. +

            +

            + +
            Returns:
            The qualifier as a string.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseFactory.Provider.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseFactory.Provider.html new file mode 100644 index 00000000..80291402 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseFactory.Provider.html @@ -0,0 +1,230 @@ + + + + + + + +HBaseFactory.Provider (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class HBaseFactory.Provider

            +
            +java.lang.Object
+  extended by org.kiji.schema.HBaseFactory.Provider
+
            +
            +
            Enclosing interface:
            HBaseFactory
            +
            +
            +
            +
            public static final class HBaseFactory.Provider
            extends Object
            + + +

            +Provider for the default HBaseFactory. + + Ensures that there is only one HBaseFactory instance. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static HBaseFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static HBaseFactory get()
            +
            +
            + +
            Returns:
            the default HBaseFactory.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseFactory.html new file mode 100644 index 00000000..99c1a756 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseFactory.html @@ -0,0 +1,306 @@ + + + + + + + +HBaseFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface HBaseFactory

            +
            +
            All Superinterfaces:
            org.kiji.delegation.PriorityProvider
            +
            +
            +
            All Known Implementing Classes:
            DefaultHBaseFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface HBaseFactory
            extends org.kiji.delegation.PriorityProvider
            + + +

            +Factory for HBase instances based on URIs. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classHBaseFactory.Provider + +
            +          Provider for the default HBaseFactory.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdminFactorygetHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactorygetHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactorygetLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  + + + + + + + +
            Methods inherited from interface org.kiji.delegation.PriorityProvider
            getPriority
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getHTableInterfaceFactory

            +
            +HTableInterfaceFactory getHTableInterfaceFactory(KijiURI uri)
            +
            +
            Reports a factory for HTableInterface for a given HBase instance. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HTableInterface for the specified HBase instance.
            +
            +
            +
            + +

            +getHBaseAdminFactory

            +
            +HBaseAdminFactory getHBaseAdminFactory(KijiURI uri)
            +
            +
            Reports a factory for HBaseAdmin for a given HBase instance. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HBaseAdmin for the specified HBase instance.
            +
            +
            +
            + +

            +getLockFactory

            +
            +LockFactory getLockFactory(KijiURI uri,
+                           Configuration conf)
+                           throws IOException
            +
            +
            Creates a lock factory for a given Kiji instance. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI of the Kiji instance to create a lock factory for.
            conf - Hadoop configuration. +
            Returns:
            a factory for locks for the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseScanOptions.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseScanOptions.html new file mode 100644 index 00000000..417652ce --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/HBaseScanOptions.html @@ -0,0 +1,382 @@ + + + + + + + +HBaseScanOptions (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class HBaseScanOptions

            +
            +java.lang.Object
+  extended by org.kiji.schema.HBaseScanOptions
+
            +
            +
            +
            @ApiAudience.Public
+public final class HBaseScanOptions
            extends Object
            + + +

            +Customizable parameters for KijiRowScanners backed by an HBase scan. + Any parameters that are not set will default to HBase values. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseScanOptions() + +
            +          Creates a new HBaseScanOptions where all parameters will default to HBase values.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + BooleangetCacheBlocks() + +
            +          Returns whether requested rows are cached server-side, + or null if using the HBase default.
            + IntegergetClientBufferSize() + +
            +          Returns the number of rows to request with each RPC, + or null if using the HBase default.
            + IntegergetServerPrefetchSize() + +
            +          Returns the number of rows for servers to prefetch, + or null if using the HBase default.
            + voidsetCacheBlocks(Boolean cacheBlocks) + +
            +          Sets whether rows requested are cached server-side for future use.
            + voidsetClientBufferSize(Integer bufferSize) + +
            +          Sets the number of rows that will be returned with each RPC when iterating + through a KijiRowScanner.
            + voidsetServerPrefetchSize(Integer prefetchSize) + +
            +          Sets the number of rows for servers to prefetch.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseScanOptions

            +
            +public HBaseScanOptions()
            +
            +
            Creates a new HBaseScanOptions where all parameters will default to HBase values. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +setClientBufferSize

            +
            +public void setClientBufferSize(Integer bufferSize)
            +
            +
            Sets the number of rows that will be returned with each RPC when iterating + through a KijiRowScanner. If null, uses HBase default. +

            +

            +
            Parameters:
            bufferSize - The number of rows to request with each RPC.
            +
            +
            +
            + +

            +getClientBufferSize

            +
            +public Integer getClientBufferSize()
            +
            +
            Returns the number of rows to request with each RPC, + or null if using the HBase default. +

            +

            + +
            Returns:
            The number of rows to request with each RPC.
            +
            +
            +
            + +

            +setServerPrefetchSize

            +
            +public void setServerPrefetchSize(Integer prefetchSize)
            +
            +
            Sets the number of rows for servers to prefetch. If null, use HBase default. + Increasing this number should improve amortized scan time, although individual requests + may take longer to complete while the server is prefetching the following rows. + It is important that the scanner timeout be long enough to allow these longer fetches. +

            +

            +
            Parameters:
            prefetchSize - The number of rows to read into memory at a time.
            +
            +
            +
            + +

            +getServerPrefetchSize

            +
            +public Integer getServerPrefetchSize()
            +
            +
            Returns the number of rows for servers to prefetch, + or null if using the HBase default. +

            +

            + +
            Returns:
            The number of rows for servers to prefetch.
            +
            +
            +
            + +

            +setCacheBlocks

            +
            +public void setCacheBlocks(Boolean cacheBlocks)
            +
            +
            Sets whether rows requested are cached server-side for future use. If null, use HBase default. +

            +

            +
            Parameters:
            cacheBlocks - Whether rows are cached server-side.
            +
            +
            +
            + +

            +getCacheBlocks

            +
            +public Boolean getCacheBlocks()
            +
            +
            Returns whether requested rows are cached server-side, + or null if using the HBase default. +

            +

            + +
            Returns:
            Whether requested rows are cached server-side.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/IncompatibleKijiVersionException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/IncompatibleKijiVersionException.html new file mode 100644 index 00000000..ad08c059 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/IncompatibleKijiVersionException.html @@ -0,0 +1,254 @@ + + + + + + + +IncompatibleKijiVersionException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class IncompatibleKijiVersionException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.IncompatibleKijiVersionException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class IncompatibleKijiVersionException
            extends IOException
            + + +

            +Thrown when there is an attempt to operate on a Kiji instance whose data format version + is incompatible with the Kiji client version. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            IncompatibleKijiVersionException(String message) + +
            +          Creates a new IncompatibleKijiVersionException with the specified + detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +IncompatibleKijiVersionException

            +
            +public IncompatibleKijiVersionException(String message)
            +
            +
            Creates a new IncompatibleKijiVersionException with the specified + detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/InternalKijiError.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/InternalKijiError.html new file mode 100644 index 00000000..0bc62e8a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/InternalKijiError.html @@ -0,0 +1,271 @@ + + + + + + + +InternalKijiError (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class InternalKijiError

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Error
+          extended by org.kiji.schema.InternalKijiError
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class InternalKijiError
            extends Error
            + + +

            +Thrown when there is something wrong with the internal Kiji + implementation. Clients should never catch one of these. Please + file a bug report if you ever see one at the + Kiji Issue tracker. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            InternalKijiError(String message) + +
            +          Creates a new InternalKijiError with the specified detail message.
            InternalKijiError(Throwable cause) + +
            +          Creates a new InternalKijiError with the specified cause.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +InternalKijiError

            +
            +public InternalKijiError(Throwable cause)
            +
            +
            Creates a new InternalKijiError with the specified cause. +

            +

            +
            Parameters:
            cause - A throwable cause.
            +
            +
            + +

            +InternalKijiError

            +
            +public InternalKijiError(String message)
            +
            +
            Creates a new InternalKijiError with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/Kiji.Factory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/Kiji.Factory.html new file mode 100644 index 00000000..775b84c6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/Kiji.Factory.html @@ -0,0 +1,320 @@ + + + + + + + +Kiji.Factory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class Kiji.Factory

            +
            +java.lang.Object
+  extended by org.kiji.schema.Kiji.Factory
+
            +
            +
            Enclosing interface:
            Kiji
            +
            +
            +
            +
            public static final class Kiji.Factory
            extends Object
            + + +

            +Provider for the default Kiji factory. + + Ensures that there is only one KijiFactory instance. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiFactoryget() + +
            +           
            +static Kijiopen(KijiConfiguration kijiConf) + +
            +          Deprecated. 
            +static Kijiopen(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            +static Kijiopen(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiFactory get()
            +
            +
            + +
            Returns:
            the default KijiFactory.
            +
            +
            +
            + +

            +open

            +
            +public static Kiji open(KijiURI uri)
+                 throws IOException
            +
            +
            Opens a Kiji instance by URI. + +

            Caller does not need to call Kiji.retain(), + but must call Kiji.release() when done with it. +

            +

            +
            Parameters:
            uri - URI specifying the Kiji instance to open. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +open

            +
            +public static Kiji open(KijiURI uri,
+                        Configuration conf)
+                 throws IOException
            +
            +
            Opens a Kiji instance by URI. + +

            Caller does not need to call Kiji.retain(), + but must call Kiji.release() when done with it. +

            +

            +
            Parameters:
            uri - URI specifying the Kiji instance to open.
            conf - Hadoop configuration. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +open

            +
            +@Deprecated
+public static Kiji open(KijiConfiguration kijiConf)
+                 throws IOException
            +
            +
            Deprecated.  +

            +

            Opens a Kiji instance. This method of opening a Kiji instance has been deprecated + in favor of a method that doesn't use KijiConfiguration. + +

            Caller does not need to call Kiji.retain(), + but must call Kiji.release() when done with it. +

            +

            +
            Parameters:
            kijiConf - The configuration. +
            Returns:
            An opened kiji instance. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/Kiji.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/Kiji.html new file mode 100644 index 00000000..2ec790c7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/Kiji.html @@ -0,0 +1,405 @@ + + + + + + + +Kiji (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface Kiji

            +
            +
            All Superinterfaces:
            KijiTableFactory, ReferenceCountable<Kiji>
            +
            +
            +
            All Known Implementing Classes:
            HBaseKiji
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface Kiji
            extends KijiTableFactory, ReferenceCountable<Kiji>
            + + +

            +

            Provides a handle to a Kiji instance that contains configuration and + table information.

            + +

            An installed Kiji instance contains several tables: +

              +
            • System table: Kiji system and version information.
              • +
            • Meta table: Metadata about the existing Kiji tables.
              • +
            • Schema table: Avro Schemas of the cells in Kiji tables.
              • +
            • User tables: The user-space Kiji tables that you create.
              • +
            +

            +

            The default Kiji instance name is default.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKiji.Factory + +
            +          Provider for the default Kiji factory.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiAdmingetAdmin() + +
            +           
            + ConfigurationgetConf() + +
            +          Deprecated. 
            + KijiMetaTablegetMetaTable() + +
            +          Gets the meta table for this Kiji instance.
            + KijiSchemaTablegetSchemaTable() + +
            +          Gets the schema table for this Kiji instance.
            + KijiSystemTablegetSystemTable() + +
            +          Gets the system table for this Kiji instance.
            + KijiURIgetURI() + +
            +           
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiTableFactory
            openTable
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.util.ReferenceCountable
            release, retain
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getConf

            +
            +@Deprecated
+Configuration getConf()
            +
            +
            Deprecated.  +

            +

            +
            +
            +
            + +
            Returns:
            The hadoop configuration.
            +
            +
            +
            + +

            +getURI

            +
            +KijiURI getURI()
            +
            +
            +
            +
            +
            + +
            Returns:
            The address of this kiji instance, trimmed to the Kiji instance path component.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +KijiSchemaTable getSchemaTable()
+                               throws IOException
            +
            +
            Gets the schema table for this Kiji instance. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji schema table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getSystemTable

            +
            +KijiSystemTable getSystemTable()
+                               throws IOException
            +
            +
            Gets the system table for this Kiji instance. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji system table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMetaTable

            +
            +KijiMetaTable getMetaTable()
+                           throws IOException
            +
            +
            Gets the meta table for this Kiji instance. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji meta table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getAdmin

            +
            +KijiAdmin getAdmin()
+                   throws IOException
            +
            +
            +
            +
            +
            + +
            Returns:
            the KijiAdmin for this Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiAdmin.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiAdmin.html new file mode 100644 index 00000000..ecaa2bbc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiAdmin.html @@ -0,0 +1,402 @@ + + + + + + + +KijiAdmin (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiAdmin

            +
            +
            All Known Implementing Classes:
            HBaseKijiAdmin
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiAdmin
            + + +

            +Administration API for managing a Kiji instance. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore) + +
            +          Creates a Kiji table in an HBase instance.
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + byte[][] splitKeys) + +
            +          Creates a Kiji table in an HBase instance.
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + int numRegions) + +
            +          Creates a Kiji table in an HBase instance.
            + voiddeleteTable(String tableName) + +
            +          Deletes a Kiji table.
            + List<String>getTableNames() + +
            +          Gets the list of Kiji table names.
            + KijiTableLayoutsetTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutsetTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +createTable

            +
            +void createTable(String tableName,
+                 KijiTableLayout tableLayout,
+                 boolean isRestore)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            isRestore - true if this is part of a metadata restore operation. + This should be set to false by all callers except KijiMetadataTool. +
            Throws: +
            IOException - on I/O error. +
            KijiAlreadyExistsException - if the table already exists.
            +
            +
            +
            + +

            +createTable

            +
            +void createTable(String tableName,
+                 KijiTableLayout tableLayout,
+                 boolean isRestore,
+                 int numRegions)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            isRestore - true if this is part of a metadata restore operation.
            numRegions - The initial number of regions to create. +
            Throws: +
            IllegalArgumentException - If numRegions is non-positive, or if numRegions is + more than 1 and row key hashing on the table layout is disabled. +
            IOException - on I/O error. +
            KijiAlreadyExistsException - if the table already exists.
            +
            +
            +
            + +

            +createTable

            +
            +void createTable(String tableName,
+                 KijiTableLayout tableLayout,
+                 boolean isRestore,
+                 byte[][] splitKeys)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            isRestore - true if this is part of a metadata restore operation.
            splitKeys - The initial key boundaries between regions. There will be splitKeys + + 1 regions created. Pass null to specify the default single region. +
            Throws: +
            IOException - on I/O error. +
            KijiAlreadyExistsException - if the table already exists.
            +
            +
            +
            + +

            +setTableLayout

            +
            +KijiTableLayout setTableLayout(String tableName,
+                               TableLayoutDesc update)
+                               throws IOException
            +
            +
            Sets the layout of a table. +

            +

            +
            Parameters:
            tableName - The name of the Kiji table to affect.
            update - Layout update. +
            Returns:
            the updated layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +setTableLayout

            +
            +KijiTableLayout setTableLayout(String tableName,
+                               TableLayoutDesc update,
+                               boolean dryRun,
+                               PrintStream printStream)
+                               throws IOException
            +
            +
            Sets the layout of a table, or print the results of setting the table layout if + dryRun is true. +

            +

            +
            Parameters:
            tableName - The name of the Kiji table to affect.
            update - Layout update.
            dryRun - true if this is a 'dry run', false if changes should be made.
            printStream - the print stream to use for information if dryRun is true. + If null, stdout will be used. +
            Returns:
            the updated layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +deleteTable

            +
            +void deleteTable(String tableName)
+                 throws IOException
            +
            +
            Deletes a Kiji table. Removes it from HBase. +

            +

            +
            Parameters:
            tableName - The name of the Kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableNames

            +
            +List<String> getTableNames()
+                           throws IOException
            +
            +
            Gets the list of Kiji table names. +

            +

            + +
            Returns:
            A list of the names of Kiji tables installed in the Kiji instance. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiAlreadyExistsException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiAlreadyExistsException.html new file mode 100644 index 00000000..fb7b150c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiAlreadyExistsException.html @@ -0,0 +1,282 @@ + + + + + + + +KijiAlreadyExistsException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiAlreadyExistsException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiAlreadyExistsException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiAlreadyExistsException
            extends RuntimeException
            + + +

            +Thrown when installing an instance or creating a table that already exists. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiAlreadyExistsException(String message, + KijiURI uri) + +
            +          Initializes a new exception object.
            +  + + + + + + + + + + + +
            +Method Summary
            + KijiURIgetURI() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiAlreadyExistsException

            +
            +public KijiAlreadyExistsException(String message,
+                                  KijiURI uri)
            +
            +
            Initializes a new exception object. +

            +

            +
            Parameters:
            message - Human readable message.
            uri - URI of the already existing entity.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getURI

            +
            +public KijiURI getURI()
            +
            +
            + +
            Returns:
            the URI of the already existing entity.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCell.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCell.html new file mode 100644 index 00000000..4fcf4cd9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCell.html @@ -0,0 +1,363 @@ + + + + + + + +KijiCell (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiCell<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiCell<T>
+
            +
            +
            Type Parameters:
            T - The type of the data in the cell.
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiCell<T>
            extends Object
            + + +

            +

            The data held in one cell of a kiji table. A KijiCell is a single + unit of data in Kiji, addressed by a tuple of (table, row, family, + qualifier, timestamp).

            + +

            Use a AvroCellDecoder or a + AvroCellEncoder to serialize/deserialize this cell in and out of a + Kiji table.

            + +

            This class has a Java type parameter T, which should be the Java type + determined by the Avro Schema. The mapping between Avro Schemas and Java types are + documented in the Avro Java API documentation: + +

            +

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiCell(org.apache.avro.Schema writerSchema, + T data) + +
            +          Constructs a single cell of kiji data.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object obj) + +
            +          Determines whether this KijiCell is equivalent to another.
            + TgetData() + +
            +          Gets the data in the cell.
            + org.apache.avro.SchemagetWriterSchema() + +
            +          Gets the schema used to write data in the cell.
            + inthashCode() + +
            +          This operation is not supported.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiCell

            +
            +public KijiCell(org.apache.avro.Schema writerSchema,
+                T data)
            +
            +
            Constructs a single cell of kiji data. +

            +

            +
            Parameters:
            writerSchema - The schema used to the encode the data in the cell.
            data - The data in the cell (the payload).
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getWriterSchema

            +
            +public org.apache.avro.Schema getWriterSchema()
            +
            +
            Gets the schema used to write data in the cell. +

            +

            + +
            Returns:
            The avro schema used by the writer to encode the data payload.
            +
            +
            +
            + +

            +getData

            +
            +public T getData()
            +
            +
            Gets the data in the cell. +

            +

            + +
            Returns:
            The decoded original data payload.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object obj)
            +
            +
            Determines whether this KijiCell is equivalent to another. They are equivalent if + they are both KijiCell objects, they have the same writer schema, and they have the + same data. +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            Parameters:
            obj - The other object to compare to. +
            Returns:
            Whether they are equivalent.
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            This operation is not supported. +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            + +
            Returns:
            Nothing, since this operation is not supported.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellDecoder.html new file mode 100644 index 00000000..808b1868 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellDecoder.html @@ -0,0 +1,252 @@ + + + + + + + +KijiCellDecoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellDecoder<T>

            +
            +
            Type Parameters:
            T - Type of the values being decoded.
            +
            +
            All Known Implementing Classes:
            AvroCellDecoder, CounterCellDecoder, GenericCellDecoder, SpecificCellDecoder
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiCellDecoder<T>
            + + +

            +Interface for Kiji cell decoders. + + A cell decoder is specific to one column and decodes only one type of value. + Cell decoders are instantiated via KijiCellDecoderFactory. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCell<T>decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + TdecodeValue(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +decodeCell

            +
            +KijiCell<T> decodeCell(byte[] bytes)
+                       throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Parameters:
            bytes - Binary encoded Kiji cell. +
            Returns:
            the decoded KijiCell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeValue

            +
            +T decodeValue(byte[] bytes)
+              throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Parameters:
            bytes - Binary encoded Kiji cell value. +
            Returns:
            the decoded cell value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellDecoderFactory.html new file mode 100644 index 00000000..fc824cb6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellDecoderFactory.html @@ -0,0 +1,229 @@ + + + + + + + +KijiCellDecoderFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellDecoderFactory

            +
            +
            All Known Implementing Classes:
            GenericCellDecoderFactory, SpecificCellDecoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiCellDecoderFactory
            + + +

            +Interface for factories of KijiCellDecoder instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<T> KijiCellDecoder<T>
            +            		create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +<T> KijiCellDecoder<T> create(CellSpec cellSpec)
+                          throws IOException
            +
            +
            Creates a new Kiji cell decoder. +

            +

            +
            Type Parameters:
            T - Type of the value to decode.
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell decoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellEncoder.html new file mode 100644 index 00000000..ddeeae59 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellEncoder.html @@ -0,0 +1,261 @@ + + + + + + + +KijiCellEncoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellEncoder

            +
            +
            All Known Implementing Classes:
            AvroCellEncoder, CounterCellEncoder
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiCellEncoder
            + + +

            +Interface for Kiji cell encoders. + + A cell encoder is configured to encode precisely one specific column and knows exactly the type + of data it is supposed to encode. + + Cell encoders are instantiated via KijiCellEncoderFactory. + + Intended for framework developers only. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + + + + + +
            +<T> byte[]
            +            		encode(T cellValue) + +
            +          Encodes the specified value.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +encode

            +
            +byte[] encode(KijiCell<?> cell)
+              throws IOException
            +
            +
            Encodes the specified Kiji cell. +

            +

            +
            Parameters:
            cell - Kiji cell to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encode

            +
            +<T> byte[] encode(T cellValue)
+              throws IOException
            +
            +
            Encodes the specified value. +

            +

            +
            Type Parameters:
            T - type of the value to encode.
            Parameters:
            cellValue - value to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellEncoderFactory.html new file mode 100644 index 00000000..5cedbeda --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCellEncoderFactory.html @@ -0,0 +1,222 @@ + + + + + + + +KijiCellEncoderFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellEncoderFactory

            +
            +
            All Known Implementing Classes:
            DefaultKijiCellEncoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiCellEncoderFactory
            + + +

            +Interface for factories of KijiCellEncoder instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + KijiCellEncodercreate(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +KijiCellEncoder create(CellSpec cellSpec)
+                       throws IOException
            +
            +
            Creates a new Kiji cell encoder. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell encoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiColumnName.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiColumnName.html new file mode 100644 index 00000000..a7e92ac2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiColumnName.html @@ -0,0 +1,519 @@ + + + + + + + +KijiColumnName (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiColumnName

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiColumnName
+
            +
            +
            All Implemented Interfaces:
            Comparable<KijiColumnName>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiColumnName
            extends Object
            implements Comparable<KijiColumnName>
            + + +

            +A Kiji column name is composed of one or two parts: a family and a qualifier. + The qualifier is sometimes also referred to as the key. + If the column is of type map, the qualifier is null. + If the column is of type group, then the qualifier is required but may be empty. +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiColumnName(String fullName) + +
            +          Constructs a column name from a string "family" or "family:qualifier".
            KijiColumnName(String family, + String qualifier) + +
            +          Constructs a column name from the two-part family:qualifier.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + intcompareTo(KijiColumnName o) + +
            +          
            + booleanequals(Object otherObj) + +
            +          
            + StringgetFamily() + +
            +          Gets the name of the column family.
            + byte[]getFamilyBytes() + +
            +          Gets the name of the column family as a byte array.
            + StringgetName() + +
            +          Gets the full name of the column.
            + StringgetQualifier() + +
            +          Gets the name of the column qualifier, which may be null or empty.
            + byte[]getQualifierBytes() + +
            +          Gets the name of the column qualifier as a byte array.
            + inthashCode() + +
            +          
            + booleanisFullyQualified() + +
            +          Determines whether the name refers to a qualified family (vs.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiColumnName

            +
            +public KijiColumnName(String fullName)
            +
            +
            Constructs a column name from a string "family" or "family:qualifier". +

            +

            +
            Parameters:
            fullName - The name of a kiji column "family:qualifier".
            +
            +
            + +

            +KijiColumnName

            +
            +public KijiColumnName(String family,
+                      String qualifier)
            +
            +
            Constructs a column name from the two-part family:qualifier. +

            +

            +
            Parameters:
            family - The kiji column family.
            qualifier - The kiji column qualifier: null means unqualified.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the full name of the column. +

            +

            +
            +
            +
            + +
            Returns:
            the full name of the column.
            +
            +
            +
            + +

            +getFamily

            +
            +public String getFamily()
            +
            +
            Gets the name of the column family. +

            +

            +
            +
            +
            + +
            Returns:
            the family component of the column name.
            +
            +
            +
            + +

            +getFamilyBytes

            +
            +public byte[] getFamilyBytes()
            +
            +
            Gets the name of the column family as a byte array. + Caches the result for subsequent calls. This method returns a shared + array instance for all calls; do not modify the returned byte array. +

            +

            +
            +
            +
            + +
            Returns:
            the family component of the column name.
            +
            +
            +
            + +

            +getQualifier

            +
            +public String getQualifier()
            +
            +
            Gets the name of the column qualifier, which may be null or empty. +

            +

            +
            +
            +
            + +
            Returns:
            the qualifier component of the column name.
            +
            +
            +
            + +

            +getQualifierBytes

            +
            +public byte[] getQualifierBytes()
            +
            +
            Gets the name of the column qualifier as a byte array. + Caches the result for subsequent calls. This method returns a shared + array instance for all calls; do not modify the returned byte array. +

            +

            +
            +
            +
            + +
            Returns:
            the qualifier component of the column name.
            +
            +
            +
            + +

            +isFullyQualified

            +
            +public boolean isFullyQualified()
            +
            +
            Determines whether the name refers to a qualified family (vs. an entire family). +

            +

            +
            +
            +
            + +
            Returns:
            whether the column refers to a fully qualified family.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object otherObj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +compareTo

            +
            +public int compareTo(KijiColumnName o)
            +
            +
            +

            +

            +
            Specified by:
            compareTo in interface Comparable<KijiColumnName>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiConfiguration.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiConfiguration.html new file mode 100644 index 00000000..039702b3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiConfiguration.html @@ -0,0 +1,520 @@ + + + + + + + +KijiConfiguration (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiConfiguration

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.KijiConfiguration
+
            +
            +
            All Implemented Interfaces:
            Configurable
            +
            +
            +Deprecated. +

            +

            +
            @ApiAudience.Public
+@Deprecated
+public final class KijiConfiguration
            extends Configured
            + + +

            +

            The configuration for a single instance of Kiji, as a cluster could + contain multiple instances.

            + +

            An installed Kiji instance contains several tables: +

              +
            • System table: Kiji system and version information.
              • +
            • Meta table: Metadata about the existing Kiji tables.
              • +
            • Schema table: Avro Schemas of the cells in Kiji tables.
              • +
            • User tables: The user-space Kiji tables that you create.
              • +
            +

            + +

            The default Kiji instance name is default.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_KIJI_INSTANCE_NAME + +
            +          Deprecated. The Configuration variable to store the kiji instance name.
            +static StringDEFAULT_CONF_FILE + +
            +          Deprecated. The default Kiji configuration file.
            +static StringDEFAULT_INSTANCE_NAME + +
            +          Deprecated. The default kiji instance name.
            +  + + + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiConfiguration(Configuration conf, + KijiURI uri) + +
            +          Deprecated. Initializes a Kiji configuration from a Hadoop configuration and a Kiji URI.
            KijiConfiguration(Configuration conf, + String instanceName) + +
            +          Deprecated. Constructs a handle to a Kiji instance.
            KijiConfiguration(KijiConfiguration kijiConf) + +
            +          Deprecated. Constructs a deep copy of an existing Kiji configuration.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiConfigurationcreate(String name) + +
            +          Deprecated. Gets a handle to a Kiji instance using the default Kiji configuration file.
            +static KijiConfigurationcreate(String confFile, + String name) + +
            +          Deprecated. Gets a handle to a Kiji instance.
            + booleanexists() + +
            +          Deprecated. Determines whether this named Kiji instance exists.
            +protected  booleanexists(HBaseAdmin hbaseAdmin) + +
            +          Deprecated. Determines whether the Kiji instance exists according to the + given HBase admin interface.
            + StringgetName() + +
            +          Deprecated. Gets the name of this Kiji instance.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +DEFAULT_CONF_FILE

            +
            +public static final String DEFAULT_CONF_FILE
            +
            +
            Deprecated. 
            The default Kiji configuration file. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULT_INSTANCE_NAME

            +
            +public static final String DEFAULT_INSTANCE_NAME
            +
            +
            Deprecated. 
            The default kiji instance name. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_KIJI_INSTANCE_NAME

            +
            +public static final String CONF_KIJI_INSTANCE_NAME
            +
            +
            Deprecated. 
            The Configuration variable to store the kiji instance name. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +KijiConfiguration

            +
            +public KijiConfiguration(Configuration conf,
+                         String instanceName)
            +
            +
            Deprecated. 
            Constructs a handle to a Kiji instance. +

            +

            +
            Parameters:
            conf - A Configuration object that specifies the HBase cluster.
            instanceName - The name of the Kiji instance.
            +
            +
            + +

            +KijiConfiguration

            +
            +public KijiConfiguration(Configuration conf,
+                         KijiURI uri)
            +
            +
            Deprecated. 
            Initializes a Kiji configuration from a Hadoop configuration and a Kiji URI. +

            +

            +
            Parameters:
            conf - Hadoop configuration.
            uri - Kiji URI of the instance to initialize.
            +
            +
            + +

            +KijiConfiguration

            +
            +public KijiConfiguration(KijiConfiguration kijiConf)
            +
            +
            Deprecated. 
            Constructs a deep copy of an existing Kiji configuration. +

            +

            +
            Parameters:
            kijiConf - The Kiji configuration to copy.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiConfiguration create(String confFile,
+                                       String name)
+                                throws IOException
            +
            +
            Deprecated. 
            Gets a handle to a Kiji instance. + This method is useful if you cannot add the HBase configuration resources to the classpath of + your application (in an HTTP Servlet, for example). +

            +

            +
            Parameters:
            confFile - The path to a configuration file that specifies the location of HBase cluster + resources.
            name - The name of the Kiji instance. +
            Returns:
            A handle to a Kiji instance. +
            Throws: +
            IOException - If there is an error reading the configuration file.
            +
            +
            +
            + +

            +create

            +
            +public static KijiConfiguration create(String name)
+                                throws IOException
            +
            +
            Deprecated. 
            Gets a handle to a Kiji instance using the default Kiji configuration file. + This method is useful if you cannot add the HBase configuration resources to the classpath of + your application (in an HTTP Servlet, for example). +

            +

            +
            Parameters:
            name - The name of the Kiji instance. +
            Returns:
            A handle to a Kiji instance. +
            Throws: +
            IOException - If there is an error reading the configuration file.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Deprecated. 
            Gets the name of this Kiji instance. +

            +

            + +
            Returns:
            The name of the Kiji instance.
            +
            +
            +
            + +

            +exists

            +
            +public boolean exists()
+               throws IOException
            +
            +
            Deprecated. 
            Determines whether this named Kiji instance exists. +

            +

            + +
            Returns:
            Whether this Kiji instance exists in the HBase cluster. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +exists

            +
            +protected boolean exists(HBaseAdmin hbaseAdmin)
+                  throws IOException
            +
            +
            Deprecated. 
            Determines whether the Kiji instance exists according to the + given HBase admin interface. +

            +

            +
            Parameters:
            hbaseAdmin - The HBase interface to use. +
            Returns:
            Whether the Kiji instance exists. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCounter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCounter.html new file mode 100644 index 00000000..f50276b8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiCounter.html @@ -0,0 +1,248 @@ + + + + + + + +KijiCounter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCounter

            +
            +
            All Known Implementing Classes:
            DefaultKijiCounter
            +
            +
            +Deprecated. KijiCounter will be merged into KijiCell. +

            +

            +
            @ApiAudience.Public
+@Deprecated
+@Inheritance.Sealed
+public interface KijiCounter
            + + +

            +A counter value stored in a column of a Kiji table. + +

            Use a KijiTableWriter to increment a counter value.

            +

            + +

            +

            +
            See Also:
            KijiIncrementer.increment(EntityId, String, String, long)
            +
            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + longgetTimestamp() + +
            +          Deprecated. Gets the timestamp at which the counter was incremented.
            + longgetValue() + +
            +          Deprecated. Gets the value of the counter.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTimestamp

            +
            +long getTimestamp()
            +
            +
            Deprecated. 
            Gets the timestamp at which the counter was incremented. +

            +

            + +
            Returns:
            A timestamp, in milliseconds since the epoch.
            +
            +
            +
            + +

            +getValue

            +
            +long getValue()
            +
            +
            Deprecated. 
            Gets the value of the counter. +

            +

            + +
            Returns:
            The value of the counter, which is zero if the counter has never been incremented.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequest.Column.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequest.Column.html new file mode 100644 index 00000000..738337e2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequest.Column.html @@ -0,0 +1,663 @@ + + + + + + + +KijiDataRequest.Column (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequest.Column

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequest.Column
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Enclosing class:
            KijiDataRequest
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiDataRequest.Column
            extends Object
            implements Serializable
            + + +

            +Describes a request for a Kiji Table column. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiDataRequest.Column(KijiColumnName name) + +
            +          Creates a new requested Column.
            KijiDataRequest.Column(String family) + +
            +          Creates a new request for the latest version of the cells in family.
            KijiDataRequest.Column(String family, + byte[] key) + +
            +          Creates a new request for the latest version of the cell in family:key.
            KijiDataRequest.Column(String family, + String key) + +
            +          Creates a new request for the latest version of the cell in family:key.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            + KijiColumnNamegetColumnName() + +
            +          Gets the column name.
            + StringgetFamily() + +
            +          Gets the name of the requested column family.
            + KijiColumnFiltergetFilter() + +
            +          Gets the column filter, or null if no filter was specified.
            + StringgetKey() + +
            +          Gets the name of the requested column qualifier, which may be null if any qualifier + should be included.
            + intgetMaxVersions() + +
            +          Gets the max number of most recent versions in this request.
            + StringgetName() + +
            +          Gets the full name of the requested column.
            + intgetPageSize() + +
            +          Gets the number of cells to return per page of results.
            + inthashCode() + +
            +          
            + booleanisPagingEnabled() + +
            +          Determines whether paging is enabled for this column.
            + StringtoString() + +
            +          
            + KijiDataRequest.ColumnwithFilter(KijiColumnFilter filter) + +
            +          Sets a filter to use on the column.
            + KijiDataRequest.ColumnwithMaxVersions(int num) + +
            +          Sets the maximum number of the most recent versions to return.
            + KijiDataRequest.ColumnwithPageSize(int cellsPerPage) + +
            +          Sets the number of cells per page (defaults to zero, which means paging is disabled).
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiDataRequest.Column

            +
            +public KijiDataRequest.Column(KijiColumnName name)
            +
            +
            Creates a new requested Column. +

            +

            +
            Parameters:
            name - The name of the column to request.
            +
            +
            + +

            +KijiDataRequest.Column

            +
            +public KijiDataRequest.Column(String family)
            +
            +
            Creates a new request for the latest version of the cells in family. +

            +

            +
            Parameters:
            family - The name of the column family to request.
            +
            +
            + +

            +KijiDataRequest.Column

            +
            +public KijiDataRequest.Column(String family,
+                              String key)
            +
            +
            Creates a new request for the latest version of the cell in family:key. +

            +

            +
            Parameters:
            family - The name of the column family to request.
            key - The name of the column qualifier to request.
            +
            +
            + +

            +KijiDataRequest.Column

            +
            +public KijiDataRequest.Column(String family,
+                              byte[] key)
            +
            +
            Creates a new request for the latest version of the cell in family:key. +

            +

            +
            Parameters:
            family - The name of the column family to request.
            key - The name of the column qualifier to request.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +withMaxVersions

            +
            +public KijiDataRequest.Column withMaxVersions(int num)
            +
            +
            Sets the maximum number of the most recent versions to return. +

            +

            +
            +
            +
            +
            Parameters:
            num - The maximum number of versions of the cell to read. +
            Returns:
            This column request instance.
            +
            +
            +
            + +

            +withFilter

            +
            +public KijiDataRequest.Column withFilter(KijiColumnFilter filter)
            +
            +
            Sets a filter to use on the column. +

            +

            +
            +
            +
            +
            Parameters:
            filter - The column filter; +
            Returns:
            This column request instance.
            +
            +
            +
            + +

            +withPageSize

            +
            +public KijiDataRequest.Column withPageSize(int cellsPerPage)
            +
            +
            Sets the number of cells per page (defaults to zero, which means paging is disabled). +

            +

            +
            +
            +
            +
            Parameters:
            cellsPerPage - The number of cells to return in each page of results. Use 0 to + disable paging and return all results at once. +
            Returns:
            This column request instance.
            +
            +
            +
            + +

            +getFamily

            +
            +public String getFamily()
            +
            +
            Gets the name of the requested column family. +

            +

            +
            +
            +
            + +
            Returns:
            A column family name.
            +
            +
            +
            + +

            +getKey

            +
            +public String getKey()
            +
            +
            Gets the name of the requested column qualifier, which may be null if any qualifier + should be included. +

            +

            +
            +
            +
            + +
            Returns:
            A column qualifier name (may be null or empty).
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +

            Gets the full name of the requested column.

            + +

            Note: A request for column "foo" means that all columns within the family "foo" + should be requested, whereas a request for column "foo:" means that the single + column with qualifier "" (empty) should be returned from the family "foo". +

            +

            +
            +
            +
            + +
            Returns:
            A column name.
            +
            +
            +
            + +

            +getColumnName

            +
            +public KijiColumnName getColumnName()
            +
            +
            Gets the column name. +

            +

            +
            +
            +
            + +
            Returns:
            The column name.
            +
            +
            +
            + +

            +getMaxVersions

            +
            +public int getMaxVersions()
            +
            +
            Gets the max number of most recent versions in this request. +

            +

            +
            +
            +
            + +
            Returns:
            A number of versions.
            +
            +
            +
            + +

            +getFilter

            +
            +public KijiColumnFilter getFilter()
            +
            +
            Gets the column filter, or null if no filter was specified. +

            +

            +
            +
            +
            + +
            Returns:
            The column filter, or null.
            +
            +
            +
            + +

            +getPageSize

            +
            +public int getPageSize()
            +
            +
            Gets the number of cells to return per page of results. +

            +

            +
            +
            +
            + +
            Returns:
            The page size (or 0 if paging is disabled).
            +
            +
            +
            + +

            +isPagingEnabled

            +
            +public boolean isPagingEnabled()
            +
            +
            Determines whether paging is enabled for this column. +

            +

            +
            +
            +
            + +
            Returns:
            Whether paging is enabled.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequest.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequest.html new file mode 100644 index 00000000..f07b13bf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequest.html @@ -0,0 +1,625 @@ + + + + + + + +KijiDataRequest (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequest

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequest
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiDataRequest
            extends Object
            implements Serializable
            + + +

            +

            Describes a request for columns of data to read from a Kiji table.

            + +

            To request the 3 most recent versions of cell data from a column bar from + the family foo within the time range (123, 456]: + + 

            + KijiDataRequest dataRequest = new KijiDataRequest()
+     .withTimeRange(123L, 456L)
+     .addColumn(new KijiDataRequest.Column("foo", "bar").withMaxVersions(3));
+
            + +

            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiDataRequest.Column + +
            +          Describes a request for a Kiji Table column.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            KijiDataRequest() + +
            +          Constructor.
            KijiDataRequest(KijiDataRequest copy) + +
            +          Creates a new KijiDataRequest from a copy.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestaddColumn(KijiDataRequest.Column column) + +
            +          Add a request for a column to this data request.
            + booleanequals(Object other) + +
            +          
            + KijiDataRequest.ColumngetColumn(String family, + String key) + +
            +          Gets a Column requested named "family:key", or + null if none exists.
            + Collection<KijiDataRequest.Column>getColumns() + +
            +          Gets the collection of requested columns.
            + longgetMaxTimestamp() + +
            +          Gets the maximum timestamp for versions in this request (exclusive).
            + longgetMinTimestamp() + +
            +          Gets the minimum timestamp for versions in this request (inclusive).
            + inthashCode() + +
            +          
            + booleanisEmpty() + +
            +          Determines whether this data request has any columns.
            + booleanisPagingEnabled() + +
            +          Determines whether paging is enabled on any of the columns in this request.
            + booleanisTimestampInRange(long ts) + +
            +          Determines whether a timestamp ts is within the time range for this + request.
            + KijiDataRequestmerge(KijiDataRequest other) + +
            +          Merges the requested columns in other into this data request.
            + StringtoString() + +
            +          
            + KijiDataRequestwithTimeRange(long minTimestamp, + long maxTimestamp) + +
            +          Sets the time range of cells to return: [minTimestamp, + maxTimestamp).
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiDataRequest

            +
            +public KijiDataRequest()
            +
            +
            Constructor. +

            +

            +
            + +

            +KijiDataRequest

            +
            +public KijiDataRequest(KijiDataRequest copy)
            +
            +
            Creates a new KijiDataRequest from a copy. +

            +

            +
            Parameters:
            copy - The KijiDataRequest to copy.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +addColumn

            +
            +public KijiDataRequest addColumn(KijiDataRequest.Column column)
            +
            +
            Add a request for a column to this data request. Only the most recent request for a + particular column is kept if multiple requests for the same column name are added. +

            +

            +
            +
            +
            +
            Parameters:
            column - The column request. +
            Returns:
            This KijiDataRequest instance.
            +
            +
            +
            + +

            +withTimeRange

            +
            +public KijiDataRequest withTimeRange(long minTimestamp,
+                                     long maxTimestamp)
            +
            +
            Sets the time range of cells to return: [minTimestamp, + maxTimestamp). +

            +

            +
            +
            +
            +
            Parameters:
            minTimestamp - Request cells with a timestamp at least minTimestamp.
            maxTimestamp - Request cells with a timestamp less than maxTimestamp. +
            Returns:
            This data request instance.
            +
            +
            +
            + +

            +merge

            +
            +public KijiDataRequest merge(KijiDataRequest other)
            +
            +
            Merges the requested columns in other into this data request. +

            +

            +
            +
            +
            +
            Parameters:
            other - Another data request to include as a part of this one. +
            Returns:
            This KijiDataRequest instance, mutated to include the other requested columns.
            +
            +
            +
            + +

            +getColumn

            +
            +public KijiDataRequest.Column getColumn(String family,
+                                        String key)
            +
            +
            Gets a Column requested named "family:key", or + null if none exists. +

            +

            +
            +
            +
            +
            Parameters:
            family - The requested column family name.
            key - The requested column qualifier name. +
            Returns:
            The requested column.
            +
            +
            +
            + +

            +isEmpty

            +
            +public boolean isEmpty()
            +
            +
            Determines whether this data request has any columns. +

            +

            +
            +
            +
            + +
            Returns:
            Whether any data has been requested.
            +
            +
            +
            + +

            +getColumns

            +
            +public Collection<KijiDataRequest.Column> getColumns()
            +
            +
            Gets the collection of requested columns. +

            +

            +
            +
            +
            + +
            Returns:
            All the requested column specs.
            +
            +
            +
            + +

            +getMinTimestamp

            +
            +public long getMinTimestamp()
            +
            +
            Gets the minimum timestamp for versions in this request (inclusive). +

            +

            +
            +
            +
            + +
            Returns:
            A minimum timestamp (milliseconds since the epoch).
            +
            +
            +
            + +

            +getMaxTimestamp

            +
            +public long getMaxTimestamp()
            +
            +
            Gets the maximum timestamp for versions in this request (exclusive). +

            +

            +
            +
            +
            + +
            Returns:
            A maximum timestamp (milliseconds since the epoch).
            +
            +
            +
            + +

            +isTimestampInRange

            +
            +public boolean isTimestampInRange(long ts)
            +
            +
            Determines whether a timestamp ts is within the time range for this + request. +

            +

            +
            +
            +
            +
            Parameters:
            ts - The timestamp to check. +
            Returns:
            Whether the timestamp is within the range of this request.
            +
            +
            +
            + +

            +isPagingEnabled

            +
            +public boolean isPagingEnabled()
            +
            +
            Determines whether paging is enabled on any of the columns in this request. +

            +

            +
            +
            +
            + +
            Returns:
            Whether paging is enabled.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequestException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequestException.html new file mode 100644 index 00000000..cbdadd51 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequestException.html @@ -0,0 +1,251 @@ + + + + + + + +KijiDataRequestException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequestException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiDataRequestException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiDataRequestException
            extends RuntimeException
            + + +

            +Thrown when there is an error validating a KijiDataRequest against a Kiji table. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiDataRequestException(String message) + +
            +          Creates a new KijiDataRequestException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiDataRequestException

            +
            +public KijiDataRequestException(String message)
            +
            +
            Creates a new KijiDataRequestException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequestValidator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequestValidator.html new file mode 100644 index 00000000..58de46d8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDataRequestValidator.html @@ -0,0 +1,269 @@ + + + + + + + +KijiDataRequestValidator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequestValidator

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequestValidator
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiDataRequestValidator
            extends Object
            + + +

            +This class validates a KijiDataRequest against the layout + of a Kiji table to make sure it contains all of the columns requested. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiDataRequestValidator(KijiDataRequest dataRequest) + +
            +          Construct a validator for a data request.
            +  + + + + + + + + + + + +
            +Method Summary
            + voidvalidate(KijiTableLayout tableLayout) + +
            +          Validates the data request against the given table layout.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiDataRequestValidator

            +
            +public KijiDataRequestValidator(KijiDataRequest dataRequest)
            +
            +
            Construct a validator for a data request. +

            +

            +
            Parameters:
            dataRequest - The data request to validate.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +validate

            +
            +public void validate(KijiTableLayout tableLayout)
+              throws InvalidLayoutException
            +
            +
            Validates the data request against the given table layout. +

            +

            +
            Parameters:
            tableLayout - The Kiji table layout to validate against. +
            Throws: +
            InvalidLayoutException - If the table layout is invalid. +
            KijiDataRequestException - If the data request is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDeleter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDeleter.html new file mode 100644 index 00000000..ee5656d7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiDeleter.html @@ -0,0 +1,468 @@ + + + + + + + +KijiDeleter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiDeleter

            +
            +
            All Superinterfaces:
            Closeable, Flushable
            +
            +
            +
            All Known Subinterfaces:
            KijiTableWriter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiDeleter
            extends Closeable, Flushable
            + + +

            +Interface for performing deletes on a Kiji table. + + Instantiated via KijiTable.openTableWriter() +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voiddeleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voiddeleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voiddeleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voiddeleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +deleteRow

            +
            +void deleteRow(EntityId entityId)
+               throws IOException
            +
            +
            Deletes an entire row. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteRow

            +
            +void deleteRow(EntityId entityId,
+               long upToTimestamp)
+               throws IOException
            +
            +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +void deleteFamily(EntityId entityId,
+                  String family)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a family. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +void deleteFamily(EntityId entityId,
+                  String family,
+                  long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +void deleteColumn(EntityId entityId,
+                  String family,
+                  String qualifier)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a column. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +void deleteColumn(EntityId entityId,
+                  String family,
+                  String qualifier,
+                  long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +void deleteCell(EntityId entityId,
+                String family,
+                String qualifier)
+                throws IOException
            +
            +
            Deletes the most recent version of the cell in a column. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +void deleteCell(EntityId entityId,
+                String family,
+                String qualifier,
+                long timestamp)
+                throws IOException
            +
            +
            Deletes a single cell with a specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            timestamp - The timestamp of the cell to delete (use HConstants.LATEST_TIMESTAMP + to delete the most recent cell in the column). +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiEncodingException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiEncodingException.html new file mode 100644 index 00000000..e7faa8bb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiEncodingException.html @@ -0,0 +1,289 @@ + + + + + + + +KijiEncodingException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiEncodingException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiEncodingException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiEncodingException
            extends RuntimeException
            + + +

            +Runtime exception thrown when encoding a cell's content fails. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiEncodingException(String message) + +
            +          Initializes an encoding exception.
            KijiEncodingException(String message, + Throwable throwable) + +
            +          Initializes an encoding exception.
            KijiEncodingException(Throwable throwable) + +
            +          Initializes an encoding exception.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiEncodingException

            +
            +public KijiEncodingException(String message)
            +
            +
            Initializes an encoding exception. +

            +

            +
            Parameters:
            message - Error message.
            +
            +
            + +

            +KijiEncodingException

            +
            +public KijiEncodingException(String message,
+                             Throwable throwable)
            +
            +
            Initializes an encoding exception. +

            +

            +
            Parameters:
            message - Error message.
            throwable - Underlying exception, if any.
            +
            +
            + +

            +KijiEncodingException

            +
            +public KijiEncodingException(Throwable throwable)
            +
            +
            Initializes an encoding exception. +

            +

            +
            Parameters:
            throwable - Underlying exception, if any.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiFactory.html new file mode 100644 index 00000000..c8caefae --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiFactory.html @@ -0,0 +1,299 @@ + + + + + + + +KijiFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiFactory

            +
            +
            All Superinterfaces:
            org.kiji.delegation.PriorityProvider
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiFactory
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiFactory
            extends org.kiji.delegation.PriorityProvider
            + + +

            +Factory for Kiji instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Kijiopen(KijiConfiguration kijiConf) + +
            +          Deprecated. 
            + Kijiopen(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + Kijiopen(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +  + + + + + + + +
            Methods inherited from interface org.kiji.delegation.PriorityProvider
            getPriority
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +open

            +
            +Kiji open(KijiURI uri)
+          throws IOException
            +
            +
            Opens a Kiji instance by URI. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI specifying the Kiji instance to open. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +open

            +
            +Kiji open(KijiURI uri,
+          Configuration conf)
+          throws IOException
            +
            +
            Opens a Kiji instance by URI. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI specifying the Kiji instance to open.
            conf - Hadoop configuration. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +open

            +
            +@Deprecated
+Kiji open(KijiConfiguration kijiConf)
+          throws IOException
            +
            +
            Deprecated.  +

            +

            Opens a Kiji instance. This method of opening a Kiji instance has been deprecated + in favor of a method that doesn't use KijiConfiguration. +

            +

            +
            +
            +
            +
            Parameters:
            kijiConf - The configuration. +
            Returns:
            An opened kiji instance. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiIncrementer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiIncrementer.html new file mode 100644 index 00000000..bfd522c8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiIncrementer.html @@ -0,0 +1,259 @@ + + + + + + + +KijiIncrementer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiIncrementer

            +
            +
            All Superinterfaces:
            Closeable, Flushable
            +
            +
            +
            All Known Subinterfaces:
            KijiTableWriter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiIncrementer
            extends Closeable, Flushable
            + + +

            +Interface for performing increments on a Kiji table. + + Instantiated via KijiTable.openTableWriter() +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + KijiCounterincrement(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +increment

            +
            +KijiCounter increment(EntityId entityId,
+                      String family,
+                      String qualifier,
+                      long amount)
+                      throws IOException
            +
            +
            Atomically increments a counter in a kiji table. + +

            Throws an exception if the specified column is not a counter.

            +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row containing the counter.
            family - Column family.
            qualifier - Column qualifier.
            amount - Amount to increment the counter (may be negative). +
            Returns:
            the new counter value, post increment. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiInstaller.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiInstaller.html new file mode 100644 index 00000000..a1bbddcd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiInstaller.html @@ -0,0 +1,323 @@ + + + + + + + +KijiInstaller (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiInstaller

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiInstaller
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiInstaller
            extends Object
            + + +

            +Installs or uninstalls Kiji instances from an HBase cluster. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidinstall(KijiURI uri, + Configuration conf) + +
            +          Installs the specified Kiji instance.
            +static voidinstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            +static voiduninstall(KijiURI uri, + Configuration conf) + +
            +          Uninstalls the specified Kiji instance.
            +static voiduninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +install

            +
            +public static void install(KijiURI uri,
+                           Configuration conf)
+                    throws IOException,
+                           KijiInvalidNameException
            +
            +
            Installs the specified Kiji instance. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to install.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error. +
            KijiInvalidNameException - if the Kiji instance name is invalid or already exists.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(KijiURI uri,
+                             Configuration conf)
+                      throws IOException,
+                             KijiInvalidNameException
            +
            +
            Uninstalls the specified Kiji instance. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to uninstall.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error. +
            KijiInvalidNameException - if the instance name is invalid or already exists.
            +
            +
            +
            + +

            +install

            +
            +public static void install(KijiURI uri,
+                           HBaseFactory hbaseFactory,
+                           Configuration conf)
+                    throws IOException,
+                           KijiInvalidNameException
            +
            +
            Installs a Kiji instance. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to install.
            hbaseFactory - Factory for HBase instances.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error. +
            KijiInvalidNameException - if the instance name is invalid or already exists.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(KijiURI uri,
+                             HBaseFactory hbaseFactory,
+                             Configuration conf)
+                      throws IOException,
+                             KijiInvalidNameException
            +
            +
            Removes a kiji instance from the HBase cluster including any user tables. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to install.
            hbaseFactory - Factory for HBase instances.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error. +
            KijiInvalidNameException - if the instance name is invalid. +
            KijiNotInstalledException - if the specified instance does not exist.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiInvalidNameException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiInvalidNameException.html new file mode 100644 index 00000000..02425656 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiInvalidNameException.html @@ -0,0 +1,250 @@ + + + + + + + +KijiInvalidNameException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiInvalidNameException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.KijiInvalidNameException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiInvalidNameException
            extends Exception
            + + +

            +Thrown when a Kiji instance or table layout name is invalid. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiInvalidNameException(String message) + +
            +          Creates a new KijiInvalidNameException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiInvalidNameException

            +
            +public KijiInvalidNameException(String message)
            +
            +
            Creates a new KijiInvalidNameException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiManagedHBaseTableName.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiManagedHBaseTableName.html new file mode 100644 index 00000000..dddecf6d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiManagedHBaseTableName.html @@ -0,0 +1,608 @@ + + + + + + + +KijiManagedHBaseTableName (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiManagedHBaseTableName

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiManagedHBaseTableName
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiManagedHBaseTableName
            extends Object
            + + +

            +

            Multiple instances of Kiji can be installed on a single HBase + cluster. Within a Kiji instance, several HBase tables are created + to manage system, metadata, schemas, and user-space tables. This + class represents the name of one of those HBase tables that are + created and managed by Kiji.

            + +

            + The names of tables in HBase created and managed by Kiji are + made of a list of delimited components. There are at least 3 + components of a name: + +

              +
            1. + Prefix: a literal string "kiji" used to mark that this table + is managed by Kiji. +
              2. +
            2. + KijiInstance: the name of kiji instance managing this table. +
              3. +
            3. + Type: the type of table (system, schema, meta, table). +
              4. +
            + + If the type of the table is "table", then it's name (the name users + of Kiji would use to refer to it) is the fourth and final component. +

            + +

            + For example, an HBase cluster might have the following tables: + 

            + devices
+ kiji.default.meta
+ kiji.default.schema
+ kiji.default.schema_hash
+ kiji.default.schema_id
+ kiji.default.system
+ kiji.default.table.foo
+ kiji.default.table.bar
+ kiji.experimental.meta
+ kiji.experimental.schema
+ kiji.experimental.schema_hash
+ kiji.experimental.schema_id
+ kiji.experimental.system
+ kiji.experimental.table.baz
+
            + + In this example, there is an HBase table completely unrelated to + kiji called "devices." There are two kiji installations, once + called "default" and another called "experimental." Within the + "default" installation, there are two Kiji tables, "foo" and + "bar." Within the "experimental" installation, there is a single + Kiji table "baz." +

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringKIJI_COMPONENT + +
            +          The first component of all HBase table names managed by Kiji.
            +static PatternKIJI_SYSTEM_TABLES_REGEX + +
            +          Regexp matching Kiji system tables.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +           
            +static KijiManagedHBaseTableNameget(String hbaseTableName) + +
            +          Constructs using an HBase HTable name.
            + StringgetKijiInstanceName() + +
            +          Gets the name of the Kiji instance this named table belongs to.
            + StringgetKijiTableName() + +
            +          Gets the name of the Kiji table.
            +static KijiManagedHBaseTableNamegetKijiTableName(String kijiInstanceName, + String kijiTableName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table.
            +static KijiManagedHBaseTableNamegetMetaTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table.
            +static KijiManagedHBaseTableNamegetSchemaHashTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table.
            +static KijiManagedHBaseTableNamegetSchemaIdTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table.
            +static KijiManagedHBaseTableNamegetSchemaV5TableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table.
            +static KijiManagedHBaseTableNamegetSystemTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table.
            + inthashCode() + +
            +           
            + byte[]toBytes() + +
            +          Gets the name of the HBase table that stores the data for this Kiji table.
            + StringtoString() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +KIJI_COMPONENT

            +
            +public static final String KIJI_COMPONENT
            +
            +
            The first component of all HBase table names managed by Kiji. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_SYSTEM_TABLES_REGEX

            +
            +public static final Pattern KIJI_SYSTEM_TABLES_REGEX
            +
            +
            Regexp matching Kiji system tables. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiManagedHBaseTableName get(String hbaseTableName)
+                                     throws NotAKijiManagedTableException
            +
            +
            Constructs using an HBase HTable name. +

            +

            +
            Parameters:
            hbaseTableName - The HBase HTable name. +
            Returns:
            A new kiji-managed HBase table name. +
            Throws: +
            NotAKijiManagedTableException - If the HBase table is not managed by kiji.
            +
            +
            +
            + +

            +getMetaTableName

            +
            +public static KijiManagedHBaseTableName getMetaTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji meta table.
            +
            +
            +
            + +

            +getSchemaV5TableName

            +
            +public static KijiManagedHBaseTableName getSchemaV5TableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji schema table up until layout v5.
            +
            +
            +
            + +

            +getSchemaHashTableName

            +
            +public static KijiManagedHBaseTableName getSchemaHashTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji schema hash table.
            +
            +
            +
            + +

            +getSchemaIdTableName

            +
            +public static KijiManagedHBaseTableName getSchemaIdTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji schema IDs table.
            +
            +
            +
            + +

            +getSystemTableName

            +
            +public static KijiManagedHBaseTableName getSystemTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji system table.
            +
            +
            +
            + +

            +getKijiTableName

            +
            +public static KijiManagedHBaseTableName getKijiTableName(String kijiInstanceName,
+                                                         String kijiTableName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance.
            kijiTableName - The name of the user-space Kiji table. +
            Returns:
            The name of the HBase table used to store the user-space Kiji table.
            +
            +
            +
            + +

            +getKijiInstanceName

            +
            +public String getKijiInstanceName()
            +
            +
            Gets the name of the Kiji instance this named table belongs to. +

            +

            + +
            Returns:
            The name of the kiji instance.
            +
            +
            +
            + +

            +getKijiTableName

            +
            +public String getKijiTableName()
            +
            +
            Gets the name of the Kiji table. +

            +

            + +
            Returns:
            The name of the kiji table, or null if this is not a user-space Kiji table.
            +
            +
            +
            + +

            +toBytes

            +
            +public byte[] toBytes()
            +
            +
            Gets the name of the HBase table that stores the data for this Kiji table. +

            +

            + +
            Returns:
            The HBase table name as a UTF-8 encoded byte array.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiMetaTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiMetaTable.html new file mode 100644 index 00000000..17193ef8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiMetaTable.html @@ -0,0 +1,412 @@ + + + + + + + +KijiMetaTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiMetaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiMetaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTableKeyValueDatabase, KijiTableLayoutDatabase
            +
            +
            +
            Direct Known Subclasses:
            HBaseMetaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public abstract class KijiMetaTable
            extends Object
            implements Closeable, KijiTableLayoutDatabase, KijiTableKeyValueDatabase
            + + +

            +The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis. +

            + +

            +

            +
            See Also:
            KijiSchemaTable, +KijiSystemTable
            +
            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected KijiMetaTable() + +
            +          Creates a new KijiMetaTable instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +abstract  voiddeleteTable(String table) + +
            +          Remove all metadata, including layouts, for a particular table.
            +protected  voidfinalize() + +
            +          
            +abstract  voidfromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            +abstract  Map<String,TableBackup>toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.layout.KijiTableLayoutDatabase
            getTableLayout, getTableLayoutVersions, getTimedTableLayoutVersions, layoutsFromBackup, layoutsToBackup, listTables, removeAllTableLayoutVersions, removeRecentTableLayoutVersions, updateTableLayout
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiTableKeyValueDatabase
            getTimedValues, getValue, getValues, keySet, keyValuesFromBackup, keyValuesToBackup, putValue, removeAllValues, removeValues, tableSet
            +  +

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

            +KijiMetaTable

            +
            +protected KijiMetaTable()
            +
            +
            Creates a new KijiMetaTable instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +deleteTable

            +
            +public abstract void deleteTable(String table)
+                          throws IOException
            +
            +
            Remove all metadata, including layouts, for a particular table. +

            +

            +
            +
            +
            +
            Parameters:
            table - The name of the kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +toBackup

            +
            +public abstract Map<String,TableBackup> toBackup()
+                                          throws IOException
            +
            +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            +
            +
            + +
            Returns:
            A map from table names to TableBackup records. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public abstract void fromBackup(Map<String,TableBackup> backup)
+                         throws IOException
            +
            +
            Restores metadata from a backup record. This consists of table layouts, schemas, and user + defined key-value pairs. +

            +

            +
            +
            +
            +
            Parameters:
            backup - A map from table name to table backup record. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiNotInstalledException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiNotInstalledException.html new file mode 100644 index 00000000..4117be69 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiNotInstalledException.html @@ -0,0 +1,284 @@ + + + + + + + +KijiNotInstalledException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiNotInstalledException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiNotInstalledException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiNotInstalledException
            extends RuntimeException
            + + +

            +Thrown when attempting to open a non existing/not installed Kiji instance. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiNotInstalledException(String message, + String instanceName) + +
            +          Creates a new KijiNotInstalledException with the specified + detail message.
            +  + + + + + + + + + + + +
            +Method Summary
            + StringgetInstanceName() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiNotInstalledException

            +
            +public KijiNotInstalledException(String message,
+                                 String instanceName)
            +
            +
            Creates a new KijiNotInstalledException with the specified + detail message. +

            +

            +
            Parameters:
            message - The exception message.
            instanceName - the Kiji instance name that is not installed.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getInstanceName

            +
            +public String getInstanceName()
            +
            +
            + +
            Returns:
            the name of the missing Kiji instance.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiPutter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiPutter.html new file mode 100644 index 00000000..e4313875 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiPutter.html @@ -0,0 +1,305 @@ + + + + + + + +KijiPutter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiPutter

            +
            +
            All Superinterfaces:
            Closeable, Flushable
            +
            +
            +
            All Known Subinterfaces:
            KijiTableWriter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiPutter
            extends Closeable, Flushable
            + + +

            +Interface for performing puts on a Kiji table. + + Instantiated via KijiTable.openTableWriter() +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +put

            +
            +<T> void put(EntityId entityId,
+             String family,
+             String qualifier,
+             T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +put

            +
            +<T> void put(EntityId entityId,
+             String family,
+             String qualifier,
+             long timestamp,
+             T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            timestamp - Timestamp, in millisecond since the Epoch.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiRowData.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiRowData.html new file mode 100644 index 00000000..922fca7e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiRowData.html @@ -0,0 +1,822 @@ + + + + + + + +KijiRowData (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiRowData

            +
            +
            All Known Implementing Classes:
            HBaseKijiRowData
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiRowData
            + + +

            +The input data for a single entity in Kiji. Implementations should be thread-safe. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleancontainsColumn(String family) + +
            +          Determines whether a particular column family has any data in this row.
            + booleancontainsColumn(String family, + String qualifier) + +
            +          Determines whether a particular column has data in this row.
            + + + + + +
            +<T> KijiCell<T>
            +            		getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		getCells(String family) + +
            +          Gets all the timestamp-cell pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		getCells(String family, + String qualifier) + +
            +          Gets all the timestamp-cell pairs stored within the specified cell.
            + KijiCountergetCounter(String family, + String qualifier) + +
            +          Gets the most recent counter from a column.
            + KijiCountergetCounter(String family, + String qualifier, + long timestamp) + +
            +          Reads a counter as it was at a particular timestamp.
            + EntityIdgetEntityId() + +
            +          Gets the entity id for this row of kiji data.
            + + + + + +
            +<T> KijiCell<T>
            +            		getMostRecentCell(String family, + String qualifier) + +
            +          Gets the latest version of the specified cell.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		getMostRecentCells(String family) + +
            +          Gets the latest version of the specified cell.
            + + + + + +
            +<T> T
            +            		getMostRecentValue(String family, + String qualifier) + +
            +          Gets the value with the latest timestamp stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,T>
            +            		getMostRecentValues(String family) + +
            +          Gets the value with the latest timestamp stored within the specified cell.
            + NavigableSet<String>getQualifiers(String family) + +
            +          Gets the set of column qualifiers that exist in a family.
            + org.apache.avro.SchemagetReaderSchema(String family, + String qualifier) + +
            +          Gets the reader schema for a column as declared in the layout of the table this row + comes from.
            + NavigableSet<Long>getTimestamps(String family, + String qualifier) + +
            +          Gets the set of timestamps on cells that exist in a column.
            + + + + + +
            +<T> T
            +            		getValue(String family, + String qualifier, + long timestamp) + +
            +          Gets the value stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,T>>
            +            		getValues(String family) + +
            +          Gets all the timestamp-value pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,T>
            +            		getValues(String family, + String qualifier) + +
            +          Gets all the timestamp-value pairs stored within the specified cell.
            + booleannextPage(String family) + +
            +          Populates the next page of cells for a requested column family.
            + booleannextPage(String family, + String qualifier) + +
            +          Populates the next page of cells for a column.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEntityId

            +
            +EntityId getEntityId()
            +
            +
            Gets the entity id for this row of kiji data. +

            +

            + +
            Returns:
            The row key.
            +
            +
            +
            + +

            +containsColumn

            +
            +boolean containsColumn(String family,
+                       String qualifier)
            +
            +
            Determines whether a particular column has data in this row. +

            +

            +
            Parameters:
            family - A column family.
            qualifier - A column qualifier. +
            Returns:
            Whether the column has data in this row.
            +
            +
            +
            + +

            +containsColumn

            +
            +boolean containsColumn(String family)
            +
            +
            Determines whether a particular column family has any data in this row. +

            +

            +
            Parameters:
            family - A column family. +
            Returns:
            Whether the family has data in this row.
            +
            +
            +
            + +

            +getQualifiers

            +
            +NavigableSet<String> getQualifiers(String family)
            +
            +
            Gets the set of column qualifiers that exist in a family. +

            +

            +
            Parameters:
            family - A column family name. +
            Returns:
            The set of column qualifiers that exist in family.
            +
            +
            +
            + +

            +getTimestamps

            +
            +NavigableSet<Long> getTimestamps(String family,
+                                 String qualifier)
            +
            +
            Gets the set of timestamps on cells that exist in a column. + +

            If iterating over the set, you will get items in order of decreasing timestamp.

            +

            +

            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The set of all timestamps of cells in the family:qualifier column.
            +
            +
            +
            + +

            +getReaderSchema

            +
            +org.apache.avro.Schema getReaderSchema(String family,
+                                       String qualifier)
+                                       throws IOException
            +
            +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +

            +

            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The Avro reader schema for the column. +
            Throws: +
            IOException - If there is an error or the column does not exist.
            +
            +
            +
            + +

            +getCounter

            +
            +KijiCounter getCounter(String family,
+                       String qualifier)
+                       throws IOException
            +
            +
            Gets the most recent counter from a column. + +

            Only columns that have been declared with <schema type="counter"/> may be + read using this method, otherwise an exception is thrown.

            +

            +

            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The most recent counter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCounter

            +
            +KijiCounter getCounter(String family,
+                       String qualifier,
+                       long timestamp)
+                       throws IOException
            +
            +
            Reads a counter as it was at a particular timestamp. + +

            Only columns that have been declared with <schema type="counter"/> may be + read using this method, otherwise an exception is thrown.

            +

            +

            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            The counter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValue

            +
            +<T> T getValue(String family,
+               String qualifier,
+               long timestamp)
+           throws IOException
            +
            +
            Gets the value stored within the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. Use #containsColumn() to distinguish between this scenarios. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValue

            +
            +<T> T getMostRecentValue(String family,
+                         String qualifier)
+                     throws IOException
            +
            +
            Gets the value with the latest timestamp stored within the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValues

            +
            +<T> NavigableMap<String,T> getMostRecentValues(String family)
+                                           throws IOException
            +
            +
            Gets the value with the latest timestamp stored within the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +<T> NavigableMap<String,NavigableMap<Long,T>> getValues(String family)
+                                                    throws IOException
            +
            +
            Gets all the timestamp-value pairs stored within the specified family. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            A sorted map containing the values stored in the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +<T> NavigableMap<Long,T> getValues(String family,
+                                   String qualifier)
+                               throws IOException
            +
            +
            Gets all the timestamp-value pairs stored within the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            A sorted map containing the values stored in the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCell

            +
            +<T> KijiCell<T> getCell(String family,
+                        String qualifier,
+                        long timestamp)
+                    throws IOException
            +
            +
            Gets the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            the specified cell, or null if the cell does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCell

            +
            +<T> KijiCell<T> getMostRecentCell(String family,
+                                  String qualifier)
+                              throws IOException
            +
            +
            Gets the latest version of the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            the most recent version of the specified cell, or null if the cell does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCells

            +
            +<T> NavigableMap<String,KijiCell<T>> getMostRecentCells(String family)
+                                                    throws IOException
            +
            +
            Gets the latest version of the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            a map from qualifier to the most recent versions of the cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>> getCells(String family)
+                                                             throws IOException
            +
            +
            Gets all the timestamp-cell pairs stored within the specified family. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            A sorted map versions of the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +<T> NavigableMap<Long,KijiCell<T>> getCells(String family,
+                                            String qualifier)
+                                        throws IOException
            +
            +
            Gets all the timestamp-cell pairs stored within the specified cell. +

            +

            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            A sorted map versions of the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +nextPage

            +
            +boolean nextPage(String family,
+                 String qualifier)
+                 throws IOException
            +
            +
            Populates the next page of cells for a column. + +

            If there are cells remaining, this KijiRowData object is populated with the next + page of cells for the requested column and the method returns true. Otherwise, data + from the column's previous page is removed, and this method returns false. This + method throws an IOException if the column does not have paging enabled in the + KijiDataRequest.

            +

            +

            +
            Parameters:
            family - A column family.
            qualifier - A column qualifier. +
            Returns:
            Whether a new page of cells has been fetched. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +nextPage

            +
            +boolean nextPage(String family)
+                 throws IOException
            +
            +
            Populates the next page of cells for a requested column family. + +

            If there are cells remaining, this KijiRowData object is populated with the next + page of cells for the requested family and the method returns true. Otherwise, data + from the family's previous page is removed, and this method returns false. This + method throws an IOException if the column does not have paging enabled in the + KijiDataRequest.

            + +

            An IOException is thrown if this method is called on a family that was not + requested explicitly in the KijiDataRequest. For example, consider the following: + + 

            +   new KijiDataRequest()
+       .addColumn(new KijiDataRequest.Column("foo").withPageSize(10))
+       .addColumn(new KijiDataRequest.Column("bar", "baz").withPageSize(10));
+
            + + It would be valid to call nextPage("foo"), but calling nextPage("bar") would throw an + IOException, since paging was not enabled on the entire "bar" family.

            +

            +

            +
            Parameters:
            family - A column family. +
            Returns:
            Whether a new page of cells has been fetched. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiRowKeySplitter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiRowKeySplitter.html new file mode 100644 index 00000000..e1965da1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiRowKeySplitter.html @@ -0,0 +1,267 @@ + + + + + + + +KijiRowKeySplitter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiRowKeySplitter

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiRowKeySplitter
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiRowKeySplitter
            extends Object
            + + +

            +Utility class for splitting the Kiji row key space. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static intHBASE_ROW_KEY_RESOLUTION + +
            +          Resolution (in number of bytes) when generating evenly spaced HBase row keys.
            +  + + + + + + + + + + + +
            +Method Summary
            +static byte[][]getSplitKeys(int numRegions) + +
            +          Returns the split keys for the given number of regions.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +HBASE_ROW_KEY_RESOLUTION

            +
            +public static final int HBASE_ROW_KEY_RESOLUTION
            +
            +
            Resolution (in number of bytes) when generating evenly spaced HBase row keys. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getSplitKeys

            +
            +public static byte[][] getSplitKeys(int numRegions)
            +
            +
            Returns the split keys for the given number of regions. This assumes that the keys are + byte strings of size HBASE_ROW_KEY_RESOLUTION. +

            +

            +
            Parameters:
            numRegions - The number of desired regions. +
            Returns:
            The row keys that serve as the boundaries between the regions.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiRowScanner.html new file mode 100644 index 00000000..f161bb06 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiRowScanner.html @@ -0,0 +1,254 @@ + + + + + + + +KijiRowScanner (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiRowScanner

            +
            +
            All Superinterfaces:
            Closeable, Iterable<KijiRowData>
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiRowScanner
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiRowScanner
            extends Closeable, Iterable<KijiRowData>
            + + +

            +Interface for scanning over rows read from a Kiji table. + +

            Because this class implements the Iterable interface, you can write code like this: + + 

            +   KijiRowScanner scanner = tableReader.getScanner(...);
+   try {
+     for (KijiRowData row : scanner) {
+       process(row);
+     }
+   } finally {
+     // Don't forget to close it!
+     scanner.close();
+   }
+
            +

            +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Closes this scanner and releases any system resources associated with it.
            +  + + + + + + + +
            Methods inherited from interface java.lang.Iterable
            iterator
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +close

            +
            +void close()
+           throws IOException
            +
            +
            Closes this scanner and releases any system resources associated with it. + +

            Calling this method when you are finished with the scanner is important. + See http://hbase.apache.org/book.html#perf.hbase.client.scannerclose for details.

            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException - If an I/O error occurs.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiSchemaTable.SchemaEntry.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiSchemaTable.SchemaEntry.html new file mode 100644 index 00000000..975fab93 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiSchemaTable.SchemaEntry.html @@ -0,0 +1,382 @@ + + + + + + + +KijiSchemaTable.SchemaEntry (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiSchemaTable.SchemaEntry

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSchemaTable.SchemaEntry
+
            +
            +
            Enclosing class:
            KijiSchemaTable
            +
            +
            +
            +
            public static class KijiSchemaTable.SchemaEntry
            extends Object
            + + +

            +Association between a schema and its ID. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiSchemaTable.SchemaEntry(long id, + BytesKey hash, + org.apache.avro.Schema schema) + +
            +          Creates a new schema entry.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            + BytesKeygetHash() + +
            +           
            + longgetId() + +
            +           
            + org.apache.avro.SchemagetSchema() + +
            +           
            + inthashCode() + +
            +          
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiSchemaTable.SchemaEntry

            +
            +@ApiAudience.Private
+public KijiSchemaTable.SchemaEntry(long id,
+                                                       BytesKey hash,
+                                                       org.apache.avro.Schema schema)
            +
            +
            Creates a new schema entry. +

            +

            +
            Parameters:
            id - the schema ID
            hash - the schema hash
            schema - the Avro schema object
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public long getId()
            +
            +
            + +
            Returns:
            the schema ID
            +
            +
            +
            + +

            +getHash

            +
            +public BytesKey getHash()
            +
            +
            + +
            Returns:
            the schema hash
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            + +
            Returns:
            the Avro schema object
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiSchemaTable.html new file mode 100644 index 00000000..79576900 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiSchemaTable.html @@ -0,0 +1,550 @@ + + + + + + + +KijiSchemaTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiSchemaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSchemaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Direct Known Subclasses:
            HBaseSchemaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public abstract class KijiSchemaTable
            extends Object
            implements Closeable
            + + +

            +The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas. +

            + +

            +

            +
            See Also:
            KijiMetaTable, +KijiSystemTable
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiSchemaTable.SchemaEntry + +
            +          Association between a schema and its ID.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiSchemaTable() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  voidclose() + +
            +          Flushes and closes the KijiSchemaTable.
            + voidflush() + +
            +          Commits any pending additions to the schema table.
            +abstract  voidfromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            +abstract  BytesKeygetOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            +abstract  longgetOrCreateSchemaId(org.apache.avro.Schema schema) + +
            +          Looks up a schema ID given an Avro schema object.
            +abstract  org.apache.avro.SchemagetSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            +abstract  org.apache.avro.SchemagetSchema(long schemaId) + +
            +          Looks up a schema given an ID.
            + BytesKeygetSchemaHash(org.apache.avro.Schema schema) + +
            +          Computes a schema hash.
            +static byte[]hashSchema(org.apache.avro.Schema schema) + +
            +          Computes a hash of the specified Avro schema.
            +abstract  List<SchemaTableEntry>toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiSchemaTable

            +
            +public KijiSchemaTable()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getOrCreateSchemaId

            +
            +public abstract long getOrCreateSchemaId(org.apache.avro.Schema schema)
+                                  throws IOException
            +
            +
            Looks up a schema ID given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            +
            +
            +
            Parameters:
            schema - The full schema to store in the table. +
            Returns:
            The schema ID. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getOrCreateSchemaHash

            +
            +public abstract BytesKey getOrCreateSchemaHash(org.apache.avro.Schema schema)
+                                        throws IOException
            +
            +
            Looks up a schema hash given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            +
            +
            +
            Parameters:
            schema - Avro schema to look up. +
            Returns:
            The schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getSchemaHash

            +
            +public BytesKey getSchemaHash(org.apache.avro.Schema schema)
            +
            +
            Computes a schema hash. +

            +

            +
            +
            +
            +
            Parameters:
            schema - Avro schema to compute a hash for. +
            Returns:
            Schema hash.
            +
            +
            +
            + +

            +getSchema

            +
            +public abstract org.apache.avro.Schema getSchema(long schemaId)
+                                          throws IOException
            +
            +
            Looks up a schema given an ID. +

            +

            +
            +
            +
            +
            Parameters:
            schemaId - Schema ID to look up. +
            Returns:
            Avro schema, or null if the schema ID is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getSchema

            +
            +public abstract org.apache.avro.Schema getSchema(BytesKey schemaHash)
+                                          throws IOException
            +
            +
            Looks up a schema given a hash. +

            +

            +
            +
            +
            +
            Parameters:
            schemaHash - Schema hash to look up. +
            Returns:
            Avro schema, or null if the schema hash is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +hashSchema

            +
            +public static final byte[] hashSchema(org.apache.avro.Schema schema)
            +
            +
            Computes a hash of the specified Avro schema. + + Kiji currently uses MD5 sums (128 bits) of the schema JSON representation. +

            +

            +
            +
            +
            +
            Parameters:
            schema - Avro schema to compute a hash of. +
            Returns:
            Hash code as an array of bytes (16 bytes).
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            Commits any pending additions to the schema table. + + Default implementation is blank as flushing is not generally a vital operation +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +close

            +
            +public abstract void close()
+                    throws IOException
            +
            +
            Flushes and closes the KijiSchemaTable. No other methods may be called after this. +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +toBackup

            +
            +public abstract List<SchemaTableEntry> toBackup()
+                                         throws IOException
            +
            +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            +
            +
            + +
            Returns:
            A list of schema table entries. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public abstract void fromBackup(List<SchemaTableEntry> backup)
+                         throws IOException
            +
            +
            Restores the schema entries from the specified backup record. +

            +

            +
            +
            +
            +
            Parameters:
            backup - The schema entries from a MetadataBackup record. This consist of the schema + definition, schema id, and schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiSystemTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiSystemTable.html new file mode 100644 index 00000000..40632df3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiSystemTable.html @@ -0,0 +1,375 @@ + + + + + + + +KijiSystemTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiSystemTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSystemTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Direct Known Subclasses:
            HBaseSystemTable
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public abstract class KijiSystemTable
            extends Object
            implements Closeable
            + + +

            +The Kiji system table, which stores system information such as the version, ready state, and + locks. +

            + +

            +

            +
            See Also:
            KijiMetaTable, +KijiSystemTable
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiSystemTable() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  StringgetDataVersion() + +
            +          Gets the version of kiji installed.
            +abstract  byte[]getValue(String key) + +
            +          Gets the value associated with a property key.
            +abstract  voidputValue(String key, + byte[] value) + +
            +          Sets a value for a property key, which creates it if it doesn't exist.
            +abstract  voidsetDataVersion(String version) + +
            +          Sets the version of kiji installed.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

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

            +KijiSystemTable

            +
            +public KijiSystemTable()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataVersion

            +
            +public abstract String getDataVersion()
+                               throws IOException
            +
            +
            Gets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            +
            +
            + +
            Returns:
            the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +setDataVersion

            +
            +public abstract void setDataVersion(String version)
+                             throws IOException
            +
            +
            Sets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            +
            +
            +
            Parameters:
            version - the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValue

            +
            +public abstract byte[] getValue(String key)
+                         throws IOException
            +
            +
            Gets the value associated with a property key. +

            +

            +
            +
            +
            +
            Parameters:
            key - The property key to look up. +
            Returns:
            The value in the system table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public abstract void putValue(String key,
+                              byte[] value)
+                       throws IOException
            +
            +
            Sets a value for a property key, which creates it if it doesn't exist. +

            +

            +
            +
            +
            +
            Parameters:
            key - The property key to set.
            value - The value of the property. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTable.html new file mode 100644 index 00000000..bc753b12 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTable.html @@ -0,0 +1,409 @@ + + + + + + + +KijiTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTable

            +
            +
            All Superinterfaces:
            Closeable
            +
            +
            +
            All Known Implementing Classes:
            AbstractKijiTable, HBaseKijiTable
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiTable
            extends Closeable
            + + +

            +Interface for Kiji Tables. + + Instantiated from KijiTableFactory.openTable(String) +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + EntityIdgetEntityId(String kijiRowKey) + +
            +          Creates an entity ID for the specified UTF8 encoded Kiji row key.
            + EntityIdFactorygetEntityIdFactory() + +
            +           
            + KijigetKiji() + +
            +           
            + KijiTableLayoutgetLayout() + +
            +           
            + StringgetName() + +
            +           
            + KijiURIgetURI() + +
            +           
            + KijiTableReaderopenTableReader() + +
            +          Opens an appropriate implementation of KijiTableReader for this table.
            + KijiTableWriteropenTableWriter() + +
            +          Opens an appropriate implementation of KijiTableWriter for this table.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getKiji

            +
            +Kiji getKiji()
            +
            +
            +
            +
            +
            + +
            Returns:
            the Kiji instance this table belongs to.
            +
            +
            +
            + +

            +getName

            +
            +String getName()
            +
            +
            +
            +
            +
            + +
            Returns:
            the name of this table.
            +
            +
            +
            + +

            +getURI

            +
            +KijiURI getURI()
            +
            +
            +
            +
            +
            + +
            Returns:
            the URI for this table, trimmed at the table path component.
            +
            +
            +
            + +

            +getLayout

            +
            +KijiTableLayout getLayout()
            +
            +
            +
            +
            +
            + +
            Returns:
            the layout of this table.
            +
            +
            +
            + +

            +getEntityIdFactory

            +
            +EntityIdFactory getEntityIdFactory()
            +
            +
            +
            +
            +
            + +
            Returns:
            the entity ID factory for this table.
            +
            +
            +
            + +

            +getEntityId

            +
            +EntityId getEntityId(String kijiRowKey)
            +
            +
            Creates an entity ID for the specified UTF8 encoded Kiji row key. +

            +

            +
            +
            +
            +
            Parameters:
            kijiRowKey - UTF8 encoded Kiji row key. +
            Returns:
            a new entity ID for the specified Kiji row key.
            +
            +
            +
            + +

            +openTableReader

            +
            +KijiTableReader openTableReader()
+                                throws IOException
            +
            +
            Opens an appropriate implementation of KijiTableReader for this table. The caller is + responsible for closing this reader. +

            +

            +
            +
            +
            + +
            Returns:
            A KijiTableReader for this table. +
            Throws: +
            IOException - If there was an error opening the reader.
            +
            +
            +
            + +

            +openTableWriter

            +
            +KijiTableWriter openTableWriter()
+                                throws IOException
            +
            +
            Opens an appropriate implementation of KijiTableWriter for this table. The caller is + responsible for closing this writer. +

            +

            +
            +
            +
            + +
            Returns:
            A KijiTableWriter for this table. +
            Throws: +
            IOException - If there was an error opening the writer.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableFactory.html new file mode 100644 index 00000000..10bf5e3a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableFactory.html @@ -0,0 +1,227 @@ + + + + + + + +KijiTableFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableFactory

            +
            +
            All Known Subinterfaces:
            Kiji
            +
            +
            +
            All Known Implementing Classes:
            DefaultKijiTableFactory, HBaseKiji
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiTableFactory
            + + +

            +Factory for KijiTable instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + KijiTableopenTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +openTable

            +
            +KijiTable openTable(String tableName)
+                    throws IOException
            +
            +
            Opens a KijiTable by name. + +

            Clients must take care to close the KijiTable instance when finished.

            +

            +

            +
            Parameters:
            tableName - Name of the table to open. +
            Returns:
            the opened Kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableKeyValueDatabase.html new file mode 100644 index 00000000..54b9237e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableKeyValueDatabase.html @@ -0,0 +1,474 @@ + + + + + + + +KijiTableKeyValueDatabase (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableKeyValueDatabase

            +
            +
            All Known Implementing Classes:
            HBaseMetaTable, HBaseTableKeyValueDatabase, KijiMetaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiTableKeyValueDatabase
            + + +

            +A database of per table key-value pairs. This is used to store meta data (in the form of + key-value pairs) on a per table basis. +

            + +

            +

            +
            See Also:
            KijiMetaTable
            +
            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + NavigableMap<Long,byte[]>getTimedValues(String table, + String key, + int numVersions) + +
            +          Returns a map of values associated with the specified table and key.
            + byte[]getValue(String table, + String key) + +
            +          Returns the most recent value associated with the specified table and key.
            + List<byte[]>getValues(String table, + String key, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key.
            + Set<String>keySet(String table) + +
            +          Returns a set view of keys contained in the map for the specified table.
            + voidkeyValuesFromBackup(String table, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            + List<KeyValueBackupEntry>keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + KijiTableKeyValueDatabaseputValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + voidremoveAllValues(String table) + +
            +          Deletes all key-value pairs associated with the specified table.
            + voidremoveValues(String table, + String key) + +
            +          Removes all values associated with the specified table and key.
            + Set<String>tableSet() + +
            +          Returns a set view of the tables that have key-value pairs defined.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +putValue

            +
            +KijiTableKeyValueDatabase putValue(String table,
+                                   String key,
+                                   byte[] value)
+                                   throws IOException
            +
            +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +

            +

            +
            Parameters:
            table - The kiji table that this key-value pair will be set with.
            key - The key to associate with the specified value.
            value - The value to associate with the specified key. +
            Returns:
            The same KijiTableKeyValueDatabase. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValue

            +
            +byte[] getValue(String table,
+                String key)
+                throws IOException
            +
            +
            Returns the most recent value associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for. +
            Returns:
            The value in the meta table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +List<byte[]> getValues(String table,
+                       String key,
+                       int numVersions)
+                       throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +

            +

            +
            Parameters:
            table - The Kiji table.
            key - The key to look up associated values for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the values for the specified table and key, + sorted by most-recent-first. If there are no values, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedValues

            +
            +NavigableMap<Long,byte[]> getTimedValues(String table,
+                                         String key,
+                                         int numVersions)
+                                         throws IOException
            +
            +
            Returns a map of values associated with the specified table and key. The Map + is keyed by timestamp. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values that are the user defined values for the specified key + and table, and keys that correspond to timestamps, ordered from newest to oldest. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeValues

            +
            +void removeValues(String table,
+                  String key)
+                  throws IOException
            +
            +
            Removes all values associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table associated with the metadata.
            key - The metadata key to look up. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllValues

            +
            +void removeAllValues(String table)
+                     throws IOException
            +
            +
            Deletes all key-value pairs associated with the specified table. +

            +

            +
            Parameters:
            table - The table to delete remove key-value pairs for. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keySet

            +
            +Set<String> keySet(String table)
+                   throws IOException
            +
            +
            Returns a set view of keys contained in the map for the specified table. +

            +

            +
            Parameters:
            table - The table to look up in use keys for. +
            Returns:
            A navigable set of keys used to store meta information for a given table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +tableSet

            +
            +Set<String> tableSet()
+                     throws IOException
            +
            +
            Returns a set view of the tables that have key-value pairs defined. +

            +

            + +
            Returns:
            A set of tables that have key-value pairs defined. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesToBackup

            +
            +List<KeyValueBackupEntry> keyValuesToBackup(String table)
+                                            throws IOException
            +
            +
            Gets a list of the TableKeyValueBackupEntries. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableKeyValueBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesFromBackup

            +
            +void keyValuesFromBackup(String table,
+                         List<KeyValueBackupEntry> keyValues)
+                         throws IOException
            +
            +
            Restores all table's key value history from a backup. +

            +

            +
            Parameters:
            table - The name of the kiji table.
            keyValues - The key values associated with the table to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableNotFoundException.html new file mode 100644 index 00000000..50341055 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableNotFoundException.html @@ -0,0 +1,251 @@ + + + + + + + +KijiTableNotFoundException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTableNotFoundException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.KijiTableNotFoundException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableNotFoundException
            extends IOException
            + + +

            +Thrown when an attempt to access a table fails because it does not exist. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTableNotFoundException(String tableName) + +
            +          Creates a new KijiTableNotFoundException for the specified table.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiTableNotFoundException

            +
            +public KijiTableNotFoundException(String tableName)
            +
            +
            Creates a new KijiTableNotFoundException for the specified table. +

            +

            +
            Parameters:
            tableName - The name of the table that wasn't found.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTablePool.NoCapacityException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTablePool.NoCapacityException.html new file mode 100644 index 00000000..009b40d0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTablePool.NoCapacityException.html @@ -0,0 +1,254 @@ + + + + + + + +KijiTablePool.NoCapacityException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTablePool.NoCapacityException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.KijiTablePool.NoCapacityException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Enclosing class:
            KijiTablePool
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiTablePool.NoCapacityException
            extends IOException
            + + +

            +Thrown when an attempt to get a table connection fails because there is no room in the pool. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTablePool.NoCapacityException(String message) + +
            +          Creates a new NoCapacityException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiTablePool.NoCapacityException

            +
            +public KijiTablePool.NoCapacityException(String message)
            +
            +
            Creates a new NoCapacityException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTablePool.Options.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTablePool.Options.html new file mode 100644 index 00000000..e5b0c98c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTablePool.Options.html @@ -0,0 +1,469 @@ + + + + + + + +KijiTablePool.Options (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTablePool.Options

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiTablePool.Options
+
            +
            +
            Enclosing class:
            KijiTablePool
            +
            +
            +
            +
            public static final class KijiTablePool.Options
            extends Object
            + + +

            +Describes the options that can be configured on the KijiTablePool. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTablePool.Options() + +
            +          Creates options with default values.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + ClockgetClock() + +
            +          Gets a clock.
            + longgetIdlePollPeriod() + +
            +          Gets the amount of time between sweeps of the pool for removing idle connections.
            + longgetIdleTimeout() + +
            +          Gets the amount of time a connection may be idle before being removed from the pool.
            + intgetMaxSize() + +
            +          Gets the maximum number of connections to keep per table.
            + intgetMinSize() + +
            +          Gets the minimum number of connections to keep per table.
            + KijiTablePool.OptionswithClock(Clock clock) + +
            +          Sets a clock.
            + KijiTablePool.OptionswithIdlePollPeriod(long periodMillis) + +
            +          Sets the amount of time between sweeps of the pool for removing idle connections.
            + KijiTablePool.OptionswithIdleTimeout(long timeoutMillis) + +
            +          Sets the amount of time a connection may be idle before being removed from the pool.
            + KijiTablePool.OptionswithMaxSize(int maxSize) + +
            +          Sets the maximum number of connections to keep per table.
            + KijiTablePool.OptionswithMinSize(int minSize) + +
            +          Sets the minimum number of connections to keep per table.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTablePool.Options

            +
            +public KijiTablePool.Options()
            +
            +
            Creates options with default values. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +withMinSize

            +
            +public KijiTablePool.Options withMinSize(int minSize)
            +
            +
            Sets the minimum number of connections to keep per table. + +

            Use zero(0) to indicate that the pool should be unbounded.

            +

            +

            +
            Parameters:
            minSize - The max number of connections to keep per table. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getMinSize

            +
            +public int getMinSize()
            +
            +
            Gets the minimum number of connections to keep per table. +

            +

            + +
            Returns:
            The min number of connections to keep per table.
            +
            +
            +
            + +

            +withMaxSize

            +
            +public KijiTablePool.Options withMaxSize(int maxSize)
            +
            +
            Sets the maximum number of connections to keep per table. + +

            Use zero(0) to indicate that the pool should be unbounded.

            +

            +

            +
            Parameters:
            maxSize - The max number of connections to keep per table. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getMaxSize

            +
            +public int getMaxSize()
            +
            +
            Gets the maximum number of connections to keep per table. +

            +

            + +
            Returns:
            The max number of connections to keep per table.
            +
            +
            +
            + +

            +withIdleTimeout

            +
            +public KijiTablePool.Options withIdleTimeout(long timeoutMillis)
            +
            +
            Sets the amount of time a connection may be idle before being removed from the pool. + +

            Use zero (0) to indicate that connections should never be removed.

            +

            +

            +
            Parameters:
            timeoutMillis - Timeout in milliseconds. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getIdleTimeout

            +
            +public long getIdleTimeout()
            +
            +
            Gets the amount of time a connection may be idle before being removed from the pool. +

            +

            + +
            Returns:
            The timeout in milliseconds.
            +
            +
            +
            + +

            +withIdlePollPeriod

            +
            +public KijiTablePool.Options withIdlePollPeriod(long periodMillis)
            +
            +
            Sets the amount of time between sweeps of the pool for removing idle connections. +

            +

            +
            Parameters:
            periodMillis - Number of milliseconds between sweeps. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getIdlePollPeriod

            +
            +public long getIdlePollPeriod()
            +
            +
            Gets the amount of time between sweeps of the pool for removing idle connections. +

            +

            + +
            Returns:
            Number of milliseconds between sweeps.
            +
            +
            +
            + +

            +withClock

            +
            +public KijiTablePool.Options withClock(Clock clock)
            +
            +
            Sets a clock. +

            +

            +
            Parameters:
            clock - A clock. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getClock

            +
            +public Clock getClock()
            +
            +
            Gets a clock. +

            +

            + +
            Returns:
            A clock.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTablePool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTablePool.html new file mode 100644 index 00000000..bd29a8fa --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTablePool.html @@ -0,0 +1,452 @@ + + + + + + + +KijiTablePool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTablePool

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiTablePool
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTablePool
            extends Object
            implements Closeable
            + + +

            +Maintains a pool of opened KijiTables. + +

            Instead of creating a new KijiTable instance when needed, clients may use a + KijiTablePool to keep a pool of opened tables for reuse. When a client asks for a + KijiTable, the pool first checks the cache for an already opened and available + table. If available, the cached table will be returned. Otherwise, a new one will be + opened and returned. When the client is finished, it should call release() to allow + other clients or threads the option to reuse the opened table.

            + +

            This class is thread-safe.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTablePool.NoCapacityException + +
            +          Thrown when an attempt to get a table connection fails because there is no room in the pool.
            +static classKijiTablePool.Options + +
            +          Describes the options that can be configured on the KijiTablePool.
            +  + + + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiTablePool(Kiji kiji) + +
            +          Constructs a new pool of Kiji tables.
            KijiTablePool(KijiTableFactory tableFactory) + +
            +          Constructs a new pool of Kiji tables.
            KijiTablePool(KijiTableFactory tableFactory, + KijiTablePool.Options options) + +
            +          Constructs a new pool of Kiji tables.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Closes the tables in the pool.
            +protected  voidfinalize() + +
            +           
            + KijiTableget(String name) + +
            +          Gets a previously opened table from the pool, or open a new connection.
            + intgetPoolSize(String tableName) + +
            +          Gets the total number of connections, active and cached, for the specified table.
            + voidrelease(KijiTable table) + +
            +          Releases a table back to the pool.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTablePool

            +
            +public KijiTablePool(Kiji kiji)
            +
            +
            Constructs a new pool of Kiji tables. +

            +

            +
            Parameters:
            kiji - The kiji instance.
            +
            +
            + +

            +KijiTablePool

            +
            +public KijiTablePool(KijiTableFactory tableFactory)
            +
            +
            Constructs a new pool of Kiji tables. +

            +

            +
            Parameters:
            tableFactory - A KijiTable factory.
            +
            +
            + +

            +KijiTablePool

            +
            +public KijiTablePool(KijiTableFactory tableFactory,
+                     KijiTablePool.Options options)
            +
            +
            Constructs a new pool of Kiji tables. +

            +

            +
            Parameters:
            tableFactory - A KijiTable factory.
            options - Configurable options for the pool.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public KijiTable get(String name)
+              throws IOException
            +
            +
            Gets a previously opened table from the pool, or open a new connection. + Clients should not call close() on the returned table. Instead, they should release the + table back to the pool when finished by passing it in call to release(). +

            +

            +
            +
            +
            +
            Parameters:
            name - The name of the Kiji table. +
            Returns:
            An opened Kiji table. +
            Throws: +
            IOException - If there is an error. +
            KijiTablePool.NoCapacityException - If the table pool is at capacity.
            +
            +
            +
            + +

            +release

            +
            +public void release(KijiTable table)
            +
            +
            Releases a table back to the pool. + +

            Only open tables that were retrieved from this pool should be released.

            +

            +

            +
            +
            +
            +
            Parameters:
            table - The table to release to the pool. If null, will be a no-op.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            Closes the tables in the pool. +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException - If there is an error closing the pool.
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +getPoolSize

            +
            +public int getPoolSize(String tableName)
            +
            +
            Gets the total number of connections, active and cached, for the specified table. +

            +

            +
            +
            +
            +
            Parameters:
            tableName - The name of the table you wish to know the pool size of. +
            Returns:
            The size of the table pool.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableReader.KijiScannerOptions.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableReader.KijiScannerOptions.html new file mode 100644 index 00000000..80d39b3a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableReader.KijiScannerOptions.html @@ -0,0 +1,429 @@ + + + + + + + +KijiTableReader.KijiScannerOptions (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTableReader.KijiScannerOptions

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiTableReader.KijiScannerOptions
+
            +
            +
            Enclosing interface:
            KijiTableReader
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiTableReader.KijiScannerOptions
            extends Object
            + + +

            +Options for KijiRowScanners. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTableReader.KijiScannerOptions() + +
            +          Creates KijiScannerOptions with uninitialized options + and default HBaseScanOptions.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseScanOptionsgetHBaseScanOptions() + +
            +          Gets the HBaseScanOptions set in these options.
            + KijiRowFiltergetKijiRowFilter() + +
            +          Gets the row filter set in these options.
            + EntityIdgetStartRow() + +
            +          Gets the start row set in these options.
            + EntityIdgetStopRow() + +
            +          Gets the stop row set in these options.
            + KijiTableReader.KijiScannerOptionssetHBaseScanOptions(HBaseScanOptions hBaseScanOptions) + +
            +          Sets the HBaseScanOptions used by a HBase backed scanner.
            + KijiTableReader.KijiScannerOptionssetKijiRowFilter(KijiRowFilter rowFilter) + +
            +          Sets the row filter used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            + KijiTableReader.KijiScannerOptionssetStartRow(EntityId startRow) + +
            +          Sets the start row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            + KijiTableReader.KijiScannerOptionssetStopRow(EntityId stopRow) + +
            +          Sets the stop row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableReader.KijiScannerOptions

            +
            +public KijiTableReader.KijiScannerOptions()
            +
            +
            Creates KijiScannerOptions with uninitialized options + and default HBaseScanOptions. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +setStartRow

            +
            +public KijiTableReader.KijiScannerOptions setStartRow(EntityId startRow)
            +
            +
            Sets the start row used by the scanner, + and returns this KijiScannerOptions to allow chaining. +

            +

            +
            Parameters:
            startRow - The row to start scanning from. +
            Returns:
            This KijiScannerOptions with the start row set.
            +
            +
            +
            + +

            +getStartRow

            +
            +public EntityId getStartRow()
            +
            +
            Gets the start row set in these options. +

            +

            + +
            Returns:
            The start row to use, null if unset.
            +
            +
            +
            + +

            +setStopRow

            +
            +public KijiTableReader.KijiScannerOptions setStopRow(EntityId stopRow)
            +
            +
            Sets the stop row used by the scanner, + and returns this KijiScannerOptions to allow chaining. +

            +

            +
            Parameters:
            stopRow - The last row to scan. +
            Returns:
            This KijiScannerOptions with the stop row set.
            +
            +
            +
            + +

            +getStopRow

            +
            +public EntityId getStopRow()
            +
            +
            Gets the stop row set in these options. +

            +

            + +
            Returns:
            The stop row to use, null if unset.
            +
            +
            +
            + +

            +setKijiRowFilter

            +
            +public KijiTableReader.KijiScannerOptions setKijiRowFilter(KijiRowFilter rowFilter)
            +
            +
            Sets the row filter used by the scanner, + and returns this KijiScannerOptions to allow chaining. +

            +

            +
            Parameters:
            rowFilter - The row filter to use. +
            Returns:
            This KijiScannerOptions with the row filter set.
            +
            +
            +
            + +

            +getKijiRowFilter

            +
            +public KijiRowFilter getKijiRowFilter()
            +
            +
            Gets the row filter set in these options. +

            +

            + +
            Returns:
            The row filter to use, null if unset.
            +
            +
            +
            + +

            +setHBaseScanOptions

            +
            +public KijiTableReader.KijiScannerOptions setHBaseScanOptions(HBaseScanOptions hBaseScanOptions)
            +
            +
            Sets the HBaseScanOptions used by a HBase backed scanner. + The default is the default HBaseScanOptions. +

            +

            +
            Parameters:
            hBaseScanOptions - The HBaseScanOptions to use. +
            Returns:
            This KijiScannerOptions with the HBaseScanOptions set.
            +
            +
            +
            + +

            +getHBaseScanOptions

            +
            +public HBaseScanOptions getHBaseScanOptions()
            +
            +
            Gets the HBaseScanOptions set in these options. +

            +

            + +
            Returns:
            The HBaseScanOptions to use; if unset, the default HbaseScanOptions.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableReader.html new file mode 100644 index 00000000..c17b1022 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableReader.html @@ -0,0 +1,352 @@ + + + + + + + +KijiTableReader (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableReader

            +
            +
            All Superinterfaces:
            Closeable
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableReader
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiTableReader
            extends Closeable
            + + +

            +Interface for reading data from a kiji table. + + Instantiated from KijiTable.openTableReader() +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTableReader.KijiScannerOptions + +
            +          Options for KijiRowScanners.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + List<KijiRowData>bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + KijiRowDataget(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions scannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +KijiRowData get(EntityId entityId,
+                KijiDataRequest dataRequest)
+                throws IOException
            +
            +
            Retrieves data from a single row in the kiji table. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - The entity id for the row to get data from.
            dataRequest - Specifies the columns of data to retrieve. +
            Returns:
            The requested data. If there is no row for the specified entityId, this + will return an empty KijiRowData. (containsColumn() will return false for all + columns.) +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +bulkGet

            +
            +List<KijiRowData> bulkGet(List<EntityId> entityIds,
+                          KijiDataRequest dataRequest)
+                          throws IOException
            +
            +
            Retrieves data from a list of rows in the kiji table. +

            +

            +
            +
            +
            +
            Parameters:
            entityIds - The list of entity ids to collect data for.
            dataRequest - Specifies constraints on the data to retrieve for each entity id. +
            Returns:
            The requested data. If an EntityId specified in entityIds + does not exist, then the corresponding KijiRowData will be empty. + If a get fails, then the corresponding KijiRowData will be null (instead of empty). +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +getScanner

            +
            +KijiRowScanner getScanner(KijiDataRequest dataRequest)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner with the specified data request. +

            +

            +
            +
            +
            +
            Parameters:
            dataRequest - The data request to scan for. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error. +
            KijiDataRequestException - If the data request is invalid.
            +
            +
            +
            + +

            +getScanner

            +
            +KijiRowScanner getScanner(KijiDataRequest dataRequest,
+                          KijiTableReader.KijiScannerOptions scannerOptions)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner using the specified data request and options. +

            +

            +
            +
            +
            +
            Parameters:
            dataRequest - The data request to scan for.
            scannerOptions - Other options for the scanner. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error. +
            KijiDataRequestException - If the data request is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableWriter.html new file mode 100644 index 00000000..bbf7387a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiTableWriter.html @@ -0,0 +1,238 @@ + + + + + + + +KijiTableWriter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableWriter

            +
            +
            All Superinterfaces:
            Closeable, Flushable, KijiDeleter, KijiIncrementer, KijiPutter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiTableWriter
            extends KijiPutter, KijiIncrementer, KijiDeleter
            + + +

            +Interface for modifying a Kiji table. + + Instantiated by calling KijiTable.openTableWriter() +

            + +

            +

            + +

            + + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiPutter
            put, put
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiIncrementer
            increment
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiDeleter
            deleteCell, deleteCell, deleteColumn, deleteColumn, deleteFamily, deleteFamily, deleteRow, deleteRow
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + +

            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiURI.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiURI.html new file mode 100644 index 00000000..acde6e1a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiURI.html @@ -0,0 +1,792 @@ + + + + + + + +KijiURI (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiURI

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiURI
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiURI
            extends Object
            + + +

            +URI that fully qualifies a Kiji instance/table/column. + Use "default" for the default Kiji instance. + + Valid URI forms look like: +

          • "kiji://zkHost" +
          • "kiji://zkHost/instance" +
          • "kiji://zkHost/instance/table" +
          • "kiji://zkHost:zkPort/instance/table" +
          • "kiji://zkHost1,zkHost2/instance/table" +
          • "kiji://(zkHost1,zkHost2):zkPort/instance/table" +
          • "kiji://zkHost/instance/table/col" +
          • "kiji://zkHost/instance/table/col1,col2" +
          • "kiji://.env/instance/table" +
          • "kiji://.unset/instance/table" +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static intDEFAULT_ZOOKEEPER_CLIENT_PORT + +
            +          Default Zookeeper port.
            +static StringENV_URI_STRING + +
            +          String to specify a value through the local environment.
            +static StringKIJI_SCHEME + +
            +          URI/URL scheme used to fully qualify a Kiji table.
            +static PatternRE_AUTHORITY_GROUP + +
            +          Pattern matching "(host1,host2,host3):port".
            +static StringUNSET_URI_STRING + +
            +          String to specify an unset KijiURI field.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            KijiURI(Iterable<String> zookeeperQuorum, + int zookeeperClientPort, + String instanceName, + String tableName, + Iterable<KijiColumnName> columnNames) + +
            +          Constructs a new KijiURI with the given parameters.
            KijiURI(URI uri) + +
            +          Constructs a URI that fully qualifies a Kiji table.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object object) + +
            +          
            + com.google.common.collect.ImmutableList<KijiColumnName>getColumn() + +
            +           
            + Collection<KijiColumnName>getColumnOrdered() + +
            +           
            + StringgetInstance() + +
            +           
            + StringgetTable() + +
            +           
            + intgetZookeeperClientPort() + +
            +           
            + com.google.common.collect.ImmutableList<String>getZookeeperQuorum() + +
            +           
            + com.google.common.collect.ImmutableList<String>getZookeeperQuorumOrdered() + +
            +           
            + inthashCode() + +
            +          
            +static KijiURIparse(String uri) + +
            +          Constructs a fully qualified Kiji table URI from a string.
            + KijiURIresolve(String path) + +
            +          Resolve the path relative to this KijiURI.
            + KijiURIsetColumnNames(Collection<String> columnNames) + +
            +          Creates a KijiURI with these column names added.
            + KijiURIsetInstanceName(String instanceName) + +
            +          Creates a new KijiURI with this instance name added.
            + KijiURIsetTableName(String tableName) + +
            +          Creates a KijiURI with this table name added.
            + KijiURIsetZookeeperQuorum(String[] quorum) + +
            +          Creates a new KijiURI with this zookeeper quorum.
            + StringtoOrderedString() + +
            +          Returns a string representation of this URI that preserves ordering of lists in fields, + such as the Zookeeper quorum and Kiji columns.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +KIJI_SCHEME

            +
            +public static final String KIJI_SCHEME
            +
            +
            URI/URL scheme used to fully qualify a Kiji table. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +UNSET_URI_STRING

            +
            +public static final String UNSET_URI_STRING
            +
            +
            String to specify an unset KijiURI field. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +ENV_URI_STRING

            +
            +public static final String ENV_URI_STRING
            +
            +
            String to specify a value through the local environment. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULT_ZOOKEEPER_CLIENT_PORT

            +
            +public static final int DEFAULT_ZOOKEEPER_CLIENT_PORT
            +
            +
            Default Zookeeper port. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +RE_AUTHORITY_GROUP

            +
            +public static final Pattern RE_AUTHORITY_GROUP
            +
            +
            Pattern matching "(host1,host2,host3):port". +

            +

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

            +KijiURI

            +
            +public KijiURI(URI uri)
+        throws KijiURIException
            +
            +
            Constructs a URI that fully qualifies a Kiji table. +

            +

            +
            Parameters:
            uri - Kiji URI +
            Throws: +
            KijiURIException - if the URI is invalid.
            +
            +
            + +

            +KijiURI

            +
            +public KijiURI(Iterable<String> zookeeperQuorum,
+               int zookeeperClientPort,
+               String instanceName,
+               String tableName,
+               Iterable<KijiColumnName> columnNames)
+        throws KijiURIException
            +
            +
            Constructs a new KijiURI with the given parameters. +

            +

            +
            Parameters:
            zookeeperQuorum - Zookeeper quorum.
            zookeeperClientPort - Zookeeper client port.
            instanceName - Instance name.
            tableName - Table name.
            columnNames - Column names. +
            Throws: +
            KijiURIException - If the parameters are invalid.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +parse

            +
            +public static KijiURI parse(String uri)
+                     throws KijiURIException
            +
            +
            Constructs a fully qualified Kiji table URI from a string. +

            +

            +
            Parameters:
            uri - Kiji URI +
            Returns:
            A KijiURI represented by uri. +
            Throws: +
            KijiURIException - if the URI is invalid.
            +
            +
            +
            + +

            +resolve

            +
            +public KijiURI resolve(String path)
+                throws KijiURIException
            +
            +
            Resolve the path relative to this KijiURI. Returns a new instance. +

            +

            +
            Parameters:
            path - The path to resolve. +
            Returns:
            The resolved KijiURI. +
            Throws: +
            KijiURIException - If this KijiURI is malformed.
            +
            +
            +
            + +

            +getZookeeperQuorum

            +
            +public com.google.common.collect.ImmutableList<String> getZookeeperQuorum()
            +
            +
            + +
            Returns:
            Zookeeper quorum (comma-separated list of host names or IPs), normalized.
            +
            +
            +
            + +

            +getZookeeperQuorumOrdered

            +
            +public com.google.common.collect.ImmutableList<String> getZookeeperQuorumOrdered()
            +
            +
            + +
            Returns:
            Zookeeper quorum (comma-separated list of host names or IPs), ordered.
            +
            +
            +
            + +

            +getZookeeperClientPort

            +
            +public int getZookeeperClientPort()
            +
            +
            + +
            Returns:
            Zookeeper client port.
            +
            +
            +
            + +

            +getInstance

            +
            +public String getInstance()
            +
            +
            + +
            Returns:
            Kiji instance name.
            +
            +
            +
            + +

            +getTable

            +
            +public String getTable()
            +
            +
            + +
            Returns:
            Kiji table name.
            +
            +
            +
            + +

            +getColumn

            +
            +public com.google.common.collect.ImmutableList<KijiColumnName> getColumn()
            +
            +
            + +
            Returns:
            Kiji columns (comma-separated list of Kiji column names), normalized.
            +
            +
            +
            + +

            +getColumnOrdered

            +
            +public Collection<KijiColumnName> getColumnOrdered()
            +
            +
            + +
            Returns:
            Kiji columns (comma-separated list of Kiji column names), ordered.
            +
            +
            +
            + +

            +setZookeeperQuorum

            +
            +public KijiURI setZookeeperQuorum(String[] quorum)
+                           throws KijiURIException
            +
            +
            Creates a new KijiURI with this zookeeper quorum. +

            +

            +
            Parameters:
            quorum - The value to set zookeeperQuorum to. +
            Returns:
            A copy of this KijiURI with the zookeeperQuorum set. +
            Throws: +
            KijiURIException - If the quorum is invalid.
            +
            +
            +
            + +

            +setInstanceName

            +
            +public KijiURI setInstanceName(String instanceName)
+                        throws KijiURIException
            +
            +
            Creates a new KijiURI with this instance name added. +

            +

            +
            Parameters:
            instanceName - The name to set the instance name to. +
            Returns:
            A copy of this KijiURI with the instance name set. +
            Throws: +
            KijiURIException - If instanceName is invalid.
            +
            +
            +
            + +

            +setTableName

            +
            +public KijiURI setTableName(String tableName)
+                     throws KijiURIException
            +
            +
            Creates a KijiURI with this table name added. +

            +

            +
            Parameters:
            tableName - The name to set the table name to. +
            Returns:
            A copy of this KijiURI with the table name set. +
            Throws: +
            KijiURIException - If tableName is invalid.
            +
            +
            +
            + +

            +setColumnNames

            +
            +public KijiURI setColumnNames(Collection<String> columnNames)
+                       throws KijiURIException
            +
            +
            Creates a KijiURI with these column names added. +

            +

            +
            Parameters:
            columnNames - The column names to set as (col1,col2). +
            Returns:
            A copy of this KijiURI with the column names set. +
            Throws: +
            KijiURIException - If columNames is invalid.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toOrderedString

            +
            +public String toOrderedString()
            +
            +
            Returns a string representation of this URI that preserves ordering of lists in fields, + such as the Zookeeper quorum and Kiji columns. +

            +

            + +
            Returns:
            An order-preserving string representation of this URI.
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object object)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiURIException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiURIException.html new file mode 100644 index 00000000..56f501a1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/KijiURIException.html @@ -0,0 +1,271 @@ + + + + + + + +KijiURIException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiURIException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.KijiURIException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiURIException
            extends IOException
            + + +

            +Thrown when parsing a bogus Kiji URI. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiURIException(String message) + +
            +          Creates a new KijiURIException.
            KijiURIException(String uri, + String message) + +
            +          Creates a new KijiURIException for the specified uri and detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiURIException

            +
            +public KijiURIException(String message)
            +
            +
            Creates a new KijiURIException. +

            +

            +
            Parameters:
            message - Human readable message.
            +
            +
            + +

            +KijiURIException

            +
            +public KijiURIException(String uri,
+                        String message)
            +
            +
            Creates a new KijiURIException for the specified uri and detail message. +

            +

            +
            Parameters:
            uri - Bogus URI.
            message - Human readable explanation.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/NoCellDataException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/NoCellDataException.html new file mode 100644 index 00000000..4e62459b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/NoCellDataException.html @@ -0,0 +1,250 @@ + + + + + + + +NoCellDataException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class NoCellDataException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.NoCellDataException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NoCellDataException
            extends Exception
            + + +

            +Thrown when attempting to read data from a cell that doesn't exist. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NoCellDataException(String message) + +
            +          Creates a new NoCellDataException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +NoCellDataException

            +
            +public NoCellDataException(String message)
            +
            +
            Creates a new NoCellDataException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/NoSuchColumnException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/NoSuchColumnException.html new file mode 100644 index 00000000..b7b7497b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/NoSuchColumnException.html @@ -0,0 +1,251 @@ + + + + + + + +NoSuchColumnException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class NoSuchColumnException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.NoSuchColumnException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NoSuchColumnException
            extends IOException
            + + +

            +Thrown when attempting to access a column that does not exist. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NoSuchColumnException(String message) + +
            +          Creates a new NoSuchColumnException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +NoSuchColumnException

            +
            +public NoSuchColumnException(String message)
            +
            +
            Creates a new NoSuchColumnException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/NotAKijiManagedTableException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/NotAKijiManagedTableException.html new file mode 100644 index 00000000..47538a3e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/NotAKijiManagedTableException.html @@ -0,0 +1,285 @@ + + + + + + + +NotAKijiManagedTableException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class NotAKijiManagedTableException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.NotAKijiManagedTableException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NotAKijiManagedTableException
            extends Exception
            + + +

            +Thrown when Kiji encounters an HBase table that is not managed by Kiji. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NotAKijiManagedTableException(String hbaseTableName, + String message) + +
            +          Creates a new NotAKijiManagedTableException for the specified + table with the specified detail message.
            +  + + + + + + + + + + + +
            +Method Summary
            + StringgetHBaseTableName() + +
            +          Gets the name of the HBase table that is not managed by Kiji.
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +NotAKijiManagedTableException

            +
            +public NotAKijiManagedTableException(String hbaseTableName,
+                                     String message)
            +
            +
            Creates a new NotAKijiManagedTableException for the specified + table with the specified detail message. +

            +

            +
            Parameters:
            hbaseTableName - The name of an HBase table that is not managed by Kiji.
            message - Detail about the exception.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseTableName

            +
            +public String getHBaseTableName()
            +
            +
            Gets the name of the HBase table that is not managed by Kiji. +

            +

            + +
            Returns:
            The HBase table name.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/SpecificCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/SpecificCellDecoderFactory.html new file mode 100644 index 00000000..0c9af1c0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/SpecificCellDecoderFactory.html @@ -0,0 +1,260 @@ + + + + + + + +SpecificCellDecoderFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class SpecificCellDecoderFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.SpecificCellDecoderFactory
+
            +
            +
            All Implemented Interfaces:
            KijiCellDecoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class SpecificCellDecoderFactory
            extends Object
            implements KijiCellDecoderFactory
            + + +

            +Factory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellDecoder<?>create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +static KijiCellDecoderFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiCellDecoderFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            an instance of the SpecificCellDecoderFactory.
            +
            +
            +
            + +

            +create

            +
            +public KijiCellDecoder<?> create(CellSpec cellSpec)
+                          throws IOException
            +
            +
            Creates a new Kiji cell decoder. +

            +

            +
            Specified by:
            create in interface KijiCellDecoderFactory
            +
            +
            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell decoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/TableKeyNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/TableKeyNotFoundException.html new file mode 100644 index 00000000..e43055e2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/TableKeyNotFoundException.html @@ -0,0 +1,252 @@ + + + + + + + +TableKeyNotFoundException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class TableKeyNotFoundException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.TableKeyNotFoundException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class TableKeyNotFoundException
            extends RuntimeException
            + + +

            +Thrown when a key is not found in a map-like API implemented by one of the + Kiji tables, the system or meta table for example. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            TableKeyNotFoundException(String message) + +
            +          Constructor.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +TableKeyNotFoundException

            +
            +public TableKeyNotFoundException(String message)
            +
            +
            Constructor. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/CellSchema.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/CellSchema.Builder.html new file mode 100644 index 00000000..b7593ac5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/CellSchema.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +CellSchema.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class CellSchema.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<CellSchema>
+          extended by org.kiji.schema.avro.CellSchema.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<CellSchema>
            +
            +
            +
            Enclosing class:
            CellSchema
            +
            +
            +
            +
            public static class CellSchema.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<CellSchema>
            implements org.apache.avro.data.RecordBuilder<CellSchema>
            + + +

            +RecordBuilder for CellSchema instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + CellSchemabuild() + +
            +           
            + CellSchema.BuilderclearStorage() + +
            +          Clears the value of the 'storage' field
            + CellSchema.BuilderclearType() + +
            +          Clears the value of the 'type' field
            + CellSchema.BuilderclearValue() + +
            +          Clears the value of the 'value' field
            + SchemaStoragegetStorage() + +
            +          Gets the value of the 'storage' field
            + SchemaTypegetType() + +
            +          Gets the value of the 'type' field
            + StringgetValue() + +
            +          Gets the value of the 'value' field
            + booleanhasStorage() + +
            +          Checks whether the 'storage' field has been set
            + booleanhasType() + +
            +          Checks whether the 'type' field has been set
            + booleanhasValue() + +
            +          Checks whether the 'value' field has been set
            + CellSchema.BuildersetStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field
            + CellSchema.BuildersetType(SchemaType value) + +
            +          Sets the value of the 'type' field
            + CellSchema.BuildersetValue(String value) + +
            +          Sets the value of the 'value' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getStorage

            +
            +public SchemaStorage getStorage()
            +
            +
            Gets the value of the 'storage' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setStorage

            +
            +public CellSchema.Builder setStorage(SchemaStorage value)
            +
            +
            Sets the value of the 'storage' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasStorage

            +
            +public boolean hasStorage()
            +
            +
            Checks whether the 'storage' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearStorage

            +
            +public CellSchema.Builder clearStorage()
            +
            +
            Clears the value of the 'storage' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getType

            +
            +public SchemaType getType()
            +
            +
            Gets the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setType

            +
            +public CellSchema.Builder setType(SchemaType value)
            +
            +
            Sets the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasType

            +
            +public boolean hasType()
            +
            +
            Checks whether the 'type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearType

            +
            +public CellSchema.Builder clearType()
            +
            +
            Clears the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public String getValue()
            +
            +
            Gets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public CellSchema.Builder setValue(String value)
            +
            +
            Sets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasValue

            +
            +public boolean hasValue()
            +
            +
            Checks whether the 'value' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearValue

            +
            +public CellSchema.Builder clearValue()
            +
            +
            Clears the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public CellSchema build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<CellSchema>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/CellSchema.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/CellSchema.html new file mode 100644 index 00000000..27403166 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/CellSchema.html @@ -0,0 +1,684 @@ + + + + + + + +CellSchema (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class CellSchema

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.CellSchema
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class CellSchema
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classCellSchema.Builder + +
            +          RecordBuilder for CellSchema instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + SchemaStoragestorage + +
            +          Deprecated. 
            + SchemaTypetype + +
            +          Deprecated. 
            + Stringvalue + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            CellSchema() + +
            +          Default constructor.
            CellSchema(SchemaStorage storage, + SchemaType type, + String value) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + org.apache.avro.SchemagetSchema() + +
            +           
            + SchemaStoragegetStorage() + +
            +          Gets the value of the 'storage' field.
            + SchemaTypegetType() + +
            +          Gets the value of the 'type' field.
            + StringgetValue() + +
            +          Gets the value of the 'value' field.
            +static CellSchema.BuildernewBuilder() + +
            +          Creates a new CellSchema RecordBuilder
            +static CellSchema.BuildernewBuilder(CellSchema.Builder other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing Builder
            +static CellSchema.BuildernewBuilder(CellSchema other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field.
            + voidsetType(SchemaType value) + +
            +          Sets the value of the 'type' field.
            + voidsetValue(String value) + +
            +          Sets the value of the 'value' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +storage

            +
            +@Deprecated
+public SchemaStorage storage
            +
            +
            Deprecated. 
            Schema encoding in cells. Unused if type is COUNTER. +

            +

            +
            +
            +
            + +

            +type

            +
            +@Deprecated
+public SchemaType type
            +
            +
            Deprecated. 
            Type of schema. +

            +

            +
            +
            +
            + +

            +value

            +
            +@Deprecated
+public String value
            +
            +
            Deprecated. 
            Schema value, whose interpretation depends on the schema type: + - inline : immediate Avro schema description, eg. "string"; + - class : Avro schema class name, eg. "org.kiji.avro.Node"; + - counter : unused, must the empty. +

            +

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

            +CellSchema

            +
            +public CellSchema()
            +
            +
            Default constructor. +

            +

            +
            + +

            +CellSchema

            +
            +public CellSchema(SchemaStorage storage,
+                  SchemaType type,
+                  String value)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getStorage

            +
            +public SchemaStorage getStorage()
            +
            +
            Gets the value of the 'storage' field. + Schema encoding in cells. Unused if type is COUNTER. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setStorage

            +
            +public void setStorage(SchemaStorage value)
            +
            +
            Sets the value of the 'storage' field. + Schema encoding in cells. Unused if type is COUNTER. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getType

            +
            +public SchemaType getType()
            +
            +
            Gets the value of the 'type' field. + Type of schema. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setType

            +
            +public void setType(SchemaType value)
            +
            +
            Sets the value of the 'type' field. + Type of schema. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public String getValue()
            +
            +
            Gets the value of the 'value' field. + * Schema value, whose interpretation depends on the schema type: + - inline : immediate Avro schema description, eg. "string"; + - class : Avro schema class name, eg. "org.kiji.avro.Node"; + - counter : unused, must the empty. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public void setValue(String value)
            +
            +
            Sets the value of the 'value' field. + * Schema value, whose interpretation depends on the schema type: + - inline : immediate Avro schema description, eg. "string"; + - class : Avro schema class name, eg. "org.kiji.avro.Node"; + - counter : unused, must the empty. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static CellSchema.Builder newBuilder()
            +
            +
            Creates a new CellSchema RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static CellSchema.Builder newBuilder(CellSchema.Builder other)
            +
            +
            Creates a new CellSchema RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static CellSchema.Builder newBuilder(CellSchema other)
            +
            +
            Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/ColumnDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/ColumnDesc.Builder.html new file mode 100644 index 00000000..2f4ee477 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/ColumnDesc.Builder.html @@ -0,0 +1,1012 @@ + + + + + + + +ColumnDesc.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class ColumnDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<ColumnDesc>
+          extended by org.kiji.schema.avro.ColumnDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<ColumnDesc>
            +
            +
            +
            Enclosing class:
            ColumnDesc
            +
            +
            +
            +
            public static class ColumnDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<ColumnDesc>
            implements org.apache.avro.data.RecordBuilder<ColumnDesc>
            + + +

            +RecordBuilder for ColumnDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + ColumnDescbuild() + +
            +           
            + ColumnDesc.BuilderclearAliases() + +
            +          Clears the value of the 'aliases' field
            + ColumnDesc.BuilderclearColumnSchema() + +
            +          Clears the value of the 'column_schema' field
            + ColumnDesc.BuilderclearDelete() + +
            +          Clears the value of the 'delete' field
            + ColumnDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + ColumnDesc.BuilderclearEnabled() + +
            +          Clears the value of the 'enabled' field
            + ColumnDesc.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + ColumnDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + ColumnDesc.BuilderclearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field
            + CellSchemagetColumnSchema() + +
            +          Gets the value of the 'column_schema' field
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field
            + IntegergetId() + +
            +          Gets the value of the 'id' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field
            + booleanhasAliases() + +
            +          Checks whether the 'aliases' field has been set
            + booleanhasColumnSchema() + +
            +          Checks whether the 'column_schema' field has been set
            + booleanhasDelete() + +
            +          Checks whether the 'delete' field has been set
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasEnabled() + +
            +          Checks whether the 'enabled' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasRenamedFrom() + +
            +          Checks whether the 'renamed_from' field has been set
            + ColumnDesc.BuildersetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + ColumnDesc.BuildersetColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field
            + ColumnDesc.BuildersetDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + ColumnDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + ColumnDesc.BuildersetEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + ColumnDesc.BuildersetId(int value) + +
            +          Sets the value of the 'id' field
            + ColumnDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + ColumnDesc.BuildersetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public ColumnDesc.Builder setId(int value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public ColumnDesc.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public ColumnDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public ColumnDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public ColumnDesc.Builder setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAliases

            +
            +public boolean hasAliases()
            +
            +
            Checks whether the 'aliases' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAliases

            +
            +public ColumnDesc.Builder clearAliases()
            +
            +
            Clears the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public ColumnDesc.Builder setEnabled(boolean value)
            +
            +
            Sets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEnabled

            +
            +public boolean hasEnabled()
            +
            +
            Checks whether the 'enabled' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEnabled

            +
            +public ColumnDesc.Builder clearEnabled()
            +
            +
            Clears the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public ColumnDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public ColumnDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumnSchema

            +
            +public CellSchema getColumnSchema()
            +
            +
            Gets the value of the 'column_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumnSchema

            +
            +public ColumnDesc.Builder setColumnSchema(CellSchema value)
            +
            +
            Sets the value of the 'column_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasColumnSchema

            +
            +public boolean hasColumnSchema()
            +
            +
            Checks whether the 'column_schema' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearColumnSchema

            +
            +public ColumnDesc.Builder clearColumnSchema()
            +
            +
            Clears the value of the 'column_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public ColumnDesc.Builder setDelete(boolean value)
            +
            +
            Sets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDelete

            +
            +public boolean hasDelete()
            +
            +
            Checks whether the 'delete' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDelete

            +
            +public ColumnDesc.Builder clearDelete()
            +
            +
            Clears the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public ColumnDesc.Builder setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasRenamedFrom

            +
            +public boolean hasRenamedFrom()
            +
            +
            Checks whether the 'renamed_from' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearRenamedFrom

            +
            +public ColumnDesc.Builder clearRenamedFrom()
            +
            +
            Clears the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public ColumnDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<ColumnDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/ColumnDesc.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/ColumnDesc.html new file mode 100644 index 00000000..e203c4e5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/ColumnDesc.html @@ -0,0 +1,1040 @@ + + + + + + + +ColumnDesc (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class ColumnDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.ColumnDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class ColumnDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classColumnDesc.Builder + +
            +          RecordBuilder for ColumnDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<String>aliases + +
            +          Deprecated. 
            + CellSchemacolumn_schema + +
            +          Deprecated. 
            + booleandelete + +
            +          Deprecated. 
            + Stringdescription + +
            +          Deprecated. 
            + booleanenabled + +
            +          Deprecated. 
            + intid + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringrenamed_from + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            ColumnDesc() + +
            +          Default constructor.
            ColumnDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema column_schema, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field.
            + CellSchemagetColumnSchema() + +
            +          Gets the value of the 'column_schema' field.
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field.
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field.
            + IntegergetId() + +
            +          Gets the value of the 'id' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static ColumnDesc.BuildernewBuilder() + +
            +          Creates a new ColumnDesc RecordBuilder
            +static ColumnDesc.BuildernewBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +static ColumnDesc.BuildernewBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field.
            + voidsetColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field.
            + voidsetDelete(Boolean value) + +
            +          Sets the value of the 'delete' field.
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetEnabled(Boolean value) + +
            +          Sets the value of the 'enabled' field.
            + voidsetId(Integer value) + +
            +          Sets the value of the 'id' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public int id
            +
            +
            Deprecated. 
            Column ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +aliases

            +
            +@Deprecated
+public List<String> aliases
            +
            +
            Deprecated. 
            Column name aliases. +

            +

            +
            +
            +
            + +

            +enabled

            +
            +@Deprecated
+public boolean enabled
            +
            +
            Deprecated. 
            When false, the column is not visible or usable. +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the column. +

            +

            +
            +
            +
            + +

            +column_schema

            +
            +@Deprecated
+public CellSchema column_schema
            +
            +
            Deprecated. 
            Schema for the cell values. +

            +

            +
            +
            +
            + +

            +delete

            +
            +@Deprecated
+public boolean delete
            +
            +
            Deprecated. 
            When true, applying this layout deletes the column. +

            +

            +
            +
            +
            + +

            +renamed_from

            +
            +@Deprecated
+public String renamed_from
            +
            +
            Deprecated. 
            Reference primary name of the column, when renaming the column. +

            +

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

            +ColumnDesc

            +
            +public ColumnDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +ColumnDesc

            +
            +public ColumnDesc(Integer id,
+                  String name,
+                  List<String> aliases,
+                  Boolean enabled,
+                  String description,
+                  CellSchema column_schema,
+                  Boolean delete,
+                  String renamed_from)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field. + Column ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Integer value)
            +
            +
            Sets the value of the 'id' field. + Column ID. Not visible to the user. 0 means unset. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field. + Column name aliases. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public void setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field. + Column name aliases. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field. + When false, the column is not visible or usable. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public void setEnabled(Boolean value)
            +
            +
            Sets the value of the 'enabled' field. + When false, the column is not visible or usable. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the column. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the column. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumnSchema

            +
            +public CellSchema getColumnSchema()
            +
            +
            Gets the value of the 'column_schema' field. + Schema for the cell values. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumnSchema

            +
            +public void setColumnSchema(CellSchema value)
            +
            +
            Sets the value of the 'column_schema' field. + Schema for the cell values. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field. + When true, applying this layout deletes the column. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public void setDelete(Boolean value)
            +
            +
            Sets the value of the 'delete' field. + When true, applying this layout deletes the column. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field. + Reference primary name of the column, when renaming the column. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public void setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field. + Reference primary name of the column, when renaming the column. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder()
            +
            +
            Creates a new ColumnDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder(ColumnDesc.Builder other)
            +
            +
            Creates a new ColumnDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder(ColumnDesc other)
            +
            +
            Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/CompressionType.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/CompressionType.html new file mode 100644 index 00000000..845dfe23 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/CompressionType.html @@ -0,0 +1,391 @@ + + + + + + + +CompressionType (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum CompressionType

            +
            +java.lang.Object
+  extended by java.lang.Enum<CompressionType>
+      extended by org.kiji.schema.avro.CompressionType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<CompressionType>
            +
            +
            +
            +
            public enum CompressionType
            extends Enum<CompressionType>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            GZ + +
            +           
            LZO + +
            +           
            NONE + +
            +           
            SNAPPY + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static CompressionTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static CompressionType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +NONE

            +
            +public static final CompressionType NONE
            +
            +
            +
            +
            +
            + +

            +GZ

            +
            +public static final CompressionType GZ
            +
            +
            +
            +
            +
            + +

            +LZO

            +
            +public static final CompressionType LZO
            +
            +
            +
            +
            +
            + +

            +SNAPPY

            +
            +public static final CompressionType SNAPPY
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static CompressionType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (CompressionType c : CompressionType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static CompressionType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/FamilyDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/FamilyDesc.Builder.html new file mode 100644 index 00000000..d3aef8e2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/FamilyDesc.Builder.html @@ -0,0 +1,1108 @@ + + + + + + + +FamilyDesc.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class FamilyDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<FamilyDesc>
+          extended by org.kiji.schema.avro.FamilyDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<FamilyDesc>
            +
            +
            +
            Enclosing class:
            FamilyDesc
            +
            +
            +
            +
            public static class FamilyDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<FamilyDesc>
            implements org.apache.avro.data.RecordBuilder<FamilyDesc>
            + + +

            +RecordBuilder for FamilyDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + FamilyDescbuild() + +
            +           
            + FamilyDesc.BuilderclearAliases() + +
            +          Clears the value of the 'aliases' field
            + FamilyDesc.BuilderclearColumns() + +
            +          Clears the value of the 'columns' field
            + FamilyDesc.BuilderclearDelete() + +
            +          Clears the value of the 'delete' field
            + FamilyDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + FamilyDesc.BuilderclearEnabled() + +
            +          Clears the value of the 'enabled' field
            + FamilyDesc.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + FamilyDesc.BuilderclearMapSchema() + +
            +          Clears the value of the 'map_schema' field
            + FamilyDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + FamilyDesc.BuilderclearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field
            + List<ColumnDesc>getColumns() + +
            +          Gets the value of the 'columns' field
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field
            + IntegergetId() + +
            +          Gets the value of the 'id' field
            + CellSchemagetMapSchema() + +
            +          Gets the value of the 'map_schema' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field
            + booleanhasAliases() + +
            +          Checks whether the 'aliases' field has been set
            + booleanhasColumns() + +
            +          Checks whether the 'columns' field has been set
            + booleanhasDelete() + +
            +          Checks whether the 'delete' field has been set
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasEnabled() + +
            +          Checks whether the 'enabled' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + booleanhasMapSchema() + +
            +          Checks whether the 'map_schema' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasRenamedFrom() + +
            +          Checks whether the 'renamed_from' field has been set
            + FamilyDesc.BuildersetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + FamilyDesc.BuildersetColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            + FamilyDesc.BuildersetDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + FamilyDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + FamilyDesc.BuildersetEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + FamilyDesc.BuildersetId(int value) + +
            +          Sets the value of the 'id' field
            + FamilyDesc.BuildersetMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field
            + FamilyDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + FamilyDesc.BuildersetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public FamilyDesc.Builder setId(int value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public FamilyDesc.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public FamilyDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public FamilyDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public FamilyDesc.Builder setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAliases

            +
            +public boolean hasAliases()
            +
            +
            Checks whether the 'aliases' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAliases

            +
            +public FamilyDesc.Builder clearAliases()
            +
            +
            Clears the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public FamilyDesc.Builder setEnabled(boolean value)
            +
            +
            Sets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEnabled

            +
            +public boolean hasEnabled()
            +
            +
            Checks whether the 'enabled' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEnabled

            +
            +public FamilyDesc.Builder clearEnabled()
            +
            +
            Clears the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public FamilyDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public FamilyDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMapSchema

            +
            +public CellSchema getMapSchema()
            +
            +
            Gets the value of the 'map_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMapSchema

            +
            +public FamilyDesc.Builder setMapSchema(CellSchema value)
            +
            +
            Sets the value of the 'map_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasMapSchema

            +
            +public boolean hasMapSchema()
            +
            +
            Checks whether the 'map_schema' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearMapSchema

            +
            +public FamilyDesc.Builder clearMapSchema()
            +
            +
            Clears the value of the 'map_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumns

            +
            +public List<ColumnDesc> getColumns()
            +
            +
            Gets the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumns

            +
            +public FamilyDesc.Builder setColumns(List<ColumnDesc> value)
            +
            +
            Sets the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasColumns

            +
            +public boolean hasColumns()
            +
            +
            Checks whether the 'columns' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearColumns

            +
            +public FamilyDesc.Builder clearColumns()
            +
            +
            Clears the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public FamilyDesc.Builder setDelete(boolean value)
            +
            +
            Sets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDelete

            +
            +public boolean hasDelete()
            +
            +
            Checks whether the 'delete' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDelete

            +
            +public FamilyDesc.Builder clearDelete()
            +
            +
            Clears the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public FamilyDesc.Builder setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasRenamedFrom

            +
            +public boolean hasRenamedFrom()
            +
            +
            Checks whether the 'renamed_from' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearRenamedFrom

            +
            +public FamilyDesc.Builder clearRenamedFrom()
            +
            +
            Clears the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public FamilyDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<FamilyDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/FamilyDesc.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/FamilyDesc.html new file mode 100644 index 00000000..8d26e058 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/FamilyDesc.html @@ -0,0 +1,1113 @@ + + + + + + + +FamilyDesc (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class FamilyDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.FamilyDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class FamilyDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classFamilyDesc.Builder + +
            +          RecordBuilder for FamilyDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<String>aliases + +
            +          Deprecated. 
            + List<ColumnDesc>columns + +
            +          Deprecated. 
            + booleandelete + +
            +          Deprecated. 
            + Stringdescription + +
            +          Deprecated. 
            + booleanenabled + +
            +          Deprecated. 
            + intid + +
            +          Deprecated. 
            + CellSchemamap_schema + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringrenamed_from + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            FamilyDesc() + +
            +          Default constructor.
            FamilyDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema map_schema, + List<ColumnDesc> columns, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field.
            + List<ColumnDesc>getColumns() + +
            +          Gets the value of the 'columns' field.
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field.
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field.
            + IntegergetId() + +
            +          Gets the value of the 'id' field.
            + CellSchemagetMapSchema() + +
            +          Gets the value of the 'map_schema' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static FamilyDesc.BuildernewBuilder() + +
            +          Creates a new FamilyDesc RecordBuilder
            +static FamilyDesc.BuildernewBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +static FamilyDesc.BuildernewBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field.
            + voidsetColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field.
            + voidsetDelete(Boolean value) + +
            +          Sets the value of the 'delete' field.
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetEnabled(Boolean value) + +
            +          Sets the value of the 'enabled' field.
            + voidsetId(Integer value) + +
            +          Sets the value of the 'id' field.
            + voidsetMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public int id
            +
            +
            Deprecated. 
            Family ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +aliases

            +
            +@Deprecated
+public List<String> aliases
            +
            +
            Deprecated. 
            Column family name aliases. +

            +

            +
            +
            +
            + +

            +enabled

            +
            +@Deprecated
+public boolean enabled
            +
            +
            Deprecated. 
            When false, the family and its columns are not visible/usable. +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the column family. +

            +

            +
            +
            +
            + +

            +map_schema

            +
            +@Deprecated
+public CellSchema map_schema
            +
            +
            Deprecated. 
            Cell schema for map-type families. Null for group-type families. +

            +

            +
            +
            +
            + +

            +columns

            +
            +@Deprecated
+public List<ColumnDesc> columns
            +
            +
            Deprecated. 
            Columns, for group-type families only. Empty for map-type families. +

            +

            +
            +
            +
            + +

            +delete

            +
            +@Deprecated
+public boolean delete
            +
            +
            Deprecated. 
            When true, applying this layout deletes the family. +

            +

            +
            +
            +
            + +

            +renamed_from

            +
            +@Deprecated
+public String renamed_from
            +
            +
            Deprecated. 
            Reference primary name of the family, when renaming the family. +

            +

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

            +FamilyDesc

            +
            +public FamilyDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +FamilyDesc

            +
            +public FamilyDesc(Integer id,
+                  String name,
+                  List<String> aliases,
+                  Boolean enabled,
+                  String description,
+                  CellSchema map_schema,
+                  List<ColumnDesc> columns,
+                  Boolean delete,
+                  String renamed_from)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field. + Family ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Integer value)
            +
            +
            Sets the value of the 'id' field. + Family ID. Not visible to the user. 0 means unset. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field. + Column family name aliases. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public void setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field. + Column family name aliases. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field. + When false, the family and its columns are not visible/usable. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public void setEnabled(Boolean value)
            +
            +
            Sets the value of the 'enabled' field. + When false, the family and its columns are not visible/usable. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the column family. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the column family. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMapSchema

            +
            +public CellSchema getMapSchema()
            +
            +
            Gets the value of the 'map_schema' field. + Cell schema for map-type families. Null for group-type families. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMapSchema

            +
            +public void setMapSchema(CellSchema value)
            +
            +
            Sets the value of the 'map_schema' field. + Cell schema for map-type families. Null for group-type families. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumns

            +
            +public List<ColumnDesc> getColumns()
            +
            +
            Gets the value of the 'columns' field. + Columns, for group-type families only. Empty for map-type families. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumns

            +
            +public void setColumns(List<ColumnDesc> value)
            +
            +
            Sets the value of the 'columns' field. + Columns, for group-type families only. Empty for map-type families. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field. + When true, applying this layout deletes the family. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public void setDelete(Boolean value)
            +
            +
            Sets the value of the 'delete' field. + When true, applying this layout deletes the family. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field. + Reference primary name of the family, when renaming the family. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public void setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field. + Reference primary name of the family, when renaming the family. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder()
            +
            +
            Creates a new FamilyDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder(FamilyDesc.Builder other)
            +
            +
            Creates a new FamilyDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder(FamilyDesc other)
            +
            +
            Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/HashType.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/HashType.html new file mode 100644 index 00000000..aa6da23e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/HashType.html @@ -0,0 +1,343 @@ + + + + + + + +HashType (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum HashType

            +
            +java.lang.Object
+  extended by java.lang.Enum<HashType>
+      extended by org.kiji.schema.avro.HashType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<HashType>
            +
            +
            +
            +
            public enum HashType
            extends Enum<HashType>
            + + +

            +

            + +

            + + + + + + + + + + +
            +Enum Constant Summary
            MD5 + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static HashTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static HashType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +MD5

            +
            +public static final HashType MD5
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static HashType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (HashType c : HashType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static HashType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KeyValueBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KeyValueBackupEntry.Builder.html new file mode 100644 index 00000000..f2c19c65 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KeyValueBackupEntry.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +KeyValueBackupEntry.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class KeyValueBackupEntry.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<KeyValueBackupEntry>
+          extended by org.kiji.schema.avro.KeyValueBackupEntry.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<KeyValueBackupEntry>
            +
            +
            +
            Enclosing class:
            KeyValueBackupEntry
            +
            +
            +
            +
            public static class KeyValueBackupEntry.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<KeyValueBackupEntry>
            implements org.apache.avro.data.RecordBuilder<KeyValueBackupEntry>
            + + +

            +RecordBuilder for KeyValueBackupEntry instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KeyValueBackupEntrybuild() + +
            +           
            + KeyValueBackupEntry.BuilderclearKey() + +
            +          Clears the value of the 'key' field
            + KeyValueBackupEntry.BuilderclearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + KeyValueBackupEntry.BuilderclearValue() + +
            +          Clears the value of the 'value' field
            + StringgetKey() + +
            +          Gets the value of the 'key' field
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field
            + ByteBuffergetValue() + +
            +          Gets the value of the 'value' field
            + booleanhasKey() + +
            +          Checks whether the 'key' field has been set
            + booleanhasTimestamp() + +
            +          Checks whether the 'timestamp' field has been set
            + booleanhasValue() + +
            +          Checks whether the 'value' field has been set
            + KeyValueBackupEntry.BuildersetKey(String value) + +
            +          Sets the value of the 'key' field
            + KeyValueBackupEntry.BuildersetTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + KeyValueBackupEntry.BuildersetValue(ByteBuffer value) + +
            +          Sets the value of the 'value' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public KeyValueBackupEntry.Builder setTimestamp(long value)
            +
            +
            Sets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasTimestamp

            +
            +public boolean hasTimestamp()
            +
            +
            Checks whether the 'timestamp' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearTimestamp

            +
            +public KeyValueBackupEntry.Builder clearTimestamp()
            +
            +
            Clears the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKey

            +
            +public String getKey()
            +
            +
            Gets the value of the 'key' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKey

            +
            +public KeyValueBackupEntry.Builder setKey(String value)
            +
            +
            Sets the value of the 'key' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasKey

            +
            +public boolean hasKey()
            +
            +
            Checks whether the 'key' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearKey

            +
            +public KeyValueBackupEntry.Builder clearKey()
            +
            +
            Clears the value of the 'key' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public ByteBuffer getValue()
            +
            +
            Gets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public KeyValueBackupEntry.Builder setValue(ByteBuffer value)
            +
            +
            Sets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasValue

            +
            +public boolean hasValue()
            +
            +
            Checks whether the 'value' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearValue

            +
            +public KeyValueBackupEntry.Builder clearValue()
            +
            +
            Clears the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public KeyValueBackupEntry build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<KeyValueBackupEntry>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KeyValueBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KeyValueBackupEntry.html new file mode 100644 index 00000000..3e6f950c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KeyValueBackupEntry.html @@ -0,0 +1,675 @@ + + + + + + + +KeyValueBackupEntry (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class KeyValueBackupEntry

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.KeyValueBackupEntry
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class KeyValueBackupEntry
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKeyValueBackupEntry.Builder + +
            +          RecordBuilder for KeyValueBackupEntry instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringkey + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + longtimestamp + +
            +          Deprecated. 
            + ByteBuffervalue + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            KeyValueBackupEntry() + +
            +          Default constructor.
            KeyValueBackupEntry(Long timestamp, + String key, + ByteBuffer value) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetKey() + +
            +          Gets the value of the 'key' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field.
            + ByteBuffergetValue() + +
            +          Gets the value of the 'value' field.
            +static KeyValueBackupEntry.BuildernewBuilder() + +
            +          Creates a new KeyValueBackupEntry RecordBuilder
            +static KeyValueBackupEntry.BuildernewBuilder(KeyValueBackupEntry.Builder other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder
            +static KeyValueBackupEntry.BuildernewBuilder(KeyValueBackupEntry other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetKey(String value) + +
            +          Sets the value of the 'key' field.
            + voidsetTimestamp(Long value) + +
            +          Sets the value of the 'timestamp' field.
            + voidsetValue(ByteBuffer value) + +
            +          Sets the value of the 'value' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +timestamp

            +
            +@Deprecated
+public long timestamp
            +
            +
            Deprecated. 
            Time Stamp. +

            +

            +
            +
            +
            + +

            +key

            +
            +@Deprecated
+public String key
            +
            +
            Deprecated. 
            Key. +

            +

            +
            +
            +
            + +

            +value

            +
            +@Deprecated
+public ByteBuffer value
            +
            +
            Deprecated. 
            Value. +

            +

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

            +KeyValueBackupEntry

            +
            +public KeyValueBackupEntry()
            +
            +
            Default constructor. +

            +

            +
            + +

            +KeyValueBackupEntry

            +
            +public KeyValueBackupEntry(Long timestamp,
+                           String key,
+                           ByteBuffer value)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field. + Time Stamp. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public void setTimestamp(Long value)
            +
            +
            Sets the value of the 'timestamp' field. + Time Stamp. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKey

            +
            +public String getKey()
            +
            +
            Gets the value of the 'key' field. + Key. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKey

            +
            +public void setKey(String value)
            +
            +
            Sets the value of the 'key' field. + Key. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public ByteBuffer getValue()
            +
            +
            Gets the value of the 'value' field. + Value. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public void setValue(ByteBuffer value)
            +
            +
            Sets the value of the 'value' field. + Value. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KeyValueBackupEntry.Builder newBuilder()
            +
            +
            Creates a new KeyValueBackupEntry RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KeyValueBackupEntry.Builder newBuilder(KeyValueBackupEntry.Builder other)
            +
            +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KeyValueBackupEntry.Builder newBuilder(KeyValueBackupEntry other)
            +
            +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html new file mode 100644 index 00000000..5f979821 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html @@ -0,0 +1,230 @@ + + + + + + + +KijiTableLayoutRecords.Callback (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Interface KijiTableLayoutRecords.Callback

            +
            +
            All Superinterfaces:
            KijiTableLayoutRecords
            +
            +
            +
            Enclosing interface:
            KijiTableLayoutRecords
            +
            +
            +
            +
            public static interface KijiTableLayoutRecords.Callback
            extends KijiTableLayoutRecords
            + + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.schema.avro.KijiTableLayoutRecords
            KijiTableLayoutRecords.Callback
            +  + + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.ProtocolPROTOCOL + +
            +           
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +PROTOCOL

            +
            +static final org.apache.avro.Protocol PROTOCOL
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KijiTableLayoutRecords.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KijiTableLayoutRecords.html new file mode 100644 index 00000000..867486e2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/KijiTableLayoutRecords.html @@ -0,0 +1,225 @@ + + + + + + + +KijiTableLayoutRecords (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Interface KijiTableLayoutRecords

            +
            +
            All Known Subinterfaces:
            KijiTableLayoutRecords.Callback
            +
            +
            +
            +
            public interface KijiTableLayoutRecords
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static interfaceKijiTableLayoutRecords.Callback + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.ProtocolPROTOCOL + +
            +           
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +PROTOCOL

            +
            +static final org.apache.avro.Protocol PROTOCOL
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/LocalityGroupDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/LocalityGroupDesc.Builder.html new file mode 100644 index 00000000..b8321b12 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/LocalityGroupDesc.Builder.html @@ -0,0 +1,1396 @@ + + + + + + + +LocalityGroupDesc.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class LocalityGroupDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<LocalityGroupDesc>
+          extended by org.kiji.schema.avro.LocalityGroupDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<LocalityGroupDesc>
            +
            +
            +
            Enclosing class:
            LocalityGroupDesc
            +
            +
            +
            +
            public static class LocalityGroupDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<LocalityGroupDesc>
            implements org.apache.avro.data.RecordBuilder<LocalityGroupDesc>
            + + +

            +RecordBuilder for LocalityGroupDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + LocalityGroupDescbuild() + +
            +           
            + LocalityGroupDesc.BuilderclearAliases() + +
            +          Clears the value of the 'aliases' field
            + LocalityGroupDesc.BuilderclearCompressionType() + +
            +          Clears the value of the 'compression_type' field
            + LocalityGroupDesc.BuilderclearDelete() + +
            +          Clears the value of the 'delete' field
            + LocalityGroupDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + LocalityGroupDesc.BuilderclearEnabled() + +
            +          Clears the value of the 'enabled' field
            + LocalityGroupDesc.BuilderclearFamilies() + +
            +          Clears the value of the 'families' field
            + LocalityGroupDesc.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + LocalityGroupDesc.BuilderclearInMemory() + +
            +          Clears the value of the 'in_memory' field
            + LocalityGroupDesc.BuilderclearMaxVersions() + +
            +          Clears the value of the 'max_versions' field
            + LocalityGroupDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + LocalityGroupDesc.BuilderclearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + LocalityGroupDesc.BuilderclearTtlSeconds() + +
            +          Clears the value of the 'ttl_seconds' field
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field
            + CompressionTypegetCompressionType() + +
            +          Gets the value of the 'compression_type' field
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field
            + List<FamilyDesc>getFamilies() + +
            +          Gets the value of the 'families' field
            + IntegergetId() + +
            +          Gets the value of the 'id' field
            + BooleangetInMemory() + +
            +          Gets the value of the 'in_memory' field
            + IntegergetMaxVersions() + +
            +          Gets the value of the 'max_versions' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field
            + IntegergetTtlSeconds() + +
            +          Gets the value of the 'ttl_seconds' field
            + booleanhasAliases() + +
            +          Checks whether the 'aliases' field has been set
            + booleanhasCompressionType() + +
            +          Checks whether the 'compression_type' field has been set
            + booleanhasDelete() + +
            +          Checks whether the 'delete' field has been set
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasEnabled() + +
            +          Checks whether the 'enabled' field has been set
            + booleanhasFamilies() + +
            +          Checks whether the 'families' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + booleanhasInMemory() + +
            +          Checks whether the 'in_memory' field has been set
            + booleanhasMaxVersions() + +
            +          Checks whether the 'max_versions' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasRenamedFrom() + +
            +          Checks whether the 'renamed_from' field has been set
            + booleanhasTtlSeconds() + +
            +          Checks whether the 'ttl_seconds' field has been set
            + LocalityGroupDesc.BuildersetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + LocalityGroupDesc.BuildersetCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field
            + LocalityGroupDesc.BuildersetDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + LocalityGroupDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + LocalityGroupDesc.BuildersetEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + LocalityGroupDesc.BuildersetFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            + LocalityGroupDesc.BuildersetId(int value) + +
            +          Sets the value of the 'id' field
            + LocalityGroupDesc.BuildersetInMemory(boolean value) + +
            +          Sets the value of the 'in_memory' field
            + LocalityGroupDesc.BuildersetMaxVersions(int value) + +
            +          Sets the value of the 'max_versions' field
            + LocalityGroupDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + LocalityGroupDesc.BuildersetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            + LocalityGroupDesc.BuildersetTtlSeconds(int value) + +
            +          Sets the value of the 'ttl_seconds' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public LocalityGroupDesc.Builder setId(int value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public LocalityGroupDesc.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public LocalityGroupDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public LocalityGroupDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public LocalityGroupDesc.Builder setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAliases

            +
            +public boolean hasAliases()
            +
            +
            Checks whether the 'aliases' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAliases

            +
            +public LocalityGroupDesc.Builder clearAliases()
            +
            +
            Clears the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public LocalityGroupDesc.Builder setEnabled(boolean value)
            +
            +
            Sets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEnabled

            +
            +public boolean hasEnabled()
            +
            +
            Checks whether the 'enabled' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEnabled

            +
            +public LocalityGroupDesc.Builder clearEnabled()
            +
            +
            Clears the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public LocalityGroupDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public LocalityGroupDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getInMemory

            +
            +public Boolean getInMemory()
            +
            +
            Gets the value of the 'in_memory' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setInMemory

            +
            +public LocalityGroupDesc.Builder setInMemory(boolean value)
            +
            +
            Sets the value of the 'in_memory' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasInMemory

            +
            +public boolean hasInMemory()
            +
            +
            Checks whether the 'in_memory' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearInMemory

            +
            +public LocalityGroupDesc.Builder clearInMemory()
            +
            +
            Clears the value of the 'in_memory' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMaxVersions

            +
            +public Integer getMaxVersions()
            +
            +
            Gets the value of the 'max_versions' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMaxVersions

            +
            +public LocalityGroupDesc.Builder setMaxVersions(int value)
            +
            +
            Sets the value of the 'max_versions' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasMaxVersions

            +
            +public boolean hasMaxVersions()
            +
            +
            Checks whether the 'max_versions' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearMaxVersions

            +
            +public LocalityGroupDesc.Builder clearMaxVersions()
            +
            +
            Clears the value of the 'max_versions' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getTtlSeconds

            +
            +public Integer getTtlSeconds()
            +
            +
            Gets the value of the 'ttl_seconds' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTtlSeconds

            +
            +public LocalityGroupDesc.Builder setTtlSeconds(int value)
            +
            +
            Sets the value of the 'ttl_seconds' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasTtlSeconds

            +
            +public boolean hasTtlSeconds()
            +
            +
            Checks whether the 'ttl_seconds' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearTtlSeconds

            +
            +public LocalityGroupDesc.Builder clearTtlSeconds()
            +
            +
            Clears the value of the 'ttl_seconds' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getCompressionType

            +
            +public CompressionType getCompressionType()
            +
            +
            Gets the value of the 'compression_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setCompressionType

            +
            +public LocalityGroupDesc.Builder setCompressionType(CompressionType value)
            +
            +
            Sets the value of the 'compression_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasCompressionType

            +
            +public boolean hasCompressionType()
            +
            +
            Checks whether the 'compression_type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearCompressionType

            +
            +public LocalityGroupDesc.Builder clearCompressionType()
            +
            +
            Clears the value of the 'compression_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getFamilies

            +
            +public List<FamilyDesc> getFamilies()
            +
            +
            Gets the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setFamilies

            +
            +public LocalityGroupDesc.Builder setFamilies(List<FamilyDesc> value)
            +
            +
            Sets the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasFamilies

            +
            +public boolean hasFamilies()
            +
            +
            Checks whether the 'families' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearFamilies

            +
            +public LocalityGroupDesc.Builder clearFamilies()
            +
            +
            Clears the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public LocalityGroupDesc.Builder setDelete(boolean value)
            +
            +
            Sets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDelete

            +
            +public boolean hasDelete()
            +
            +
            Checks whether the 'delete' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDelete

            +
            +public LocalityGroupDesc.Builder clearDelete()
            +
            +
            Clears the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public LocalityGroupDesc.Builder setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasRenamedFrom

            +
            +public boolean hasRenamedFrom()
            +
            +
            Checks whether the 'renamed_from' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearRenamedFrom

            +
            +public LocalityGroupDesc.Builder clearRenamedFrom()
            +
            +
            Clears the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public LocalityGroupDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<LocalityGroupDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/LocalityGroupDesc.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/LocalityGroupDesc.html new file mode 100644 index 00000000..e102ff01 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/LocalityGroupDesc.html @@ -0,0 +1,1332 @@ + + + + + + + +LocalityGroupDesc (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class LocalityGroupDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.LocalityGroupDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class LocalityGroupDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classLocalityGroupDesc.Builder + +
            +          RecordBuilder for LocalityGroupDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<String>aliases + +
            +          Deprecated. 
            + CompressionTypecompression_type + +
            +          Deprecated. 
            + booleandelete + +
            +          Deprecated. 
            + Stringdescription + +
            +          Deprecated. 
            + booleanenabled + +
            +          Deprecated. 
            + List<FamilyDesc>families + +
            +          Deprecated. 
            + intid + +
            +          Deprecated. 
            + booleanin_memory + +
            +          Deprecated. 
            + intmax_versions + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringrenamed_from + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + intttl_seconds + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            LocalityGroupDesc() + +
            +          Default constructor.
            LocalityGroupDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + Boolean in_memory, + Integer max_versions, + Integer ttl_seconds, + CompressionType compression_type, + List<FamilyDesc> families, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field.
            + CompressionTypegetCompressionType() + +
            +          Gets the value of the 'compression_type' field.
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field.
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field.
            + List<FamilyDesc>getFamilies() + +
            +          Gets the value of the 'families' field.
            + IntegergetId() + +
            +          Gets the value of the 'id' field.
            + BooleangetInMemory() + +
            +          Gets the value of the 'in_memory' field.
            + IntegergetMaxVersions() + +
            +          Gets the value of the 'max_versions' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + IntegergetTtlSeconds() + +
            +          Gets the value of the 'ttl_seconds' field.
            +static LocalityGroupDesc.BuildernewBuilder() + +
            +          Creates a new LocalityGroupDesc RecordBuilder
            +static LocalityGroupDesc.BuildernewBuilder(LocalityGroupDesc.Builder other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder
            +static LocalityGroupDesc.BuildernewBuilder(LocalityGroupDesc other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field.
            + voidsetCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field.
            + voidsetDelete(Boolean value) + +
            +          Sets the value of the 'delete' field.
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetEnabled(Boolean value) + +
            +          Sets the value of the 'enabled' field.
            + voidsetFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field.
            + voidsetId(Integer value) + +
            +          Sets the value of the 'id' field.
            + voidsetInMemory(Boolean value) + +
            +          Sets the value of the 'in_memory' field.
            + voidsetMaxVersions(Integer value) + +
            +          Sets the value of the 'max_versions' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field.
            + voidsetTtlSeconds(Integer value) + +
            +          Sets the value of the 'ttl_seconds' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public int id
            +
            +
            Deprecated. 
            Locality group ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Locality group primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +aliases

            +
            +@Deprecated
+public List<String> aliases
            +
            +
            Deprecated. 
            Locality group name aliases. +

            +

            +
            +
            +
            + +

            +enabled

            +
            +@Deprecated
+public boolean enabled
            +
            +
            Deprecated. 
            When false, the locality group and its famillies are not visible. +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the locality group. +

            +

            +
            +
            +
            + +

            +in_memory

            +
            +@Deprecated
+public boolean in_memory
            +
            +
            Deprecated. 
            Reduce latency by forcing all data to be kept in memory. +

            +

            +
            +
            +
            + +

            +max_versions

            +
            +@Deprecated
+public int max_versions
            +
            +
            Deprecated. 
            Maximum number of the most recent cell versions to retain. +

            +

            +
            +
            +
            + +

            +ttl_seconds

            +
            +@Deprecated
+public int ttl_seconds
            +
            +
            Deprecated. 
            Length of time in seconds to retain cells. +

            +

            +
            +
            +
            + +

            +compression_type

            +
            +@Deprecated
+public CompressionType compression_type
            +
            +
            Deprecated. 
            Data compression type. +

            +

            +
            +
            +
            + +

            +families

            +
            +@Deprecated
+public List<FamilyDesc> families
            +
            +
            Deprecated. 
            Column family descriptors. +

            +

            +
            +
            +
            + +

            +delete

            +
            +@Deprecated
+public boolean delete
            +
            +
            Deprecated. 
            When true, applying this layout deletes the locality group. +

            +

            +
            +
            +
            + +

            +renamed_from

            +
            +@Deprecated
+public String renamed_from
            +
            +
            Deprecated. 
            Reference primary name of the locality group, when renaming. +

            +

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

            +LocalityGroupDesc

            +
            +public LocalityGroupDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +LocalityGroupDesc

            +
            +public LocalityGroupDesc(Integer id,
+                         String name,
+                         List<String> aliases,
+                         Boolean enabled,
+                         String description,
+                         Boolean in_memory,
+                         Integer max_versions,
+                         Integer ttl_seconds,
+                         CompressionType compression_type,
+                         List<FamilyDesc> families,
+                         Boolean delete,
+                         String renamed_from)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field. + Locality group ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Integer value)
            +
            +
            Sets the value of the 'id' field. + Locality group ID. Not visible to the user. 0 means unset. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Locality group primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Locality group primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field. + Locality group name aliases. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public void setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field. + Locality group name aliases. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field. + When false, the locality group and its famillies are not visible. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public void setEnabled(Boolean value)
            +
            +
            Sets the value of the 'enabled' field. + When false, the locality group and its famillies are not visible. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the locality group. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the locality group. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getInMemory

            +
            +public Boolean getInMemory()
            +
            +
            Gets the value of the 'in_memory' field. + Reduce latency by forcing all data to be kept in memory. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setInMemory

            +
            +public void setInMemory(Boolean value)
            +
            +
            Sets the value of the 'in_memory' field. + Reduce latency by forcing all data to be kept in memory. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMaxVersions

            +
            +public Integer getMaxVersions()
            +
            +
            Gets the value of the 'max_versions' field. + Maximum number of the most recent cell versions to retain. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMaxVersions

            +
            +public void setMaxVersions(Integer value)
            +
            +
            Sets the value of the 'max_versions' field. + Maximum number of the most recent cell versions to retain. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getTtlSeconds

            +
            +public Integer getTtlSeconds()
            +
            +
            Gets the value of the 'ttl_seconds' field. + Length of time in seconds to retain cells. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTtlSeconds

            +
            +public void setTtlSeconds(Integer value)
            +
            +
            Sets the value of the 'ttl_seconds' field. + Length of time in seconds to retain cells. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getCompressionType

            +
            +public CompressionType getCompressionType()
            +
            +
            Gets the value of the 'compression_type' field. + Data compression type. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setCompressionType

            +
            +public void setCompressionType(CompressionType value)
            +
            +
            Sets the value of the 'compression_type' field. + Data compression type. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getFamilies

            +
            +public List<FamilyDesc> getFamilies()
            +
            +
            Gets the value of the 'families' field. + Column family descriptors. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setFamilies

            +
            +public void setFamilies(List<FamilyDesc> value)
            +
            +
            Sets the value of the 'families' field. + Column family descriptors. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field. + When true, applying this layout deletes the locality group. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public void setDelete(Boolean value)
            +
            +
            Sets the value of the 'delete' field. + When true, applying this layout deletes the locality group. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field. + Reference primary name of the locality group, when renaming. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public void setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field. + Reference primary name of the locality group, when renaming. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static LocalityGroupDesc.Builder newBuilder()
            +
            +
            Creates a new LocalityGroupDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static LocalityGroupDesc.Builder newBuilder(LocalityGroupDesc.Builder other)
            +
            +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static LocalityGroupDesc.Builder newBuilder(LocalityGroupDesc other)
            +
            +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/MD5Hash.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/MD5Hash.html new file mode 100644 index 00000000..b7ea695a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/MD5Hash.html @@ -0,0 +1,294 @@ + + + + + + + +MD5Hash (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class MD5Hash

            +
            +java.lang.Object
+  extended by org.apache.avro.generic.GenericData.Fixed
+      extended by org.apache.avro.specific.SpecificFixed
+          extended by org.kiji.schema.avro.MD5Hash
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.generic.GenericData.Fixed>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.GenericFixed
            +
            +
            +
            +
            @FixedSize(value=16)
+public class MD5Hash
            extends org.apache.avro.specific.SpecificFixed
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            MD5Hash() + +
            +          Creates a new MD5Hash
            MD5Hash(byte[] bytes) + +
            +          Creates a new MD5Hash with the given bytes
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.generic.GenericData.Fixed
            bytes, bytes, compareTo, equals, getSchema, hashCode, setSchema, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +MD5Hash

            +
            +public MD5Hash()
            +
            +
            Creates a new MD5Hash +

            +

            +
            + +

            +MD5Hash

            +
            +public MD5Hash(byte[] bytes)
            +
            +
            Creates a new MD5Hash with the given bytes +

            +

            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/MetadataBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/MetadataBackup.Builder.html new file mode 100644 index 00000000..395fd68d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/MetadataBackup.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +MetadataBackup.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class MetadataBackup.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<MetadataBackup>
+          extended by org.kiji.schema.avro.MetadataBackup.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<MetadataBackup>
            +
            +
            +
            Enclosing class:
            MetadataBackup
            +
            +
            +
            +
            public static class MetadataBackup.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<MetadataBackup>
            implements org.apache.avro.data.RecordBuilder<MetadataBackup>
            + + +

            +RecordBuilder for MetadataBackup instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + MetadataBackupbuild() + +
            +           
            + MetadataBackup.BuilderclearLayoutVersion() + +
            +          Clears the value of the 'layout_version' field
            + MetadataBackup.BuilderclearMetaTable() + +
            +          Clears the value of the 'meta_table' field
            + MetadataBackup.BuilderclearSchemaTable() + +
            +          Clears the value of the 'schema_table' field
            + StringgetLayoutVersion() + +
            +          Gets the value of the 'layout_version' field
            + Map<String,TableBackup>getMetaTable() + +
            +          Gets the value of the 'meta_table' field
            + List<SchemaTableEntry>getSchemaTable() + +
            +          Gets the value of the 'schema_table' field
            + booleanhasLayoutVersion() + +
            +          Checks whether the 'layout_version' field has been set
            + booleanhasMetaTable() + +
            +          Checks whether the 'meta_table' field has been set
            + booleanhasSchemaTable() + +
            +          Checks whether the 'schema_table' field has been set
            + MetadataBackup.BuildersetLayoutVersion(String value) + +
            +          Sets the value of the 'layout_version' field
            + MetadataBackup.BuildersetMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field
            + MetadataBackup.BuildersetSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getLayoutVersion

            +
            +public String getLayoutVersion()
            +
            +
            Gets the value of the 'layout_version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutVersion

            +
            +public MetadataBackup.Builder setLayoutVersion(String value)
            +
            +
            Sets the value of the 'layout_version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayoutVersion

            +
            +public boolean hasLayoutVersion()
            +
            +
            Checks whether the 'layout_version' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayoutVersion

            +
            +public MetadataBackup.Builder clearLayoutVersion()
            +
            +
            Clears the value of the 'layout_version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public List<SchemaTableEntry> getSchemaTable()
            +
            +
            Gets the value of the 'schema_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSchemaTable

            +
            +public MetadataBackup.Builder setSchemaTable(List<SchemaTableEntry> value)
            +
            +
            Sets the value of the 'schema_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasSchemaTable

            +
            +public boolean hasSchemaTable()
            +
            +
            Checks whether the 'schema_table' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearSchemaTable

            +
            +public MetadataBackup.Builder clearSchemaTable()
            +
            +
            Clears the value of the 'schema_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMetaTable

            +
            +public Map<String,TableBackup> getMetaTable()
            +
            +
            Gets the value of the 'meta_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMetaTable

            +
            +public MetadataBackup.Builder setMetaTable(Map<String,TableBackup> value)
            +
            +
            Sets the value of the 'meta_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasMetaTable

            +
            +public boolean hasMetaTable()
            +
            +
            Checks whether the 'meta_table' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearMetaTable

            +
            +public MetadataBackup.Builder clearMetaTable()
            +
            +
            Clears the value of the 'meta_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public MetadataBackup build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<MetadataBackup>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/MetadataBackup.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/MetadataBackup.html new file mode 100644 index 00000000..92b01621 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/MetadataBackup.html @@ -0,0 +1,675 @@ + + + + + + + +MetadataBackup (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class MetadataBackup

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.MetadataBackup
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class MetadataBackup
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classMetadataBackup.Builder + +
            +          RecordBuilder for MetadataBackup instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringlayout_version + +
            +          Deprecated. 
            + Map<String,TableBackup>meta_table + +
            +          Deprecated. 
            + List<SchemaTableEntry>schema_table + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            MetadataBackup() + +
            +          Default constructor.
            MetadataBackup(String layout_version, + List<SchemaTableEntry> schema_table, + Map<String,TableBackup> meta_table) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetLayoutVersion() + +
            +          Gets the value of the 'layout_version' field.
            + Map<String,TableBackup>getMetaTable() + +
            +          Gets the value of the 'meta_table' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + List<SchemaTableEntry>getSchemaTable() + +
            +          Gets the value of the 'schema_table' field.
            +static MetadataBackup.BuildernewBuilder() + +
            +          Creates a new MetadataBackup RecordBuilder
            +static MetadataBackup.BuildernewBuilder(MetadataBackup.Builder other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing Builder
            +static MetadataBackup.BuildernewBuilder(MetadataBackup other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetLayoutVersion(String value) + +
            +          Sets the value of the 'layout_version' field.
            + voidsetMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field.
            + voidsetSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +layout_version

            +
            +@Deprecated
+public String layout_version
            +
            +
            Deprecated. 
            Layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            + +

            +schema_table

            +
            +@Deprecated
+public List<SchemaTableEntry> schema_table
            +
            +
            Deprecated. 
            Schema entries. +

            +

            +
            +
            +
            + +

            +meta_table

            +
            +@Deprecated
+public Map<String,TableBackup> meta_table
            +
            +
            Deprecated. 
            Map from table names to table backup records. +

            +

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

            +MetadataBackup

            +
            +public MetadataBackup()
            +
            +
            Default constructor. +

            +

            +
            + +

            +MetadataBackup

            +
            +public MetadataBackup(String layout_version,
+                      List<SchemaTableEntry> schema_table,
+                      Map<String,TableBackup> meta_table)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getLayoutVersion

            +
            +public String getLayoutVersion()
            +
            +
            Gets the value of the 'layout_version' field. + Layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutVersion

            +
            +public void setLayoutVersion(String value)
            +
            +
            Sets the value of the 'layout_version' field. + Layout version (eg. "kiji-1.0"). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public List<SchemaTableEntry> getSchemaTable()
            +
            +
            Gets the value of the 'schema_table' field. + Schema entries. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSchemaTable

            +
            +public void setSchemaTable(List<SchemaTableEntry> value)
            +
            +
            Sets the value of the 'schema_table' field. + Schema entries. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMetaTable

            +
            +public Map<String,TableBackup> getMetaTable()
            +
            +
            Gets the value of the 'meta_table' field. + Map from table names to table backup records. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMetaTable

            +
            +public void setMetaTable(Map<String,TableBackup> value)
            +
            +
            Sets the value of the 'meta_table' field. + Map from table names to table backup records. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static MetadataBackup.Builder newBuilder()
            +
            +
            Creates a new MetadataBackup RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static MetadataBackup.Builder newBuilder(MetadataBackup.Builder other)
            +
            +
            Creates a new MetadataBackup RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static MetadataBackup.Builder newBuilder(MetadataBackup other)
            +
            +
            Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/RowKeyEncoding.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/RowKeyEncoding.html new file mode 100644 index 00000000..e272ec48 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/RowKeyEncoding.html @@ -0,0 +1,375 @@ + + + + + + + +RowKeyEncoding (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum RowKeyEncoding

            +
            +java.lang.Object
+  extended by java.lang.Enum<RowKeyEncoding>
+      extended by org.kiji.schema.avro.RowKeyEncoding
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<RowKeyEncoding>
            +
            +
            +
            +
            public enum RowKeyEncoding
            extends Enum<RowKeyEncoding>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            HASH + +
            +           
            HASH_PREFIX + +
            +           
            RAW + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static RowKeyEncodingvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static RowKeyEncoding[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +RAW

            +
            +public static final RowKeyEncoding RAW
            +
            +
            +
            +
            +
            + +

            +HASH

            +
            +public static final RowKeyEncoding HASH
            +
            +
            +
            +
            +
            + +

            +HASH_PREFIX

            +
            +public static final RowKeyEncoding HASH_PREFIX
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static RowKeyEncoding[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (RowKeyEncoding c : RowKeyEncoding.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static RowKeyEncoding valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/RowKeyFormat.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/RowKeyFormat.Builder.html new file mode 100644 index 00000000..8fc4b7ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/RowKeyFormat.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +RowKeyFormat.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class RowKeyFormat.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<RowKeyFormat>
+          extended by org.kiji.schema.avro.RowKeyFormat.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<RowKeyFormat>
            +
            +
            +
            Enclosing class:
            RowKeyFormat
            +
            +
            +
            +
            public static class RowKeyFormat.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<RowKeyFormat>
            implements org.apache.avro.data.RecordBuilder<RowKeyFormat>
            + + +

            +RecordBuilder for RowKeyFormat instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + RowKeyFormatbuild() + +
            +           
            + RowKeyFormat.BuilderclearEncoding() + +
            +          Clears the value of the 'encoding' field
            + RowKeyFormat.BuilderclearHashSize() + +
            +          Clears the value of the 'hash_size' field
            + RowKeyFormat.BuilderclearHashType() + +
            +          Clears the value of the 'hash_type' field
            + RowKeyEncodinggetEncoding() + +
            +          Gets the value of the 'encoding' field
            + IntegergetHashSize() + +
            +          Gets the value of the 'hash_size' field
            + HashTypegetHashType() + +
            +          Gets the value of the 'hash_type' field
            + booleanhasEncoding() + +
            +          Checks whether the 'encoding' field has been set
            + booleanhasHashSize() + +
            +          Checks whether the 'hash_size' field has been set
            + booleanhasHashType() + +
            +          Checks whether the 'hash_type' field has been set
            + RowKeyFormat.BuildersetEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            + RowKeyFormat.BuildersetHashSize(int value) + +
            +          Sets the value of the 'hash_size' field
            + RowKeyFormat.BuildersetHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEncoding

            +
            +public RowKeyEncoding getEncoding()
            +
            +
            Gets the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEncoding

            +
            +public RowKeyFormat.Builder setEncoding(RowKeyEncoding value)
            +
            +
            Sets the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEncoding

            +
            +public boolean hasEncoding()
            +
            +
            Checks whether the 'encoding' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEncoding

            +
            +public RowKeyFormat.Builder clearEncoding()
            +
            +
            Clears the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashType

            +
            +public HashType getHashType()
            +
            +
            Gets the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashType

            +
            +public RowKeyFormat.Builder setHashType(HashType value)
            +
            +
            Sets the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHashType

            +
            +public boolean hasHashType()
            +
            +
            Checks whether the 'hash_type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHashType

            +
            +public RowKeyFormat.Builder clearHashType()
            +
            +
            Clears the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashSize

            +
            +public Integer getHashSize()
            +
            +
            Gets the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashSize

            +
            +public RowKeyFormat.Builder setHashSize(int value)
            +
            +
            Sets the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHashSize

            +
            +public boolean hasHashSize()
            +
            +
            Checks whether the 'hash_size' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHashSize

            +
            +public RowKeyFormat.Builder clearHashSize()
            +
            +
            Clears the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public RowKeyFormat build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<RowKeyFormat>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/RowKeyFormat.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/RowKeyFormat.html new file mode 100644 index 00000000..45fd9778 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/RowKeyFormat.html @@ -0,0 +1,681 @@ + + + + + + + +RowKeyFormat (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class RowKeyFormat

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.RowKeyFormat
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class RowKeyFormat
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classRowKeyFormat.Builder + +
            +          RecordBuilder for RowKeyFormat instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + RowKeyEncodingencoding + +
            +          Deprecated. 
            + inthash_size + +
            +          Deprecated. 
            + HashTypehash_type + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            RowKeyFormat() + +
            +          Default constructor.
            RowKeyFormat(RowKeyEncoding encoding, + HashType hash_type, + Integer hash_size) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + RowKeyEncodinggetEncoding() + +
            +          Gets the value of the 'encoding' field.
            + IntegergetHashSize() + +
            +          Gets the value of the 'hash_size' field.
            + HashTypegetHashType() + +
            +          Gets the value of the 'hash_type' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static RowKeyFormat.BuildernewBuilder() + +
            +          Creates a new RowKeyFormat RecordBuilder
            +static RowKeyFormat.BuildernewBuilder(RowKeyFormat.Builder other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing Builder
            +static RowKeyFormat.BuildernewBuilder(RowKeyFormat other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field.
            + voidsetHashSize(Integer value) + +
            +          Sets the value of the 'hash_size' field.
            + voidsetHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +encoding

            +
            +@Deprecated
+public RowKeyEncoding encoding
            +
            +
            Deprecated. 
            Encoding of the row key. +

            +

            +
            +
            +
            + +

            +hash_type

            +
            +@Deprecated
+public HashType hash_type
            +
            +
            Deprecated. 
            Type of hashing used, if any. +

            +

            +
            +
            +
            + +

            +hash_size

            +
            +@Deprecated
+public int hash_size
            +
            +
            Deprecated. 
            Size of the hash, in bytes. + - unused when encoding is RAW. + - smaller than the hash size used for HASH or HASH_PREFIX. +

            +

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

            +RowKeyFormat

            +
            +public RowKeyFormat()
            +
            +
            Default constructor. +

            +

            +
            + +

            +RowKeyFormat

            +
            +public RowKeyFormat(RowKeyEncoding encoding,
+                    HashType hash_type,
+                    Integer hash_size)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getEncoding

            +
            +public RowKeyEncoding getEncoding()
            +
            +
            Gets the value of the 'encoding' field. + Encoding of the row key. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEncoding

            +
            +public void setEncoding(RowKeyEncoding value)
            +
            +
            Sets the value of the 'encoding' field. + Encoding of the row key. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashType

            +
            +public HashType getHashType()
            +
            +
            Gets the value of the 'hash_type' field. + Type of hashing used, if any. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashType

            +
            +public void setHashType(HashType value)
            +
            +
            Sets the value of the 'hash_type' field. + Type of hashing used, if any. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashSize

            +
            +public Integer getHashSize()
            +
            +
            Gets the value of the 'hash_size' field. + * Size of the hash, in bytes. + - unused when encoding is RAW. + - smaller than the hash size used for HASH or HASH_PREFIX. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashSize

            +
            +public void setHashSize(Integer value)
            +
            +
            Sets the value of the 'hash_size' field. + * Size of the hash, in bytes. + - unused when encoding is RAW. + - smaller than the hash size used for HASH or HASH_PREFIX. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat.Builder newBuilder()
            +
            +
            Creates a new RowKeyFormat RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat.Builder newBuilder(RowKeyFormat.Builder other)
            +
            +
            Creates a new RowKeyFormat RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat.Builder newBuilder(RowKeyFormat other)
            +
            +
            Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaStorage.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaStorage.html new file mode 100644 index 00000000..c378fbf5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaStorage.html @@ -0,0 +1,375 @@ + + + + + + + +SchemaStorage (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum SchemaStorage

            +
            +java.lang.Object
+  extended by java.lang.Enum<SchemaStorage>
+      extended by org.kiji.schema.avro.SchemaStorage
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<SchemaStorage>
            +
            +
            +
            +
            public enum SchemaStorage
            extends Enum<SchemaStorage>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            FINAL + +
            +           
            HASH + +
            +           
            UID + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static SchemaStoragevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaStorage[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +HASH

            +
            +public static final SchemaStorage HASH
            +
            +
            +
            +
            +
            + +

            +UID

            +
            +public static final SchemaStorage UID
            +
            +
            +
            +
            +
            + +

            +FINAL

            +
            +public static final SchemaStorage FINAL
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static SchemaStorage[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (SchemaStorage c : SchemaStorage.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static SchemaStorage valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaTableEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaTableEntry.Builder.html new file mode 100644 index 00000000..07e914f4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaTableEntry.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +SchemaTableEntry.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class SchemaTableEntry.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<SchemaTableEntry>
+          extended by org.kiji.schema.avro.SchemaTableEntry.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<SchemaTableEntry>
            +
            +
            +
            Enclosing class:
            SchemaTableEntry
            +
            +
            +
            +
            public static class SchemaTableEntry.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<SchemaTableEntry>
            implements org.apache.avro.data.RecordBuilder<SchemaTableEntry>
            + + +

            +RecordBuilder for SchemaTableEntry instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + SchemaTableEntrybuild() + +
            +           
            + SchemaTableEntry.BuilderclearAvroSchema() + +
            +          Clears the value of the 'avro_schema' field
            + SchemaTableEntry.BuilderclearHash() + +
            +          Clears the value of the 'hash' field
            + SchemaTableEntry.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + StringgetAvroSchema() + +
            +          Gets the value of the 'avro_schema' field
            + MD5HashgetHash() + +
            +          Gets the value of the 'hash' field
            + LonggetId() + +
            +          Gets the value of the 'id' field
            + booleanhasAvroSchema() + +
            +          Checks whether the 'avro_schema' field has been set
            + booleanhasHash() + +
            +          Checks whether the 'hash' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + SchemaTableEntry.BuildersetAvroSchema(String value) + +
            +          Sets the value of the 'avro_schema' field
            + SchemaTableEntry.BuildersetHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field
            + SchemaTableEntry.BuildersetId(long value) + +
            +          Sets the value of the 'id' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Long getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public SchemaTableEntry.Builder setId(long value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public SchemaTableEntry.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHash

            +
            +public MD5Hash getHash()
            +
            +
            Gets the value of the 'hash' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHash

            +
            +public SchemaTableEntry.Builder setHash(MD5Hash value)
            +
            +
            Sets the value of the 'hash' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHash

            +
            +public boolean hasHash()
            +
            +
            Checks whether the 'hash' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHash

            +
            +public SchemaTableEntry.Builder clearHash()
            +
            +
            Clears the value of the 'hash' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAvroSchema

            +
            +public String getAvroSchema()
            +
            +
            Gets the value of the 'avro_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAvroSchema

            +
            +public SchemaTableEntry.Builder setAvroSchema(String value)
            +
            +
            Sets the value of the 'avro_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAvroSchema

            +
            +public boolean hasAvroSchema()
            +
            +
            Checks whether the 'avro_schema' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAvroSchema

            +
            +public SchemaTableEntry.Builder clearAvroSchema()
            +
            +
            Clears the value of the 'avro_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public SchemaTableEntry build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<SchemaTableEntry>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaTableEntry.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaTableEntry.html new file mode 100644 index 00000000..b91e06f5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaTableEntry.html @@ -0,0 +1,675 @@ + + + + + + + +SchemaTableEntry (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class SchemaTableEntry

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.SchemaTableEntry
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class SchemaTableEntry
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classSchemaTableEntry.Builder + +
            +          RecordBuilder for SchemaTableEntry instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringavro_schema + +
            +          Deprecated. 
            + MD5Hashhash + +
            +          Deprecated. 
            + longid + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            SchemaTableEntry() + +
            +          Default constructor.
            SchemaTableEntry(Long id, + MD5Hash hash, + String avro_schema) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetAvroSchema() + +
            +          Gets the value of the 'avro_schema' field.
            + MD5HashgetHash() + +
            +          Gets the value of the 'hash' field.
            + LonggetId() + +
            +          Gets the value of the 'id' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static SchemaTableEntry.BuildernewBuilder() + +
            +          Creates a new SchemaTableEntry RecordBuilder
            +static SchemaTableEntry.BuildernewBuilder(SchemaTableEntry.Builder other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder
            +static SchemaTableEntry.BuildernewBuilder(SchemaTableEntry other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAvroSchema(String value) + +
            +          Sets the value of the 'avro_schema' field.
            + voidsetHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field.
            + voidsetId(Long value) + +
            +          Sets the value of the 'id' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public long id
            +
            +
            Deprecated. 
            Schema ID: positive integers only. +

            +

            +
            +
            +
            + +

            +hash

            +
            +@Deprecated
+public MD5Hash hash
            +
            +
            Deprecated. 
            128 bits (16 bytes) hash of the schema JSON representation. +

            +

            +
            +
            +
            + +

            +avro_schema

            +
            +@Deprecated
+public String avro_schema
            +
            +
            Deprecated. 
            JSON representation of the schema. +

            +

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

            +SchemaTableEntry

            +
            +public SchemaTableEntry()
            +
            +
            Default constructor. +

            +

            +
            + +

            +SchemaTableEntry

            +
            +public SchemaTableEntry(Long id,
+                        MD5Hash hash,
+                        String avro_schema)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Long getId()
            +
            +
            Gets the value of the 'id' field. + Schema ID: positive integers only. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Long value)
            +
            +
            Sets the value of the 'id' field. + Schema ID: positive integers only. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHash

            +
            +public MD5Hash getHash()
            +
            +
            Gets the value of the 'hash' field. + 128 bits (16 bytes) hash of the schema JSON representation. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHash

            +
            +public void setHash(MD5Hash value)
            +
            +
            Sets the value of the 'hash' field. + 128 bits (16 bytes) hash of the schema JSON representation. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAvroSchema

            +
            +public String getAvroSchema()
            +
            +
            Gets the value of the 'avro_schema' field. + JSON representation of the schema. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAvroSchema

            +
            +public void setAvroSchema(String value)
            +
            +
            Sets the value of the 'avro_schema' field. + JSON representation of the schema. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static SchemaTableEntry.Builder newBuilder()
            +
            +
            Creates a new SchemaTableEntry RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static SchemaTableEntry.Builder newBuilder(SchemaTableEntry.Builder other)
            +
            +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static SchemaTableEntry.Builder newBuilder(SchemaTableEntry other)
            +
            +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaType.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaType.html new file mode 100644 index 00000000..9f292b75 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/SchemaType.html @@ -0,0 +1,375 @@ + + + + + + + +SchemaType (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum SchemaType

            +
            +java.lang.Object
+  extended by java.lang.Enum<SchemaType>
+      extended by org.kiji.schema.avro.SchemaType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<SchemaType>
            +
            +
            +
            +
            public enum SchemaType
            extends Enum<SchemaType>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            CLASS + +
            +           
            COUNTER + +
            +           
            INLINE + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static SchemaTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +INLINE

            +
            +public static final SchemaType INLINE
            +
            +
            +
            +
            +
            + +

            +CLASS

            +
            +public static final SchemaType CLASS
            +
            +
            +
            +
            +
            + +

            +COUNTER

            +
            +public static final SchemaType COUNTER
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static SchemaType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (SchemaType c : SchemaType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static SchemaType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableBackup.Builder.html new file mode 100644 index 00000000..6690b4a1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableBackup.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +TableBackup.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableBackup.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<TableBackup>
+          extended by org.kiji.schema.avro.TableBackup.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<TableBackup>
            +
            +
            +
            Enclosing class:
            TableBackup
            +
            +
            +
            +
            public static class TableBackup.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<TableBackup>
            implements org.apache.avro.data.RecordBuilder<TableBackup>
            + + +

            +RecordBuilder for TableBackup instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TableBackupbuild() + +
            +           
            + TableBackup.BuilderclearKeyValues() + +
            +          Clears the value of the 'key_values' field
            + TableBackup.BuilderclearLayouts() + +
            +          Clears the value of the 'layouts' field
            + TableBackup.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + List<KeyValueBackupEntry>getKeyValues() + +
            +          Gets the value of the 'key_values' field
            + List<TableLayoutBackupEntry>getLayouts() + +
            +          Gets the value of the 'layouts' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + booleanhasKeyValues() + +
            +          Checks whether the 'key_values' field has been set
            + booleanhasLayouts() + +
            +          Checks whether the 'layouts' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + TableBackup.BuildersetKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field
            + TableBackup.BuildersetLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field
            + TableBackup.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public TableBackup.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public TableBackup.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayouts

            +
            +public List<TableLayoutBackupEntry> getLayouts()
            +
            +
            Gets the value of the 'layouts' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayouts

            +
            +public TableBackup.Builder setLayouts(List<TableLayoutBackupEntry> value)
            +
            +
            Sets the value of the 'layouts' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayouts

            +
            +public boolean hasLayouts()
            +
            +
            Checks whether the 'layouts' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayouts

            +
            +public TableBackup.Builder clearLayouts()
            +
            +
            Clears the value of the 'layouts' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeyValues

            +
            +public List<KeyValueBackupEntry> getKeyValues()
            +
            +
            Gets the value of the 'key_values' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeyValues

            +
            +public TableBackup.Builder setKeyValues(List<KeyValueBackupEntry> value)
            +
            +
            Sets the value of the 'key_values' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasKeyValues

            +
            +public boolean hasKeyValues()
            +
            +
            Checks whether the 'key_values' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearKeyValues

            +
            +public TableBackup.Builder clearKeyValues()
            +
            +
            Clears the value of the 'key_values' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public TableBackup build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<TableBackup>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableBackup.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableBackup.html new file mode 100644 index 00000000..8ca5bf18 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableBackup.html @@ -0,0 +1,675 @@ + + + + + + + +TableBackup (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableBackup

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.TableBackup
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class TableBackup
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTableBackup.Builder + +
            +          RecordBuilder for TableBackup instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<KeyValueBackupEntry>key_values + +
            +          Deprecated. 
            + List<TableLayoutBackupEntry>layouts + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            TableBackup() + +
            +          Default constructor.
            TableBackup(String name, + List<TableLayoutBackupEntry> layouts, + List<KeyValueBackupEntry> key_values) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<KeyValueBackupEntry>getKeyValues() + +
            +          Gets the value of the 'key_values' field.
            + List<TableLayoutBackupEntry>getLayouts() + +
            +          Gets the value of the 'layouts' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static TableBackup.BuildernewBuilder() + +
            +          Creates a new TableBackup RecordBuilder
            +static TableBackup.BuildernewBuilder(TableBackup.Builder other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing Builder
            +static TableBackup.BuildernewBuilder(TableBackup other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field.
            + voidsetLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Table name. +

            +

            +
            +
            +
            + +

            +layouts

            +
            +@Deprecated
+public List<TableLayoutBackupEntry> layouts
            +
            +
            Deprecated. 
            Sequence of layouts for the specified table, in order +

            +

            +
            +
            +
            + +

            +key_values

            +
            +@Deprecated
+public List<KeyValueBackupEntry> key_values
            +
            +
            Deprecated. 
            Sequence of user defined key-value pairs for the specified table, in order. +

            +

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

            +TableBackup

            +
            +public TableBackup()
            +
            +
            Default constructor. +

            +

            +
            + +

            +TableBackup

            +
            +public TableBackup(String name,
+                   List<TableLayoutBackupEntry> layouts,
+                   List<KeyValueBackupEntry> key_values)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Table name. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Table name. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayouts

            +
            +public List<TableLayoutBackupEntry> getLayouts()
            +
            +
            Gets the value of the 'layouts' field. + Sequence of layouts for the specified table, in order +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayouts

            +
            +public void setLayouts(List<TableLayoutBackupEntry> value)
            +
            +
            Sets the value of the 'layouts' field. + Sequence of layouts for the specified table, in order * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeyValues

            +
            +public List<KeyValueBackupEntry> getKeyValues()
            +
            +
            Gets the value of the 'key_values' field. + Sequence of user defined key-value pairs for the specified table, in order. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeyValues

            +
            +public void setKeyValues(List<KeyValueBackupEntry> value)
            +
            +
            Sets the value of the 'key_values' field. + Sequence of user defined key-value pairs for the specified table, in order. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableBackup.Builder newBuilder()
            +
            +
            Creates a new TableBackup RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableBackup.Builder newBuilder(TableBackup.Builder other)
            +
            +
            Creates a new TableBackup RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableBackup.Builder newBuilder(TableBackup other)
            +
            +
            Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html new file mode 100644 index 00000000..4297fa74 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +TableLayoutBackupEntry.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutBackupEntry.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutBackupEntry>
+          extended by org.kiji.schema.avro.TableLayoutBackupEntry.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<TableLayoutBackupEntry>
            +
            +
            +
            Enclosing class:
            TableLayoutBackupEntry
            +
            +
            +
            +
            public static class TableLayoutBackupEntry.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutBackupEntry>
            implements org.apache.avro.data.RecordBuilder<TableLayoutBackupEntry>
            + + +

            +RecordBuilder for TableLayoutBackupEntry instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TableLayoutBackupEntrybuild() + +
            +           
            + TableLayoutBackupEntry.BuilderclearLayout() + +
            +          Clears the value of the 'layout' field
            + TableLayoutBackupEntry.BuilderclearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuilderclearUpdate() + +
            +          Clears the value of the 'update' field
            + TableLayoutDescgetLayout() + +
            +          Gets the value of the 'layout' field
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field
            + TableLayoutDescgetUpdate() + +
            +          Gets the value of the 'update' field
            + booleanhasLayout() + +
            +          Checks whether the 'layout' field has been set
            + booleanhasTimestamp() + +
            +          Checks whether the 'timestamp' field has been set
            + booleanhasUpdate() + +
            +          Checks whether the 'update' field has been set
            + TableLayoutBackupEntry.BuildersetLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field
            + TableLayoutBackupEntry.BuildersetTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuildersetUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public TableLayoutBackupEntry.Builder setTimestamp(long value)
            +
            +
            Sets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasTimestamp

            +
            +public boolean hasTimestamp()
            +
            +
            Checks whether the 'timestamp' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearTimestamp

            +
            +public TableLayoutBackupEntry.Builder clearTimestamp()
            +
            +
            Clears the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getUpdate

            +
            +public TableLayoutDesc getUpdate()
            +
            +
            Gets the value of the 'update' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setUpdate

            +
            +public TableLayoutBackupEntry.Builder setUpdate(TableLayoutDesc value)
            +
            +
            Sets the value of the 'update' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasUpdate

            +
            +public boolean hasUpdate()
            +
            +
            Checks whether the 'update' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearUpdate

            +
            +public TableLayoutBackupEntry.Builder clearUpdate()
            +
            +
            Clears the value of the 'update' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayout

            +
            +public TableLayoutDesc getLayout()
            +
            +
            Gets the value of the 'layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayout

            +
            +public TableLayoutBackupEntry.Builder setLayout(TableLayoutDesc value)
            +
            +
            Sets the value of the 'layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayout

            +
            +public boolean hasLayout()
            +
            +
            Checks whether the 'layout' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayout

            +
            +public TableLayoutBackupEntry.Builder clearLayout()
            +
            +
            Clears the value of the 'layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public TableLayoutBackupEntry build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<TableLayoutBackupEntry>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutBackupEntry.html new file mode 100644 index 00000000..304ddccc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutBackupEntry.html @@ -0,0 +1,678 @@ + + + + + + + +TableLayoutBackupEntry (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutBackupEntry

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.TableLayoutBackupEntry
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class TableLayoutBackupEntry
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTableLayoutBackupEntry.Builder + +
            +          RecordBuilder for TableLayoutBackupEntry instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + TableLayoutDesclayout + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + longtimestamp + +
            +          Deprecated. 
            + TableLayoutDescupdate + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            TableLayoutBackupEntry() + +
            +          Default constructor.
            TableLayoutBackupEntry(Long timestamp, + TableLayoutDesc update, + TableLayoutDesc layout) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + TableLayoutDescgetLayout() + +
            +          Gets the value of the 'layout' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field.
            + TableLayoutDescgetUpdate() + +
            +          Gets the value of the 'update' field.
            +static TableLayoutBackupEntry.BuildernewBuilder() + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder
            +static TableLayoutBackupEntry.BuildernewBuilder(TableLayoutBackupEntry.Builder other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder
            +static TableLayoutBackupEntry.BuildernewBuilder(TableLayoutBackupEntry other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field.
            + voidsetTimestamp(Long value) + +
            +          Sets the value of the 'timestamp' field.
            + voidsetUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +timestamp

            +
            +@Deprecated
+public long timestamp
            +
            +
            Deprecated. 
            Time Stamp. +

            +

            +
            +
            +
            + +

            +update

            +
            +@Deprecated
+public TableLayoutDesc update
            +
            +
            Deprecated. 
            Table layout update, as specified by the submitter/user. + Except for the first one, the update builds on the previous layout. +

            +

            +
            +
            +
            + +

            +layout

            +
            +@Deprecated
+public TableLayoutDesc layout
            +
            +
            Deprecated. 
            Effective table layout, after applying the update. +

            +

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

            +TableLayoutBackupEntry

            +
            +public TableLayoutBackupEntry()
            +
            +
            Default constructor. +

            +

            +
            + +

            +TableLayoutBackupEntry

            +
            +public TableLayoutBackupEntry(Long timestamp,
+                              TableLayoutDesc update,
+                              TableLayoutDesc layout)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field. + Time Stamp. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public void setTimestamp(Long value)
            +
            +
            Sets the value of the 'timestamp' field. + Time Stamp. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getUpdate

            +
            +public TableLayoutDesc getUpdate()
            +
            +
            Gets the value of the 'update' field. + * Table layout update, as specified by the submitter/user. + Except for the first one, the update builds on the previous layout. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setUpdate

            +
            +public void setUpdate(TableLayoutDesc value)
            +
            +
            Sets the value of the 'update' field. + * Table layout update, as specified by the submitter/user. + Except for the first one, the update builds on the previous layout. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayout

            +
            +public TableLayoutDesc getLayout()
            +
            +
            Gets the value of the 'layout' field. + Effective table layout, after applying the update. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayout

            +
            +public void setLayout(TableLayoutDesc value)
            +
            +
            Sets the value of the 'layout' field. + Effective table layout, after applying the update. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutBackupEntry.Builder newBuilder()
            +
            +
            Creates a new TableLayoutBackupEntry RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutBackupEntry.Builder newBuilder(TableLayoutBackupEntry.Builder other)
            +
            +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutBackupEntry.Builder newBuilder(TableLayoutBackupEntry other)
            +
            +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutDesc.Builder.html new file mode 100644 index 00000000..b2c6ec70 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutDesc.Builder.html @@ -0,0 +1,916 @@ + + + + + + + +TableLayoutDesc.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutDesc>
+          extended by org.kiji.schema.avro.TableLayoutDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<TableLayoutDesc>
            +
            +
            +
            Enclosing class:
            TableLayoutDesc
            +
            +
            +
            +
            public static class TableLayoutDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutDesc>
            implements org.apache.avro.data.RecordBuilder<TableLayoutDesc>
            + + +

            +RecordBuilder for TableLayoutDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TableLayoutDescbuild() + +
            +           
            + TableLayoutDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + TableLayoutDesc.BuilderclearKeysFormat() + +
            +          Clears the value of the 'keys_format' field
            + TableLayoutDesc.BuilderclearLayoutId() + +
            +          Clears the value of the 'layout_id' field
            + TableLayoutDesc.BuilderclearLocalityGroups() + +
            +          Clears the value of the 'locality_groups' field
            + TableLayoutDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + TableLayoutDesc.BuilderclearReferenceLayout() + +
            +          Clears the value of the 'reference_layout' field
            + TableLayoutDesc.BuilderclearVersion() + +
            +          Clears the value of the 'version' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + RowKeyFormatgetKeysFormat() + +
            +          Gets the value of the 'keys_format' field
            + StringgetLayoutId() + +
            +          Gets the value of the 'layout_id' field
            + List<LocalityGroupDesc>getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetReferenceLayout() + +
            +          Gets the value of the 'reference_layout' field
            + StringgetVersion() + +
            +          Gets the value of the 'version' field
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasKeysFormat() + +
            +          Checks whether the 'keys_format' field has been set
            + booleanhasLayoutId() + +
            +          Checks whether the 'layout_id' field has been set
            + booleanhasLocalityGroups() + +
            +          Checks whether the 'locality_groups' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasReferenceLayout() + +
            +          Checks whether the 'reference_layout' field has been set
            + booleanhasVersion() + +
            +          Checks whether the 'version' field has been set
            + TableLayoutDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + TableLayoutDesc.BuildersetKeysFormat(RowKeyFormat value) + +
            +          Sets the value of the 'keys_format' field
            + TableLayoutDesc.BuildersetLayoutId(String value) + +
            +          Sets the value of the 'layout_id' field
            + TableLayoutDesc.BuildersetLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field
            + TableLayoutDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + TableLayoutDesc.BuildersetReferenceLayout(String value) + +
            +          Sets the value of the 'reference_layout' field
            + TableLayoutDesc.BuildersetVersion(String value) + +
            +          Sets the value of the 'version' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public TableLayoutDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public TableLayoutDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public TableLayoutDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public TableLayoutDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeysFormat

            +
            +public RowKeyFormat getKeysFormat()
            +
            +
            Gets the value of the 'keys_format' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeysFormat

            +
            +public TableLayoutDesc.Builder setKeysFormat(RowKeyFormat value)
            +
            +
            Sets the value of the 'keys_format' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasKeysFormat

            +
            +public boolean hasKeysFormat()
            +
            +
            Checks whether the 'keys_format' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearKeysFormat

            +
            +public TableLayoutDesc.Builder clearKeysFormat()
            +
            +
            Clears the value of the 'keys_format' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLocalityGroups

            +
            +public List<LocalityGroupDesc> getLocalityGroups()
            +
            +
            Gets the value of the 'locality_groups' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLocalityGroups

            +
            +public TableLayoutDesc.Builder setLocalityGroups(List<LocalityGroupDesc> value)
            +
            +
            Sets the value of the 'locality_groups' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLocalityGroups

            +
            +public boolean hasLocalityGroups()
            +
            +
            Checks whether the 'locality_groups' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLocalityGroups

            +
            +public TableLayoutDesc.Builder clearLocalityGroups()
            +
            +
            Clears the value of the 'locality_groups' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getVersion

            +
            +public String getVersion()
            +
            +
            Gets the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setVersion

            +
            +public TableLayoutDesc.Builder setVersion(String value)
            +
            +
            Sets the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasVersion

            +
            +public boolean hasVersion()
            +
            +
            Checks whether the 'version' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearVersion

            +
            +public TableLayoutDesc.Builder clearVersion()
            +
            +
            Clears the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayoutId

            +
            +public String getLayoutId()
            +
            +
            Gets the value of the 'layout_id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutId

            +
            +public TableLayoutDesc.Builder setLayoutId(String value)
            +
            +
            Sets the value of the 'layout_id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayoutId

            +
            +public boolean hasLayoutId()
            +
            +
            Checks whether the 'layout_id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayoutId

            +
            +public TableLayoutDesc.Builder clearLayoutId()
            +
            +
            Clears the value of the 'layout_id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getReferenceLayout

            +
            +public String getReferenceLayout()
            +
            +
            Gets the value of the 'reference_layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setReferenceLayout

            +
            +public TableLayoutDesc.Builder setReferenceLayout(String value)
            +
            +
            Sets the value of the 'reference_layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasReferenceLayout

            +
            +public boolean hasReferenceLayout()
            +
            +
            Checks whether the 'reference_layout' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearReferenceLayout

            +
            +public TableLayoutDesc.Builder clearReferenceLayout()
            +
            +
            Clears the value of the 'reference_layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public TableLayoutDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<TableLayoutDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutDesc.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutDesc.html new file mode 100644 index 00000000..9cc44bdb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/TableLayoutDesc.html @@ -0,0 +1,967 @@ + + + + + + + +TableLayoutDesc (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.TableLayoutDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class TableLayoutDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTableLayoutDesc.Builder + +
            +          RecordBuilder for TableLayoutDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringdescription + +
            +          Deprecated. 
            + RowKeyFormatkeys_format + +
            +          Deprecated. 
            + Stringlayout_id + +
            +          Deprecated. 
            + List<LocalityGroupDesc>locality_groups + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringreference_layout + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + Stringversion + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            TableLayoutDesc() + +
            +          Default constructor.
            TableLayoutDesc(String name, + String description, + RowKeyFormat keys_format, + List<LocalityGroupDesc> locality_groups, + String version, + String layout_id, + String reference_layout) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + RowKeyFormatgetKeysFormat() + +
            +          Gets the value of the 'keys_format' field.
            + StringgetLayoutId() + +
            +          Gets the value of the 'layout_id' field.
            + List<LocalityGroupDesc>getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetReferenceLayout() + +
            +          Gets the value of the 'reference_layout' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + StringgetVersion() + +
            +          Gets the value of the 'version' field.
            +static TableLayoutDesc.BuildernewBuilder() + +
            +          Creates a new TableLayoutDesc RecordBuilder
            +static TableLayoutDesc.BuildernewBuilder(TableLayoutDesc.Builder other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder
            +static TableLayoutDesc.BuildernewBuilder(TableLayoutDesc other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetKeysFormat(RowKeyFormat value) + +
            +          Sets the value of the 'keys_format' field.
            + voidsetLayoutId(String value) + +
            +          Sets the value of the 'layout_id' field.
            + voidsetLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetReferenceLayout(String value) + +
            +          Sets the value of the 'reference_layout' field.
            + voidsetVersion(String value) + +
            +          Sets the value of the 'version' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Name of the table ([a-zA-Z0-9_]+). +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the table. +

            +

            +
            +
            +
            + +

            +keys_format

            +
            +@Deprecated
+public RowKeyFormat keys_format
            +
            +
            Deprecated. 
            Whether row key hashing should be managed by Kiji. +

            +

            +
            +
            +
            + +

            +locality_groups

            +
            +@Deprecated
+public List<LocalityGroupDesc> locality_groups
            +
            +
            Deprecated. 
            Locality groups in the table. +

            +

            +
            +
            +
            + +

            +version

            +
            +@Deprecated
+public String version
            +
            +
            Deprecated. 
            Data layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            + +

            +layout_id

            +
            +@Deprecated
+public String layout_id
            +
            +
            Deprecated. 
            ID of the layout. +

            +

            +
            +
            +
            + +

            +reference_layout

            +
            +@Deprecated
+public String reference_layout
            +
            +
            Deprecated. 
            Reference to the base layout this descriptor builds on. +

            +

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

            +TableLayoutDesc

            +
            +public TableLayoutDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +TableLayoutDesc

            +
            +public TableLayoutDesc(String name,
+                       String description,
+                       RowKeyFormat keys_format,
+                       List<LocalityGroupDesc> locality_groups,
+                       String version,
+                       String layout_id,
+                       String reference_layout)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Name of the table ([a-zA-Z0-9_]+). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Name of the table ([a-zA-Z0-9_]+). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the table. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the table. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeysFormat

            +
            +public RowKeyFormat getKeysFormat()
            +
            +
            Gets the value of the 'keys_format' field. + Whether row key hashing should be managed by Kiji. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeysFormat

            +
            +public void setKeysFormat(RowKeyFormat value)
            +
            +
            Sets the value of the 'keys_format' field. + Whether row key hashing should be managed by Kiji. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLocalityGroups

            +
            +public List<LocalityGroupDesc> getLocalityGroups()
            +
            +
            Gets the value of the 'locality_groups' field. + Locality groups in the table. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLocalityGroups

            +
            +public void setLocalityGroups(List<LocalityGroupDesc> value)
            +
            +
            Sets the value of the 'locality_groups' field. + Locality groups in the table. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getVersion

            +
            +public String getVersion()
            +
            +
            Gets the value of the 'version' field. + Data layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setVersion

            +
            +public void setVersion(String value)
            +
            +
            Sets the value of the 'version' field. + Data layout version (eg. "kiji-1.0"). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayoutId

            +
            +public String getLayoutId()
            +
            +
            Gets the value of the 'layout_id' field. + ID of the layout. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutId

            +
            +public void setLayoutId(String value)
            +
            +
            Sets the value of the 'layout_id' field. + ID of the layout. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getReferenceLayout

            +
            +public String getReferenceLayout()
            +
            +
            Gets the value of the 'reference_layout' field. + Reference to the base layout this descriptor builds on. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setReferenceLayout

            +
            +public void setReferenceLayout(String value)
            +
            +
            Sets the value of the 'reference_layout' field. + Reference to the base layout this descriptor builds on. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutDesc.Builder newBuilder()
            +
            +
            Creates a new TableLayoutDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutDesc.Builder newBuilder(TableLayoutDesc.Builder other)
            +
            +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutDesc.Builder newBuilder(TableLayoutDesc other)
            +
            +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/CellSchema.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/CellSchema.Builder.html new file mode 100644 index 00000000..259a2f03 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/CellSchema.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.CellSchema.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.CellSchema.Builder

            +
            + + + + + + + + + +
            +Packages that use CellSchema.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of CellSchema.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return CellSchema.Builder
            + CellSchema.BuilderCellSchema.Builder.clearStorage() + +
            +          Clears the value of the 'storage' field
            + CellSchema.BuilderCellSchema.Builder.clearType() + +
            +          Clears the value of the 'type' field
            + CellSchema.BuilderCellSchema.Builder.clearValue() + +
            +          Clears the value of the 'value' field
            +static CellSchema.BuilderCellSchema.newBuilder() + +
            +          Creates a new CellSchema RecordBuilder
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema.Builder other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing Builder
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance
            + CellSchema.BuilderCellSchema.Builder.setStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field
            + CellSchema.BuilderCellSchema.Builder.setType(SchemaType value) + +
            +          Sets the value of the 'type' field
            + CellSchema.BuilderCellSchema.Builder.setValue(String value) + +
            +          Sets the value of the 'value' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type CellSchema.Builder
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema.Builder other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/CellSchema.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/CellSchema.html new file mode 100644 index 00000000..91be05f6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/CellSchema.html @@ -0,0 +1,435 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.CellSchema (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.CellSchema

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use CellSchema
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of CellSchema in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as CellSchema
            + CellSchemaColumnDesc.column_schema + +
            +          Deprecated. 
            + CellSchemaFamilyDesc.map_schema + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return CellSchema
            + CellSchemaCellSchema.Builder.build() + +
            +           
            + CellSchemaColumnDesc.getColumnSchema() + +
            +          Gets the value of the 'column_schema' field.
            + CellSchemaColumnDesc.Builder.getColumnSchema() + +
            +          Gets the value of the 'column_schema' field
            + CellSchemaFamilyDesc.getMapSchema() + +
            +          Gets the value of the 'map_schema' field.
            + CellSchemaFamilyDesc.Builder.getMapSchema() + +
            +          Gets the value of the 'map_schema' field
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type CellSchema
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance
            + voidColumnDesc.setColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field.
            + ColumnDesc.BuilderColumnDesc.Builder.setColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field
            + voidFamilyDesc.setMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field.
            + FamilyDesc.BuilderFamilyDesc.Builder.setMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type CellSchema
            ColumnDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema column_schema, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            FamilyDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema map_schema, + List<ColumnDesc> columns, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of CellSchema in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return CellSchema
            + CellSchemaKijiTableLayout.getCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type CellSchema
            +static org.apache.avro.SchemaKijiTableLayout.readAvroSchema(CellSchema avro) + +
            +          Reads the Avro schema from the table layout.
            +  +

            + + + + + +
            +Uses of CellSchema in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return CellSchema
            + CellSchemaCellSpec.getCellSchema() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type CellSchema
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            +static org.apache.avro.SchemaCellSpec.readAvroSchema(CellSchema cellSchema) + +
            +          Reads the Avro schema from the table layout.
            + CellSpecCellSpec.setCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html new file mode 100644 index 00000000..5c17e310 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html @@ -0,0 +1,341 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.ColumnDesc.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.ColumnDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use ColumnDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of ColumnDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return ColumnDesc.Builder
            + ColumnDesc.BuilderColumnDesc.Builder.clearAliases() + +
            +          Clears the value of the 'aliases' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearColumnSchema() + +
            +          Clears the value of the 'column_schema' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearDelete() + +
            +          Clears the value of the 'delete' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearEnabled() + +
            +          Clears the value of the 'enabled' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearId() + +
            +          Clears the value of the 'id' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            +static ColumnDesc.BuilderColumnDesc.newBuilder() + +
            +          Creates a new ColumnDesc RecordBuilder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            + ColumnDesc.BuilderColumnDesc.Builder.setAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + ColumnDesc.BuilderColumnDesc.Builder.setColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field
            + ColumnDesc.BuilderColumnDesc.Builder.setDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + ColumnDesc.BuilderColumnDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + ColumnDesc.BuilderColumnDesc.Builder.setEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + ColumnDesc.BuilderColumnDesc.Builder.setId(int value) + +
            +          Sets the value of the 'id' field
            + ColumnDesc.BuilderColumnDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + ColumnDesc.BuilderColumnDesc.Builder.setRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type ColumnDesc.Builder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/ColumnDesc.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/ColumnDesc.html new file mode 100644 index 00000000..9d9674ef --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/ColumnDesc.html @@ -0,0 +1,327 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.ColumnDesc (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.ColumnDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use ColumnDesc
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of ColumnDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type ColumnDesc
            + List<ColumnDesc>FamilyDesc.columns + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return ColumnDesc
            + ColumnDescColumnDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type ColumnDesc
            + List<ColumnDesc>FamilyDesc.getColumns() + +
            +          Gets the value of the 'columns' field.
            + List<ColumnDesc>FamilyDesc.Builder.getColumns() + +
            +          Gets the value of the 'columns' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type ColumnDesc
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type ColumnDesc
            + voidFamilyDesc.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field.
            + FamilyDesc.BuilderFamilyDesc.Builder.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type ColumnDesc
            FamilyDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema map_schema, + List<ColumnDesc> columns, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of ColumnDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return ColumnDesc
            + ColumnDescKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.getDesc() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type ColumnDesc
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc desc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout reference) + +
            +          Builds a new column layout instance from a descriptor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/CompressionType.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/CompressionType.html new file mode 100644 index 00000000..4c301c79 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/CompressionType.html @@ -0,0 +1,271 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.CompressionType (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.CompressionType

            +
            + + + + + + + + + +
            +Packages that use CompressionType
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of CompressionType in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as CompressionType
            + CompressionTypeLocalityGroupDesc.compression_type + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return CompressionType
            + CompressionTypeLocalityGroupDesc.getCompressionType() + +
            +          Gets the value of the 'compression_type' field.
            + CompressionTypeLocalityGroupDesc.Builder.getCompressionType() + +
            +          Gets the value of the 'compression_type' field
            +static CompressionTypeCompressionType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static CompressionType[]CompressionType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type CompressionType
            + voidLocalityGroupDesc.setCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field.
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type CompressionType
            LocalityGroupDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + Boolean in_memory, + Integer max_versions, + Integer ttl_seconds, + CompressionType compression_type, + List<FamilyDesc> families, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html new file mode 100644 index 00000000..dfdec35e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html @@ -0,0 +1,357 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.FamilyDesc.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.FamilyDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use FamilyDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of FamilyDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return FamilyDesc.Builder
            + FamilyDesc.BuilderFamilyDesc.Builder.clearAliases() + +
            +          Clears the value of the 'aliases' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearColumns() + +
            +          Clears the value of the 'columns' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearDelete() + +
            +          Clears the value of the 'delete' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearEnabled() + +
            +          Clears the value of the 'enabled' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearId() + +
            +          Clears the value of the 'id' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearMapSchema() + +
            +          Clears the value of the 'map_schema' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            +static FamilyDesc.BuilderFamilyDesc.newBuilder() + +
            +          Creates a new FamilyDesc RecordBuilder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            + FamilyDesc.BuilderFamilyDesc.Builder.setAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setId(int value) + +
            +          Sets the value of the 'id' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type FamilyDesc.Builder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/FamilyDesc.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/FamilyDesc.html new file mode 100644 index 00000000..1177ac5d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/FamilyDesc.html @@ -0,0 +1,330 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.FamilyDesc (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.FamilyDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use FamilyDesc
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of FamilyDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type FamilyDesc
            + List<FamilyDesc>LocalityGroupDesc.families + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return FamilyDesc
            + FamilyDescFamilyDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type FamilyDesc
            + List<FamilyDesc>LocalityGroupDesc.getFamilies() + +
            +          Gets the value of the 'families' field.
            + List<FamilyDesc>LocalityGroupDesc.Builder.getFamilies() + +
            +          Gets the value of the 'families' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type FamilyDesc
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type FamilyDesc
            + voidLocalityGroupDesc.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field.
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type FamilyDesc
            LocalityGroupDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + Boolean in_memory, + Integer max_versions, + Integer ttl_seconds, + CompressionType compression_type, + List<FamilyDesc> families, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of FamilyDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return FamilyDesc
            + FamilyDescKijiTableLayout.LocalityGroupLayout.FamilyLayout.getDesc() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type FamilyDesc
            KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc familyDesc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout reference) + +
            +          Builds a new family layout instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/HashType.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/HashType.html new file mode 100644 index 00000000..ecc46f22 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/HashType.html @@ -0,0 +1,262 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.HashType (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.HashType

            +
            + + + + + + + + + +
            +Packages that use HashType
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of HashType in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as HashType
            + HashTypeRowKeyFormat.hash_type + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return HashType
            + HashTypeRowKeyFormat.getHashType() + +
            +          Gets the value of the 'hash_type' field.
            + HashTypeRowKeyFormat.Builder.getHashType() + +
            +          Gets the value of the 'hash_type' field
            +static HashTypeHashType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static HashType[]HashType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type HashType
            + voidRowKeyFormat.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field.
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type HashType
            RowKeyFormat(RowKeyEncoding encoding, + HashType hash_type, + Integer hash_size) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KeyValueBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KeyValueBackupEntry.Builder.html new file mode 100644 index 00000000..84f1e58b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KeyValueBackupEntry.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.KeyValueBackupEntry.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.KeyValueBackupEntry.Builder

            +
            + + + + + + + + + +
            +Packages that use KeyValueBackupEntry.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return KeyValueBackupEntry.Builder
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.clearKey() + +
            +          Clears the value of the 'key' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.clearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.clearValue() + +
            +          Clears the value of the 'value' field
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder() + +
            +          Creates a new KeyValueBackupEntry RecordBuilder
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry.Builder other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.setKey(String value) + +
            +          Sets the value of the 'key' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.setTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.setValue(ByteBuffer value) + +
            +          Sets the value of the 'value' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type KeyValueBackupEntry.Builder
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry.Builder other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KeyValueBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KeyValueBackupEntry.html new file mode 100644 index 00000000..a3003166 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KeyValueBackupEntry.html @@ -0,0 +1,386 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.KeyValueBackupEntry (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.KeyValueBackupEntry

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KeyValueBackupEntry
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>KijiTableKeyValueDatabase.keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type KeyValueBackupEntry
            + voidKijiTableKeyValueDatabase.keyValuesFromBackup(String table, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>TableBackup.key_values + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return KeyValueBackupEntry
            + KeyValueBackupEntryKeyValueBackupEntry.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>TableBackup.getKeyValues() + +
            +          Gets the value of the 'key_values' field.
            + List<KeyValueBackupEntry>TableBackup.Builder.getKeyValues() + +
            +          Gets the value of the 'key_values' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type KeyValueBackupEntry
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type KeyValueBackupEntry
            + voidTableBackup.setKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field.
            + TableBackup.BuilderTableBackup.Builder.setKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type KeyValueBackupEntry
            TableBackup(String name, + List<TableLayoutBackupEntry> layouts, + List<KeyValueBackupEntry> key_values) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>HBaseMetaTable.keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + List<KeyValueBackupEntry>HBaseTableKeyValueDatabase.keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type KeyValueBackupEntry
            + voidHBaseMetaTable.keyValuesFromBackup(String table, + List<KeyValueBackupEntry> tableBackup) + +
            +          Restores all table's key value history from a backup.
            + voidHBaseTableKeyValueDatabase.keyValuesFromBackup(String tableName, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html new file mode 100644 index 00000000..1e2dc5b9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface org.kiji.schema.avro.KijiTableLayoutRecords.Callback (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.avro.KijiTableLayoutRecords.Callback

            +
            +No usage of org.kiji.schema.avro.KijiTableLayoutRecords.Callback +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html new file mode 100644 index 00000000..485261f0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface org.kiji.schema.avro.KijiTableLayoutRecords (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.avro.KijiTableLayoutRecords

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayoutRecords
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of KijiTableLayoutRecords in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiTableLayoutRecords in org.kiji.schema.avro
            +static interfaceKijiTableLayoutRecords.Callback + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html new file mode 100644 index 00000000..e970982f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html @@ -0,0 +1,405 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.LocalityGroupDesc.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.LocalityGroupDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use LocalityGroupDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of LocalityGroupDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return LocalityGroupDesc.Builder
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearAliases() + +
            +          Clears the value of the 'aliases' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearCompressionType() + +
            +          Clears the value of the 'compression_type' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearDelete() + +
            +          Clears the value of the 'delete' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearEnabled() + +
            +          Clears the value of the 'enabled' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearFamilies() + +
            +          Clears the value of the 'families' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearId() + +
            +          Clears the value of the 'id' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearInMemory() + +
            +          Clears the value of the 'in_memory' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearMaxVersions() + +
            +          Clears the value of the 'max_versions' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearTtlSeconds() + +
            +          Clears the value of the 'ttl_seconds' field
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder() + +
            +          Creates a new LocalityGroupDesc RecordBuilder
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc.Builder other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setId(int value) + +
            +          Sets the value of the 'id' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setInMemory(boolean value) + +
            +          Sets the value of the 'in_memory' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setMaxVersions(int value) + +
            +          Sets the value of the 'max_versions' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setTtlSeconds(int value) + +
            +          Sets the value of the 'ttl_seconds' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type LocalityGroupDesc.Builder
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc.Builder other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/LocalityGroupDesc.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/LocalityGroupDesc.html new file mode 100644 index 00000000..adeb4ae4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/LocalityGroupDesc.html @@ -0,0 +1,325 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.LocalityGroupDesc (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.LocalityGroupDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use LocalityGroupDesc
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of LocalityGroupDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type LocalityGroupDesc
            + List<LocalityGroupDesc>TableLayoutDesc.locality_groups + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return LocalityGroupDesc
            + LocalityGroupDescLocalityGroupDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type LocalityGroupDesc
            + List<LocalityGroupDesc>TableLayoutDesc.getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field.
            + List<LocalityGroupDesc>TableLayoutDesc.Builder.getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type LocalityGroupDesc
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type LocalityGroupDesc
            + voidTableLayoutDesc.setLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field.
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type LocalityGroupDesc
            TableLayoutDesc(String name, + String description, + RowKeyFormat keys_format, + List<LocalityGroupDesc> locality_groups, + String version, + String layout_id, + String reference_layout) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of LocalityGroupDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return LocalityGroupDesc
            + LocalityGroupDescKijiTableLayout.LocalityGroupLayout.getDesc() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type LocalityGroupDesc
            KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc lgDesc, + KijiTableLayout.LocalityGroupLayout reference) + +
            +          Constructs a locality group layout.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/MD5Hash.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/MD5Hash.html new file mode 100644 index 00000000..7866894d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/MD5Hash.html @@ -0,0 +1,245 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.MD5Hash (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.MD5Hash

            +
            + + + + + + + + + +
            +Packages that use MD5Hash
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of MD5Hash in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as MD5Hash
            + MD5HashSchemaTableEntry.hash + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return MD5Hash
            + MD5HashSchemaTableEntry.getHash() + +
            +          Gets the value of the 'hash' field.
            + MD5HashSchemaTableEntry.Builder.getHash() + +
            +          Gets the value of the 'hash' field
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type MD5Hash
            + voidSchemaTableEntry.setHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field.
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type MD5Hash
            SchemaTableEntry(Long id, + MD5Hash hash, + String avro_schema) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html new file mode 100644 index 00000000..c98c7eee --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.MetadataBackup.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.MetadataBackup.Builder

            +
            + + + + + + + + + +
            +Packages that use MetadataBackup.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of MetadataBackup.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return MetadataBackup.Builder
            + MetadataBackup.BuilderMetadataBackup.Builder.clearLayoutVersion() + +
            +          Clears the value of the 'layout_version' field
            + MetadataBackup.BuilderMetadataBackup.Builder.clearMetaTable() + +
            +          Clears the value of the 'meta_table' field
            + MetadataBackup.BuilderMetadataBackup.Builder.clearSchemaTable() + +
            +          Clears the value of the 'schema_table' field
            +static MetadataBackup.BuilderMetadataBackup.newBuilder() + +
            +          Creates a new MetadataBackup RecordBuilder
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup.Builder other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing Builder
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance
            + MetadataBackup.BuilderMetadataBackup.Builder.setLayoutVersion(String value) + +
            +          Sets the value of the 'layout_version' field
            + MetadataBackup.BuilderMetadataBackup.Builder.setMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field
            + MetadataBackup.BuilderMetadataBackup.Builder.setSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type MetadataBackup.Builder
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup.Builder other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/MetadataBackup.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/MetadataBackup.html new file mode 100644 index 00000000..694f8b6e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/MetadataBackup.html @@ -0,0 +1,236 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.MetadataBackup (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.MetadataBackup

            +
            + + + + + + + + + + + + + +
            +Packages that use MetadataBackup
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of MetadataBackup in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return MetadataBackup
            + MetadataBackupMetadataBackup.Builder.build() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type MetadataBackup
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance
            +  +

            + + + + + +
            +Uses of MetadataBackup in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type MetadataBackup
            + voidMetadataRestorer.restoreSchemas(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all SchemaTable entries from the metadata backup.
            + voidMetadataRestorer.restoreTables(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all tables from the metadata backup into the running Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/RowKeyEncoding.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/RowKeyEncoding.html new file mode 100644 index 00000000..397463e0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/RowKeyEncoding.html @@ -0,0 +1,262 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyEncoding (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyEncoding

            +
            + + + + + + + + + +
            +Packages that use RowKeyEncoding
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of RowKeyEncoding in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as RowKeyEncoding
            + RowKeyEncodingRowKeyFormat.encoding + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyEncoding
            + RowKeyEncodingRowKeyFormat.getEncoding() + +
            +          Gets the value of the 'encoding' field.
            + RowKeyEncodingRowKeyFormat.Builder.getEncoding() + +
            +          Gets the value of the 'encoding' field
            +static RowKeyEncodingRowKeyEncoding.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static RowKeyEncoding[]RowKeyEncoding.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyEncoding
            + voidRowKeyFormat.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field.
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type RowKeyEncoding
            RowKeyFormat(RowKeyEncoding encoding, + HashType hash_type, + Integer hash_size) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html new file mode 100644 index 00000000..920bff57 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyFormat.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyFormat.Builder

            +
            + + + + + + + + + +
            +Packages that use RowKeyFormat.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of RowKeyFormat.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyFormat.Builder
            + RowKeyFormat.BuilderRowKeyFormat.Builder.clearEncoding() + +
            +          Clears the value of the 'encoding' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.clearHashSize() + +
            +          Clears the value of the 'hash_size' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.clearHashType() + +
            +          Clears the value of the 'hash_type' field
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder() + +
            +          Creates a new RowKeyFormat RecordBuilder
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat.Builder other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing Builder
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setHashSize(int value) + +
            +          Sets the value of the 'hash_size' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyFormat.Builder
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat.Builder other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/RowKeyFormat.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/RowKeyFormat.html new file mode 100644 index 00000000..b5b2100a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/RowKeyFormat.html @@ -0,0 +1,479 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyFormat (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyFormat

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use RowKeyFormat
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return RowKeyFormat
            + RowKeyFormatEntityIdFactory.getFormat() + +
            +           
            +abstract  RowKeyFormatEntityId.getFormat() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type RowKeyFormat
            +static EntityIdFactoryEntityIdFactory.create(RowKeyFormat format) + +
            +          Creates an entity ID factory for the specified row key format.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type RowKeyFormat
            EntityIdFactory(RowKeyFormat format) + +
            +          Creates an entity ID factory.
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as RowKeyFormat
            + RowKeyFormatTableLayoutDesc.keys_format + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyFormat
            + RowKeyFormatRowKeyFormat.Builder.build() + +
            +           
            + RowKeyFormatTableLayoutDesc.getKeysFormat() + +
            +          Gets the value of the 'keys_format' field.
            + RowKeyFormatTableLayoutDesc.Builder.getKeysFormat() + +
            +          Gets the value of the 'keys_format' field
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyFormat
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance
            + voidTableLayoutDesc.setKeysFormat(RowKeyFormat value) + +
            +          Sets the value of the 'keys_format' field.
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setKeysFormat(RowKeyFormat value) + +
            +          Sets the value of the 'keys_format' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type RowKeyFormat
            TableLayoutDesc(String name, + String description, + RowKeyFormat keys_format, + List<LocalityGroupDesc> locality_groups, + String version, + String layout_id, + String reference_layout) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return RowKeyFormat
            + RowKeyFormatHBaseEntityId.getFormat() + +
            +          
            + RowKeyFormatRawEntityId.getFormat() + +
            +          
            + RowKeyFormatHashPrefixedEntityId.getFormat() + +
            +          
            + RowKeyFormatHashedEntityId.getFormat() + +
            +          
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type RowKeyFormat
            +static HashPrefixedEntityIdHashPrefixedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified HBase row key.
            +static HashedEntityIdHashedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified HBase row key.
            +static HashPrefixedEntityIdHashPrefixedEntityId.fromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified Kiji row key.
            +static HashedEntityIdHashedEntityId.fromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified Kiji row key.
            +static byte[]HashPrefixedEntityId.hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            +static byte[]HashedEntityId.hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type RowKeyFormat
            +static EntityIdToolUtils.createEntityIdFromUserInputs(String entityId, + String entityHash, + RowKeyFormat format) + +
            +          Create an EntityId from the --entity-id and --entity-hash arguments to a kiji tool.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaStorage.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaStorage.html new file mode 100644 index 00000000..edbed388 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaStorage.html @@ -0,0 +1,320 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaStorage (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaStorage

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use SchemaStorage
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of SchemaStorage in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as SchemaStorage
            + SchemaStorageCellSchema.storage + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaStorage
            + SchemaStorageCellSchema.getStorage() + +
            +          Gets the value of the 'storage' field.
            + SchemaStorageCellSchema.Builder.getStorage() + +
            +          Gets the value of the 'storage' field
            +static SchemaStorageSchemaStorage.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaStorage[]SchemaStorage.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaStorage
            + voidCellSchema.setStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field.
            + CellSchema.BuilderCellSchema.Builder.setStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type SchemaStorage
            CellSchema(SchemaStorage storage, + SchemaType type, + String value) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of SchemaStorage in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return SchemaStorage
            + SchemaStorageKijiTableLayout.getCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            +  +

            + + + + + +
            +Uses of SchemaStorage in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type SchemaStorage
            + CellSpecCellSpec.setSchemaStorage(SchemaStorage schemaStorage) + +
            +          Sets the schema storage.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html new file mode 100644 index 00000000..8f2d87b2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaTableEntry.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaTableEntry.Builder

            +
            + + + + + + + + + +
            +Packages that use SchemaTableEntry.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of SchemaTableEntry.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaTableEntry.Builder
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.clearAvroSchema() + +
            +          Clears the value of the 'avro_schema' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.clearHash() + +
            +          Clears the value of the 'hash' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.clearId() + +
            +          Clears the value of the 'id' field
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder() + +
            +          Creates a new SchemaTableEntry RecordBuilder
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry.Builder other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setAvroSchema(String value) + +
            +          Sets the value of the 'avro_schema' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setId(long value) + +
            +          Sets the value of the 'id' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaTableEntry.Builder
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry.Builder other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaTableEntry.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaTableEntry.html new file mode 100644 index 00000000..3b7d8f66 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaTableEntry.html @@ -0,0 +1,417 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaTableEntry (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaTableEntry

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use SchemaTableEntry
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of SchemaTableEntry in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type SchemaTableEntry
            +abstract  List<SchemaTableEntry>KijiSchemaTable.toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type SchemaTableEntry
            +abstract  voidKijiSchemaTable.fromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            +  +

            + + + + + +
            +Uses of SchemaTableEntry in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type SchemaTableEntry
            + List<SchemaTableEntry>MetadataBackup.schema_table + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaTableEntry
            + SchemaTableEntrySchemaTableEntry.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type SchemaTableEntry
            + List<SchemaTableEntry>MetadataBackup.getSchemaTable() + +
            +          Gets the value of the 'schema_table' field.
            + List<SchemaTableEntry>MetadataBackup.Builder.getSchemaTable() + +
            +          Gets the value of the 'schema_table' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaTableEntry
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type SchemaTableEntry
            + voidMetadataBackup.setSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field.
            + MetadataBackup.BuilderMetadataBackup.Builder.setSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type SchemaTableEntry
            MetadataBackup(String layout_version, + List<SchemaTableEntry> schema_table, + Map<String,TableBackup> meta_table) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of SchemaTableEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return SchemaTableEntry
            +static SchemaTableEntryHBaseSchemaTable.decodeSchemaEntry(byte[] bytes) + +
            +          Decodes a binary-encoded Avro schema entry.
            +static SchemaTableEntryHBaseSchemaTable.toAvroEntry(KijiSchemaTable.SchemaEntry entry) + +
            +          Converts a SchemaEntry into an Avro SchemaTableEntry.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type SchemaTableEntry
            + List<SchemaTableEntry>HBaseSchemaTable.toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type SchemaTableEntry
            +static byte[]HBaseSchemaTable.encodeSchemaEntry(SchemaTableEntry avroEntry) + +
            +          Encodes an Avro schema entry into binary.
            +static KijiSchemaTable.SchemaEntryHBaseSchemaTable.fromAvroEntry(SchemaTableEntry avroEntry) + +
            +          Converts an Avro SchemaTableEntry into a SchemaEntry.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type SchemaTableEntry
            + voidHBaseSchemaTable.fromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaType.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaType.html new file mode 100644 index 00000000..dcd4aec7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/SchemaType.html @@ -0,0 +1,291 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaType (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaType

            +
            + + + + + + + + + + + + + +
            +Packages that use SchemaType
            org.kiji.schema.avro  
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of SchemaType in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as SchemaType
            + SchemaTypeCellSchema.type + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaType
            + SchemaTypeCellSchema.getType() + +
            +          Gets the value of the 'type' field.
            + SchemaTypeCellSchema.Builder.getType() + +
            +          Gets the value of the 'type' field
            +static SchemaTypeSchemaType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaType[]SchemaType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaType
            + voidCellSchema.setType(SchemaType value) + +
            +          Sets the value of the 'type' field.
            + CellSchema.BuilderCellSchema.Builder.setType(SchemaType value) + +
            +          Sets the value of the 'type' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type SchemaType
            CellSchema(SchemaStorage storage, + SchemaType type, + String value) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of SchemaType in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type SchemaType
            + CellSpecCellSpec.setType(SchemaType schemaType) + +
            +          Sets the cell type.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableBackup.Builder.html new file mode 100644 index 00000000..5485d208 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableBackup.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableBackup.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableBackup.Builder

            +
            + + + + + + + + + +
            +Packages that use TableBackup.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of TableBackup.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableBackup.Builder
            + TableBackup.BuilderTableBackup.Builder.clearKeyValues() + +
            +          Clears the value of the 'key_values' field
            + TableBackup.BuilderTableBackup.Builder.clearLayouts() + +
            +          Clears the value of the 'layouts' field
            + TableBackup.BuilderTableBackup.Builder.clearName() + +
            +          Clears the value of the 'name' field
            +static TableBackup.BuilderTableBackup.newBuilder() + +
            +          Creates a new TableBackup RecordBuilder
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup.Builder other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing Builder
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance
            + TableBackup.BuilderTableBackup.Builder.setKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field
            + TableBackup.BuilderTableBackup.Builder.setLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field
            + TableBackup.BuilderTableBackup.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableBackup.Builder
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup.Builder other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableBackup.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableBackup.html new file mode 100644 index 00000000..194b0714 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableBackup.html @@ -0,0 +1,369 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableBackup (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableBackup

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use TableBackup
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of TableBackup in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type TableBackup
            +abstract  Map<String,TableBackup>KijiMetaTable.toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type TableBackup
            +abstract  voidKijiMetaTable.fromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            +  +

            + + + + + +
            +Uses of TableBackup in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type TableBackup
            + Map<String,TableBackup>MetadataBackup.meta_table + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableBackup
            + TableBackupTableBackup.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type TableBackup
            + Map<String,TableBackup>MetadataBackup.getMetaTable() + +
            +          Gets the value of the 'meta_table' field.
            + Map<String,TableBackup>MetadataBackup.Builder.getMetaTable() + +
            +          Gets the value of the 'meta_table' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableBackup
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type TableBackup
            + voidMetadataBackup.setMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field.
            + MetadataBackup.BuilderMetadataBackup.Builder.setMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type TableBackup
            MetadataBackup(String layout_version, + List<SchemaTableEntry> schema_table, + Map<String,TableBackup> meta_table) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of TableBackup in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type TableBackup
            + Map<String,TableBackup>HBaseMetaTable.toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type TableBackup
            + voidHBaseMetaTable.fromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html new file mode 100644 index 00000000..b1c7ed96 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutBackupEntry.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutBackupEntry.Builder

            +
            + + + + + + + + + +
            +Packages that use TableLayoutBackupEntry.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutBackupEntry.Builder
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.clearLayout() + +
            +          Clears the value of the 'layout' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.clearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.clearUpdate() + +
            +          Clears the value of the 'update' field
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder() + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry.Builder other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutBackupEntry.Builder
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry.Builder other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html new file mode 100644 index 00000000..72b835a4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html @@ -0,0 +1,415 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutBackupEntry (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutBackupEntry

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use TableLayoutBackupEntry
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>TableBackup.layouts + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutBackupEntry
            + TableLayoutBackupEntryTableLayoutBackupEntry.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>TableBackup.getLayouts() + +
            +          Gets the value of the 'layouts' field.
            + List<TableLayoutBackupEntry>TableBackup.Builder.getLayouts() + +
            +          Gets the value of the 'layouts' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutBackupEntry
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type TableLayoutBackupEntry
            + voidTableBackup.setLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field.
            + TableBackup.BuilderTableBackup.Builder.setLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type TableLayoutBackupEntry
            TableBackup(String name, + List<TableLayoutBackupEntry> layouts, + List<KeyValueBackupEntry> key_values) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>HBaseMetaTable.layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type TableLayoutBackupEntry
            + voidHBaseMetaTable.layoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +           
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>KijiTableLayoutDatabase.layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.layout with type arguments of type TableLayoutBackupEntry
            + voidKijiTableLayoutDatabase.layoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +          Restores a table layout history from a backup.
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>HBaseTableLayoutDatabase.layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.layout.impl with type arguments of type TableLayoutBackupEntry
            + voidHBaseTableLayoutDatabase.layoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> layoutBackup) + +
            +          Restores a table layout history from a backup.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html new file mode 100644 index 00000000..9faed102 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html @@ -0,0 +1,325 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutDesc.Builder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use TableLayoutDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of TableLayoutDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutDesc.Builder
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearKeysFormat() + +
            +          Clears the value of the 'keys_format' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearLayoutId() + +
            +          Clears the value of the 'layout_id' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearLocalityGroups() + +
            +          Clears the value of the 'locality_groups' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearReferenceLayout() + +
            +          Clears the value of the 'reference_layout' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearVersion() + +
            +          Clears the value of the 'version' field
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder() + +
            +          Creates a new TableLayoutDesc RecordBuilder
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc.Builder other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setKeysFormat(RowKeyFormat value) + +
            +          Sets the value of the 'keys_format' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setLayoutId(String value) + +
            +          Sets the value of the 'layout_id' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setReferenceLayout(String value) + +
            +          Sets the value of the 'reference_layout' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setVersion(String value) + +
            +          Sets the value of the 'version' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutDesc.Builder
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc.Builder other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutDesc.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutDesc.html new file mode 100644 index 00000000..be9766ed --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/class-use/TableLayoutDesc.html @@ -0,0 +1,493 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutDesc (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutDesc

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use TableLayoutDesc
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type TableLayoutDesc
            + KijiTableLayoutKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as TableLayoutDesc
            + TableLayoutDescTableLayoutBackupEntry.layout + +
            +          Deprecated. 
            + TableLayoutDescTableLayoutBackupEntry.update + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutDesc
            + TableLayoutDescTableLayoutDesc.Builder.build() + +
            +           
            + TableLayoutDescTableLayoutBackupEntry.getLayout() + +
            +          Gets the value of the 'layout' field.
            + TableLayoutDescTableLayoutBackupEntry.Builder.getLayout() + +
            +          Gets the value of the 'layout' field
            + TableLayoutDescTableLayoutBackupEntry.getUpdate() + +
            +          Gets the value of the 'update' field.
            + TableLayoutDescTableLayoutBackupEntry.Builder.getUpdate() + +
            +          Gets the value of the 'update' field
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutDesc
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance
            + voidTableLayoutBackupEntry.setLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field.
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field
            + voidTableLayoutBackupEntry.setUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field.
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type TableLayoutDesc
            TableLayoutBackupEntry(Long timestamp, + TableLayoutDesc update, + TableLayoutDesc layout) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type TableLayoutDesc
            + KijiTableLayoutHBaseKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutHBaseKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            + KijiTableLayoutHBaseMetaTable.updateTableLayout(String table, + TableLayoutDesc layoutUpdate) + +
            +          Sets a table's layout.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return TableLayoutDesc
            + TableLayoutDescKijiTableLayout.getDesc() + +
            +           
            +static TableLayoutDescKijiTableLayout.readTableLayoutDescFromJSON(InputStream istream) + +
            +          Reads a table layout descriptor from its JSON serialized form.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type TableLayoutDesc
            + KijiTableLayoutKijiTableLayoutDatabase.updateTableLayout(String table, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type TableLayoutDesc
            KijiTableLayout(TableLayoutDesc desc, + KijiTableLayout reference) + +
            +          Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type TableLayoutDesc
            + KijiTableLayoutHBaseTableLayoutDatabase.updateTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-frame.html new file mode 100644 index 00000000..ee58fc52 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-frame.html @@ -0,0 +1,109 @@ + + + + + + + +org.kiji.schema.avro (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.schema.avro + + + + +
            +Interfaces  + +
            +KijiTableLayoutRecords +
            +KijiTableLayoutRecords.Callback
            + + + + + + +
            +Classes  + +
            +CellSchema +
            +CellSchema.Builder +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +KeyValueBackupEntry +
            +KeyValueBackupEntry.Builder +
            +LocalityGroupDesc +
            +LocalityGroupDesc.Builder +
            +MD5Hash +
            +MetadataBackup +
            +MetadataBackup.Builder +
            +RowKeyFormat +
            +RowKeyFormat.Builder +
            +SchemaTableEntry +
            +SchemaTableEntry.Builder +
            +TableBackup +
            +TableBackup.Builder +
            +TableLayoutBackupEntry +
            +TableLayoutBackupEntry.Builder +
            +TableLayoutDesc +
            +TableLayoutDesc.Builder
            + + + + + + +
            +Enums  + +
            +CompressionType +
            +HashType +
            +RowKeyEncoding +
            +SchemaStorage +
            +SchemaType
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-summary.html new file mode 100644 index 00000000..502147ff --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-summary.html @@ -0,0 +1,294 @@ + + + + + + + +org.kiji.schema.avro (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.avro +

            + + + + + + + + + + + + + +
            +Interface Summary
            KijiTableLayoutRecords 
            KijiTableLayoutRecords.Callback 
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            CellSchema 
            CellSchema.BuilderRecordBuilder for CellSchema instances.
            ColumnDesc 
            ColumnDesc.BuilderRecordBuilder for ColumnDesc instances.
            FamilyDesc 
            FamilyDesc.BuilderRecordBuilder for FamilyDesc instances.
            KeyValueBackupEntry 
            KeyValueBackupEntry.BuilderRecordBuilder for KeyValueBackupEntry instances.
            LocalityGroupDesc 
            LocalityGroupDesc.BuilderRecordBuilder for LocalityGroupDesc instances.
            MD5Hash 
            MetadataBackup 
            MetadataBackup.BuilderRecordBuilder for MetadataBackup instances.
            RowKeyFormat 
            RowKeyFormat.BuilderRecordBuilder for RowKeyFormat instances.
            SchemaTableEntry 
            SchemaTableEntry.BuilderRecordBuilder for SchemaTableEntry instances.
            TableBackup 
            TableBackup.BuilderRecordBuilder for TableBackup instances.
            TableLayoutBackupEntry 
            TableLayoutBackupEntry.BuilderRecordBuilder for TableLayoutBackupEntry instances.
            TableLayoutDesc 
            TableLayoutDesc.BuilderRecordBuilder for TableLayoutDesc instances.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Enum Summary
            CompressionType 
            HashType 
            RowKeyEncoding 
            SchemaStorage 
            SchemaType 
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-tree.html new file mode 100644 index 00000000..7f4bd01c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-tree.html @@ -0,0 +1,206 @@ + + + + + + + +org.kiji.schema.avro Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.avro +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.avro.generic.GenericData.Fixed (implements java.lang.Comparable<T>, org.apache.avro.generic.GenericFixed) +
                  +
                • org.apache.avro.specific.SpecificFixed +
                +
              • org.apache.avro.data.RecordBuilderBase<T> (implements org.apache.avro.data.RecordBuilder<T>) + +
              • org.apache.avro.specific.SpecificRecordBase (implements java.lang.Comparable<T>, org.apache.avro.specific.SpecificRecord) +
                  +
                • org.kiji.schema.avro.CellSchema (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.ColumnDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.FamilyDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.KeyValueBackupEntry (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.LocalityGroupDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.MetadataBackup (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.RowKeyFormat (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.SchemaTableEntry (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.TableBackup (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.TableLayoutBackupEntry (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.TableLayoutDesc (implements org.apache.avro.specific.SpecificRecord) +
                +
              +
            +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-use.html new file mode 100644 index 00000000..c42a90c7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/avro/package-use.html @@ -0,0 +1,555 @@ + + + + + + + +Uses of Package org.kiji.schema.avro (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.avro

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.avro
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema
            KeyValueBackupEntry + +
            +           
            RowKeyFormat + +
            +           
            SchemaTableEntry + +
            +           
            TableBackup + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.avro
            CellSchema + +
            +           
            CellSchema.Builder + +
            +          RecordBuilder for CellSchema instances.
            ColumnDesc + +
            +           
            ColumnDesc.Builder + +
            +          RecordBuilder for ColumnDesc instances.
            CompressionType + +
            +           
            FamilyDesc + +
            +           
            FamilyDesc.Builder + +
            +          RecordBuilder for FamilyDesc instances.
            HashType + +
            +           
            KeyValueBackupEntry + +
            +           
            KeyValueBackupEntry.Builder + +
            +          RecordBuilder for KeyValueBackupEntry instances.
            KijiTableLayoutRecords + +
            +           
            LocalityGroupDesc + +
            +           
            LocalityGroupDesc.Builder + +
            +          RecordBuilder for LocalityGroupDesc instances.
            MD5Hash + +
            +           
            MetadataBackup + +
            +           
            MetadataBackup.Builder + +
            +          RecordBuilder for MetadataBackup instances.
            RowKeyEncoding + +
            +           
            RowKeyFormat + +
            +           
            RowKeyFormat.Builder + +
            +          RecordBuilder for RowKeyFormat instances.
            SchemaStorage + +
            +           
            SchemaTableEntry + +
            +           
            SchemaTableEntry.Builder + +
            +          RecordBuilder for SchemaTableEntry instances.
            SchemaType + +
            +           
            TableBackup + +
            +           
            TableBackup.Builder + +
            +          RecordBuilder for TableBackup instances.
            TableLayoutBackupEntry + +
            +           
            TableLayoutBackupEntry.Builder + +
            +          RecordBuilder for TableLayoutBackupEntry instances.
            TableLayoutDesc + +
            +           
            TableLayoutDesc.Builder + +
            +          RecordBuilder for TableLayoutDesc instances.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.impl
            KeyValueBackupEntry + +
            +           
            MetadataBackup + +
            +           
            RowKeyFormat + +
            +           
            SchemaTableEntry + +
            +           
            TableBackup + +
            +           
            TableLayoutBackupEntry + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.layout
            CellSchema + +
            +           
            ColumnDesc + +
            +           
            FamilyDesc + +
            +           
            LocalityGroupDesc + +
            +           
            SchemaStorage + +
            +           
            TableLayoutBackupEntry + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.layout.impl
            CellSchema + +
            +           
            SchemaStorage + +
            +           
            SchemaType + +
            +           
            TableLayoutBackupEntry + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.tools
            RowKeyFormat + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/EntityId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/EntityId.html new file mode 100644 index 00000000..70a69e4b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/EntityId.html @@ -0,0 +1,813 @@ + + + + + + + +Uses of Class org.kiji.schema.EntityId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.EntityId

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use EntityId
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji map-reduce utilities. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return EntityId
            +abstract  EntityIdEntityIdFactory.fromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates an entity ID from an HBase row key.
            +abstract  EntityIdEntityIdFactory.fromKijiRowKey(byte[] kijiRowKey) + +
            +          Creates an entity ID from a Kiji row key.
            + EntityIdEntityIdFactory.fromKijiRowKey(String text) + +
            +          Creates an entity ID from a UTF8 text Kiji row key.
            + EntityIdKijiRowData.getEntityId() + +
            +          Gets the entity id for this row of kiji data.
            + EntityIdKijiTable.getEntityId(String kijiRowKey) + +
            +          Creates an entity ID for the specified UTF8 encoded Kiji row key.
            + EntityIdKijiTableReader.KijiScannerOptions.getStartRow() + +
            +          Gets the start row set in these options.
            + EntityIdKijiTableReader.KijiScannerOptions.getStopRow() + +
            +          Gets the stop row set in these options.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type EntityId
            + voidKijiDeleter.deleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voidKijiDeleter.deleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voidKijiDeleter.deleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voidKijiDeleter.deleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voidKijiDeleter.deleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voidKijiDeleter.deleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voidKijiDeleter.deleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voidKijiDeleter.deleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            + KijiRowDataKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiCounterKijiIncrementer.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            + + + + + +
            +<T> void
            +            		KijiPutter.put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		KijiPutter.put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setStartRow(EntityId startRow) + +
            +          Sets the start row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setStopRow(EntityId stopRow) + +
            +          Sets the stop row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type EntityId
            + List<KijiRowData>KijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of EntityId in org.kiji.schema.impl
            + classHashedEntityId + +
            +          Implements the hashed row key format.
            + classHashPrefixedEntityId + +
            +          Implements the hash-prefixed row key format.
            + classHBaseEntityId + +
            +          Entity ID encapsulating an HBase row key.
            + classRawEntityId + +
            +          Implements the raw row key format.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return EntityId
            + EntityIdHBaseKijiRowData.getEntityId() + +
            +          Gets the entity id for this row of kiji data.
            + EntityIdAbstractKijiTable.getEntityId(String kijiRowKey) + +
            +          Creates an entity ID for the specified UTF8 encoded Kiji row key.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type EntityId
            + Set<Map.Entry<EntityId,List<T>>>KijiDataBuffer.getEntries() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type EntityId
            + KijiDataBuffer<T>KijiDataBuffer.add(EntityId id, + T value) + +
            +          Adds a buffer element to the buffer and associates it with the specified entity.
            + voidHBaseKijiTableWriter.deleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voidHBaseKijiTableWriter.deleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voidHBaseKijiTableWriter.deleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voidHBaseKijiTableWriter.deleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voidHBaseKijiTableWriter.deleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voidHBaseKijiTableWriter.deleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voidHBaseKijiTableWriter.deleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voidHBaseKijiTableWriter.deleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            + KijiRowDataHBaseKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            +protected  List<T>KijiDataBuffer.getBuffer(EntityId id) + +
            +          Gets the list of buffer elements associated with the specified entity.
            + KijiCounterHBaseKijiTableWriter.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            + + + + + +
            +<T> void
            +            		HBaseKijiTableWriter.put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		HBaseKijiTableWriter.put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            + GetHBaseDataRequestAdapter.toGet(EntityId entityId, + KijiTableLayout tableLayout) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + GetHBaseDataRequestAdapter.toGet(EntityId entityId, + KijiTableLayout tableLayout, + int pageIndex) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type EntityId
            + List<KijiRowData>HBaseKijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type EntityId
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            KijiColumnPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HTableInterface htable) + +
            +          Creates a new KijiColumnPager.
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return EntityId
            + EntityIdKijiTableInputFormat.KijiTableRecordReader.getCurrentKey() + +
            +          
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return types with arguments of type EntityId
            + RecordReader<EntityId,KijiRowData>KijiTableInputFormat.createRecordReader(InputSplit split, + TaskAttemptContext context) + +
            +          Deprecated. 
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools that return EntityId
            +static EntityIdToolUtils.createEntityIdFromUserInputs(String entityId, + String entityHash, + RowKeyFormat format) + +
            +          Create an EntityId from the --entity-id and --entity-hash arguments to a kiji tool.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/EntityIdFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/EntityIdFactory.html new file mode 100644 index 00000000..5efd55c8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/EntityIdFactory.html @@ -0,0 +1,218 @@ + + + + + + + +Uses of Class org.kiji.schema.EntityIdFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.EntityIdFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use EntityIdFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of EntityIdFactory in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return EntityIdFactory
            +static EntityIdFactoryEntityIdFactory.create(RowKeyFormat format) + +
            +          Creates an entity ID factory for the specified row key format.
            + EntityIdFactoryKijiTable.getEntityIdFactory() + +
            +           
            +  +

            + + + + + +
            +Uses of EntityIdFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return EntityIdFactory
            + EntityIdFactoryHBaseKijiTable.getEntityIdFactory() + +
            +          
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/GenericCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/GenericCellDecoderFactory.html new file mode 100644 index 00000000..9b061eb9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/GenericCellDecoderFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.GenericCellDecoderFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.GenericCellDecoderFactory

            +
            +No usage of org.kiji.schema.GenericCellDecoderFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseColumnName.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseColumnName.html new file mode 100644 index 00000000..57e11885 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseColumnName.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Class org.kiji.schema.HBaseColumnName (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.HBaseColumnName

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseColumnName
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of HBaseColumnName in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that return HBaseColumnName
            + HBaseColumnNameKijiColumnFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +abstract  HBaseColumnNameKijiRowFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            +  +

            + + + + + +
            +Uses of HBaseColumnName in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return HBaseColumnName
            + HBaseColumnNameColumnNameTranslator.toHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type HBaseColumnName
            + KijiColumnNameColumnNameTranslator.toKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseFactory.Provider.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseFactory.Provider.html new file mode 100644 index 00000000..094463d1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseFactory.Provider.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.HBaseFactory.Provider (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.HBaseFactory.Provider

            +
            +No usage of org.kiji.schema.HBaseFactory.Provider +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseFactory.html new file mode 100644 index 00000000..b3cee05d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseFactory.html @@ -0,0 +1,238 @@ + + + + + + + +Uses of Interface org.kiji.schema.HBaseFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.HBaseFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return HBaseFactory
            +static HBaseFactoryHBaseFactory.Provider.get() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type HBaseFactory
            +static voidKijiInstaller.install(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            +static voidKijiInstaller.uninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  +

            + + + + + +
            +Uses of HBaseFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement HBaseFactory
            + classDefaultHBaseFactory + +
            +          Factory for HBase instances based on URIs.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseScanOptions.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseScanOptions.html new file mode 100644 index 00000000..73072a23 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/HBaseScanOptions.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Class org.kiji.schema.HBaseScanOptions (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.HBaseScanOptions

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseScanOptions
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseScanOptions in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return HBaseScanOptions
            + HBaseScanOptionsKijiTableReader.KijiScannerOptions.getHBaseScanOptions() + +
            +          Gets the HBaseScanOptions set in these options.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type HBaseScanOptions
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setHBaseScanOptions(HBaseScanOptions hBaseScanOptions) + +
            +          Sets the HBaseScanOptions used by a HBase backed scanner.
            +  +

            + + + + + +
            +Uses of HBaseScanOptions in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HBaseScanOptions
            + ScanHBaseDataRequestAdapter.toScan(KijiTableLayout tableLayout, + HBaseScanOptions scanOptions) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/IncompatibleKijiVersionException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/IncompatibleKijiVersionException.html new file mode 100644 index 00000000..55347b95 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/IncompatibleKijiVersionException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.IncompatibleKijiVersionException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.IncompatibleKijiVersionException

            +
            +No usage of org.kiji.schema.IncompatibleKijiVersionException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/InternalKijiError.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/InternalKijiError.html new file mode 100644 index 00000000..37882d20 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/InternalKijiError.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.InternalKijiError (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.InternalKijiError

            +
            +No usage of org.kiji.schema.InternalKijiError +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/Kiji.Factory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/Kiji.Factory.html new file mode 100644 index 00000000..43cd8942 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/Kiji.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.Kiji.Factory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.Kiji.Factory

            +
            +No usage of org.kiji.schema.Kiji.Factory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/Kiji.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/Kiji.html new file mode 100644 index 00000000..7bdbf4a5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/Kiji.html @@ -0,0 +1,447 @@ + + + + + + + +Uses of Interface org.kiji.schema.Kiji (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.Kiji

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use Kiji
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return Kiji
            + KijiKijiTable.getKiji() + +
            +           
            + KijiKijiFactory.open(KijiConfiguration kijiConf) + +
            +          Deprecated. 
            +static KijiKiji.Factory.open(KijiConfiguration kijiConf) + +
            +          Deprecated. 
            + KijiKijiFactory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            +static KijiKiji.Factory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + KijiKijiFactory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +static KijiKiji.Factory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type Kiji
            KijiTablePool(Kiji kiji) + +
            +          Constructs a new pool of Kiji tables.
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement Kiji
            + classHBaseKiji + +
            +          Kiji instance class that contains configuration and table + information.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return Kiji
            + KijiAbstractKijiTable.getKiji() + +
            +          
            + KijiHBaseKijiFactory.open(KijiConfiguration kijiConf) + +
            +          Opens a Kiji instance.
            + KijiHBaseKijiFactory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + KijiHBaseKijiFactory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            + KijiHBaseKiji.retain() + +
            +          Expresses interest in retaining this resource.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type Kiji
            + voidMetadataRestorer.exportMetadata(String outputFile, + Kiji kiji) + +
            +          Exports all Kiji metadata to an Avro file with the specified filename.
            + voidMetadataRestorer.restoreSchemas(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all SchemaTable entries from the metadata backup.
            + voidMetadataRestorer.restoreTables(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all tables from the metadata backup into the running Kiji instance.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type Kiji
            AbstractKijiTable(Kiji kiji, + String name) + +
            +          Creates a new KijiTable instance.
            DefaultKijiTableFactory(Kiji kiji) + +
            +          Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance.
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools that return Kiji
            +protected  KijiVersionValidatedTool.openKiji() + +
            +          Opens a kiji instance.
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema.util
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util with parameters of type Kiji
            +static StringVersionInfo.getClusterDataVersion(Kiji kiji) + +
            +          Gets the version of the Kiji data format installed in the instance of the HBase cluster.
            +static voidVersionInfo.validateVersion(Kiji kiji) + +
            +          Validates that the client data version matches the data version installed on a Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiAdmin.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiAdmin.html new file mode 100644 index 00000000..4ccbb796 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiAdmin.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiAdmin (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiAdmin

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiAdmin
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiAdmin in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiAdmin
            + KijiAdminKiji.getAdmin() + +
            +           
            +  +

            + + + + + +
            +Uses of KijiAdmin in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiAdmin
            + classHBaseKijiAdmin + +
            +          Administration API for managing a Kiji instance that uses HBase as its underlying data store.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiAdmin
            + KijiAdminHBaseKiji.getAdmin() + +
            +          
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiAlreadyExistsException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiAlreadyExistsException.html new file mode 100644 index 00000000..06237b80 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiAlreadyExistsException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiAlreadyExistsException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiAlreadyExistsException

            +
            +No usage of org.kiji.schema.KijiAlreadyExistsException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCell.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCell.html new file mode 100644 index 00000000..53937a4d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCell.html @@ -0,0 +1,478 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiCell (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiCell

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiCell
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCell in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCell
            + KijiCell<T>KijiCellDecoder.decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + + + + + +
            +<T> KijiCell<T>
            +            		KijiRowData.getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> KijiCell<T>
            +            		KijiRowData.getMostRecentCell(String family, + String qualifier) + +
            +          Gets the latest version of the specified cell.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiCell
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		KijiRowData.getCells(String family) + +
            +          Gets all the timestamp-cell pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		KijiRowData.getCells(String family, + String qualifier) + +
            +          Gets all the timestamp-cell pairs stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		KijiRowData.getMostRecentCells(String family) + +
            +          Gets the latest version of the specified cell.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiCell
            + byte[]KijiCellEncoder.encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            +  +

            + + + + + +
            +Uses of KijiCell in org.kiji.schema.filter
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiCell
            +abstract  byte[]KijiRowFilter.Context.getHBaseCellValue(KijiColumnName column, + KijiCell<?> kijiCell) + +
            +          Converts a Kiji cell value into an HBase cell value.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.filter with parameters of type KijiCell
            ColumnValueEqualsRowFilter(String family, + String qualifier, + KijiCell<?> value) + +
            +          Creates a new ColumnValueEqualsRowFilter instance.
            +  +

            + + + + + +
            +Uses of KijiCell in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCell
            + KijiCell<T>AvroCellDecoder.decodeCell(byte[] encodedBytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + KijiCell<Long>CounterCellDecoder.decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + + + + + +
            +<T> KijiCell<T>
            +            		HBaseKijiRowData.getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> KijiCell<T>
            +            		HBaseKijiRowData.getMostRecentCell(String family, + String qualifier) + +
            +          Gets the latest version of the specified cell.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KijiCell
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		HBaseKijiRowData.getCells(String family) + +
            +          Gets all the timestamp-cell pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		HBaseKijiRowData.getCells(String family, + String qualifier) + +
            +          Gets all the timestamp-cell pairs stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		HBaseKijiRowData.getMostRecentCells(String family) + +
            +          Gets the latest version of the specified cell.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiCell
            + byte[]CounterCellEncoder.encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + byte[]AvroCellEncoder.encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellDecoder.html new file mode 100644 index 00000000..a6b97f95 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellDecoder.html @@ -0,0 +1,257 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellDecoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellDecoder

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCellDecoder
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellDecoder in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCellDecoder
            + KijiCellDecoder<?>GenericCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + KijiCellDecoder<?>SpecificCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + + + + + +
            +<T> KijiCellDecoder<T>
            +            		KijiCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +  +

            + + + + + +
            +Uses of KijiCellDecoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCellDecoder
            + classAvroCellDecoder<T> + +
            +          Base class for decoders that read Kiji cells encoded using Avro.
            + classCounterCellDecoder + +
            +          Cell decoder for counters.
            + classGenericCellDecoder<T> + +
            +          Decodes cells encoded using Avro into generic types.
            + classSpecificCellDecoder<T> + +
            +          Decodes cells encoded using Avro into specific types.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellDecoderFactory.html new file mode 100644 index 00000000..fc44d253 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellDecoderFactory.html @@ -0,0 +1,287 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellDecoderFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellDecoderFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCellDecoderFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellDecoderFactory in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema that implement KijiCellDecoderFactory
            + classGenericCellDecoderFactory + +
            +          Factory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas.
            + classSpecificCellDecoderFactory + +
            +          Factory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCellDecoderFactory
            +static KijiCellDecoderFactoryGenericCellDecoderFactory.get() + +
            +           
            +static KijiCellDecoderFactorySpecificCellDecoderFactory.get() + +
            +           
            +  +

            + + + + + +
            +Uses of KijiCellDecoderFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCellDecoderFactory
            + KijiCellDecoderFactoryHBaseKijiRowScanner.Options.getCellDecoderFactory() + +
            +          Gets the cell decoder factory.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiCellDecoderFactory
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory) + +
            +          Sets the cell decoder factory to use when reading cells from the scanner.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiCellDecoderFactory
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellEncoder.html new file mode 100644 index 00000000..c4766491 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellEncoder.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellEncoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellEncoder

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCellEncoder
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellEncoder in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCellEncoder
            + KijiCellEncoderKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            + + + + + +
            +Uses of KijiCellEncoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCellEncoder
            + classAvroCellEncoder + +
            +          Serializes a KijiCell.
            + classCounterCellEncoder + +
            +          Encoder for Kiji counters.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCellEncoder
            + KijiCellEncoderDefaultKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellEncoderFactory.html new file mode 100644 index 00000000..1448bf8a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCellEncoderFactory.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellEncoderFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellEncoderFactory

            +
            + + + + + + + + + +
            +Packages that use KijiCellEncoderFactory
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellEncoderFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCellEncoderFactory
            + classDefaultKijiCellEncoderFactory + +
            +          Factory for cell encoders.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiColumnName.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiColumnName.html new file mode 100644 index 00000000..f3657b19 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiColumnName.html @@ -0,0 +1,428 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiColumnName (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiColumnName

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiColumnName
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiColumnName in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiColumnName
            + KijiColumnNameKijiDataRequest.Column.getColumnName() + +
            +          Gets the column name.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiColumnName
            + com.google.common.collect.ImmutableList<KijiColumnName>KijiURI.getColumn() + +
            +           
            + Collection<KijiColumnName>KijiURI.getColumnOrdered() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiColumnName
            + intKijiColumnName.compareTo(KijiColumnName o) + +
            +          
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiColumnName
            KijiDataRequest.Column(KijiColumnName name) + +
            +          Creates a new requested Column.
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema with type arguments of type KijiColumnName
            KijiURI(Iterable<String> zookeeperQuorum, + int zookeeperClientPort, + String instanceName, + String tableName, + Iterable<KijiColumnName> columnNames) + +
            +          Constructs a new KijiURI with the given parameters.
            +  +

            + + + + + +
            +Uses of KijiColumnName in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiColumnName
            +abstract  byte[]KijiRowFilter.Context.getHBaseCellValue(KijiColumnName column, + KijiCell<?> kijiCell) + +
            +          Converts a Kiji cell value into an HBase cell value.
            + HBaseColumnNameKijiColumnFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +abstract  HBaseColumnNameKijiRowFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            + FilterKijiColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + ColumnNameTranslator columnNameTranslator) + +
            +          Expresses a KijiColumnFilter in terms of an equivalent HBase filter, translating the + KijiColumnNames to the corresponding HBaseColumnName.
            +abstract  FilterKijiColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            + FilterRegexQualifierColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  +

            + + + + + +
            +Uses of KijiColumnName in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiColumnName
            + KijiColumnNameColumnNameTranslator.toKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiColumnName
            + Set<KijiColumnName>KijiTableLayout.getColumnNames() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type KijiColumnName
            + booleanKijiTableLayout.exists(KijiColumnName column) + +
            +          Reports whether a column exists.
            + SchemaStorageKijiTableLayout.getCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            + CellSchemaKijiTableLayout.getCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            + CellSpecKijiTableLayout.getCellSpec(KijiColumnName column) + +
            +           
            + org.apache.avro.SchemaKijiTableLayout.getSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            + HBaseColumnNameColumnNameTranslator.toHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiConfiguration.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiConfiguration.html new file mode 100644 index 00000000..7356976f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiConfiguration.html @@ -0,0 +1,381 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiConfiguration (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiConfiguration

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiConfiguration
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiConfiguration in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiConfiguration
            +static KijiConfigurationKijiConfiguration.create(String name) + +
            +          Deprecated. Gets a handle to a Kiji instance using the default Kiji configuration file.
            +static KijiConfigurationKijiConfiguration.create(String confFile, + String name) + +
            +          Deprecated. Gets a handle to a Kiji instance.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiConfiguration
            + KijiKijiFactory.open(KijiConfiguration kijiConf) + +
            +          Deprecated. 
            +static KijiKiji.Factory.open(KijiConfiguration kijiConf) + +
            +          Deprecated. 
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiConfiguration
            KijiConfiguration(KijiConfiguration kijiConf) + +
            +          Deprecated. Constructs a deep copy of an existing Kiji configuration.
            +  +

            + + + + + +
            +Uses of KijiConfiguration in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiConfiguration
            +static voidHBaseSystemTable.install(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Installs a Kiji system table into a running HBase instance.
            +static voidHBaseSchemaTable.install(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static LockHBaseSchemaTable.newLock(KijiConfiguration conf, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +static HTableInterfaceHBaseMetaTable.newMetaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates an HTableInterface for the specified table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaHashTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema hash table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaIdTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema ID table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaV5Table(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema V5 table.
            +static HTableInterfaceHBaseSystemTable.newSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates a new HTableInterface for the Kiji system table.
            + KijiHBaseKijiFactory.open(KijiConfiguration kijiConf) + +
            +          Opens a Kiji instance.
            +static voidHBaseSystemTable.uninstall(HBaseAdmin admin, + KijiConfiguration kijiConf) + +
            +          Disables and delete the system table from HBase.
            +static voidHBaseSchemaTable.uninstall(HBaseAdmin admin, + KijiConfiguration kijiConf) + +
            +          Disables and removes the schema table from HBase.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiConfiguration
            HBaseMetaTable(KijiConfiguration kijiConf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseSchemaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            HBaseSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Connect to the HBase system table inside a Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCounter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCounter.html new file mode 100644 index 00000000..809c0ab1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiCounter.html @@ -0,0 +1,271 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCounter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCounter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCounter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCounter in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCounter
            + KijiCounterKijiRowData.getCounter(String family, + String qualifier) + +
            +          Gets the most recent counter from a column.
            + KijiCounterKijiRowData.getCounter(String family, + String qualifier, + long timestamp) + +
            +          Reads a counter as it was at a particular timestamp.
            + KijiCounterKijiIncrementer.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            +  +

            + + + + + +
            +Uses of KijiCounter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCounter
            + classDefaultKijiCounter + +
            +          The default implementation of a Kiji counter, which contains the data in a counter cell + of a column.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCounter
            + KijiCounterHBaseKijiRowData.getCounter(String family, + String qualifier) + +
            +          Deprecated. 
            + KijiCounterHBaseKijiRowData.getCounter(String family, + String qualifier, + long timestamp) + +
            +          Deprecated. 
            + KijiCounterHBaseKijiTableWriter.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequest.Column.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequest.Column.html new file mode 100644 index 00000000..8576988d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequest.Column.html @@ -0,0 +1,239 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequest.Column (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequest.Column

            +
            + + + + + + + + + +
            +Packages that use KijiDataRequest.Column
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiDataRequest.Column in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiDataRequest.Column
            + KijiDataRequest.ColumnKijiDataRequest.getColumn(String family, + String key) + +
            +          Gets a Column requested named "family:key", or + null if none exists.
            + KijiDataRequest.ColumnKijiDataRequest.Column.withFilter(KijiColumnFilter filter) + +
            +          Sets a filter to use on the column.
            + KijiDataRequest.ColumnKijiDataRequest.Column.withMaxVersions(int num) + +
            +          Sets the maximum number of the most recent versions to return.
            + KijiDataRequest.ColumnKijiDataRequest.Column.withPageSize(int cellsPerPage) + +
            +          Sets the number of cells per page (defaults to zero, which means paging is disabled).
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiDataRequest.Column
            + Collection<KijiDataRequest.Column>KijiDataRequest.getColumns() + +
            +          Gets the collection of requested columns.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiDataRequest.Column
            + KijiDataRequestKijiDataRequest.addColumn(KijiDataRequest.Column column) + +
            +          Add a request for a column to this data request.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequest.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequest.html new file mode 100644 index 00000000..16ad0190 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequest.html @@ -0,0 +1,521 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequest (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequest

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiDataRequest
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji map-reduce utilities. 
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiDataRequest
            + KijiDataRequestKijiDataRequest.addColumn(KijiDataRequest.Column column) + +
            +          Add a request for a column to this data request.
            + KijiDataRequestKijiDataRequest.merge(KijiDataRequest other) + +
            +          Merges the requested columns in other into this data request.
            + KijiDataRequestKijiDataRequest.withTimeRange(long minTimestamp, + long maxTimestamp) + +
            +          Sets the time range of cells to return: [minTimestamp, + maxTimestamp).
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiDataRequest
            + List<KijiRowData>KijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + KijiRowDataKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions scannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            + KijiDataRequestKijiDataRequest.merge(KijiDataRequest other) + +
            +          Merges the requested columns in other into this data request.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiDataRequest
            KijiDataRequest(KijiDataRequest copy) + +
            +          Creates a new KijiDataRequest from a copy.
            KijiDataRequestValidator(KijiDataRequest dataRequest) + +
            +          Construct a validator for a data request.
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that return KijiDataRequest
            + KijiDataRequestStripValueRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            +abstract  KijiDataRequestKijiRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + KijiDataRequestOperatorRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + KijiDataRequestColumnValueEqualsRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + KijiDataRequestHasColumnDataRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiDataRequest
            + KijiDataRequestHBaseKijiRowScanner.Options.getDataRequest() + +
            +          Gets the data request.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiDataRequest
            + List<KijiRowData>HBaseKijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + KijiRowDataHBaseKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions kijiScannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withDataRequest(KijiDataRequest dataRequest) + +
            +          Sets the data request used to generate the KijiRowScanner.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiDataRequest
            HBaseDataRequestAdapter(KijiDataRequest kijiDataRequest) + +
            +          Wraps a KijiDataRequest.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            KijiColumnPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HTableInterface htable) + +
            +          Creates a new KijiColumnPager.
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.mapreduce declared as KijiDataRequest
            +protected  KijiDataRequestKijiTableInputFormat.KijiTableRecordReader.mDataRequest + +
            +          Data request.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce with parameters of type KijiDataRequest
            +static voidKijiTableInputFormat.configureJob(Job job, + KijiURI tableURI, + KijiDataRequest dataRequest, + String startRow, + String endRow) + +
            +          Deprecated. Configures a Hadoop M/R job to read from a given table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequestException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequestException.html new file mode 100644 index 00000000..386546b9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequestException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequestException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequestException

            +
            +No usage of org.kiji.schema.KijiDataRequestException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequestValidator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequestValidator.html new file mode 100644 index 00000000..ae984da9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDataRequestValidator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequestValidator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequestValidator

            +
            +No usage of org.kiji.schema.KijiDataRequestValidator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDeleter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDeleter.html new file mode 100644 index 00000000..cf4e0620 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiDeleter.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiDeleter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiDeleter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiDeleter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiDeleter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiDeleter in org.kiji.schema
            + interfaceKijiTableWriter + +
            +          Interface for modifying a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiDeleter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiDeleter
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiEncodingException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiEncodingException.html new file mode 100644 index 00000000..19b8e509 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiEncodingException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiEncodingException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiEncodingException

            +
            +No usage of org.kiji.schema.KijiEncodingException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiFactory.html new file mode 100644 index 00000000..9fb7348a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiFactory.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiFactory
            +static KijiFactoryKiji.Factory.get() + +
            +           
            +  +

            + + + + + +
            +Uses of KijiFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiFactory
            + classHBaseKijiFactory + +
            +          Factory for constructing instances of HBaseKiji.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiIncrementer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiIncrementer.html new file mode 100644 index 00000000..86bad284 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiIncrementer.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiIncrementer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiIncrementer

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiIncrementer
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiIncrementer in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiIncrementer in org.kiji.schema
            + interfaceKijiTableWriter + +
            +          Interface for modifying a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiIncrementer in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiIncrementer
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiInstaller.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiInstaller.html new file mode 100644 index 00000000..864a1fd1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiInstaller.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiInstaller (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiInstaller

            +
            +No usage of org.kiji.schema.KijiInstaller +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiInvalidNameException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiInvalidNameException.html new file mode 100644 index 00000000..0f89fed5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiInvalidNameException.html @@ -0,0 +1,258 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiInvalidNameException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiInvalidNameException

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiInvalidNameException
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of KijiInvalidNameException in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that throw KijiInvalidNameException
            +static voidKijiInstaller.install(KijiURI uri, + Configuration conf) + +
            +          Installs the specified Kiji instance.
            +static voidKijiInstaller.install(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            +static voidKijiInstaller.uninstall(KijiURI uri, + Configuration conf) + +
            +          Uninstalls the specified Kiji instance.
            +static voidKijiInstaller.uninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  +

            + + + + + +
            +Uses of KijiInvalidNameException in org.kiji.schema.util
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util that throw KijiInvalidNameException
            +static voidKijiNameValidator.validateAlias(CharSequence name) + +
            +          Validates characters that may be used in an alias for a qualifier, family, or + locality group.
            +static voidKijiNameValidator.validateKijiName(CharSequence name) + +
            +          Determines whether a string is a valid Kiji instance name.
            +static voidKijiNameValidator.validateLayoutName(CharSequence name) + +
            +          Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiManagedHBaseTableName.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiManagedHBaseTableName.html new file mode 100644 index 00000000..1f07818d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiManagedHBaseTableName.html @@ -0,0 +1,260 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiManagedHBaseTableName (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiManagedHBaseTableName

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiManagedHBaseTableName
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiManagedHBaseTableName in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiManagedHBaseTableName
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.get(String hbaseTableName) + +
            +          Constructs using an HBase HTable name.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getKijiTableName(String kijiInstanceName, + String kijiTableName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getMetaTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSchemaHashTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSchemaIdTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSchemaV5TableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSystemTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table.
            +  +

            + + + + + +
            +Uses of KijiManagedHBaseTableName in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiManagedHBaseTableName
            +static HTableDescriptorHTableDescriptorComparator.makeEmptyTableDescriptor(KijiManagedHBaseTableName hbaseTableName) + +
            +          Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout().
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiMetaTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiMetaTable.html new file mode 100644 index 00000000..1d05f8a3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiMetaTable.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiMetaTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiMetaTable

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiMetaTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiMetaTable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiMetaTable
            + KijiMetaTableKiji.getMetaTable() + +
            +          Gets the meta table for this Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiMetaTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiMetaTable in org.kiji.schema.impl
            + classHBaseMetaTable + +
            +          An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiMetaTable
            + KijiMetaTableHBaseKiji.getMetaTable() + +
            +          Gets the meta table for this Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiNotInstalledException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiNotInstalledException.html new file mode 100644 index 00000000..3ed06e8f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiNotInstalledException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiNotInstalledException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiNotInstalledException

            +
            +No usage of org.kiji.schema.KijiNotInstalledException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiPutter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiPutter.html new file mode 100644 index 00000000..cbc9844f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiPutter.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiPutter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiPutter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiPutter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiPutter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiPutter in org.kiji.schema
            + interfaceKijiTableWriter + +
            +          Interface for modifying a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiPutter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiPutter
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiRowData.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiRowData.html new file mode 100644 index 00000000..a3c2950f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiRowData.html @@ -0,0 +1,308 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiRowData (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiRowData

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiRowData
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji map-reduce utilities. 
            +  +

            + + + + + +
            +Uses of KijiRowData in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiRowData
            + KijiRowDataKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiRowData
            + List<KijiRowData>KijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + +
            +Uses of KijiRowData in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiRowData
            + classHBaseKijiRowData + +
            +          An implementation of KijiRowData that wraps an HBase Result object.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiRowData
            + KijiRowDataHBaseKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KijiRowData
            + List<KijiRowData>HBaseKijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + +
            +Uses of KijiRowData in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return KijiRowData
            + KijiRowDataKijiTableInputFormat.KijiTableRecordReader.getCurrentValue() + +
            +          
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return types with arguments of type KijiRowData
            + RecordReader<EntityId,KijiRowData>KijiTableInputFormat.createRecordReader(InputSplit split, + TaskAttemptContext context) + +
            +          Deprecated. 
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiRowKeySplitter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiRowKeySplitter.html new file mode 100644 index 00000000..f70c69d7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiRowKeySplitter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiRowKeySplitter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiRowKeySplitter

            +
            +No usage of org.kiji.schema.KijiRowKeySplitter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiRowScanner.html new file mode 100644 index 00000000..d1b2a61c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiRowScanner.html @@ -0,0 +1,244 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiRowScanner (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiRowScanner

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiRowScanner
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiRowScanner in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiRowScanner
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions scannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  +

            + + + + + +
            +Uses of KijiRowScanner in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiRowScanner
            + classHBaseKijiRowScanner + +
            +          The internal implementation of KijiRowScanner that reads from HTables.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiRowScanner
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions kijiScannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html new file mode 100644 index 00000000..10937076 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiSchemaTable.SchemaEntry (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiSchemaTable.SchemaEntry

            +
            + + + + + + + + + +
            +Packages that use KijiSchemaTable.SchemaEntry
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiSchemaTable.SchemaEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiSchemaTable.SchemaEntry
            +static KijiSchemaTable.SchemaEntryHBaseSchemaTable.fromAvroEntry(SchemaTableEntry avroEntry) + +
            +          Converts an Avro SchemaTableEntry into a SchemaEntry.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiSchemaTable.SchemaEntry
            +static SchemaTableEntryHBaseSchemaTable.toAvroEntry(KijiSchemaTable.SchemaEntry entry) + +
            +          Converts a SchemaEntry into an Avro SchemaTableEntry.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiSchemaTable.html new file mode 100644 index 00000000..b285bd41 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiSchemaTable.html @@ -0,0 +1,378 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiSchemaTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiSchemaTable

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiSchemaTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiSchemaTable
            + KijiSchemaTableKiji.getSchemaTable() + +
            +          Gets the schema table for this Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema.filter
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.filter with parameters of type KijiSchemaTable
            KijiRowFilterApplicator(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiSchemaTable in org.kiji.schema.impl
            + classHBaseSchemaTable + +
            +           + Mapping between schema IDs, hashes and Avro schema objects.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiSchemaTable
            + KijiSchemaTableHBaseKiji.getSchemaTable() + +
            +          Gets the schema table for this Kiji instance.
            + KijiSchemaTableHBaseKijiRowData.getSchemaTable() + +
            +          Gets the schema table this kiji row data uses for decoding.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiSchemaTable
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseMetaTable(HTableInterface htable, + KijiSchemaTable schemaTable) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseMetaTable(KijiConfiguration kijiConf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return KijiSchemaTable
            + KijiSchemaTableCellSpec.getSchemaTable() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type KijiSchemaTable
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            + CellSpecCellSpec.setSchemaTable(KijiSchemaTable schemaTable) + +
            +          Sets the schema table.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout.impl with parameters of type KijiSchemaTable
            HBaseTableLayoutDatabase(HTableInterface htable, + String family, + KijiSchemaTable schemaTable) + +
            +          Creates a new HBaseTableLayoutDatabase instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiSystemTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiSystemTable.html new file mode 100644 index 00000000..7ed94c58 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiSystemTable.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiSystemTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiSystemTable

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiSystemTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiSystemTable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiSystemTable
            + KijiSystemTableKiji.getSystemTable() + +
            +          Gets the system table for this Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiSystemTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiSystemTable in org.kiji.schema.impl
            + classHBaseSystemTable + +
            +          The Kiji system table that is stored in HBase.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiSystemTable
            + KijiSystemTableHBaseKiji.getSystemTable() + +
            +          Gets the system table for this Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTable.html new file mode 100644 index 00000000..a9cd6351 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTable.html @@ -0,0 +1,283 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTable

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTable in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTable
            + KijiTableKijiTablePool.get(String name) + +
            +          Gets a previously opened table from the pool, or open a new connection.
            + KijiTableKijiTableFactory.openTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiTable
            + voidKijiTablePool.release(KijiTable table) + +
            +          Releases a table back to the pool.
            +  +

            + + + + + +
            +Uses of KijiTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTable
            + classAbstractKijiTable + +
            +          Main handle for a Kiji table with basic functionality.
            + classHBaseKijiTable + +
            +          A KijiTable that exposes the underlying HBase implementation.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTable
            + KijiTableHBaseKiji.openTable(String tableName) + +
            +          Opens a KijiTable by name.
            + KijiTableDefaultKijiTableFactory.openTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiTable
            +static HBaseKijiTableHBaseKijiTable.downcast(KijiTable kijiTable) + +
            +          We know that all KijiTables are really HBaseKijiTables + instances.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableFactory.html new file mode 100644 index 00000000..a618a56e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableFactory.html @@ -0,0 +1,241 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiTableFactory in org.kiji.schema
            + interfaceKiji + +
            +          Provides a handle to a Kiji instance that contains configuration and + table information.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiTableFactory
            KijiTablePool(KijiTableFactory tableFactory) + +
            +          Constructs a new pool of Kiji tables.
            KijiTablePool(KijiTableFactory tableFactory, + KijiTablePool.Options options) + +
            +          Constructs a new pool of Kiji tables.
            +  +

            + + + + + +
            +Uses of KijiTableFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableFactory
            + classDefaultKijiTableFactory + +
            +          The default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open().
            + classHBaseKiji + +
            +          Kiji instance class that contains configuration and table + information.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html new file mode 100644 index 00000000..837077cb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html @@ -0,0 +1,288 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableKeyValueDatabase (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableKeyValueDatabase

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableKeyValueDatabase
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableKeyValueDatabase in org.kiji.schema
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema that implement KijiTableKeyValueDatabase
            + classKijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableKeyValueDatabase
            + KijiTableKeyValueDatabaseKijiTableKeyValueDatabase.putValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            +  +

            + + + + + +
            +Uses of KijiTableKeyValueDatabase in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableKeyValueDatabase
            + classHBaseMetaTable + +
            +          An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            + classHBaseTableKeyValueDatabase + +
            +          Manages key-value pairs on a per table basis.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableKeyValueDatabase
            + KijiTableKeyValueDatabaseHBaseMetaTable.putValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + KijiTableKeyValueDatabaseHBaseTableKeyValueDatabase.putValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTableKeyValueDatabase
            HBaseMetaTable(HTableInterface htable, + KijiTableLayoutDatabase tableLayoutDatabase, + KijiTableKeyValueDatabase tableKeyValueDatabase) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableNotFoundException.html new file mode 100644 index 00000000..13fd4479 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableNotFoundException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTableNotFoundException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTableNotFoundException

            +
            +No usage of org.kiji.schema.KijiTableNotFoundException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html new file mode 100644 index 00000000..210e7271 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTablePool.NoCapacityException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTablePool.NoCapacityException

            +
            +No usage of org.kiji.schema.KijiTablePool.NoCapacityException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTablePool.Options.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTablePool.Options.html new file mode 100644 index 00000000..04b5f711 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTablePool.Options.html @@ -0,0 +1,228 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTablePool.Options (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTablePool.Options

            +
            + + + + + + + + + +
            +Packages that use KijiTablePool.Options
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiTablePool.Options in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTablePool.Options
            + KijiTablePool.OptionsKijiTablePool.Options.withClock(Clock clock) + +
            +          Sets a clock.
            + KijiTablePool.OptionsKijiTablePool.Options.withIdlePollPeriod(long periodMillis) + +
            +          Sets the amount of time between sweeps of the pool for removing idle connections.
            + KijiTablePool.OptionsKijiTablePool.Options.withIdleTimeout(long timeoutMillis) + +
            +          Sets the amount of time a connection may be idle before being removed from the pool.
            + KijiTablePool.OptionsKijiTablePool.Options.withMaxSize(int maxSize) + +
            +          Sets the maximum number of connections to keep per table.
            + KijiTablePool.OptionsKijiTablePool.Options.withMinSize(int minSize) + +
            +          Sets the minimum number of connections to keep per table.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiTablePool.Options
            KijiTablePool(KijiTableFactory tableFactory, + KijiTablePool.Options options) + +
            +          Constructs a new pool of Kiji tables.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTablePool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTablePool.html new file mode 100644 index 00000000..70982136 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTablePool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTablePool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTablePool

            +
            +No usage of org.kiji.schema.KijiTablePool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableReader.KijiScannerOptions.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableReader.KijiScannerOptions.html new file mode 100644 index 00000000..90c9cb49 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableReader.KijiScannerOptions.html @@ -0,0 +1,255 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTableReader.KijiScannerOptions (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTableReader.KijiScannerOptions

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableReader.KijiScannerOptions
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableReader.KijiScannerOptions in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableReader.KijiScannerOptions
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setHBaseScanOptions(HBaseScanOptions hBaseScanOptions) + +
            +          Sets the HBaseScanOptions used by a HBase backed scanner.
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setKijiRowFilter(KijiRowFilter rowFilter) + +
            +          Sets the row filter used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setStartRow(EntityId startRow) + +
            +          Sets the start row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setStopRow(EntityId stopRow) + +
            +          Sets the stop row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiTableReader.KijiScannerOptions
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions scannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  +

            + + + + + +
            +Uses of KijiTableReader.KijiScannerOptions in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiTableReader.KijiScannerOptions
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions kijiScannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableReader.html new file mode 100644 index 00000000..a52dca95 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableReader.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableReader (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableReader

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableReader
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableReader in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableReader
            + KijiTableReaderKijiTable.openTableReader() + +
            +          Opens an appropriate implementation of KijiTableReader for this table.
            +  +

            + + + + + +
            +Uses of KijiTableReader in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableReader
            + classHBaseKijiTableReader + +
            +          Reads from a kiji table by sending the requests directly to the HBase tables.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableReader
            + KijiTableReaderHBaseKijiTable.openTableReader() + +
            +          Opens an appropriate implementation of KijiTableReader for this table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableWriter.html new file mode 100644 index 00000000..4164c9cc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiTableWriter.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableWriter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableWriter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableWriter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableWriter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableWriter
            + KijiTableWriterKijiTable.openTableWriter() + +
            +          Opens an appropriate implementation of KijiTableWriter for this table.
            +  +

            + + + + + +
            +Uses of KijiTableWriter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableWriter
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableWriter
            + KijiTableWriterHBaseKijiTable.openTableWriter() + +
            +          Opens an appropriate implementation of KijiTableWriter for this table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiURI.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiURI.html new file mode 100644 index 00000000..f93c6997 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiURI.html @@ -0,0 +1,556 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiURI (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiURI

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiURI
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji map-reduce utilities. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiURI
            + KijiURIKijiAlreadyExistsException.getURI() + +
            +           
            + KijiURIKiji.getURI() + +
            +           
            + KijiURIKijiTable.getURI() + +
            +           
            +static KijiURIKijiURI.parse(String uri) + +
            +          Constructs a fully qualified Kiji table URI from a string.
            + KijiURIKijiURI.resolve(String path) + +
            +          Resolve the path relative to this KijiURI.
            + KijiURIKijiURI.setColumnNames(Collection<String> columnNames) + +
            +          Creates a KijiURI with these column names added.
            + KijiURIKijiURI.setInstanceName(String instanceName) + +
            +          Creates a new KijiURI with this instance name added.
            + KijiURIKijiURI.setTableName(String tableName) + +
            +          Creates a KijiURI with this table name added.
            + KijiURIKijiURI.setZookeeperQuorum(String[] quorum) + +
            +          Creates a new KijiURI with this zookeeper quorum.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiURI
            + HBaseAdminFactoryHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactoryHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactoryHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +static voidKijiInstaller.install(KijiURI uri, + Configuration conf) + +
            +          Installs the specified Kiji instance.
            +static voidKijiInstaller.install(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            + KijiKijiFactory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            +static KijiKiji.Factory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + KijiKijiFactory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +static KijiKiji.Factory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +static voidKijiInstaller.uninstall(KijiURI uri, + Configuration conf) + +
            +          Uninstalls the specified Kiji instance.
            +static voidKijiInstaller.uninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiURI
            KijiAlreadyExistsException(String message, + KijiURI uri) + +
            +          Initializes a new exception object.
            KijiConfiguration(Configuration conf, + KijiURI uri) + +
            +          Deprecated. Initializes a Kiji configuration from a Hadoop configuration and a Kiji URI.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiURI
            + KijiURIHBaseKiji.getURI() + +
            +          
            + KijiURIAbstractKijiTable.getURI() + +
            +          
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiURI
            + HBaseAdminFactoryDefaultHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactoryDefaultHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactoryDefaultHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +static voidHBaseMetaTable.install(HBaseAdmin admin, + KijiURI uri) + +
            +          Install the meta table into a Kiji instance.
            + KijiHBaseKijiFactory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + KijiHBaseKijiFactory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +static voidHBaseMetaTable.uninstall(HBaseAdmin admin, + KijiURI uri) + +
            +          Removes the meta table from HBase.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce with parameters of type KijiURI
            +static voidKijiTableInputFormat.configureJob(Job job, + KijiURI tableURI, + KijiDataRequest dataRequest, + String startRow, + String endRow) + +
            +          Deprecated. Configures a Hadoop M/R job to read from a given table.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools that return KijiURI
            +protected  KijiURIBaseTool.getURI() + +
            +          Returns the kiji URI of the target this tool operates on.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type KijiURI
            +protected  voidBaseTool.setURI(KijiURI uri) + +
            +          Sets the kiji URI of the target this tool operates on.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiURIException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiURIException.html new file mode 100644 index 00000000..3022860e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/KijiURIException.html @@ -0,0 +1,245 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiURIException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiURIException

            +
            + + + + + + + + + +
            +Packages that use KijiURIException
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiURIException in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that throw KijiURIException
            +static KijiURIKijiURI.parse(String uri) + +
            +          Constructs a fully qualified Kiji table URI from a string.
            + KijiURIKijiURI.resolve(String path) + +
            +          Resolve the path relative to this KijiURI.
            + KijiURIKijiURI.setColumnNames(Collection<String> columnNames) + +
            +          Creates a KijiURI with these column names added.
            + KijiURIKijiURI.setInstanceName(String instanceName) + +
            +          Creates a new KijiURI with this instance name added.
            + KijiURIKijiURI.setTableName(String tableName) + +
            +          Creates a KijiURI with this table name added.
            + KijiURIKijiURI.setZookeeperQuorum(String[] quorum) + +
            +          Creates a new KijiURI with this zookeeper quorum.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema that throw KijiURIException
            KijiURI(Iterable<String> zookeeperQuorum, + int zookeeperClientPort, + String instanceName, + String tableName, + Iterable<KijiColumnName> columnNames) + +
            +          Constructs a new KijiURI with the given parameters.
            KijiURI(URI uri) + +
            +          Constructs a URI that fully qualifies a Kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/NoCellDataException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/NoCellDataException.html new file mode 100644 index 00000000..27087db4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/NoCellDataException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.NoCellDataException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.NoCellDataException

            +
            +No usage of org.kiji.schema.NoCellDataException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/NoSuchColumnException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/NoSuchColumnException.html new file mode 100644 index 00000000..b15f5633 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/NoSuchColumnException.html @@ -0,0 +1,250 @@ + + + + + + + +Uses of Class org.kiji.schema.NoSuchColumnException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.NoSuchColumnException

            +
            + + + + + + + + + + + + + +
            +Packages that use NoSuchColumnException
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of NoSuchColumnException in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that throw NoSuchColumnException
            + HBaseColumnNameKijiColumnFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +abstract  HBaseColumnNameKijiRowFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            +  +

            + + + + + +
            +Uses of NoSuchColumnException in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that throw NoSuchColumnException
            + SchemaStorageKijiTableLayout.getCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            + CellSchemaKijiTableLayout.getCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            + org.apache.avro.SchemaKijiTableLayout.getSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            + HBaseColumnNameColumnNameTranslator.toHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            + KijiColumnNameColumnNameTranslator.toKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/NotAKijiManagedTableException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/NotAKijiManagedTableException.html new file mode 100644 index 00000000..2fd2c561 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/NotAKijiManagedTableException.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.NotAKijiManagedTableException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.NotAKijiManagedTableException

            +
            + + + + + + + + + +
            +Packages that use NotAKijiManagedTableException
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of NotAKijiManagedTableException in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that throw NotAKijiManagedTableException
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.get(String hbaseTableName) + +
            +          Constructs using an HBase HTable name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/SpecificCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/SpecificCellDecoderFactory.html new file mode 100644 index 00000000..0c2aeb80 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/SpecificCellDecoderFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.SpecificCellDecoderFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.SpecificCellDecoderFactory

            +
            +No usage of org.kiji.schema.SpecificCellDecoderFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/TableKeyNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/TableKeyNotFoundException.html new file mode 100644 index 00000000..74681928 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/class-use/TableKeyNotFoundException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.TableKeyNotFoundException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.TableKeyNotFoundException

            +
            +No usage of org.kiji.schema.TableKeyNotFoundException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/AndRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/AndRowFilter.html new file mode 100644 index 00000000..d934797f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/AndRowFilter.html @@ -0,0 +1,277 @@ + + + + + + + +AndRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class AndRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.OperatorRowFilter
+          extended by org.kiji.schema.filter.AndRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class AndRowFilter
            extends OperatorRowFilter
            + + +

            +A KijiRowFilter for a conjunction (AND operator) of other filters. + +

            If a row R is accepted by both filter A and B, R + will be accepted by AndRowFilter(A, B).

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.OperatorRowFilter
            OperatorRowFilter.Operator
            +  + + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            AndRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new AndRowFilter instance.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.filter.OperatorRowFilter
            getDataRequest, toHBaseFilter
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AndRowFilter

            +
            +public AndRowFilter(List<? extends KijiRowFilter> filters)
            +
            +
            Creates a new AndRowFilter instance. +

            +

            +
            Parameters:
            filters - The filters that should be used in the filter conjunction.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html new file mode 100644 index 00000000..85003ae2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html @@ -0,0 +1,352 @@ + + + + + + + +ColumnValueEqualsRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class ColumnValueEqualsRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.ColumnValueEqualsRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class ColumnValueEqualsRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value. + +

            This filter will only pass if the data in the Kiji cell matches the specified value + exactly. Both the data and the Avro schema must be the same.

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            ColumnValueEqualsRowFilter(String family, + String qualifier, + KijiCell<?> value) + +
            +          Creates a new ColumnValueEqualsRowFilter instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ColumnValueEqualsRowFilter

            +
            +public ColumnValueEqualsRowFilter(String family,
+                                  String qualifier,
+                                  KijiCell<?> value)
            +
            +
            Creates a new ColumnValueEqualsRowFilter instance. +

            +

            +
            Parameters:
            family - The column family of interest.
            qualifier - The column qualifier of interest.
            value - The value the most recent cell in the column must equal to pass the filter.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/HasColumnDataRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/HasColumnDataRowFilter.html new file mode 100644 index 00000000..5243525d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/HasColumnDataRowFilter.html @@ -0,0 +1,364 @@ + + + + + + + +HasColumnDataRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class HasColumnDataRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.HasColumnDataRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class HasColumnDataRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter that excludes rows that have no data for some column columnName. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + + + + +
            +Constructor Summary
            HasColumnDataRowFilter(String columnName) + +
            +          Constructs a row filter that excludes rows that have no data in columnName.
            HasColumnDataRowFilter(String family, + String qualifier) + +
            +          Constructs a row filter that excludes rows that have no data in columnName.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HasColumnDataRowFilter

            +
            +public HasColumnDataRowFilter(String family,
+                              String qualifier)
            +
            +
            Constructs a row filter that excludes rows that have no data in columnName. +

            +

            +
            Parameters:
            family - The column family of interest.
            qualifier - The column qualifier of interest.
            +
            +
            + +

            +HasColumnDataRowFilter

            +
            +public HasColumnDataRowFilter(String columnName)
            +
            +
            Constructs a row filter that excludes rows that have no data in columnName. +

            +

            +
            Parameters:
            columnName - The column family:qualifier of interest.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiColumnFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiColumnFilter.Context.html new file mode 100644 index 00000000..5a609fdf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiColumnFilter.Context.html @@ -0,0 +1,223 @@ + + + + + + + +KijiColumnFilter.Context (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Interface KijiColumnFilter.Context

            +
            +
            Enclosing class:
            KijiColumnFilter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public static interface KijiColumnFilter.Context
            + + +

            +An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + HBaseColumnNamegetHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseColumnName

            +
            +HBaseColumnName getHBaseColumnName(KijiColumnName kijiColumnName)
+                                   throws NoSuchColumnException
            +
            +
            Converts a Kiji column name to an HBase column name. +

            +

            +
            Parameters:
            kijiColumnName - The name of a kiji column. +
            Returns:
            The name of the HBase column that stores the kiji column data. +
            Throws: +
            NoSuchColumnException - If there is no such column in the kiji table.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiColumnFilter.html new file mode 100644 index 00000000..1f13e8d5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiColumnFilter.html @@ -0,0 +1,338 @@ + + + + + + + +KijiColumnFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiColumnFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiColumnFilter
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Direct Known Subclasses:
            RegexQualifierColumnFilter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KijiColumnFilter
            extends Object
            implements Serializable
            + + +

            +A column filter provides a means of filtering cells from a column on the server side. + +

            To make your jobs more efficient, you may use a KijiColumnFilter to specify that + certain cells from a column be filtered. The cells will be filtered on the server, + which reduces the amount of data that needs to be sent to the client.

            + +

            KijiColumnFilters filter cells from a column, in contrast with KijiRowFilters, which + filters rows from a table.

            +

            + +

            +

            +
            See Also:
            KijiRowFilter, +KijiDataRequest.Column.withFilter(KijiColumnFilter), +Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static interfaceKijiColumnFilter.Context + +
            +          An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiColumnFilter() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + FiltertoHBaseFilter(KijiColumnName kijiColumnName, + ColumnNameTranslator columnNameTranslator) + +
            +          Expresses a KijiColumnFilter in terms of an equivalent HBase filter, translating the + KijiColumnNames to the corresponding HBaseColumnName.
            +abstract  FiltertoHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiColumnFilter

            +
            +public KijiColumnFilter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toHBaseFilter

            +
            +public abstract Filter toHBaseFilter(KijiColumnName kijiColumnName,
+                                     KijiColumnFilter.Context context)
+                              throws IOException
            +
            +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +

            +

            +
            +
            +
            +
            Parameters:
            kijiColumnName - The column this filter applies to.
            context - The context. +
            Returns:
            An equivalent HBase Filter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiColumnName kijiColumnName,
+                            ColumnNameTranslator columnNameTranslator)
+                     throws IOException
            +
            +
            Expresses a KijiColumnFilter in terms of an equivalent HBase filter, translating the + KijiColumnNames to the corresponding HBaseColumnName. +

            +

            +
            +
            +
            +
            Parameters:
            kijiColumnName - The column this filter applies to.
            columnNameTranslator - The column name translator that maps KijiColumnNames to + HBaseColumnNames. +
            Returns:
            An equivalent HBase Filter +
            Throws: +
            IOException - If there is an error
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiRowFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiRowFilter.Context.html new file mode 100644 index 00000000..643ed17d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiRowFilter.Context.html @@ -0,0 +1,320 @@ + + + + + + + +KijiRowFilter.Context (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiRowFilter.Context

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter.Context
+
            +
            +
            Enclosing class:
            KijiRowFilter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract static class KijiRowFilter.Context
            extends Object
            + + +

            +A helper class for converting between Kiji objects and their HBase counterparts. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiRowFilter.Context() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  byte[]getHBaseCellValue(KijiColumnName column, + KijiCell<?> kijiCell) + +
            +          Converts a Kiji cell value into an HBase cell value.
            +abstract  HBaseColumnNamegetHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            +abstract  byte[]getHBaseRowKey(String kijiRowKey) + +
            +          Converts a Kiji row key into an HBase row key.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiRowFilter.Context

            +
            +public KijiRowFilter.Context()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseRowKey

            +
            +public abstract byte[] getHBaseRowKey(String kijiRowKey)
            +
            +
            Converts a Kiji row key into an HBase row key. + +

            This method is useful only on tables with row key hashing disabled, since hashed + row keys have no ordering or semantics beyond being an identifier.

            +

            +

            +
            Parameters:
            kijiRowKey - A kiji row key. +
            Returns:
            The corresponding HBase row key.
            +
            +
            +
            + +

            +getHBaseColumnName

            +
            +public abstract HBaseColumnName getHBaseColumnName(KijiColumnName kijiColumnName)
+                                            throws NoSuchColumnException
            +
            +
            Converts a Kiji column name to an HBase column family name. +

            +

            +
            Parameters:
            kijiColumnName - The name of a kiji column. +
            Returns:
            The name of the HBase column that stores the kiji column data. +
            Throws: +
            NoSuchColumnException - If there is no such column in the kiji table.
            +
            +
            +
            + +

            +getHBaseCellValue

            +
            +public abstract byte[] getHBaseCellValue(KijiColumnName column,
+                                         KijiCell<?> kijiCell)
+                                  throws IOException
            +
            +
            Converts a Kiji cell value into an HBase cell value. +

            +

            +
            Parameters:
            column - Name of the column this cell belongs to.
            kijiCell - A kiji cell value. +
            Returns:
            The Kiji cell encoded as an HBase value. +
            Throws: +
            IOException - If there is an error encoding the cell value.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiRowFilter.html new file mode 100644 index 00000000..cd628fa8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiRowFilter.html @@ -0,0 +1,335 @@ + + + + + + + +KijiRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+
            +
            +
            Direct Known Subclasses:
            ColumnValueEqualsRowFilter, HasColumnDataRowFilter, OperatorRowFilter, StripValueRowFilter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KijiRowFilter
            extends Object
            + + +

            +The abstract base class for filters that exclude data from KijiRows. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiRowFilter.Context + +
            +          A helper class for converting between Kiji objects and their HBase counterparts.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiRowFilter() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            +abstract  FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiRowFilter

            +
            +public KijiRowFilter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public abstract KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public abstract Filter toHBaseFilter(KijiRowFilter.Context context)
+                              throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiRowFilterApplicator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiRowFilterApplicator.html new file mode 100644 index 00000000..226f3ddc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/KijiRowFilterApplicator.html @@ -0,0 +1,277 @@ + + + + + + + +KijiRowFilterApplicator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiRowFilterApplicator

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilterApplicator
+
            +
            +
            +
            @ApiAudience.Private
+public final class KijiRowFilterApplicator
            extends Object
            + + +

            +Applies a KijiRowFilter to various row-savvy objects. + + There are several limitations when filtering cells this way, as the filter relies on byte + comparisons, which does not play well with Avro records. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiRowFilterApplicator(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + voidapplyTo(Scan scan) + +
            +          Applies the row filter to an HBase scan object.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiRowFilterApplicator

            +
            +public KijiRowFilterApplicator(KijiRowFilter rowFilter,
+                               KijiTableLayout tableLayout,
+                               KijiSchemaTable schemaTable)
            +
            +
            Creates a new KijiRowFilterApplicator instance. +

            +

            +
            Parameters:
            rowFilter - The row filter to be applied.
            schemaTable - The kiji schema table.
            tableLayout - The layout of the table this filter applies to.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +applyTo

            +
            +public void applyTo(Scan scan)
+             throws IOException
            +
            +
            Applies the row filter to an HBase scan object. + +

            This will tell HBase region servers to filter rows on the server-side, so filtered + rows will not even need to get sent across the network back to the client.

            +

            +

            +
            Parameters:
            scan - An HBase scan descriptor. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/OperatorRowFilter.Operator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/OperatorRowFilter.Operator.html new file mode 100644 index 00000000..3c1e7c8c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/OperatorRowFilter.Operator.html @@ -0,0 +1,334 @@ + + + + + + + +OperatorRowFilter.Operator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Enum OperatorRowFilter.Operator

            +
            +java.lang.Object
+  extended by java.lang.Enum<OperatorRowFilter.Operator>
+      extended by org.kiji.schema.filter.OperatorRowFilter.Operator
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<OperatorRowFilter.Operator>
            +
            +
            +
            Enclosing class:
            OperatorRowFilter
            +
            +
            +
            +
            public static enum OperatorRowFilter.Operator
            extends Enum<OperatorRowFilter.Operator>
            + + +

            +Available logical operators. +

            + +

            +

            + +

            + + + + + + + + + + + + + +
            +Enum Constant Summary
            AND + +
            +          Conjunction.
            OR + +
            +          Disjunction.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static OperatorRowFilter.OperatorvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static OperatorRowFilter.Operator[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +AND

            +
            +public static final OperatorRowFilter.Operator AND
            +
            +
            Conjunction. +

            +

            +
            +
            +
            + +

            +OR

            +
            +public static final OperatorRowFilter.Operator OR
            +
            +
            Disjunction. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static OperatorRowFilter.Operator[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (OperatorRowFilter.Operator c : OperatorRowFilter.Operator.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static OperatorRowFilter.Operator valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/OperatorRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/OperatorRowFilter.html new file mode 100644 index 00000000..49bd7aac --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/OperatorRowFilter.html @@ -0,0 +1,318 @@ + + + + + + + +OperatorRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class OperatorRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.OperatorRowFilter
+
            +
            +
            Direct Known Subclasses:
            AndRowFilter, OrRowFilter
            +
            +
            +
            +
            @ApiAudience.Public
+public class OperatorRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter for a logical operator of composed of other filters. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classOperatorRowFilter.Operator + +
            +          Available logical operators.
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/OrRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/OrRowFilter.html new file mode 100644 index 00000000..5a10ac64 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/OrRowFilter.html @@ -0,0 +1,277 @@ + + + + + + + +OrRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class OrRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.OperatorRowFilter
+          extended by org.kiji.schema.filter.OrRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class OrRowFilter
            extends OperatorRowFilter
            + + +

            +A KijiRowFilter for a disjunction (OR operator) of other filters. + +

            If a row R is accepted by filter A or B, R + will be accepted by OrRowFilter(A, B).

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.OperatorRowFilter
            OperatorRowFilter.Operator
            +  + + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            OrRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new OrRowFilter instance.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.filter.OperatorRowFilter
            getDataRequest, toHBaseFilter
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +OrRowFilter

            +
            +public OrRowFilter(List<? extends KijiRowFilter> filters)
            +
            +
            Creates a new OrRowFilter instance. +

            +

            +
            Parameters:
            filters - The filters that should be used in the filter conjunction.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/RegexQualifierColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/RegexQualifierColumnFilter.html new file mode 100644 index 00000000..9844f7df --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/RegexQualifierColumnFilter.html @@ -0,0 +1,309 @@ + + + + + + + +RegexQualifierColumnFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class RegexQualifierColumnFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiColumnFilter
+      extended by org.kiji.schema.filter.RegexQualifierColumnFilter
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class RegexQualifierColumnFilter
            extends KijiColumnFilter
            + + +

            +A KijiColumnFilter that only allows qualifiers that match a given regular expression. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiColumnFilter
            KijiColumnFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            RegexQualifierColumnFilter(String regularExpression) + +
            +          Constructor.
            +  + + + + + + + + + + + +
            +Method Summary
            + FiltertoHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.filter.KijiColumnFilter
            toHBaseFilter
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +RegexQualifierColumnFilter

            +
            +public RegexQualifierColumnFilter(String regularExpression)
            +
            +
            Constructor. +

            +

            +
            Parameters:
            regularExpression - The regular expression for qualifiers that should be + accepted by this filter. The expression is matched against the full qualifier (as + if it implicitly starts with '^' and ends with '$'.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiColumnName kijiColumnName,
+                            KijiColumnFilter.Context context)
+                     throws IOException
            +
            +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +

            +

            +
            Specified by:
            toHBaseFilter in class KijiColumnFilter
            +
            +
            +
            Parameters:
            kijiColumnName - The column this filter applies to.
            context - The context. +
            Returns:
            An equivalent HBase Filter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/StripValueRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/StripValueRowFilter.html new file mode 100644 index 00000000..e03fe0e1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/StripValueRowFilter.html @@ -0,0 +1,343 @@ + + + + + + + +StripValueRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class StripValueRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.StripValueRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class StripValueRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest. This strips out + all values from all columns and is useful if you just want to retrieve timestamps. Note that + attempting to decode the data (through calls like KijiRowData.getValues()) will + result in an IOException. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            StripValueRowFilter() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +StripValueRowFilter

            +
            +public StripValueRowFilter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/AndRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/AndRowFilter.html new file mode 100644 index 00000000..26db96ef --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/AndRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.AndRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.AndRowFilter

            +
            +No usage of org.kiji.schema.filter.AndRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html new file mode 100644 index 00000000..1fe777ba --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.ColumnValueEqualsRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.ColumnValueEqualsRowFilter

            +
            +No usage of org.kiji.schema.filter.ColumnValueEqualsRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html new file mode 100644 index 00000000..054f9350 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.HasColumnDataRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.HasColumnDataRowFilter

            +
            +No usage of org.kiji.schema.filter.HasColumnDataRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html new file mode 100644 index 00000000..b26423d8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Interface org.kiji.schema.filter.KijiColumnFilter.Context (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.filter.KijiColumnFilter.Context

            +
            + + + + + + + + + +
            +Packages that use KijiColumnFilter.Context
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiColumnFilter.Context in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiColumnFilter.Context
            +abstract  FilterKijiColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            + FilterRegexQualifierColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiColumnFilter.html new file mode 100644 index 00000000..3c762a16 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiColumnFilter.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiColumnFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiColumnFilter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiColumnFilter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiColumnFilter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiColumnFilter
            + KijiColumnFilterKijiDataRequest.Column.getFilter() + +
            +          Gets the column filter, or null if no filter was specified.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiColumnFilter
            + KijiDataRequest.ColumnKijiDataRequest.Column.withFilter(KijiColumnFilter filter) + +
            +          Sets a filter to use on the column.
            +  +

            + + + + + +
            +Uses of KijiColumnFilter in org.kiji.schema.filter
            +  +

            + + + + + + + + + +
            Subclasses of KijiColumnFilter in org.kiji.schema.filter
            + classRegexQualifierColumnFilter + +
            +          A KijiColumnFilter that only allows qualifiers that match a given regular expression.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html new file mode 100644 index 00000000..2a272f62 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html @@ -0,0 +1,218 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiRowFilter.Context (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiRowFilter.Context

            +
            + + + + + + + + + +
            +Packages that use KijiRowFilter.Context
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiRowFilter.Context in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiRowFilter.Context
            + FilterStripValueRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +abstract  FilterKijiRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            + FilterOperatorRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            + FilterColumnValueEqualsRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            + FilterHasColumnDataRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiRowFilter.html new file mode 100644 index 00000000..3b86d387 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiRowFilter.html @@ -0,0 +1,304 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiRowFilter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiRowFilter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiRowFilter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiRowFilter
            + KijiRowFilterKijiTableReader.KijiScannerOptions.getKijiRowFilter() + +
            +          Gets the row filter set in these options.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiRowFilter
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setKijiRowFilter(KijiRowFilter rowFilter) + +
            +          Sets the row filter used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            +  +

            + + + + + +
            +Uses of KijiRowFilter in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of KijiRowFilter in org.kiji.schema.filter
            + classAndRowFilter + +
            +          A KijiRowFilter for a conjunction (AND operator) of other filters.
            + classColumnValueEqualsRowFilter + +
            +          A KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value.
            + classHasColumnDataRowFilter + +
            +          A KijiRowFilter that excludes rows that have no data for some column columnName.
            + classOperatorRowFilter + +
            +          A KijiRowFilter for a logical operator of composed of other filters.
            + classOrRowFilter + +
            +          A KijiRowFilter for a disjunction (OR operator) of other filters.
            + classStripValueRowFilter + +
            +          A KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.filter with parameters of type KijiRowFilter
            KijiRowFilterApplicator(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  +

            + + + + + + + + + + + +
            Constructor parameters in org.kiji.schema.filter with type arguments of type KijiRowFilter
            AndRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new AndRowFilter instance.
            OrRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new OrRowFilter instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html new file mode 100644 index 00000000..d72fc6bf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiRowFilterApplicator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiRowFilterApplicator

            +
            +No usage of org.kiji.schema.filter.KijiRowFilterApplicator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/OperatorRowFilter.Operator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/OperatorRowFilter.Operator.html new file mode 100644 index 00000000..271277a7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/OperatorRowFilter.Operator.html @@ -0,0 +1,190 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.OperatorRowFilter.Operator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.OperatorRowFilter.Operator

            +
            + + + + + + + + + +
            +Packages that use OperatorRowFilter.Operator
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of OperatorRowFilter.Operator in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that return OperatorRowFilter.Operator
            +static OperatorRowFilter.OperatorOperatorRowFilter.Operator.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static OperatorRowFilter.Operator[]OperatorRowFilter.Operator.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/OperatorRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/OperatorRowFilter.html new file mode 100644 index 00000000..c03a65f4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/OperatorRowFilter.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.OperatorRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.OperatorRowFilter

            +
            + + + + + + + + + +
            +Packages that use OperatorRowFilter
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of OperatorRowFilter in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Subclasses of OperatorRowFilter in org.kiji.schema.filter
            + classAndRowFilter + +
            +          A KijiRowFilter for a conjunction (AND operator) of other filters.
            + classOrRowFilter + +
            +          A KijiRowFilter for a disjunction (OR operator) of other filters.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/OrRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/OrRowFilter.html new file mode 100644 index 00000000..baad3af2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/OrRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.OrRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.OrRowFilter

            +
            +No usage of org.kiji.schema.filter.OrRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html new file mode 100644 index 00000000..6a5ad979 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.RegexQualifierColumnFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.RegexQualifierColumnFilter

            +
            +No usage of org.kiji.schema.filter.RegexQualifierColumnFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/StripValueRowFilter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/StripValueRowFilter.html new file mode 100644 index 00000000..e2226e5d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/class-use/StripValueRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.StripValueRowFilter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.StripValueRowFilter

            +
            +No usage of org.kiji.schema.filter.StripValueRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-frame.html new file mode 100644 index 00000000..aee469e6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-frame.html @@ -0,0 +1,75 @@ + + + + + + + +org.kiji.schema.filter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.schema.filter + + + + +
            +Interfaces  + +
            +KijiColumnFilter.Context
            + + + + + + +
            +Classes  + +
            +AndRowFilter +
            +ColumnValueEqualsRowFilter +
            +HasColumnDataRowFilter +
            +KijiColumnFilter +
            +KijiRowFilter +
            +KijiRowFilter.Context +
            +KijiRowFilterApplicator +
            +OperatorRowFilter +
            +OrRowFilter +
            +RegexQualifierColumnFilter +
            +StripValueRowFilter
            + + + + + + +
            +Enums  + +
            +OperatorRowFilter.Operator
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-summary.html new file mode 100644 index 00000000..b72e9f9d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-summary.html @@ -0,0 +1,253 @@ + + + + + + + +org.kiji.schema.filter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.filter +

            +Row level filters used when reading data from Kiji tables. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            KijiColumnFilter.ContextAn object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AndRowFilterA KijiRowFilter for a conjunction (AND operator) of other filters.
            ColumnValueEqualsRowFilterA KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value.
            HasColumnDataRowFilterA KijiRowFilter that excludes rows that have no data for some column columnName.
            KijiColumnFilterA column filter provides a means of filtering cells from a column on the server side.
            KijiRowFilterThe abstract base class for filters that exclude data from KijiRows.
            KijiRowFilter.ContextA helper class for converting between Kiji objects and their HBase counterparts.
            KijiRowFilterApplicatorApplies a KijiRowFilter to various row-savvy objects.
            OperatorRowFilterA KijiRowFilter for a logical operator of composed of other filters.
            OrRowFilterA KijiRowFilter for a disjunction (OR operator) of other filters.
            RegexQualifierColumnFilterA KijiColumnFilter that only allows qualifiers that match a given regular expression.
            StripValueRowFilterA KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest.
            +  + +

            + + + + + + + + + +
            +Enum Summary
            OperatorRowFilter.OperatorAvailable logical operators.
            +  + +

            +

            +Package org.kiji.schema.filter Description +

            + +

            +Row level filters used when reading data from Kiji tables. + +

            + Provides row level filters which are applied to data read from + KijiTable. Only one filter can be used + at a time, but a single filter can be composed as a + combination of multiple filters using the operator filters: + AndRowFilter and + OrRowFilter. Filters are applied to + KijiDataRequest objects. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-tree.html new file mode 100644 index 00000000..93938e45 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-tree.html @@ -0,0 +1,176 @@ + + + + + + + +org.kiji.schema.filter Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.filter +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-use.html new file mode 100644 index 00000000..9bb5632d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/filter/package-use.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Package org.kiji.schema.filter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.filter

            +
            + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.filter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.filter used by org.kiji.schema
            KijiColumnFilter + +
            +          A column filter provides a means of filtering cells from a column on the server side.
            KijiRowFilter + +
            +          The abstract base class for filters that exclude data from KijiRows.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.filter used by org.kiji.schema.filter
            KijiColumnFilter + +
            +          A column filter provides a means of filtering cells from a column on the server side.
            KijiColumnFilter.Context + +
            +          An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            KijiRowFilter + +
            +          The abstract base class for filters that exclude data from KijiRows.
            KijiRowFilter.Context + +
            +          A helper class for converting between Kiji objects and their HBase counterparts.
            OperatorRowFilter + +
            +          A KijiRowFilter for a logical operator of composed of other filters.
            OperatorRowFilter.Operator + +
            +          Available logical operators.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/AbstractKijiTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/AbstractKijiTable.html new file mode 100644 index 00000000..ddb30516 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/AbstractKijiTable.html @@ -0,0 +1,471 @@ + + + + + + + +AbstractKijiTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class AbstractKijiTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AbstractKijiTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTable
            +
            +
            +
            Direct Known Subclasses:
            HBaseKijiTable
            +
            +
            +
            +
            @ApiAudience.Private
+public abstract class AbstractKijiTable
            extends Object
            implements KijiTable
            + + +

            +Main handle for a Kiji table with basic functionality. + + A KijiTable has all the data about an entity. + Entity data is keyed by the entityId. + Each row in the table represents one entity. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected AbstractKijiTable(Kiji kiji, + String name) + +
            +          Creates a new KijiTable instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + booleanequals(Object obj) + +
            +          
            +protected  voidfinalize() + +
            +          
            + EntityIdgetEntityId(String kijiRowKey) + +
            +          Creates an entity ID for the specified UTF8 encoded Kiji row key.
            + KijigetKiji() + +
            +          
            + StringgetName() + +
            +          
            + KijiURIgetURI() + +
            +          
            + inthashCode() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, getClass, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiTable
            getEntityIdFactory, getLayout, openTableReader, openTableWriter
            +  +

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

            +AbstractKijiTable

            +
            +protected AbstractKijiTable(Kiji kiji,
+                            String name)
+                     throws IOException
            +
            +
            Creates a new KijiTable instance. +

            +

            +
            Parameters:
            kiji - The kiji instance.
            name - The name of the kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getKiji

            +
            +public Kiji getKiji()
            +
            +
            +

            +

            +
            Specified by:
            getKiji in interface KijiTable
            +
            +
            + +
            Returns:
            the Kiji instance this table belongs to.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            Specified by:
            getName in interface KijiTable
            +
            +
            + +
            Returns:
            the name of this table.
            +
            +
            +
            + +

            +getURI

            +
            +public KijiURI getURI()
            +
            +
            +

            +

            +
            Specified by:
            getURI in interface KijiTable
            +
            +
            + +
            Returns:
            the URI for this table, trimmed at the table path component.
            +
            +
            +
            + +

            +getEntityId

            +
            +public EntityId getEntityId(String kijiRowKey)
            +
            +
            Creates an entity ID for the specified UTF8 encoded Kiji row key. +

            +

            +
            Specified by:
            getEntityId in interface KijiTable
            +
            +
            +
            Parameters:
            kijiRowKey - UTF8 encoded Kiji row key. +
            Returns:
            a new entity ID for the specified Kiji row key.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object obj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/AvroCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/AvroCellDecoder.html new file mode 100644 index 00000000..fdd125cc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/AvroCellDecoder.html @@ -0,0 +1,410 @@ + + + + + + + +AvroCellDecoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class AvroCellDecoder<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellDecoder<T>
+
            +
            +
            Type Parameters:
            T - The type of the decoded cell data.
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<T>
            +
            +
            +
            Direct Known Subclasses:
            GenericCellDecoder, SpecificCellDecoder
            +
            +
            +
            +
            @ApiAudience.Private
+public abstract class AvroCellDecoder<T>
            extends Object
            implements KijiCellDecoder<T>
            + + +

            +Base class for decoders that read Kiji cells encoded using Avro. + + Kiji cells are encoded as Extension records, although for efficiency reasons, this class + provides a custom decoder that avoid copying bytes unnecessarily. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected AvroCellDecoder(CellSpec cellSpec) + +
            +          Initializes an abstract KijiAvroCellDecoder.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected abstract  org.apache.avro.io.DatumReader<T>createDatumReader(org.apache.avro.Schema writer, + org.apache.avro.Schema reader) + +
            +          Factory for DatumReader instances.
            +protected  TdecodeAvro(ByteBuffer encodedData, + org.apache.avro.Schema writerSchema, + org.apache.avro.Schema readerSchema, + T reuse) + +
            +          Decodes the data payload given the reader and writer schema.
            + KijiCell<T>decodeCell(byte[] encodedBytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + TdecodeValue(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + ByteBuffergetPayload(byte[] bytes) + +
            +          Gets the portion of the encoded byte array from an HBase table cell that has the avro-encoded + data payload.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroCellDecoder

            +
            +protected AvroCellDecoder(CellSpec cellSpec)
+                   throws IOException
            +
            +
            Initializes an abstract KijiAvroCellDecoder. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createDatumReader

            +
            +protected abstract org.apache.avro.io.DatumReader<T> createDatumReader(org.apache.avro.Schema writer,
+                                                                       org.apache.avro.Schema reader)
            +
            +
            Factory for DatumReader instances. + + Sub-classes must create DatumReader implementations for specific or generic records. +

            +

            +
            +
            +
            +
            Parameters:
            writer - Writer schema.
            reader - Reader schema. +
            Returns:
            a new DatumReader instance for the specified writer/reader schema combination.
            +
            +
            +
            + +

            +decodeCell

            +
            +public KijiCell<T> decodeCell(byte[] encodedBytes)
+                       throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeCell in interface KijiCellDecoder<T>
            +
            +
            +
            Parameters:
            encodedBytes - Binary encoded Kiji cell. +
            Returns:
            the decoded KijiCell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeValue

            +
            +public T decodeValue(byte[] bytes)
+              throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeValue in interface KijiCellDecoder<T>
            +
            +
            +
            Parameters:
            bytes - Binary encoded Kiji cell value. +
            Returns:
            the decoded cell value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getPayload

            +
            +public ByteBuffer getPayload(byte[] bytes)
+                      throws IOException
            +
            +
            Gets the portion of the encoded byte array from an HBase table cell that has the avro-encoded + data payload. +

            +

            +
            +
            +
            +
            Parameters:
            bytes - The bytes from an HBase table cell. +
            Returns:
            the portion of the encoded byte array that contains the binary-encoded avro message. +
            Throws: +
            IOException - on I/O error (eg. decoding error).
            +
            +
            +
            + +

            +decodeAvro

            +
            +protected T decodeAvro(ByteBuffer encodedData,
+                       org.apache.avro.Schema writerSchema,
+                       org.apache.avro.Schema readerSchema,
+                       T reuse)
+                throws IOException
            +
            +
            Decodes the data payload given the reader and writer schema. If reuse is non-null, the + implementation may fill it and return that object. +

            +

            +
            +
            +
            +
            Parameters:
            encodedData - The avro-encoded bytes of the data payload.
            writerSchema - The schema that was used to encode the data.
            readerSchema - The schema that is expected by the reader.
            reuse - An optional object to be filled and returned to save on object construction + (may be null). +
            Returns:
            The decoded avro object. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/AvroCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/AvroCellEncoder.html new file mode 100644 index 00000000..b34310e6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/AvroCellEncoder.html @@ -0,0 +1,315 @@ + + + + + + + +AvroCellEncoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class AvroCellEncoder

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellEncoder
+
            +
            +
            All Implemented Interfaces:
            KijiCellEncoder
            +
            +
            +
            +
            @ApiAudience.Private
+public final class AvroCellEncoder
            extends Object
            implements KijiCellEncoder
            + + +

            +Serializes a KijiCell. + + A Kiji cell is encoded as an Extension record, although this class implements the encoder + in a specific way for efficiency. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            AvroCellEncoder(CellSpec cellSpec) + +
            +          Creates a new KijiCellEncoder instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + + + + + +
            +<T> byte[]
            +            		encode(T cellValue) + +
            +          Encodes the specified value.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroCellEncoder

            +
            +public AvroCellEncoder(CellSpec cellSpec)
+                throws IOException
            +
            +
            Creates a new KijiCellEncoder instance. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell to encode. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +encode

            +
            +public byte[] encode(KijiCell<?> cell)
+              throws IOException
            +
            +
            Encodes the specified Kiji cell. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Parameters:
            cell - Kiji cell to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encode

            +
            +public <T> byte[] encode(T cellValue)
+              throws IOException
            +
            +
            Encodes the specified value. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Type Parameters:
            T - type of the value to encode.
            Parameters:
            cellValue - value to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/CounterCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/CounterCellDecoder.html new file mode 100644 index 00000000..d1cb8ccc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/CounterCellDecoder.html @@ -0,0 +1,288 @@ + + + + + + + +CounterCellDecoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class CounterCellDecoder

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.CounterCellDecoder
+
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<Long>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class CounterCellDecoder
            extends Object
            implements KijiCellDecoder<Long>
            + + +

            +Cell decoder for counters. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCell<Long>decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + LongdecodeValue(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            +static CounterCellDecoderget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static CounterCellDecoder get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the counter cell decoder singleton.
            +
            +
            +
            + +

            +decodeCell

            +
            +public KijiCell<Long> decodeCell(byte[] bytes)
+                          throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeCell in interface KijiCellDecoder<Long>
            +
            +
            +
            Parameters:
            bytes - Binary encoded Kiji cell. +
            Returns:
            the decoded KijiCell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeValue

            +
            +public Long decodeValue(byte[] bytes)
+                 throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeValue in interface KijiCellDecoder<Long>
            +
            +
            +
            Parameters:
            bytes - Binary encoded Kiji cell value. +
            Returns:
            the decoded cell value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/CounterCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/CounterCellEncoder.html new file mode 100644 index 00000000..f582112a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/CounterCellEncoder.html @@ -0,0 +1,295 @@ + + + + + + + +CounterCellEncoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class CounterCellEncoder

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.CounterCellEncoder
+
            +
            +
            All Implemented Interfaces:
            KijiCellEncoder
            +
            +
            +
            +
            @ApiAudience.Private
+public final class CounterCellEncoder
            extends Object
            implements KijiCellEncoder
            + + +

            +Encoder for Kiji counters. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]encode(KijiCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + + + + + +
            +<T> byte[]
            +            		encode(T cellValue) + +
            +          Encodes the specified value.
            +static CounterCellEncoderget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static CounterCellEncoder get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the singleton encoder for counters.
            +
            +
            +
            + +

            +encode

            +
            +public byte[] encode(KijiCell<?> cell)
+              throws IOException
            +
            +
            Encodes the specified Kiji cell. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Parameters:
            cell - Kiji cell to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encode

            +
            +public <T> byte[] encode(T cellValue)
+              throws IOException
            +
            +
            Encodes the specified value. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Type Parameters:
            T - type of the value to encode.
            Parameters:
            cellValue - value to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultHBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultHBaseAdminFactory.html new file mode 100644 index 00000000..c99975bb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultHBaseAdminFactory.html @@ -0,0 +1,260 @@ + + + + + + + +DefaultHBaseAdminFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultHBaseAdminFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultHBaseAdminFactory
+
            +
            +
            All Implemented Interfaces:
            HBaseAdminFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultHBaseAdminFactory
            extends Object
            implements HBaseAdminFactory
            + + +

            +Factory for HBaseAdmin that creates concrete HBaseAdmin instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdmincreate(Configuration conf) + +
            +          Creates a new HBaseAdmin instance.
            +static HBaseAdminFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static HBaseAdminFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            an instance of the default factory.
            +
            +
            +
            + +

            +create

            +
            +public HBaseAdmin create(Configuration conf)
+                  throws IOException
            +
            +
            Creates a new HBaseAdmin instance. +

            +

            +
            Specified by:
            create in interface HBaseAdminFactory
            +
            +
            +
            Parameters:
            conf - Configuration. +
            Returns:
            a new HBaseAdmin. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultHBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultHBaseFactory.html new file mode 100644 index 00000000..2919e300 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultHBaseFactory.html @@ -0,0 +1,368 @@ + + + + + + + +DefaultHBaseFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultHBaseFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultHBaseFactory
+
            +
            +
            All Implemented Interfaces:
            org.kiji.delegation.PriorityProvider, HBaseFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultHBaseFactory
            extends Object
            implements HBaseFactory
            + + +

            +Factory for HBase instances based on URIs. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.schema.HBaseFactory
            HBaseFactory.Provider
            +  + + + + + + + + + + + +
            +Constructor Summary
            DefaultHBaseFactory() + +
            +          Public constructor for use by the service loader.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdminFactorygetHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactorygetHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactorygetLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            + intgetPriority(Map<String,String> runtimeHints) + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DefaultHBaseFactory

            +
            +public DefaultHBaseFactory()
            +
            +
            Public constructor for use by the service loader. Clients should use + HBaseFactory.Provider.get(), which maintains a singleton instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getHTableInterfaceFactory

            +
            +public HTableInterfaceFactory getHTableInterfaceFactory(KijiURI uri)
            +
            +
            Reports a factory for HTableInterface for a given HBase instance. +

            +

            +
            Specified by:
            getHTableInterfaceFactory in interface HBaseFactory
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HTableInterface for the specified HBase instance.
            +
            +
            +
            + +

            +getHBaseAdminFactory

            +
            +public HBaseAdminFactory getHBaseAdminFactory(KijiURI uri)
            +
            +
            Reports a factory for HBaseAdmin for a given HBase instance. +

            +

            +
            Specified by:
            getHBaseAdminFactory in interface HBaseFactory
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HBaseAdmin for the specified HBase instance.
            +
            +
            +
            + +

            +getLockFactory

            +
            +public LockFactory getLockFactory(KijiURI uri,
+                                  Configuration conf)
+                           throws IOException
            +
            +
            Creates a lock factory for a given Kiji instance. +

            +

            +
            Specified by:
            getLockFactory in interface HBaseFactory
            +
            +
            +
            Parameters:
            uri - URI of the Kiji instance to create a lock factory for.
            conf - Hadoop configuration. +
            Returns:
            a factory for locks for the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getPriority

            +
            +public int getPriority(Map<String,String> runtimeHints)
            +
            +
            +

            +

            +
            Specified by:
            getPriority in interface org.kiji.delegation.PriorityProvider
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultHTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultHTableInterfaceFactory.html new file mode 100644 index 00000000..cde9d300 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultHTableInterfaceFactory.html @@ -0,0 +1,262 @@ + + + + + + + +DefaultHTableInterfaceFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultHTableInterfaceFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultHTableInterfaceFactory
+
            +
            +
            All Implemented Interfaces:
            HTableInterfaceFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultHTableInterfaceFactory
            extends Object
            implements HTableInterfaceFactory
            + + +

            +Factory for HTableInterface that creates concrete HTable instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + HTableInterfacecreate(Configuration conf, + String hbaseTableName) + +
            +          Creates a new HTableInterface instance.
            +static HTableInterfaceFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static HTableInterfaceFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the default factory singleton.
            +
            +
            +
            + +

            +create

            +
            +public HTableInterface create(Configuration conf,
+                              String hbaseTableName)
+                       throws IOException
            +
            +
            Creates a new HTableInterface instance. +

            +

            +
            Specified by:
            create in interface HTableInterfaceFactory
            +
            +
            +
            Parameters:
            conf - The configuration for the HBase cluster.
            hbaseTableName - The name of the HBase table to create a connection to. +
            Returns:
            a new HTableInterface for the specified table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultKijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultKijiCellEncoderFactory.html new file mode 100644 index 00000000..cb2bd3c4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultKijiCellEncoderFactory.html @@ -0,0 +1,260 @@ + + + + + + + +DefaultKijiCellEncoderFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultKijiCellEncoderFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultKijiCellEncoderFactory
+
            +
            +
            All Implemented Interfaces:
            KijiCellEncoderFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultKijiCellEncoderFactory
            extends Object
            implements KijiCellEncoderFactory
            + + +

            +Factory for cell encoders. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellEncodercreate(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +static DefaultKijiCellEncoderFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static DefaultKijiCellEncoderFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the default factory for cell encoders.
            +
            +
            +
            + +

            +create

            +
            +public KijiCellEncoder create(CellSpec cellSpec)
+                       throws IOException
            +
            +
            Creates a new Kiji cell encoder. +

            +

            +
            Specified by:
            create in interface KijiCellEncoderFactory
            +
            +
            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell encoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultKijiCounter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultKijiCounter.html new file mode 100644 index 00000000..1222272f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultKijiCounter.html @@ -0,0 +1,299 @@ + + + + + + + +DefaultKijiCounter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultKijiCounter

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultKijiCounter
+
            +
            +
            All Implemented Interfaces:
            KijiCounter
            +
            +
            +
            +
            @ApiAudience.Private
+public class DefaultKijiCounter
            extends Object
            implements KijiCounter
            + + +

            +The default implementation of a Kiji counter, which contains the data in a counter cell + of a column. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DefaultKijiCounter(long timestamp, + long value) + +
            +          Creates a new DefaultKijiCounter instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + longgetTimestamp() + +
            +          Gets the timestamp at which the counter was incremented.
            + longgetValue() + +
            +          Gets the value of the counter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DefaultKijiCounter

            +
            +public DefaultKijiCounter(long timestamp,
+                          long value)
            +
            +
            Creates a new DefaultKijiCounter instance. +

            +

            +
            Parameters:
            timestamp - The timestamp at which the counter was incremented.
            value - The counter value.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getTimestamp

            +
            +public long getTimestamp()
            +
            +
            Gets the timestamp at which the counter was incremented. +

            +

            +
            Specified by:
            getTimestamp in interface KijiCounter
            +
            +
            + +
            Returns:
            A timestamp, in milliseconds since the epoch.
            +
            +
            +
            + +

            +getValue

            +
            +public long getValue()
            +
            +
            Gets the value of the counter. +

            +

            +
            Specified by:
            getValue in interface KijiCounter
            +
            +
            + +
            Returns:
            The value of the counter, which is zero if the counter has never been incremented.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultKijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultKijiTableFactory.html new file mode 100644 index 00000000..278ae0f1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/DefaultKijiTableFactory.html @@ -0,0 +1,276 @@ + + + + + + + +DefaultKijiTableFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultKijiTableFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultKijiTableFactory
+
            +
            +
            All Implemented Interfaces:
            KijiTableFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public class DefaultKijiTableFactory
            extends Object
            implements KijiTableFactory
            + + +

            +The default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open(). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DefaultKijiTableFactory(Kiji kiji) + +
            +          Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + KijiTableopenTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DefaultKijiTableFactory

            +
            +public DefaultKijiTableFactory(Kiji kiji)
            +
            +
            Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance. +

            +

            +
            Parameters:
            kiji - The kiji instance containing the tables to open.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +openTable

            +
            +public KijiTable openTable(String tableName)
+                    throws IOException
            +
            +
            Opens a KijiTable by name. + +

            Clients must take care to close the KijiTable instance when finished.

            +

            +

            +
            Specified by:
            openTable in interface KijiTableFactory
            +
            +
            +
            Parameters:
            tableName - Name of the table to open. +
            Returns:
            the opened Kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/GenericCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/GenericCellDecoder.html new file mode 100644 index 00000000..6d30358e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/GenericCellDecoder.html @@ -0,0 +1,290 @@ + + + + + + + +GenericCellDecoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class GenericCellDecoder<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellDecoder<T>
+      extended by org.kiji.schema.impl.GenericCellDecoder<T>
+
            +
            +
            Type Parameters:
            T - The type of the decoded data.
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<T>
            +
            +
            +
            +
            @ApiAudience.Private
+public class GenericCellDecoder<T>
            extends AvroCellDecoder<T>
            + + +

            +Decodes cells encoded using Avro into generic types. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            GenericCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates generic Avro types.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  org.apache.avro.io.DatumReader<T>createDatumReader(org.apache.avro.Schema writer, + org.apache.avro.Schema reader) + +
            +          Factory for DatumReader instances.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.impl.AvroCellDecoder
            decodeAvro, decodeCell, decodeValue, getPayload
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +GenericCellDecoder

            +
            +public GenericCellDecoder(CellSpec cellSpec)
+                   throws IOException
            +
            +
            Initializes a cell decoder that creates generic Avro types. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createDatumReader

            +
            +protected org.apache.avro.io.DatumReader<T> createDatumReader(org.apache.avro.Schema writer,
+                                                              org.apache.avro.Schema reader)
            +
            +
            Factory for DatumReader instances. + + Sub-classes must create DatumReader implementations for specific or generic records. +

            +

            +
            Specified by:
            createDatumReader in class AvroCellDecoder<T>
            +
            +
            +
            Parameters:
            writer - Writer schema.
            reader - Reader schema. +
            Returns:
            a new DatumReader instance for the specified writer/reader schema combination.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseAdminFactory.html new file mode 100644 index 00000000..4bdb8d60 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseAdminFactory.html @@ -0,0 +1,222 @@ + + + + + + + +HBaseAdminFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Interface HBaseAdminFactory

            +
            +
            All Known Implementing Classes:
            DefaultHBaseAdminFactory
            +
            +
            +
            +
            public interface HBaseAdminFactory
            + + +

            +Factory for HBaseAdmin. + + Note: there is no interface for HBaseAdmin :( +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdmincreate(Configuration conf) + +
            +          Creates a new HBaseAdmin instance.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +HBaseAdmin create(Configuration conf)
+                  throws IOException
            +
            +
            Creates a new HBaseAdmin instance. +

            +

            +
            Parameters:
            conf - Configuration. +
            Returns:
            a new HBaseAdmin. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseDataRequestAdapter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseDataRequestAdapter.html new file mode 100644 index 00000000..3e01b3fa --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseDataRequestAdapter.html @@ -0,0 +1,390 @@ + + + + + + + +HBaseDataRequestAdapter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseDataRequestAdapter

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseDataRequestAdapter
+
            +
            +
            +
            @ApiAudience.Private
+public class HBaseDataRequestAdapter
            extends Object
            + + +

            +Wraps a KijiDataRequest to expose methods that generate meaningful objects in HBase + land, like Puts and Gets. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseDataRequestAdapter(KijiDataRequest kijiDataRequest) + +
            +          Wraps a KijiDataRequest.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidapplyToScan(Scan scan, + KijiTableLayout tableLayout) + +
            +          Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one.
            + GettoGet(EntityId entityId, + KijiTableLayout tableLayout) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + GettoGet(EntityId entityId, + KijiTableLayout tableLayout, + int pageIndex) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + ScantoScan(KijiTableLayout tableLayout) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            + ScantoScan(KijiTableLayout tableLayout, + HBaseScanOptions scanOptions) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseDataRequestAdapter

            +
            +public HBaseDataRequestAdapter(KijiDataRequest kijiDataRequest)
            +
            +
            Wraps a KijiDataRequest. +

            +

            +
            Parameters:
            kijiDataRequest - The Kiji data request to wrap.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toScan

            +
            +public Scan toScan(KijiTableLayout tableLayout)
+            throws IOException
            +
            +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +

            +

            +
            Parameters:
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns. +
            Returns:
            An HBase Scan descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toScan

            +
            +public Scan toScan(KijiTableLayout tableLayout,
+                   HBaseScanOptions scanOptions)
+            throws IOException
            +
            +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +

            +

            +
            Parameters:
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns.
            scanOptions - Custom options for this scan. +
            Returns:
            An HBase Scan descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +applyToScan

            +
            +public void applyToScan(Scan scan,
+                        KijiTableLayout tableLayout)
+                 throws IOException
            +
            +
            Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one. + +

            Any existing request settings in the Scan object will be preserved.

            +

            +

            +
            Parameters:
            scan - The existing scan object to apply the data request to.
            tableLayout - The layout of the Kiji table the scan will read from. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toGet

            +
            +public Get toGet(EntityId entityId,
+                 KijiTableLayout tableLayout)
+          throws IOException
            +
            +
            Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row. +

            +

            +
            Parameters:
            entityId - The row to build an HBase Get request for.
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns. +
            Returns:
            An HBase Get descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toGet

            +
            +public Get toGet(EntityId entityId,
+                 KijiTableLayout tableLayout,
+                 int pageIndex)
+          throws IOException
            +
            +
            Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row. +

            +

            +
            Parameters:
            entityId - The row to build an HBase Get request for.
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns.
            pageIndex - Which page of column data to retrieve (zero means the first page). +
            Returns:
            An HBase Get descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseEntityId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseEntityId.html new file mode 100644 index 00000000..907bb28c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseEntityId.html @@ -0,0 +1,328 @@ + + + + + + + +HBaseEntityId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.HBaseEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public class HBaseEntityId
            extends EntityId
            + + +

            +Entity ID encapsulating an HBase row key. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseEntityId(byte[] hbaseRowKey) + +
            +          Creates an HBaseEntityId from the specified HBase row key.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + RowKeyFormatgetFormat() + +
            +          
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + byte[]getKijiRowKey() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseEntityId

            +
            +public HBaseEntityId(byte[] hbaseRowKey)
            +
            +
            Creates an HBaseEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getFormat

            +
            +public RowKeyFormat getFormat()
            +
            +
            +

            +

            +
            Specified by:
            getFormat in class EntityId
            +
            +
            + +
            Returns:
            the format of this row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public byte[] getKijiRowKey()
            +
            +
            +

            +

            +
            Specified by:
            getKijiRowKey in class EntityId
            +
            +
            + +
            Returns:
            the Kiji row key as a byte array.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKiji.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKiji.html new file mode 100644 index 00000000..9e01dea8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKiji.html @@ -0,0 +1,506 @@ + + + + + + + +HBaseKiji (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKiji

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKiji
+
            +
            +
            All Implemented Interfaces:
            Kiji, KijiTableFactory, ReferenceCountable<Kiji>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class HBaseKiji
            extends Object
            implements Kiji
            + + +

            +Kiji instance class that contains configuration and table + information. Multiple instances of Kiji can be installed onto a + single HBase cluster. This class represents a single one of those + instances. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.schema.Kiji
            Kiji.Factory
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidfinalize() + +
            +          
            + KijiAdmingetAdmin() + +
            +          
            + ConfigurationgetConf() + +
            +          
            + KijiMetaTablegetMetaTable() + +
            +          Gets the meta table for this Kiji instance.
            + KijiSchemaTablegetSchemaTable() + +
            +          Gets the schema table for this Kiji instance.
            + KijiSystemTablegetSystemTable() + +
            +          Gets the system table for this Kiji instance.
            + KijiURIgetURI() + +
            +          
            + KijiTableopenTable(String tableName) + +
            +          Opens a KijiTable by name.
            + voidrelease() + +
            +          Notifies this resource that we are no longer interested in it.
            + Kijiretain() + +
            +          Expresses interest in retaining this resource.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getConf

            +
            +public Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface Kiji
            +
            +
            + +
            Returns:
            The hadoop configuration.
            +
            +
            +
            + +

            +getURI

            +
            +public KijiURI getURI()
            +
            +
            +

            +

            +
            Specified by:
            getURI in interface Kiji
            +
            +
            + +
            Returns:
            The address of this kiji instance, trimmed to the Kiji instance path component.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public KijiSchemaTable getSchemaTable()
+                               throws IOException
            +
            +
            Gets the schema table for this Kiji instance. +

            +

            +
            Specified by:
            getSchemaTable in interface Kiji
            +
            +
            + +
            Returns:
            The kiji schema table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getSystemTable

            +
            +public KijiSystemTable getSystemTable()
+                               throws IOException
            +
            +
            Gets the system table for this Kiji instance. +

            +

            +
            Specified by:
            getSystemTable in interface Kiji
            +
            +
            + +
            Returns:
            The kiji system table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMetaTable

            +
            +public KijiMetaTable getMetaTable()
+                           throws IOException
            +
            +
            Gets the meta table for this Kiji instance. +

            +

            +
            Specified by:
            getMetaTable in interface Kiji
            +
            +
            + +
            Returns:
            The kiji meta table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getAdmin

            +
            +public KijiAdmin getAdmin()
+                   throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getAdmin in interface Kiji
            +
            +
            + +
            Returns:
            the KijiAdmin for this Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +openTable

            +
            +public KijiTable openTable(String tableName)
+                    throws IOException
            +
            +
            Opens a KijiTable by name. + +

            Clients must take care to close the KijiTable instance when finished.

            +

            +

            +
            Specified by:
            openTable in interface KijiTableFactory
            +
            +
            +
            Parameters:
            tableName - Name of the table to open. +
            Returns:
            the opened Kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +retain

            +
            +public Kiji retain()
            +
            +
            Expresses interest in retaining this resource. + + The resource will not be disposed until a call to release() happens +

            +

            +
            Specified by:
            retain in interface ReferenceCountable<Kiji>
            +
            +
            + +
            Returns:
            the retained resource.
            +
            +
            +
            + +

            +release

            +
            +public void release()
+             throws IOException
            +
            +
            Notifies this resource that we are no longer interested in it. + + This resource may be disposed if no other entity has expressed interest in using it. +

            +

            +
            Specified by:
            release in interface ReferenceCountable<Kiji>
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiAdmin.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiAdmin.html new file mode 100644 index 00000000..a1b68dcf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiAdmin.html @@ -0,0 +1,480 @@ + + + + + + + +HBaseKijiAdmin (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiAdmin

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiAdmin
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiAdmin
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseKijiAdmin
            extends Object
            implements KijiAdmin, Closeable
            + + +

            +Administration API for managing a Kiji instance that uses HBase as its underlying data store. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore) + +
            +          Creates a Kiji table in an HBase instance.
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + byte[][] splitKeys) + +
            +          Creates a Kiji table in an HBase instance.
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + int numRegions) + +
            +          Creates a Kiji table in an HBase instance.
            + voiddeleteTable(String tableName) + +
            +          Deletes a Kiji table.
            + HBaseAdmingetHBaseAdmin() + +
            +           
            + List<String>getTableNames() + +
            +          Gets the list of Kiji table names.
            + KijiTableLayoutsetTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutsetTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +createTable

            +
            +public void createTable(String tableName,
+                        KijiTableLayout tableLayout,
+                        boolean isRestore)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Specified by:
            createTable in interface KijiAdmin
            +
            +
            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            isRestore - true if this is part of a metadata restore operation. + This should be set to false by all callers except KijiMetadataTool. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +createTable

            +
            +public void createTable(String tableName,
+                        KijiTableLayout tableLayout,
+                        boolean isRestore,
+                        int numRegions)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Specified by:
            createTable in interface KijiAdmin
            +
            +
            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            isRestore - true if this is part of a metadata restore operation.
            numRegions - The initial number of regions to create. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +createTable

            +
            +public void createTable(String tableName,
+                        KijiTableLayout tableLayout,
+                        boolean isRestore,
+                        byte[][] splitKeys)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Specified by:
            createTable in interface KijiAdmin
            +
            +
            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            isRestore - true if this is part of a metadata restore operation.
            splitKeys - The initial key boundaries between regions. There will be splitKeys + + 1 regions created. Pass null to specify the default single region. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +setTableLayout

            +
            +public KijiTableLayout setTableLayout(String tableName,
+                                      TableLayoutDesc update)
+                               throws IOException
            +
            +
            Sets the layout of a table. +

            +

            +
            Specified by:
            setTableLayout in interface KijiAdmin
            +
            +
            +
            Parameters:
            tableName - The name of the Kiji table to affect.
            update - Layout update. +
            Returns:
            the updated layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +setTableLayout

            +
            +public KijiTableLayout setTableLayout(String tableName,
+                                      TableLayoutDesc update,
+                                      boolean dryRun,
+                                      PrintStream printStream)
+                               throws IOException
            +
            +
            Sets the layout of a table, or print the results of setting the table layout if + dryRun is true. +

            +

            +
            Specified by:
            setTableLayout in interface KijiAdmin
            +
            +
            +
            Parameters:
            tableName - The name of the Kiji table to affect.
            update - Layout update.
            dryRun - true if this is a 'dry run', false if changes should be made.
            printStream - the print stream to use for information if dryRun is true. + If null, stdout will be used. +
            Returns:
            the updated layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +deleteTable

            +
            +public void deleteTable(String tableName)
+                 throws IOException
            +
            +
            Deletes a Kiji table. Removes it from HBase. +

            +

            +
            Specified by:
            deleteTable in interface KijiAdmin
            +
            +
            +
            Parameters:
            tableName - The name of the Kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableNames

            +
            +public List<String> getTableNames()
+                           throws IOException
            +
            +
            Gets the list of Kiji table names. +

            +

            +
            Specified by:
            getTableNames in interface KijiAdmin
            +
            +
            + +
            Returns:
            A list of the names of Kiji tables installed in the Kiji instance. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getHBaseAdmin

            +
            +public HBaseAdmin getHBaseAdmin()
            +
            +
            +
            +
            +
            + +
            Returns:
            the underlying HBaseAdmin.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiFactory.html new file mode 100644 index 00000000..b542626b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiFactory.html @@ -0,0 +1,353 @@ + + + + + + + +HBaseKijiFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiFactory
+
            +
            +
            All Implemented Interfaces:
            org.kiji.delegation.PriorityProvider, KijiFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseKijiFactory
            extends Object
            implements KijiFactory
            + + +

            +Factory for constructing instances of HBaseKiji. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiFactory() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + intgetPriority(Map<String,String> runtimeHints) + +
            +          
            + Kijiopen(KijiConfiguration kijiConf) + +
            +          Opens a Kiji instance.
            + Kijiopen(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + Kijiopen(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiFactory

            +
            +public HBaseKijiFactory()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +open

            +
            +public Kiji open(KijiURI uri)
+          throws IOException
            +
            +
            Opens a Kiji instance by URI. +

            +

            +
            Specified by:
            open in interface KijiFactory
            +
            +
            +
            Parameters:
            uri - URI specifying the Kiji instance to open. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +open

            +
            +public Kiji open(KijiURI uri,
+                 Configuration conf)
+          throws IOException
            +
            +
            Opens a Kiji instance by URI. +

            +

            +
            Specified by:
            open in interface KijiFactory
            +
            +
            +
            Parameters:
            uri - URI specifying the Kiji instance to open.
            conf - Hadoop configuration. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +open

            +
            +public Kiji open(KijiConfiguration kijiConf)
+          throws IOException
            +
            +
            Opens a Kiji instance. This method of opening a Kiji instance has been deprecated + in favor of a method that doesn't use KijiConfiguration. +

            +

            +
            Specified by:
            open in interface KijiFactory
            +
            +
            +
            Parameters:
            kijiConf - The configuration. +
            Returns:
            An opened kiji instance. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getPriority

            +
            +public int getPriority(Map<String,String> runtimeHints)
            +
            +
            +

            +

            +
            Specified by:
            getPriority in interface org.kiji.delegation.PriorityProvider
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiRowData.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiRowData.html new file mode 100644 index 00000000..143efb39 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiRowData.html @@ -0,0 +1,1206 @@ + + + + + + + +HBaseKijiRowData (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiRowData

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiRowData
+
            +
            +
            All Implemented Interfaces:
            KijiRowData
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseKijiRowData
            extends Object
            implements KijiRowData
            + + +

            +An implementation of KijiRowData that wraps an HBase Result object. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleancontainsColumn(String family) + +
            +          Determines whether a particular column family has any data in this row.
            + booleancontainsColumn(String family, + String qualifier) + +
            +          Determines whether a particular column has data in this row.
            + + + + + +
            +<T> KijiCell<T>
            +            		getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		getCells(String family) + +
            +          Gets all the timestamp-cell pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		getCells(String family, + String qualifier) + +
            +          Gets all the timestamp-cell pairs stored within the specified cell.
            + KijiCountergetCounter(String family, + String qualifier) + +
            +          Deprecated. 
            + KijiCountergetCounter(String family, + String qualifier, + long timestamp) + +
            +          Deprecated. 
            + EntityIdgetEntityId() + +
            +          Gets the entity id for this row of kiji data.
            + ResultgetHBaseResult() + +
            +          Gets the HBase result backing this KijiRowData.
            + NavigableMap<String,NavigableMap<String,NavigableMap<Long,byte[]>>>getMap() + +
            +          Gets a map from kiji family to qualifier to timestamp to raw kiji-encoded bytes of a cell.
            + + + + + +
            +<T> KijiCell<T>
            +            		getMostRecentCell(String family, + String qualifier) + +
            +          Gets the latest version of the specified cell.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		getMostRecentCells(String family) + +
            +          Gets the latest version of the specified cell.
            + + + + + +
            +<T> T
            +            		getMostRecentValue(String family, + String qualifier) + +
            +          Gets the value with the latest timestamp stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,T>
            +            		getMostRecentValues(String family) + +
            +          Gets the value with the latest timestamp stored within the specified cell.
            + NavigableSet<String>getQualifiers(String family) + +
            +          Gets the set of column qualifiers that exist in a family.
            + org.apache.avro.SchemagetReaderSchema(String family, + String qualifier) + +
            +          Gets the reader schema for a column as declared in the layout of the table this row + comes from.
            + KijiSchemaTablegetSchemaTable() + +
            +          Gets the schema table this kiji row data uses for decoding.
            + KijiTableLayoutgetTableLayout() + +
            +          Gets the layout of the table this row data belongs to.
            + NavigableSet<Long>getTimestamps(String family, + String qualifier) + +
            +          Gets the set of timestamps on cells that exist in a column.
            + + + + + +
            +<T> T
            +            		getValue(String family, + String qualifier, + long timestamp) + +
            +          Gets the value stored within the specified cell.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,T>>
            +            		getValues(String family) + +
            +          Gets all the timestamp-value pairs stored within the specified family.
            + + + + + +
            +<T> NavigableMap<Long,T>
            +            		getValues(String family, + String qualifier) + +
            +          Gets all the timestamp-value pairs stored within the specified cell.
            + voidmerge(Collection<KeyValue> keyValues) + +
            +          Merges in the data from a collection of KeyValues.
            + voidmerge(HBaseKijiRowData kijiRowData) + +
            +          Merges in the data from another HBaseKijiRowData instance.
            + voidmerge(Put put) + +
            +          Merges in the data an HBase Put object.
            + booleannextPage(String family) + +
            +          Populates the next page of cells for a requested column family.
            + booleannextPage(String family, + String qualifier) + +
            +          Populates the next page of cells for a column.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiRowData

            +
            +@Deprecated
+public HBaseKijiRowData(EntityId entityId,
+                                   KijiDataRequest request,
+                                   KijiCellDecoderFactory decoderFactory,
+                                   KijiTableLayout layout,
+                                   Result result,
+                                   KijiSchemaTable schemaTable)
            +
            +
            Deprecated.  +

            +

            Initializes a row data. +

            +

            +
            Parameters:
            entityId - Entity ID of the row.
            request - Data request to build the row.
            decoderFactory - Factory for cell decoders.
            layout - Layout of the table the row belongs to.
            result - HTable result with the encoded row content.
            schemaTable - Schema table.
            +
            +
            + +

            +HBaseKijiRowData

            +
            +@Deprecated
+public HBaseKijiRowData(KijiDataRequest request,
+                                   KijiCellDecoderFactory decoderFactory,
+                                   KijiTableLayout layout,
+                                   Result result,
+                                   KijiSchemaTable schemaTable)
            +
            +
            Deprecated.  +

            +

            Initializes a row data. + + The entity ID is constructed from the HTable encoded result. + This may fail if the table uses hashed row keys. +

            +

            +
            Parameters:
            request - Data request to build the row.
            decoderFactory - Factory for cell decoders.
            layout - Layout of the table the row belongs to.
            result - HTable result with the encoded row content.
            schemaTable - Schema table.
            +
            +
            + +

            +HBaseKijiRowData

            +
            +public HBaseKijiRowData(EntityId entityId,
+                        KijiDataRequest request,
+                        HBaseKijiTable table,
+                        Result result)
            +
            +
            Initializes a row data. +

            +

            +
            Parameters:
            entityId - The entityId of the row.
            request - The requested data.
            table - The Kiji table that this row belongs to.
            result - The HBase result containing the row data.
            +
            +
            + +

            +HBaseKijiRowData

            +
            +public HBaseKijiRowData(KijiDataRequest request,
+                        HBaseKijiTable table,
+                        Result result)
+                 throws IOException
            +
            +
            Initializes a row data. + + The entity ID is constructed from the HTable encoded result. + This may fail if the table uses hashed row keys. +

            +

            +
            Parameters:
            request - The requested data.
            table - The Kiji table that this row belongs to.
            result - The HBase result containing the row data. +
            Throws: +
            IOException - If there is an error reading the entityId from the hbase result.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseResult

            +
            +public Result getHBaseResult()
            +
            +
            Gets the HBase result backing this KijiRowData. +

            +

            +
            +
            +
            + +
            Returns:
            The HBase result.
            +
            +
            +
            + +

            +getEntityId

            +
            +public EntityId getEntityId()
            +
            +
            Gets the entity id for this row of kiji data. +

            +

            +
            Specified by:
            getEntityId in interface KijiRowData
            +
            +
            + +
            Returns:
            The row key.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout()
            +
            +
            Gets the layout of the table this row data belongs to. +

            +

            +
            +
            +
            + +
            Returns:
            The table layout.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public KijiSchemaTable getSchemaTable()
            +
            +
            Gets the schema table this kiji row data uses for decoding. +

            +

            +
            +
            +
            + +
            Returns:
            The schema table.
            +
            +
            +
            + +

            +merge

            +
            +public void merge(HBaseKijiRowData kijiRowData)
            +
            +
            Merges in the data from another HBaseKijiRowData instance. +

            +

            +
            +
            +
            +
            Parameters:
            kijiRowData - The data to merge in.
            +
            +
            +
            + +

            +merge

            +
            +public void merge(Put put)
            +
            +
            Merges in the data an HBase Put object. +

            +

            +
            +
            +
            +
            Parameters:
            put - The data to merge in.
            +
            +
            +
            + +

            +merge

            +
            +public void merge(Collection<KeyValue> keyValues)
            +
            +
            Merges in the data from a collection of KeyValues. +

            +

            +
            +
            +
            +
            Parameters:
            keyValues - The data to merge in.
            +
            +
            +
            + +

            +getMap

            +
            +public NavigableMap<String,NavigableMap<String,NavigableMap<Long,byte[]>>> getMap()
            +
            +
            Gets a map from kiji family to qualifier to timestamp to raw kiji-encoded bytes of a cell. +

            +

            +
            +
            +
            + +
            Returns:
            The map.
            +
            +
            +
            + +

            +containsColumn

            +
            +public boolean containsColumn(String family,
+                              String qualifier)
            +
            +
            Determines whether a particular column has data in this row. +

            +

            +
            Specified by:
            containsColumn in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family.
            qualifier - A column qualifier. +
            Returns:
            Whether the column has data in this row.
            +
            +
            +
            + +

            +containsColumn

            +
            +public boolean containsColumn(String family)
            +
            +
            Determines whether a particular column family has any data in this row. +

            +

            +
            Specified by:
            containsColumn in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family. +
            Returns:
            Whether the family has data in this row.
            +
            +
            +
            + +

            +getQualifiers

            +
            +public NavigableSet<String> getQualifiers(String family)
            +
            +
            Gets the set of column qualifiers that exist in a family. +

            +

            +
            Specified by:
            getQualifiers in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family name. +
            Returns:
            The set of column qualifiers that exist in family.
            +
            +
            +
            + +

            +getTimestamps

            +
            +public NavigableSet<Long> getTimestamps(String family,
+                                        String qualifier)
            +
            +
            Gets the set of timestamps on cells that exist in a column. + +

            If iterating over the set, you will get items in order of decreasing timestamp.

            +

            +

            +
            Specified by:
            getTimestamps in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The set of all timestamps of cells in the family:qualifier column.
            +
            +
            +
            + +

            +getReaderSchema

            +
            +public org.apache.avro.Schema getReaderSchema(String family,
+                                              String qualifier)
+                                       throws IOException
            +
            +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +

            +

            +
            Specified by:
            getReaderSchema in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The Avro reader schema for the column. +
            Throws: +
            IOException - If there is an error or the column does not exist.
            +
            +
            +
            + +

            +nextPage

            +
            +public boolean nextPage(String family,
+                        String qualifier)
+                 throws IOException
            +
            +
            Populates the next page of cells for a column. + +

            If there are cells remaining, this KijiRowData object is populated with the next + page of cells for the requested column and the method returns true. Otherwise, data + from the column's previous page is removed, and this method returns false. This + method throws an IOException if the column does not have paging enabled in the + KijiDataRequest.

            +

            +

            +
            Specified by:
            nextPage in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family.
            qualifier - A column qualifier. +
            Returns:
            Whether a new page of cells has been fetched. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +nextPage

            +
            +public boolean nextPage(String family)
+                 throws IOException
            +
            +
            Populates the next page of cells for a requested column family. + +

            If there are cells remaining, this KijiRowData object is populated with the next + page of cells for the requested family and the method returns true. Otherwise, data + from the family's previous page is removed, and this method returns false. This + method throws an IOException if the column does not have paging enabled in the + KijiDataRequest.

            + +

            An IOException is thrown if this method is called on a family that was not + requested explicitly in the KijiDataRequest. For example, consider the following: + + 

            +   new KijiDataRequest()
+       .addColumn(new KijiDataRequest.Column("foo").withPageSize(10))
+       .addColumn(new KijiDataRequest.Column("bar", "baz").withPageSize(10));
+
            + + It would be valid to call nextPage("foo"), but calling nextPage("bar") would throw an + IOException, since paging was not enabled on the entire "bar" family.

            +

            +

            +
            Specified by:
            nextPage in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family. +
            Returns:
            Whether a new page of cells has been fetched. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValue

            +
            +public <T> T getValue(String family,
+                      String qualifier,
+                      long timestamp)
+           throws IOException
            +
            +
            Gets the value stored within the specified cell. +

            +

            +
            Specified by:
            getValue in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. Use #containsColumn() to distinguish between this scenarios. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCell

            +
            +public <T> KijiCell<T> getCell(String family,
+                               String qualifier,
+                               long timestamp)
+                    throws IOException
            +
            +
            Gets the specified cell. +

            +

            +
            Specified by:
            getCell in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            the specified cell, or null if the cell does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValue

            +
            +public <T> T getMostRecentValue(String family,
+                                String qualifier)
+                     throws IOException
            +
            +
            Gets the value with the latest timestamp stored within the specified cell. +

            +

            +
            Specified by:
            getMostRecentValue in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValues

            +
            +public <T> NavigableMap<String,T> getMostRecentValues(String family)
+                                           throws IOException
            +
            +
            Gets the value with the latest timestamp stored within the specified cell. +

            +

            +
            Specified by:
            getMostRecentValues in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            the value of the specified cell, or null if the cell does not exist. + Note: this method does not distinguish between Avro encoded nulls and non-existant + cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public <T> NavigableMap<Long,T> getValues(String family,
+                                          String qualifier)
+                               throws IOException
            +
            +
            Gets all the timestamp-value pairs stored within the specified cell. +

            +

            +
            Specified by:
            getValues in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            A sorted map containing the values stored in the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public <T> NavigableMap<String,NavigableMap<Long,T>> getValues(String family)
+                                                    throws IOException
            +
            +
            Gets all the timestamp-value pairs stored within the specified family. +

            +

            +
            Specified by:
            getValues in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            A sorted map containing the values stored in the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCell

            +
            +public <T> KijiCell<T> getMostRecentCell(String family,
+                                         String qualifier)
+                              throws IOException
            +
            +
            Gets the latest version of the specified cell. +

            +

            +
            Specified by:
            getMostRecentCell in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            the most recent version of the specified cell, or null if the cell does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCells

            +
            +public <T> NavigableMap<String,KijiCell<T>> getMostRecentCells(String family)
+                                                    throws IOException
            +
            +
            Gets the latest version of the specified cell. +

            +

            +
            Specified by:
            getMostRecentCells in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            a map from qualifier to the most recent versions of the cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +public <T> NavigableMap<Long,KijiCell<T>> getCells(String family,
+                                                   String qualifier)
+                                        throws IOException
            +
            +
            Gets all the timestamp-cell pairs stored within the specified cell. +

            +

            +
            Specified by:
            getCells in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            A sorted map versions of the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +public <T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>> getCells(String family)
+                                                             throws IOException
            +
            +
            Gets all the timestamp-cell pairs stored within the specified family. +

            +

            +
            Specified by:
            getCells in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - The type of the values stored at the specified coordinates.
            Parameters:
            family - A column family name. +
            Returns:
            A sorted map versions of the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCounter

            +
            +@Deprecated
+public KijiCounter getCounter(String family,
+                                         String qualifier)
+                       throws IOException
            +
            +
            Deprecated.  +

            +

            Gets the most recent counter from a column. + +

            Only columns that have been declared with <schema type="counter"/> may be + read using this method, otherwise an exception is thrown.

            +

            +

            +
            Specified by:
            getCounter in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name. +
            Returns:
            The most recent counter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCounter

            +
            +@Deprecated
+public KijiCounter getCounter(String family,
+                                         String qualifier,
+                                         long timestamp)
+                       throws IOException
            +
            +
            Deprecated.  +

            +

            Reads a counter as it was at a particular timestamp. + +

            Only columns that have been declared with <schema type="counter"/> may be + read using this method, otherwise an exception is thrown.

            +

            +

            +
            Specified by:
            getCounter in interface KijiRowData
            +
            +
            +
            Parameters:
            family - A column family name.
            qualifier - A column qualifier name.
            timestamp - The timestamp of the cell. +
            Returns:
            The counter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html new file mode 100644 index 00000000..53c06a72 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html @@ -0,0 +1,417 @@ + + + + + + + +HBaseKijiRowScanner.Options (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiRowScanner.Options

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiRowScanner.Options
+
            +
            +
            Enclosing class:
            HBaseKijiRowScanner
            +
            +
            +
            +
            public static class HBaseKijiRowScanner.Options
            extends Object
            + + +

            +A class to encapsulate the various options the HBaseKijiRowScanner constructor requires. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiRowScanner.Options() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellDecoderFactorygetCellDecoderFactory() + +
            +          Gets the cell decoder factory.
            + KijiDataRequestgetDataRequest() + +
            +          Gets the data request.
            + ResultScannergetHBaseResultScanner() + +
            +          Gets the HBase result scanner.
            + HBaseKijiTablegetTable() + +
            +          Gets the table being scanned.
            + HBaseKijiRowScanner.OptionswithCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory) + +
            +          Sets the cell decoder factory to use when reading cells from the scanner.
            + HBaseKijiRowScanner.OptionswithDataRequest(KijiDataRequest dataRequest) + +
            +          Sets the data request used to generate the KijiRowScanner.
            + HBaseKijiRowScanner.OptionswithHBaseResultScanner(ResultScanner hbaseResultScanner) + +
            +          Sets the HBase result scanner the KijiRowScanner will wrap.
            + HBaseKijiRowScanner.OptionswithTable(HBaseKijiTable table) + +
            +          Sets the table being scanned.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiRowScanner.Options

            +
            +public HBaseKijiRowScanner.Options()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +withHBaseResultScanner

            +
            +public HBaseKijiRowScanner.Options withHBaseResultScanner(ResultScanner hbaseResultScanner)
            +
            +
            Sets the HBase result scanner the KijiRowScanner will wrap. +

            +

            +
            Parameters:
            hbaseResultScanner - An HBase result scanner. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +withDataRequest

            +
            +public HBaseKijiRowScanner.Options withDataRequest(KijiDataRequest dataRequest)
            +
            +
            Sets the data request used to generate the KijiRowScanner. +

            +

            +
            Parameters:
            dataRequest - A data request. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +withTable

            +
            +public HBaseKijiRowScanner.Options withTable(HBaseKijiTable table)
            +
            +
            Sets the table being scanned. +

            +

            +
            Parameters:
            table - The table being scanned. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +withCellDecoderFactory

            +
            +public HBaseKijiRowScanner.Options withCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory)
            +
            +
            Sets the cell decoder factory to use when reading cells from the scanner. +

            +

            +
            Parameters:
            cellDecoderFactory - A cell decoder factory. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +getHBaseResultScanner

            +
            +public ResultScanner getHBaseResultScanner()
            +
            +
            Gets the HBase result scanner. +

            +

            + +
            Returns:
            The HBase result scanner.
            +
            +
            +
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Gets the data request. +

            +

            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +getTable

            +
            +public HBaseKijiTable getTable()
            +
            +
            Gets the table being scanned. +

            +

            + +
            Returns:
            The Kiji table.
            +
            +
            +
            + +

            +getCellDecoderFactory

            +
            +public KijiCellDecoderFactory getCellDecoderFactory()
            +
            +
            Gets the cell decoder factory. +

            +

            + +
            Returns:
            The cell decoder factory.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiRowScanner.html new file mode 100644 index 00000000..32dafdce --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiRowScanner.html @@ -0,0 +1,341 @@ + + + + + + + +HBaseKijiRowScanner (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiRowScanner

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiRowScanner
+
            +
            +
            All Implemented Interfaces:
            Closeable, Iterable<KijiRowData>, KijiRowScanner
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseKijiRowScanner
            extends Object
            implements KijiRowScanner
            + + +

            +The internal implementation of KijiRowScanner that reads from HTables. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classHBaseKijiRowScanner.Options + +
            +          A class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            +  + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiRowScanner(HBaseKijiRowScanner.Options options) + +
            +          Creates a new KijiRowScanner instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Closes this scanner and releases any system resources associated with it.
            +protected  voidfinalize() + +
            +          
            + org.kiji.schema.impl.HBaseKijiRowScanner.KijiRowIteratoriterator() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiRowScanner

            +
            +public HBaseKijiRowScanner(HBaseKijiRowScanner.Options options)
            +
            +
            Creates a new KijiRowScanner instance. +

            +

            +
            Parameters:
            options - The options for this scanner.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +iterator

            +
            +public org.kiji.schema.impl.HBaseKijiRowScanner.KijiRowIterator iterator()
            +
            +
            +

            +

            +
            Specified by:
            iterator in interface Iterable<KijiRowData>
            +
            +
            +
            +
            +
            +
            + +

            +close

            +
            +public void close()
            +
            +
            Closes this scanner and releases any system resources associated with it. + +

            Calling this method when you are finished with the scanner is important. + See http://hbase.apache.org/book.html#perf.hbase.client.scannerclose for details.

            +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in interface KijiRowScanner
            +
            +
            +
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiTable.html new file mode 100644 index 00000000..a2b57573 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiTable.html @@ -0,0 +1,388 @@ + + + + + + + +HBaseKijiTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AbstractKijiTable
+      extended by org.kiji.schema.impl.HBaseKijiTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseKijiTable
            extends AbstractKijiTable
            + + +

            +

            A KijiTable that exposes the underlying HBase implementation.

            + +

            Within the internal Kiji code, we use this class so that we have + access to the HTable interface. Methods that Kiji clients should + have access to should be added to org.kiji.schema.KijiTable.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +static HBaseKijiTabledowncast(KijiTable kijiTable) + +
            +          We know that all KijiTables are really HBaseKijiTables + instances.
            + EntityIdFactorygetEntityIdFactory() + +
            +          
            + HTableInterfacegetHTable() + +
            +           
            + KijiTableLayoutgetLayout() + +
            +          
            + KijiTableReaderopenTableReader() + +
            +          Opens an appropriate implementation of KijiTableReader for this table.
            + KijiTableWriteropenTableWriter() + +
            +          Opens an appropriate implementation of KijiTableWriter for this table.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.impl.AbstractKijiTable
            equals, finalize, getEntityId, getKiji, getName, getURI, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +downcast

            +
            +public static HBaseKijiTable downcast(KijiTable kijiTable)
            +
            +
            We know that all KijiTables are really HBaseKijiTables + instances. This is a convenience method for downcasting, which + is common within the internals of Kiji code. +

            +

            +
            Parameters:
            kijiTable - The Kiji table to downcast to an HBaseKijiTable. +
            Returns:
            The given Kiji table as an HBaseKijiTable.
            +
            +
            +
            + +

            +getHTable

            +
            +public HTableInterface getHTable()
            +
            +
            + +
            Returns:
            The underlying HTable instance.
            +
            +
            +
            + +

            +getLayout

            +
            +public KijiTableLayout getLayout()
            +
            +
            +

            +

            + +
            Returns:
            the layout of this table.
            +
            +
            +
            + +

            +getEntityIdFactory

            +
            +public EntityIdFactory getEntityIdFactory()
            +
            +
            +

            +

            + +
            Returns:
            the entity ID factory for this table.
            +
            +
            +
            + +

            +openTableReader

            +
            +public KijiTableReader openTableReader()
            +
            +
            Opens an appropriate implementation of KijiTableReader for this table. The caller is + responsible for closing this reader. +

            +

            + +
            Returns:
            A KijiTableReader for this table.
            +
            +
            +
            + +

            +openTableWriter

            +
            +public KijiTableWriter openTableWriter()
+                                throws IOException
            +
            +
            Opens an appropriate implementation of KijiTableWriter for this table. The caller is + responsible for closing this writer. +

            +

            + +
            Returns:
            A KijiTableWriter for this table. +
            Throws: +
            IOException - If there was an error opening the writer.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Overrides:
            close in class AbstractKijiTable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiTableReader.html new file mode 100644 index 00000000..8530077b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiTableReader.html @@ -0,0 +1,413 @@ + + + + + + + +HBaseKijiTableReader (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiTableReader

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiTableReader
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTableReader
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseKijiTableReader
            extends Object
            implements KijiTableReader
            + + +

            +Reads from a kiji table by sending the requests directly to the HBase tables. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.schema.KijiTableReader
            KijiTableReader.KijiScannerOptions
            +  + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiTableReader(HBaseKijiTable table) + +
            +          Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + List<KijiRowData>bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + voidclose() + +
            +          
            + KijiRowDataget(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions kijiScannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiTableReader

            +
            +public HBaseKijiTableReader(HBaseKijiTable table)
            +
            +
            Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase. +

            +

            +
            Parameters:
            table - The kiji table to read from.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public KijiRowData get(EntityId entityId,
+                       KijiDataRequest dataRequest)
+                throws IOException
            +
            +
            Retrieves data from a single row in the kiji table. +

            +

            +
            Specified by:
            get in interface KijiTableReader
            +
            +
            +
            Parameters:
            entityId - The entity id for the row to get data from.
            dataRequest - Specifies the columns of data to retrieve. +
            Returns:
            The requested data. If there is no row for the specified entityId, this + will return an empty KijiRowData. (containsColumn() will return false for all + columns.) +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +bulkGet

            +
            +public List<KijiRowData> bulkGet(List<EntityId> entityIds,
+                                 KijiDataRequest dataRequest)
+                          throws IOException
            +
            +
            Retrieves data from a list of rows in the kiji table. +

            +

            +
            Specified by:
            bulkGet in interface KijiTableReader
            +
            +
            +
            Parameters:
            entityIds - The list of entity ids to collect data for.
            dataRequest - Specifies constraints on the data to retrieve for each entity id. +
            Returns:
            The requested data. If an EntityId specified in entityIds + does not exist, then the corresponding KijiRowData will be empty. + If a get fails, then the corresponding KijiRowData will be null (instead of empty). +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +getScanner

            +
            +public KijiRowScanner getScanner(KijiDataRequest dataRequest)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner with the specified data request. +

            +

            +
            Specified by:
            getScanner in interface KijiTableReader
            +
            +
            +
            Parameters:
            dataRequest - The data request to scan for. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +getScanner

            +
            +public KijiRowScanner getScanner(KijiDataRequest dataRequest,
+                                 KijiTableReader.KijiScannerOptions kijiScannerOptions)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner using the specified data request and options. +

            +

            +
            Specified by:
            getScanner in interface KijiTableReader
            +
            +
            +
            Parameters:
            dataRequest - The data request to scan for.
            kijiScannerOptions - Other options for the scanner. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiTableWriter.html new file mode 100644 index 00000000..79545f80 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseKijiTableWriter.html @@ -0,0 +1,662 @@ + + + + + + + +HBaseKijiTableWriter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiTableWriter

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiTableWriter
+
            +
            +
            All Implemented Interfaces:
            Closeable, Flushable, KijiDeleter, KijiIncrementer, KijiPutter, KijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseKijiTableWriter
            extends Object
            implements KijiTableWriter
            + + +

            +Makes modifications to a Kiji table by sending requests directly to HBase from the local client. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiTableWriter(HBaseKijiTable table) + +
            +          Creates a non-buffered kiji table writer that sends modifications directly to Kiji.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +           
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voiddeleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voiddeleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voiddeleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voiddeleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            + voidflush() + +
            +           
            + KijiCounterincrement(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiTableWriter

            +
            +public HBaseKijiTableWriter(HBaseKijiTable table)
+                     throws IOException
            +
            +
            Creates a non-buffered kiji table writer that sends modifications directly to Kiji. +

            +

            +
            Parameters:
            table - A kiji table. +
            Throws: +
            IOException - If there is an error creating the writer.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +put

            +
            +public <T> void put(EntityId entityId,
+                    String family,
+                    String qualifier,
+                    T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            Specified by:
            put in interface KijiPutter
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(EntityId entityId,
+                    String family,
+                    String qualifier,
+                    long timestamp,
+                    T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            Specified by:
            put in interface KijiPutter
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            timestamp - Timestamp, in millisecond since the Epoch.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +increment

            +
            +public KijiCounter increment(EntityId entityId,
+                             String family,
+                             String qualifier,
+                             long amount)
+                      throws IOException
            +
            +
            Atomically increments a counter in a kiji table. + +

            Throws an exception if the specified column is not a counter.

            +

            +

            +
            Specified by:
            increment in interface KijiIncrementer
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row containing the counter.
            family - Column family.
            qualifier - Column qualifier.
            amount - Amount to increment the counter (may be negative). +
            Returns:
            the new counter value, post increment. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteRow

            +
            +public void deleteRow(EntityId entityId)
+               throws IOException
            +
            +
            Deletes an entire row. +

            +

            +
            Specified by:
            deleteRow in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteRow

            +
            +public void deleteRow(EntityId entityId,
+                      long upToTimestamp)
+               throws IOException
            +
            +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +

            +

            +
            Specified by:
            deleteRow in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +public void deleteFamily(EntityId entityId,
+                         String family)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a family. +

            +

            +
            Specified by:
            deleteFamily in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +public void deleteFamily(EntityId entityId,
+                         String family,
+                         long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +

            +

            +
            Specified by:
            deleteFamily in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +public void deleteColumn(EntityId entityId,
+                         String family,
+                         String qualifier)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a column. +

            +

            +
            Specified by:
            deleteColumn in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +public void deleteColumn(EntityId entityId,
+                         String family,
+                         String qualifier,
+                         long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +

            +

            +
            Specified by:
            deleteColumn in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +public void deleteCell(EntityId entityId,
+                       String family,
+                       String qualifier)
+                throws IOException
            +
            +
            Deletes the most recent version of the cell in a column. +

            +

            +
            Specified by:
            deleteCell in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +public void deleteCell(EntityId entityId,
+                       String family,
+                       String qualifier,
+                       long timestamp)
+                throws IOException
            +
            +
            Deletes a single cell with a specified timestamp. +

            +

            +
            Specified by:
            deleteCell in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            timestamp - The timestamp of the cell to delete (use HConstants.LATEST_TIMESTAMP + to delete the most recent cell in the column). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            +
            Specified by:
            flush in interface Flushable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseMetaTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseMetaTable.html new file mode 100644 index 00000000..b9dc33f2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseMetaTable.html @@ -0,0 +1,1016 @@ + + + + + + + +HBaseMetaTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseMetaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiMetaTable
+      extended by org.kiji.schema.impl.HBaseMetaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTableKeyValueDatabase, KijiTableLayoutDatabase
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseMetaTable
            extends KijiMetaTable
            + + +

            +An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseMetaTable(HTableInterface htable, + KijiSchemaTable schemaTable) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseMetaTable(HTableInterface htable, + KijiTableLayoutDatabase tableLayoutDatabase, + KijiTableKeyValueDatabase tableKeyValueDatabase) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseMetaTable(KijiConfiguration kijiConf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + voiddeleteTable(String table) + +
            +          Remove all metadata, including layouts, for a particular table.
            + voidfromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            + KijiTableLayoutgetTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + List<KijiTableLayout>getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            + NavigableMap<Long,byte[]>getTimedValues(String table, + String key, + int numVersions) + +
            +          Returns a map of values associated with the specified table and key.
            + byte[]getValue(String table, + String key) + +
            +          Returns the most recent value associated with the specified table and key.
            + List<byte[]>getValues(String table, + String key, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key.
            +static voidinstall(HBaseAdmin admin, + KijiURI uri) + +
            +          Install the meta table into a Kiji instance.
            + Set<String>keySet(String table) + +
            +          Returns a set view of keys contained in the map for the specified table.
            + voidkeyValuesFromBackup(String table, + List<KeyValueBackupEntry> tableBackup) + +
            +          Restores all table's key value history from a backup.
            + List<KeyValueBackupEntry>keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + voidlayoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +          Restores a table layout history from a backup.
            + List<TableLayoutBackupEntry>layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            + List<String>listTables() + +
            +          Lists the tables in this Kiji instance.
            +static HTableInterfacenewMetaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates an HTableInterface for the specified table.
            + KijiTableKeyValueDatabaseputValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + voidremoveAllTableLayoutVersions(String table) + +
            +          Removes all layout information for a particular table.
            + voidremoveAllValues(String table) + +
            +          Deletes all key-value pairs associated with the specified table.
            + voidremoveRecentTableLayoutVersions(String table, + int numVersions) + +
            +          Removes the most recent layout information for a given table.
            + voidremoveValues(String table, + String key) + +
            +          Removes all values associated with the specified table and key.
            + Set<String>tableSet() + +
            +          Returns a set view of the tables that have key-value pairs defined.
            + Map<String,TableBackup>toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +static voiduninstall(HBaseAdmin admin, + KijiURI uri) + +
            +          Removes the meta table from HBase.
            + KijiTableLayoutupdateTableLayout(String table, + TableLayoutDesc layoutUpdate) + +
            +          Sets a table's layout.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.KijiMetaTable
            finalize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseMetaTable

            +
            +public HBaseMetaTable(KijiConfiguration kijiConf,
+                      KijiSchemaTable schemaTable,
+                      HTableInterfaceFactory factory)
+               throws IOException
            +
            +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +

            +

            +
            Parameters:
            kijiConf - The Kiji configuration.
            schemaTable - The Kiji schema table.
            factory - HTableInterface factory. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +

            +HBaseMetaTable

            +
            +public HBaseMetaTable(HTableInterface htable,
+                      KijiSchemaTable schemaTable)
+               throws IOException
            +
            +
            Create a connection to a Kiji meta table backed by an HTable within HBase. + +

            This class takes ownership of the HTable. It will be closed when this instance is + closed.

            +

            +

            +
            Parameters:
            htable - The HTable to use for storing Kiji meta data.
            schemaTable - The Kiji schema table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +

            +HBaseMetaTable

            +
            +public HBaseMetaTable(HTableInterface htable,
+                      KijiTableLayoutDatabase tableLayoutDatabase,
+                      KijiTableKeyValueDatabase tableKeyValueDatabase)
            +
            +
            Create a connection to a Kiji meta table backed by an HTable within HBase. + +

            This class takes ownership of the HTable. It will be closed when this instance is + closed.

            +

            +

            +
            Parameters:
            htable - The HTable to use for storing Kiji meta data.
            tableLayoutDatabase - A database of table layouts to delegate layout storage to.
            tableKeyValueDatabase - A database of key-value pairs to delegate metadata storage to.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newMetaTable

            +
            +public static HTableInterface newMetaTable(KijiConfiguration kijiConf,
+                                           HTableInterfaceFactory factory)
+                                    throws IOException
            +
            +
            Creates an HTableInterface for the specified table. +

            +

            +
            Parameters:
            kijiConf - Kiji configuration.
            factory - HTableInterface factory to use. +
            Returns:
            a new HTableInterface for the specified table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteTable

            +
            +public void deleteTable(String table)
+                 throws IOException
            +
            +
            Remove all metadata, including layouts, for a particular table. +

            +

            +
            Specified by:
            deleteTable in class KijiMetaTable
            +
            +
            +
            Parameters:
            table - The name of the kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +updateTableLayout

            +
            +public KijiTableLayout updateTableLayout(String table,
+                                         TableLayoutDesc layoutUpdate)
+                                  throws IOException
            +
            +
            Sets a table's layout. Also calls validateAndAssignLayout(). +

            +

            +
            Parameters:
            table - The name of the Kiji table to affect.
            layoutUpdate - Descriptor for the layout update. +
            Returns:
            the new effective layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout(String table)
+                               throws IOException
            +
            +
            Gets the most recent versions of the layout for a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            The table's layout. +
            Throws: +
            IOException - If there is an error or no such table.
            +
            +
            +
            + +

            +getTableLayoutVersions

            +
            +public List<KijiTableLayout> getTableLayoutVersions(String table,
+                                                    int numVersions)
+                                             throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the table layout. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the layout for the table, sorted by + most-recent-first. If there are no layouts, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedTableLayoutVersions

            +
            +public NavigableMap<Long,KijiTableLayout> getTimedTableLayoutVersions(String table,
+                                                                      int numVersions)
+                                                               throws IOException
            +
            +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values the most recent versions of the layout for the table, and + keys the corresponding timestamps, ordered from most recent first to least recent last. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllTableLayoutVersions

            +
            +public void removeAllTableLayoutVersions(String table)
+                                  throws IOException
            +
            +
            Removes all layout information for a particular table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeRecentTableLayoutVersions

            +
            +public void removeRecentTableLayoutVersions(String table,
+                                            int numVersions)
+                                     throws IOException
            +
            +
            Removes the most recent layout information for a given table. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +listTables

            +
            +public List<String> listTables()
+                        throws IOException
            +
            +
            Lists the tables in this Kiji instance. +

            +

            + +
            Returns:
            The list of table names. +
            Throws: +
            IOException - If the list of tables cannot be retrieved.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Overrides:
            close in class KijiMetaTable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getValue

            +
            +public byte[] getValue(String table,
+                       String key)
+                throws IOException
            +
            +
            Returns the most recent value associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for. +
            Returns:
            The value in the meta table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public KijiTableKeyValueDatabase putValue(String table,
+                                          String key,
+                                          byte[] value)
+                                   throws IOException
            +
            +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +

            +

            +
            Parameters:
            table - The kiji table that this key-value pair will be set with.
            key - The key to associate with the specified value.
            value - The value to associate with the specified key. +
            Returns:
            The same KijiTableKeyValueDatabase. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeValues

            +
            +public void removeValues(String table,
+                         String key)
+                  throws IOException
            +
            +
            Removes all values associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table associated with the metadata.
            key - The metadata key to look up. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +tableSet

            +
            +public Set<String> tableSet()
+                     throws IOException
            +
            +
            Returns a set view of the tables that have key-value pairs defined. +

            +

            + +
            Returns:
            A set of tables that have key-value pairs defined. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keySet

            +
            +public Set<String> keySet(String table)
+                   throws IOException
            +
            +
            Returns a set view of keys contained in the map for the specified table. +

            +

            +
            Parameters:
            table - The table to look up in use keys for. +
            Returns:
            A navigable set of keys used to store meta information for a given table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllValues

            +
            +public void removeAllValues(String table)
+                     throws IOException
            +
            +
            Deletes all key-value pairs associated with the specified table. +

            +

            +
            Parameters:
            table - The table to delete remove key-value pairs for. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +install

            +
            +public static void install(HBaseAdmin admin,
+                           KijiURI uri)
+                    throws IOException
            +
            +
            Install the meta table into a Kiji instance. +

            +

            +
            Parameters:
            admin - The HBase Admin interface for the HBase cluster to install into.
            uri - The uri of the Kiji instance to install. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(HBaseAdmin admin,
+                             KijiURI uri)
+                      throws IOException
            +
            +
            Removes the meta table from HBase. +

            +

            +
            Parameters:
            admin - The HBase admin object.
            uri - The uri of the Kiji instance to uninstall. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toBackup

            +
            +public Map<String,TableBackup> toBackup()
+                                 throws IOException
            +
            +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            Specified by:
            toBackup in class KijiMetaTable
            +
            +
            + +
            Returns:
            A map from table names to TableBackup records. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public void fromBackup(Map<String,TableBackup> backup)
+                throws IOException
            +
            +
            Restores metadata from a backup record. This consists of table layouts, schemas, and user + defined key-value pairs. +

            +

            +
            Specified by:
            fromBackup in class KijiMetaTable
            +
            +
            +
            Parameters:
            backup - A map from table name to table backup record. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +layoutsToBackup

            +
            +public List<TableLayoutBackupEntry> layoutsToBackup(String table)
+                                             throws IOException
            +
            +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableLayoutBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public List<byte[]> getValues(String table,
+                              String key,
+                              int numVersions)
+                       throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +

            +

            +
            Parameters:
            table - The Kiji table.
            key - The key to look up associated values for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the values for the specified table and key, + sorted by most-recent-first. If there are no values, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedValues

            +
            +public NavigableMap<Long,byte[]> getTimedValues(String table,
+                                                String key,
+                                                int numVersions)
+                                         throws IOException
            +
            +
            Returns a map of values associated with the specified table and key. The Map + is keyed by timestamp. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values that are the user defined values for the specified key + and table, and keys that correspond to timestamps, ordered from newest to oldest. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesToBackup

            +
            +public List<KeyValueBackupEntry> keyValuesToBackup(String table)
+                                            throws IOException
            +
            +
            Gets a list of the TableKeyValueBackupEntries. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableKeyValueBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesFromBackup

            +
            +public void keyValuesFromBackup(String table,
+                                List<KeyValueBackupEntry> tableBackup)
+                         throws IOException
            +
            +
            Restores all table's key value history from a backup. +

            +

            +
            Parameters:
            table - The name of the kiji table.
            tableBackup - The key values associated with the table to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +layoutsFromBackup

            +
            +public void layoutsFromBackup(String tableName,
+                              List<TableLayoutBackupEntry> tableBackup)
+                       throws IOException
            +
            +
            Description copied from interface: KijiTableLayoutDatabase
            +
            Restores a table layout history from a backup. +

            +

            +
            Parameters:
            tableName - The name of the table to restore layouts for.
            tableBackup - Table layout backup entries to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseSchemaTable.html new file mode 100644 index 00000000..cf028ff5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseSchemaTable.html @@ -0,0 +1,932 @@ + + + + + + + +HBaseSchemaTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseSchemaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSchemaTable
+      extended by org.kiji.schema.impl.HBaseSchemaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseSchemaTable
            extends KijiSchemaTable
            + + +

            +

            + Mapping between schema IDs, hashes and Avro schema objects. + This class is thread-safe. +

            + +

            + Schemas are stored in two tables with a single column family named "schema" and that contains + SchemaTableEntry records. One table is indexed by schema hashes (128-bit MD5 hashes of the + schema JSON representation). Other table is indexed by schema IDs (integers >= 0). + + There may be multiple schema IDs for a single schema. +

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.KijiSchemaTable
            KijiSchemaTable.SchemaEntry
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static intPRE_REGISTERED_SCHEMA_COUNT + +
            +          Number of pre-allocated schemas.
            +static StringSCHEMA_COLUMN_FAMILY + +
            +          The column family in HBase used to store schema entries.
            +static StringSCHEMA_COLUMN_QUALIFIER + +
            +          The column qualifier in HBase used to store schema entries.
            +static StringSCHEMA_COUNTER_ROW_NAME + +
            +          Schema IDs are generated using a counter.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseSchemaTable(HTableInterface hashTable, + HTableInterface idTable, + Lock zkLock) + +
            +          Wrap an existing HBase table assumed to be where the schema data is stored.
            HBaseSchemaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Flushes and closes the KijiSchemaTable.
            +static SchemaTableEntrydecodeSchemaEntry(byte[] bytes) + +
            +          Decodes a binary-encoded Avro schema entry.
            +static byte[]encodeSchemaEntry(SchemaTableEntry avroEntry) + +
            +          Encodes an Avro schema entry into binary.
            +protected  voidfinalize() + +
            +          
            + voidflush() + +
            +          Commits any pending additions to the schema table.
            +static KijiSchemaTable.SchemaEntryfromAvroEntry(SchemaTableEntry avroEntry) + +
            +          Converts an Avro SchemaTableEntry into a SchemaEntry.
            + voidfromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            + BytesKeygetOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            + longgetOrCreateSchemaId(org.apache.avro.Schema schema) + +
            +          Looks up a schema ID given an Avro schema object.
            + org.apache.avro.SchemagetSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            + org.apache.avro.SchemagetSchema(long schemaId) + +
            +          Looks up a schema given an ID.
            +static voidinstall(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static LocknewLock(KijiConfiguration conf, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +static HTableInterfacenewSchemaHashTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema hash table.
            +static HTableInterfacenewSchemaIdTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema ID table.
            +static HTableInterfacenewSchemaV5Table(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema V5 table.
            +static SchemaTableEntrytoAvroEntry(KijiSchemaTable.SchemaEntry entry) + +
            +          Converts a SchemaEntry into an Avro SchemaTableEntry.
            + List<SchemaTableEntry>toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +static voiduninstall(HBaseAdmin admin, + KijiConfiguration kijiConf) + +
            +          Disables and removes the schema table from HBase.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.KijiSchemaTable
            getSchemaHash, hashSchema
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA_COLUMN_FAMILY

            +
            +public static final String SCHEMA_COLUMN_FAMILY
            +
            +
            The column family in HBase used to store schema entries. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +SCHEMA_COLUMN_QUALIFIER

            +
            +public static final String SCHEMA_COLUMN_QUALIFIER
            +
            +
            The column qualifier in HBase used to store schema entries. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +SCHEMA_COUNTER_ROW_NAME

            +
            +public static final String SCHEMA_COUNTER_ROW_NAME
            +
            +
            Schema IDs are generated using a counter. The counter is stored in the schema ID table. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +PRE_REGISTERED_SCHEMA_COUNT

            +
            +public static final int PRE_REGISTERED_SCHEMA_COUNT
            +
            +
            Number of pre-allocated schemas. +

            +

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

            +HBaseSchemaTable

            +
            +public HBaseSchemaTable(KijiConfiguration kijiConf,
+                        HTableInterfaceFactory tableFactory,
+                        LockFactory lockFactory)
+                 throws IOException
            +
            +
            Open a connection to the HBase schema table for a Kiji instance. +

            +

            +
            Parameters:
            kijiConf - The kiji configuration.
            tableFactory - HTableInterface factory.
            lockFactory - Factory for locks. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +

            +HBaseSchemaTable

            +
            +public HBaseSchemaTable(HTableInterface hashTable,
+                        HTableInterface idTable,
+                        Lock zkLock)
+                 throws IOException
            +
            +
            Wrap an existing HBase table assumed to be where the schema data is stored. +

            +

            +
            Parameters:
            hashTable - The HTable that maps schema hashes to schema entries.
            idTable - The HTable that maps schema IDs to schema entries.
            zkLock - Lock protecting the schema tables. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newSchemaV5Table

            +
            +public static HTableInterface newSchemaV5Table(KijiConfiguration conf,
+                                               HTableInterfaceFactory factory)
+                                        throws IOException
            +
            +
            Creates an HTable handle to the schema V5 table. +

            +

            +
            Parameters:
            conf - Kiji/HBase configuration to open the table.
            factory - HTableInterface factory. +
            Returns:
            a new interface for the table storing the schemas up until data layout v5. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +newSchemaHashTable

            +
            +public static HTableInterface newSchemaHashTable(KijiConfiguration conf,
+                                                 HTableInterfaceFactory factory)
+                                          throws IOException
            +
            +
            Creates an HTable handle to the schema hash table. +

            +

            +
            Parameters:
            conf - Kiji/HBase configuration to open the table.
            factory - HTableInterface factory. +
            Returns:
            a new interface for the table storing the mapping from schema hash to schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +newSchemaIdTable

            +
            +public static HTableInterface newSchemaIdTable(KijiConfiguration conf,
+                                               HTableInterfaceFactory factory)
+                                        throws IOException
            +
            +
            Creates an HTable handle to the schema ID table. +

            +

            +
            Parameters:
            conf - Kiji/HBase configuration to open the table.
            factory - HTableInterface factory. +
            Returns:
            a new interface for the table storing the mapping from schema ID to schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +newLock

            +
            +public static Lock newLock(KijiConfiguration conf,
+                           LockFactory factory)
+                    throws IOException
            +
            +
            Creates a lock for a given Kiji instance. +

            +

            +
            Parameters:
            conf - Configuration of the Kiji instance.
            factory - Factory for locks. +
            Returns:
            a lock for the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeSchemaEntry

            +
            +public static SchemaTableEntry decodeSchemaEntry(byte[] bytes)
+                                          throws IOException
            +
            +
            Decodes a binary-encoded Avro schema entry. +

            +

            +
            Parameters:
            bytes - Binary-encoded Avro schema entry. +
            Returns:
            Decoded Avro schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encodeSchemaEntry

            +
            +public static byte[] encodeSchemaEntry(SchemaTableEntry avroEntry)
+                                throws IOException
            +
            +
            Encodes an Avro schema entry into binary. +

            +

            +
            Parameters:
            avroEntry - Avro schema entry to encode. +
            Returns:
            Binary-encoded Avro schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getOrCreateSchemaId

            +
            +public long getOrCreateSchemaId(org.apache.avro.Schema schema)
+                         throws IOException
            +
            +
            Looks up a schema ID given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            Specified by:
            getOrCreateSchemaId in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schema - The full schema to store in the table. +
            Returns:
            The schema ID. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getOrCreateSchemaHash

            +
            +public BytesKey getOrCreateSchemaHash(org.apache.avro.Schema schema)
+                               throws IOException
            +
            +
            Looks up a schema hash given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            Specified by:
            getOrCreateSchemaHash in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schema - Avro schema to look up. +
            Returns:
            The schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +fromAvroEntry

            +
            +public static KijiSchemaTable.SchemaEntry fromAvroEntry(SchemaTableEntry avroEntry)
            +
            +
            Converts an Avro SchemaTableEntry into a SchemaEntry. +

            +

            +
            Parameters:
            avroEntry - Avro SchemaTableEntry +
            Returns:
            an equivalent SchemaEntry
            +
            +
            +
            + +

            +toAvroEntry

            +
            +public static SchemaTableEntry toAvroEntry(KijiSchemaTable.SchemaEntry entry)
            +
            +
            Converts a SchemaEntry into an Avro SchemaTableEntry. +

            +

            +
            Parameters:
            entry - a SchemaEntry. +
            Returns:
            an equivalent Avro SchemaTableEntry.
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema(long schemaId)
+                                 throws IOException
            +
            +
            Looks up a schema given an ID. +

            +

            +
            Specified by:
            getSchema in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schemaId - Schema ID to look up. +
            Returns:
            Avro schema, or null if the schema ID is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema(BytesKey schemaHash)
+                                 throws IOException
            +
            +
            Looks up a schema given a hash. +

            +

            +
            Specified by:
            getSchema in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schemaHash - Schema hash to look up. +
            Returns:
            Avro schema, or null if the schema hash is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            Commits any pending additions to the schema table. + + Default implementation is blank as flushing is not generally a vital operation +

            +

            +
            Overrides:
            flush in class KijiSchemaTable
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            Flushes and closes the KijiSchemaTable. No other methods may be called after this. +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in class KijiSchemaTable
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +install

            +
            +public static void install(HBaseAdmin admin,
+                           KijiConfiguration kijiConf,
+                           HTableInterfaceFactory tableFactory,
+                           LockFactory lockFactory)
+                    throws IOException
            +
            +
            Install the schema table into a Kiji instance. +

            +

            +
            Parameters:
            admin - The HBase Admin interface for the HBase cluster to install into.
            kijiConf - The Kiji configuration.
            tableFactory - HTableInterface factory.
            lockFactory - Factory for locks. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(HBaseAdmin admin,
+                             KijiConfiguration kijiConf)
+                      throws IOException
            +
            +
            Disables and removes the schema table from HBase. +

            +

            +
            Parameters:
            admin - The HBase Admin object.
            kijiConf - The configuration for the kiji instance to remove. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toBackup

            +
            +public List<SchemaTableEntry> toBackup()
+                                throws IOException
            +
            +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            Specified by:
            toBackup in class KijiSchemaTable
            +
            +
            + +
            Returns:
            A list of schema table entries. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public void fromBackup(List<SchemaTableEntry> backup)
+                throws IOException
            +
            +
            Restores the schema entries from the specified backup record. +

            +

            +
            Specified by:
            fromBackup in class KijiSchemaTable
            +
            +
            +
            Parameters:
            backup - The schema entries from a MetadataBackup record. This consist of the schema + definition, schema id, and schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseSystemTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseSystemTable.html new file mode 100644 index 00000000..3734cb31 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseSystemTable.html @@ -0,0 +1,629 @@ + + + + + + + +HBaseSystemTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseSystemTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSystemTable
+      extended by org.kiji.schema.impl.HBaseSystemTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseSystemTable
            extends KijiSystemTable
            + + +

            +

            The Kiji system table that is stored in HBase.

            + +

            The system table (a Kiji system table) is a simple key-value store for system-wide + properties of a Kiji installation. There is a single column family "value". For a + key-value property (K,V), the key K is stored as the row key in the HTable, + and the value V is stored in the "value:" column.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringDEFAULTS_PROPERTIES_FILE + +
            +          The name of the file that stores the current system table defaults that are loaded + at installation time.
            +static StringKEY_DATA_VERSION + +
            +          The HBase row key that stores the installed Kiji data format version.
            +static StringVALUE_COLUMN_FAMILY + +
            +          The HBase column family that stores the value of the properties.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseSystemTable(HTableInterface htable) + +
            +          Wrap an existing HTable connection that is assumed to be the table that stores the + Kiji instance properties.
            HBaseSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Connect to the HBase system table inside a Kiji instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +protected  voidfinalize() + +
            +          
            + StringgetDataVersion() + +
            +          Gets the version of kiji installed.
            + byte[]getValue(String key) + +
            +          Gets the value associated with a property key.
            +static voidinstall(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Installs a Kiji system table into a running HBase instance.
            +protected  voidloadDefaults(String resource) + +
            +          Load the system table with the key/value pairs from the properties file named by resource.
            +static HTableInterfacenewSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates a new HTableInterface for the Kiji system table.
            + voidputValue(String key, + byte[] value) + +
            +          Sets a value for a property key, which creates it if it doesn't exist.
            + voidsetDataVersion(String version) + +
            +          Sets the version of kiji installed.
            +static voiduninstall(HBaseAdmin admin, + KijiConfiguration kijiConf) + +
            +          Disables and delete the system table from HBase.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +VALUE_COLUMN_FAMILY

            +
            +public static final String VALUE_COLUMN_FAMILY
            +
            +
            The HBase column family that stores the value of the properties. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KEY_DATA_VERSION

            +
            +public static final String KEY_DATA_VERSION
            +
            +
            The HBase row key that stores the installed Kiji data format version. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULTS_PROPERTIES_FILE

            +
            +public static final String DEFAULTS_PROPERTIES_FILE
            +
            +
            The name of the file that stores the current system table defaults that are loaded + at installation time. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +HBaseSystemTable

            +
            +public HBaseSystemTable(KijiConfiguration kijiConf,
+                        HTableInterfaceFactory factory)
+                 throws IOException
            +
            +
            Connect to the HBase system table inside a Kiji instance. +

            +

            +
            Parameters:
            kijiConf - The Kiji configuration.
            factory - HTableInterface factory. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +

            +HBaseSystemTable

            +
            +public HBaseSystemTable(HTableInterface htable)
            +
            +
            Wrap an existing HTable connection that is assumed to be the table that stores the + Kiji instance properties. +

            +

            +
            Parameters:
            htable - An HTable to wrap.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newSystemTable

            +
            +public static HTableInterface newSystemTable(KijiConfiguration kijiConf,
+                                             HTableInterfaceFactory factory)
+                                      throws IOException
            +
            +
            Creates a new HTableInterface for the Kiji system table. +

            +

            +
            Parameters:
            kijiConf - Kiji configuration.
            factory - HTableInterface factory. +
            Returns:
            a new HTableInterface for the Kiji system table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getDataVersion

            +
            +public String getDataVersion()
+                      throws IOException
            +
            +
            Gets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            Specified by:
            getDataVersion in class KijiSystemTable
            +
            +
            + +
            Returns:
            the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +setDataVersion

            +
            +public void setDataVersion(String version)
+                    throws IOException
            +
            +
            Sets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            Specified by:
            setDataVersion in class KijiSystemTable
            +
            +
            +
            Parameters:
            version - the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +getValue

            +
            +public byte[] getValue(String key)
+                throws IOException
            +
            +
            Gets the value associated with a property key. +

            +

            +
            Specified by:
            getValue in class KijiSystemTable
            +
            +
            +
            Parameters:
            key - The property key to look up. +
            Returns:
            The value in the HBase table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public void putValue(String key,
+                     byte[] value)
+              throws IOException
            +
            +
            Sets a value for a property key, which creates it if it doesn't exist. +

            +

            +
            Specified by:
            putValue in class KijiSystemTable
            +
            +
            +
            Parameters:
            key - The property key to set.
            value - The value of the property. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +loadDefaults

            +
            +protected void loadDefaults(String resource)
+                     throws IOException
            +
            +
            Load the system table with the key/value pairs from the properties file named by resource. +

            +

            +
            Parameters:
            resource - The name of the properties resource holding the defaults. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +install

            +
            +public static void install(HBaseAdmin admin,
+                           KijiConfiguration kijiConf,
+                           HTableInterfaceFactory factory)
+                    throws IOException
            +
            +
            Installs a Kiji system table into a running HBase instance. +

            +

            +
            Parameters:
            admin - The HBase cluster to install into.
            kijiConf - The Kiji configuration.
            factory - HTableInterface factory. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(HBaseAdmin admin,
+                             KijiConfiguration kijiConf)
+                      throws IOException
            +
            +
            Disables and delete the system table from HBase. +

            +

            +
            Parameters:
            admin - The HBase admin object.
            kijiConf - The configuration for the kiji instance to remove. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html new file mode 100644 index 00000000..c8c7f374 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html @@ -0,0 +1,590 @@ + + + + + + + +HBaseTableKeyValueDatabase (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseTableKeyValueDatabase

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseTableKeyValueDatabase
+
            +
            +
            All Implemented Interfaces:
            KijiTableKeyValueDatabase
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseTableKeyValueDatabase
            extends Object
            implements KijiTableKeyValueDatabase
            + + +

            +Manages key-value pairs on a per table basis. Storage of these key-value pairs is provided by + a column family of an HTable. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static org.slf4j.LoggerLOG + +
            +           
            +  + + + + + + + + + + +
            +Constructor Summary
            HBaseTableKeyValueDatabase(HTableInterface hTable, + String metaFamily) + +
            +          This class manages the storage and retrieval of key-value pairs on a per table basis.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + NavigableMap<Long,byte[]>getTimedValues(String table, + String key, + int numVersions) + +
            +          Returns a map of values associated with the specified table and key.
            + byte[]getValue(String table, + String key) + +
            +          Returns the most recent value associated with the specified table and key.
            + List<byte[]>getValues(String table, + String key, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key.
            + Set<String>keySet(String table) + +
            +          Returns a set view of keys contained in the map for the specified table.
            + voidkeyValuesFromBackup(String tableName, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            + List<KeyValueBackupEntry>keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + KijiTableKeyValueDatabaseputValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + voidremoveAllValues(String table) + +
            +          Deletes all key-value pairs associated with the specified table.
            + voidremoveValues(String table, + String key) + +
            +          Removes all values associated with the specified table and key.
            + Set<String>tableSet() + +
            +          Returns a set view of the tables that have key-value pairs defined.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +LOG

            +
            +public static final org.slf4j.Logger LOG
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +HBaseTableKeyValueDatabase

            +
            +public HBaseTableKeyValueDatabase(HTableInterface hTable,
+                                  String metaFamily)
            +
            +
            This class manages the storage and retrieval of key-value pairs on a per table basis. It is + backed by a column family in HBase specified by metaFamily, in the table specified by table. +

            +

            +
            Parameters:
            hTable - The table to store the key-value information in.
            metaFamily - the name of the column family to use.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getValue

            +
            +public byte[] getValue(String table,
+                       String key)
+                throws IOException
            +
            +
            Returns the most recent value associated with the specified table and key. +

            +

            +
            Specified by:
            getValue in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for. +
            Returns:
            The value in the meta table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public List<byte[]> getValues(String table,
+                              String key,
+                              int numVersions)
+                       throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +

            +

            +
            Specified by:
            getValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The Kiji table.
            key - The key to look up associated values for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the values for the specified table and key, + sorted by most-recent-first. If there are no values, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedValues

            +
            +public NavigableMap<Long,byte[]> getTimedValues(String table,
+                                                String key,
+                                                int numVersions)
+                                         throws IOException
            +
            +
            Returns a map of values associated with the specified table and key. The Map + is keyed by timestamp. +

            +

            +
            Specified by:
            getTimedValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values that are the user defined values for the specified key + and table, and keys that correspond to timestamps, ordered from newest to oldest. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public KijiTableKeyValueDatabase putValue(String table,
+                                          String key,
+                                          byte[] value)
+                                   throws IOException
            +
            +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +

            +

            +
            Specified by:
            putValue in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table that this key-value pair will be set with.
            key - The key to associate with the specified value.
            value - The value to associate with the specified key. +
            Returns:
            The same KijiTableKeyValueDatabase. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeValues

            +
            +public void removeValues(String table,
+                         String key)
+                  throws IOException
            +
            +
            Removes all values associated with the specified table and key. +

            +

            +
            Specified by:
            removeValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table associated with the metadata.
            key - The metadata key to look up. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keySet

            +
            +public Set<String> keySet(String table)
+                   throws IOException
            +
            +
            Returns a set view of keys contained in the map for the specified table. +

            +

            +
            Specified by:
            keySet in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The table to look up in use keys for. +
            Returns:
            A navigable set of keys used to store meta information for a given table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +tableSet

            +
            +public Set<String> tableSet()
+                     throws IOException
            +
            +
            Returns a set view of the tables that have key-value pairs defined. +

            +

            +
            Specified by:
            tableSet in interface KijiTableKeyValueDatabase
            +
            +
            + +
            Returns:
            A set of tables that have key-value pairs defined. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllValues

            +
            +public void removeAllValues(String table)
+                     throws IOException
            +
            +
            Deletes all key-value pairs associated with the specified table. +

            +

            +
            Specified by:
            removeAllValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The table to delete remove key-value pairs for. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesToBackup

            +
            +public List<KeyValueBackupEntry> keyValuesToBackup(String table)
+                                            throws IOException
            +
            +
            Gets a list of the TableKeyValueBackupEntries. +

            +

            +
            Specified by:
            keyValuesToBackup in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableKeyValueBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesFromBackup

            +
            +public void keyValuesFromBackup(String tableName,
+                                List<KeyValueBackupEntry> keyValues)
+                         throws IOException
            +
            +
            Restores all table's key value history from a backup. +

            +

            +
            Specified by:
            keyValuesFromBackup in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            tableName - The name of the kiji table.
            keyValues - The key values associated with the table to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HColumnDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HColumnDescriptorComparator.html new file mode 100644 index 00000000..7b04b751 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HColumnDescriptorComparator.html @@ -0,0 +1,276 @@ + + + + + + + +HColumnDescriptorComparator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HColumnDescriptorComparator

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HColumnDescriptorComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator<HColumnDescriptor>
            +
            +
            +
            +
            @ApiAudience.Private
+public class HColumnDescriptorComparator
            extends Object
            implements Comparator<HColumnDescriptor>
            + + +

            +Comparator for HColumnDescriptors. They are sorted by name, then + by max versions, ttl, and whether it is in memory. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HColumnDescriptorComparator() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + intcompare(HColumnDescriptor o1, + HColumnDescriptor o2) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

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

            +HColumnDescriptorComparator

            +
            +public HColumnDescriptorComparator()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(HColumnDescriptor o1,
+                   HColumnDescriptor o2)
            +
            +
            +
            Specified by:
            compare in interface Comparator<HColumnDescriptor>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HTableDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HTableDescriptorComparator.html new file mode 100644 index 00000000..eb184c85 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HTableDescriptorComparator.html @@ -0,0 +1,304 @@ + + + + + + + +HTableDescriptorComparator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HTableDescriptorComparator

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HTableDescriptorComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator<HTableDescriptor>
            +
            +
            +
            +
            @ApiAudience.Private
+public class HTableDescriptorComparator
            extends Object
            implements Comparator<HTableDescriptor>
            + + +

            +Compares HTableDescriptors. They + are equal if they have the same HTable name with the same column + families. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HTableDescriptorComparator() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + intcompare(HTableDescriptor o1, + HTableDescriptor o2) + +
            +           
            +static HTableDescriptormakeEmptyTableDescriptor(KijiManagedHBaseTableName hbaseTableName) + +
            +          Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout().
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

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

            +HTableDescriptorComparator

            +
            +public HTableDescriptorComparator()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(HTableDescriptor o1,
+                   HTableDescriptor o2)
            +
            +
            +
            Specified by:
            compare in interface Comparator<HTableDescriptor>
            +
            +
            +
            +
            +
            +
            + +

            +makeEmptyTableDescriptor

            +
            +public static HTableDescriptor makeEmptyTableDescriptor(KijiManagedHBaseTableName hbaseTableName)
            +
            +
            Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout(). +

            +

            +
            +
            +
            +
            Parameters:
            hbaseTableName - the HBase table name being represented by this "empty table." +
            Returns:
            an HTableDescriptor that represents a table with no column families.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HTableInterfaceFactory.html new file mode 100644 index 00000000..78bc92b7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HTableInterfaceFactory.html @@ -0,0 +1,225 @@ + + + + + + + +HTableInterfaceFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Interface HTableInterfaceFactory

            +
            +
            All Known Implementing Classes:
            DefaultHTableInterfaceFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public interface HTableInterfaceFactory
            + + +

            +Factory for HTableInterface instances. + + This interface exists because the HBase HTableInstanceFactory doesn't throw IOException. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + HTableInterfacecreate(Configuration conf, + String hbaseTableName) + +
            +          Creates a new HTableInterface instance.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +HTableInterface create(Configuration conf,
+                       String hbaseTableName)
+                       throws IOException
            +
            +
            Creates a new HTableInterface instance. +

            +

            +
            Parameters:
            conf - The configuration for the HBase cluster.
            hbaseTableName - The name of the HBase table to create a connection to. +
            Returns:
            a new HTableInterface for the specified table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HashPrefixedEntityId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HashPrefixedEntityId.html new file mode 100644 index 00000000..46939957 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HashPrefixedEntityId.html @@ -0,0 +1,363 @@ + + + + + + + +HashPrefixedEntityId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HashPrefixedEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.HashPrefixedEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public final class HashPrefixedEntityId
            extends EntityId
            + + +

            +Implements the hash-prefixed row key format. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static HashPrefixedEntityIdfromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified HBase row key.
            +static HashPrefixedEntityIdfromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified Kiji row key.
            + RowKeyFormatgetFormat() + +
            +          
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + byte[]getKijiRowKey() + +
            +          
            +static byte[]hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +fromKijiRowKey

            +
            +public static HashPrefixedEntityId fromKijiRowKey(byte[] kijiRowKey,
+                                                  RowKeyFormat format)
            +
            +
            Creates a HashPrefixedEntityId from the specified Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key.
            format - Row key hashing specification. +
            Returns:
            a new HashPrefixedEntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public static HashPrefixedEntityId fromHBaseRowKey(byte[] hbaseRowKey,
+                                                   RowKeyFormat format)
            +
            +
            Creates a HashPrefixedEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key.
            format - Row key hashing specification. +
            Returns:
            a new HashedEntityId with the specified HBase row key.
            +
            +
            +
            + +

            +hashKijiRowKey

            +
            +public static byte[] hashKijiRowKey(RowKeyFormat format,
+                                    byte[] kijiRowKey)
            +
            +
            Hashes a Kiji row key. +

            +

            +
            Parameters:
            format - Hashing specification.
            kijiRowKey - Kiji row key. +
            Returns:
            a hash of the Kiji row key.
            +
            +
            +
            + +

            +getFormat

            +
            +public RowKeyFormat getFormat()
            +
            +
            +

            +

            +
            Specified by:
            getFormat in class EntityId
            +
            +
            + +
            Returns:
            the format of this row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public byte[] getKijiRowKey()
            +
            +
            +

            +

            +
            Specified by:
            getKijiRowKey in class EntityId
            +
            +
            + +
            Returns:
            the Kiji row key as a byte array.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HashedEntityId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HashedEntityId.html new file mode 100644 index 00000000..057c4149 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/HashedEntityId.html @@ -0,0 +1,363 @@ + + + + + + + +HashedEntityId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HashedEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.HashedEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public final class HashedEntityId
            extends EntityId
            + + +

            +Implements the hashed row key format. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static HashedEntityIdfromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified HBase row key.
            +static HashedEntityIdfromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified Kiji row key.
            + RowKeyFormatgetFormat() + +
            +          
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + byte[]getKijiRowKey() + +
            +          
            +static byte[]hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +fromKijiRowKey

            +
            +public static HashedEntityId fromKijiRowKey(byte[] kijiRowKey,
+                                            RowKeyFormat format)
            +
            +
            Creates a HashedEntityId from the specified Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key.
            format - Row key hashing specification. +
            Returns:
            a new HashedEntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public static HashedEntityId fromHBaseRowKey(byte[] hbaseRowKey,
+                                             RowKeyFormat format)
            +
            +
            Creates a HashedEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key.
            format - Row key hashing specification. +
            Returns:
            a new HashedEntityId with the specified HBase row key.
            +
            +
            +
            + +

            +hashKijiRowKey

            +
            +public static byte[] hashKijiRowKey(RowKeyFormat format,
+                                    byte[] kijiRowKey)
            +
            +
            Hashes a Kiji row key. +

            +

            +
            Parameters:
            format - Hashing specification.
            kijiRowKey - Kiji row key to hash. +
            Returns:
            a hash of the given Kiji row key.
            +
            +
            +
            + +

            +getFormat

            +
            +public RowKeyFormat getFormat()
            +
            +
            +

            +

            +
            Specified by:
            getFormat in class EntityId
            +
            +
            + +
            Returns:
            the format of this row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public byte[] getKijiRowKey()
            +
            +
            +

            +

            +
            Specified by:
            getKijiRowKey in class EntityId
            +
            +
            + +
            Returns:
            the Kiji row key as a byte array.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/InvalidColumnNameException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/InvalidColumnNameException.html new file mode 100644 index 00000000..b1cbc624 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/InvalidColumnNameException.html @@ -0,0 +1,251 @@ + + + + + + + +InvalidColumnNameException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class InvalidColumnNameException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.impl.InvalidColumnNameException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Private
+public final class InvalidColumnNameException
            extends RuntimeException
            + + +

            +Thrown when kiji encounters a column name that is not valid. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            InvalidColumnNameException(String message) + +
            +          Creates a new InvalidColumnNameException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +InvalidColumnNameException

            +
            +public InvalidColumnNameException(String message)
            +
            +
            Creates a new InvalidColumnNameException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/KijiColumnPager.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/KijiColumnPager.html new file mode 100644 index 00000000..68b9cf2e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/KijiColumnPager.html @@ -0,0 +1,303 @@ + + + + + + + +KijiColumnPager (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class KijiColumnPager

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.KijiColumnPager
+
            +
            +
            +
            @ApiAudience.Private
+public final class KijiColumnPager
            extends Object
            + + +

            +Fetches new pages of column data in Kiji, and maintains state for which page each column is on. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiColumnPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HTableInterface htable) + +
            +          Creates a new KijiColumnPager.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + NavigableMap<String,NavigableMap<Long,byte[]>>getNextPage(String family) + +
            +          Gets the next page of data in a family with paging enabled.
            + NavigableMap<Long,byte[]>getNextPage(String family, + String qualifier) + +
            +          Gets the next page of data in a column with paging enabled.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiColumnPager

            +
            +public KijiColumnPager(EntityId entityId,
+                       KijiDataRequest dataRequest,
+                       KijiTableLayout tableLayout,
+                       HTableInterface htable)
            +
            +
            Creates a new KijiColumnPager. +

            +

            +
            Parameters:
            entityId - The entity id of the row having columns paged.
            dataRequest - The data request that was used to fetch the row data.
            tableLayout - The layout of the Kiji table being read from.
            htable - An HTable connection for the table that stores the Kiji table data.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getNextPage

            +
            +public NavigableMap<Long,byte[]> getNextPage(String family,
+                                             String qualifier)
+                                      throws IOException
            +
            +
            Gets the next page of data in a column with paging enabled. +

            +

            +
            Parameters:
            family - A column family.
            qualifier - A column qualifier. +
            Returns:
            The next page of data (or null if there is no more data). +
            Throws: +
            KijiColumnPagingNotEnabledException - If paging is not enabled on the requested column. +
            IOException - If there is an I/O error.
            +
            +
            +
            + +

            +getNextPage

            +
            +public NavigableMap<String,NavigableMap<Long,byte[]>> getNextPage(String family)
+                                                           throws IOException
            +
            +
            Gets the next page of data in a family with paging enabled. +

            +

            +
            Parameters:
            family - A column family. +
            Returns:
            The next page of data (or null if there is no more data). +
            Throws: +
            KijiColumnPagingNotEnabledException - If paging is not enabled on the requested column. +
            IOException - If there is an I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/KijiColumnPagingNotEnabledException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/KijiColumnPagingNotEnabledException.html new file mode 100644 index 00000000..e125e7c7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/KijiColumnPagingNotEnabledException.html @@ -0,0 +1,256 @@ + + + + + + + +KijiColumnPagingNotEnabledException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class KijiColumnPagingNotEnabledException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.impl.KijiColumnPagingNotEnabledException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiColumnPagingNotEnabledException
            extends IOException
            + + +

            +Thrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column. + +

            To enable paging on a column, use the KijiDataRequest.Column#withPageSize(int) method in your KijiDataRequest.

            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiColumnPagingNotEnabledException(String message) + +
            +          Creates a new KijiColumnPagingNotEnabledException with the specified + detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiColumnPagingNotEnabledException

            +
            +public KijiColumnPagingNotEnabledException(String message)
            +
            +
            Creates a new KijiColumnPagingNotEnabledException with the specified + detail message. +

            +

            +
            Parameters:
            message - An error message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/KijiDataBuffer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/KijiDataBuffer.html new file mode 100644 index 00000000..c81404d1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/KijiDataBuffer.html @@ -0,0 +1,370 @@ + + + + + + + +KijiDataBuffer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class KijiDataBuffer<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.KijiDataBuffer<T>
+
            +
            +
            Type Parameters:
            T - The type of the elements being stored in the buffer.
            +
            +
            +
            @ApiAudience.Private
+public class KijiDataBuffer<T>
            extends Object
            + + +

            +A buffer used to hold data entries waiting to be written to a KijiTable. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiDataBuffer() + +
            +          Creates an instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataBuffer<T>add(EntityId id, + T value) + +
            +          Adds a buffer element to the buffer and associates it with the specified entity.
            + voidclear() + +
            +          Clears the buffer by removing all elements stored in it.
            +protected  List<T>getBuffer(EntityId id) + +
            +          Gets the list of buffer elements associated with the specified entity.
            + Collection<List<T>>getBuffers() + +
            +           
            + Set<Map.Entry<EntityId,List<T>>>getEntries() + +
            +           
            + intsize() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiDataBuffer

            +
            +public KijiDataBuffer()
            +
            +
            Creates an instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +add

            +
            +public KijiDataBuffer<T> add(EntityId id,
+                             T value)
            +
            +
            Adds a buffer element to the buffer and associates it with the specified entity. +

            +

            +
            Parameters:
            id - The entity id.
            value - The buffer element to add to the buffer. +
            Returns:
            A reference to this to allow chaining of add statements.
            +
            +
            +
            + +

            +clear

            +
            +public void clear()
            +
            +
            Clears the buffer by removing all elements stored in it. +

            +

            +
            +
            +
            +
            + +

            +getBuffer

            +
            +protected List<T> getBuffer(EntityId id)
            +
            +
            Gets the list of buffer elements associated with the specified entity. +

            +

            +
            Parameters:
            id - The entity id. +
            Returns:
            The list of buffer elements used for buffering.
            +
            +
            +
            + +

            +getBuffers

            +
            +public Collection<List<T>> getBuffers()
            +
            +
            + +
            Returns:
            The elements stored in this buffer grouped by their entityId.
            +
            +
            +
            + +

            +getEntries

            +
            +public Set<Map.Entry<EntityId,List<T>>> getEntries()
            +
            +
            + +
            Returns:
            The Map.Entrys that are stored in the buffer.
            +
            +
            +
            + +

            +size

            +
            +public int size()
            +
            +
            + +
            Returns:
            The number of elements stored in this buffer.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/MetadataRestorer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/MetadataRestorer.html new file mode 100644 index 00000000..212d8539 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/MetadataRestorer.html @@ -0,0 +1,317 @@ + + + + + + + +MetadataRestorer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class MetadataRestorer

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.MetadataRestorer
+
            +
            +
            +
            public class MetadataRestorer
            extends Object
            + + +

            +Metadata restorer backups up meta info to MetadataBackup records and can restore metadata to the + meta and schema tables. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            MetadataRestorer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidexportMetadata(String outputFile, + Kiji kiji) + +
            +          Exports all Kiji metadata to an Avro file with the specified filename.
            + voidrestoreSchemas(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all SchemaTable entries from the metadata backup.
            + voidrestoreTables(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all tables from the metadata backup into the running Kiji instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MetadataRestorer

            +
            +public MetadataRestorer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +exportMetadata

            +
            +public void exportMetadata(String outputFile,
+                           Kiji kiji)
+                    throws IOException
            +
            +
            Exports all Kiji metadata to an Avro file with the specified filename. +

            +

            +
            Parameters:
            outputFile - the output filename. This file must not exist.
            kiji - the Kiji instance to backup. +
            Throws: +
            IOException - when an error communicating with HBase or the filesystem occurs.
            +
            +
            +
            + +

            +restoreTables

            +
            +public void restoreTables(MetadataBackup backup,
+                          Kiji kiji)
+                   throws IOException
            +
            +
            Restores all tables from the metadata backup into the running Kiji instance. +

            +

            +
            Parameters:
            backup - the deserialized backup of the metadata.
            kiji - the connected Kiji instance. +
            Throws: +
            IOException - if there is an error communicating with HBase.
            +
            +
            +
            + +

            +restoreSchemas

            +
            +public void restoreSchemas(MetadataBackup backup,
+                           Kiji kiji)
+                    throws IOException
            +
            +
            Restores all SchemaTable entries from the metadata backup. +

            +

            +
            Parameters:
            backup - the deserialized backup of the metadata.
            kiji - the connected Kiji instance. +
            Throws: +
            IOException - if there is an error communicating with HBase.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/RawEntityId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/RawEntityId.html new file mode 100644 index 00000000..69abd56c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/RawEntityId.html @@ -0,0 +1,372 @@ + + + + + + + +RawEntityId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class RawEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.RawEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public final class RawEntityId
            extends EntityId
            + + +

            +Implements the raw row key format. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            RawEntityId(byte[] rowKey) + +
            +          Creates a raw entity ID.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static RawEntityIdfromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates a RawEntityId from the specified HBase row key.
            +static RawEntityIdfromKijiRowKey(byte[] kijiRowKey) + +
            +          Creates a RawEntityId from the specified Kiji row key.
            + RowKeyFormatgetFormat() + +
            +          
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + byte[]getKijiRowKey() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +RawEntityId

            +
            +public RawEntityId(byte[] rowKey)
            +
            +
            Creates a raw entity ID. +

            +

            +
            Parameters:
            rowKey - Kiji/HBase row key (both row keys are identical).
            +
            + + + + + + + + +
            +Method Detail
            + +

            +fromKijiRowKey

            +
            +public static RawEntityId fromKijiRowKey(byte[] kijiRowKey)
            +
            +
            Creates a RawEntityId from the specified Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key. +
            Returns:
            a new RawEntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public static RawEntityId fromHBaseRowKey(byte[] hbaseRowKey)
            +
            +
            Creates a RawEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key. +
            Returns:
            a new RawEntityId with the specified HBase row key.
            +
            +
            +
            + +

            +getFormat

            +
            +public RowKeyFormat getFormat()
            +
            +
            +

            +

            +
            Specified by:
            getFormat in class EntityId
            +
            +
            + +
            Returns:
            the format of this row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public byte[] getKijiRowKey()
            +
            +
            +

            +

            +
            Specified by:
            getKijiRowKey in class EntityId
            +
            +
            + +
            Returns:
            the Kiji row key as a byte array.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/SpecificCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/SpecificCellDecoder.html new file mode 100644 index 00000000..b8dd963a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/SpecificCellDecoder.html @@ -0,0 +1,290 @@ + + + + + + + +SpecificCellDecoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class SpecificCellDecoder<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellDecoder<T>
+      extended by org.kiji.schema.impl.SpecificCellDecoder<T>
+
            +
            +
            Type Parameters:
            T - The type of the decoded data.
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<T>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class SpecificCellDecoder<T>
            extends AvroCellDecoder<T>
            + + +

            +Decodes cells encoded using Avro into specific types. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            SpecificCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates specific Avro types.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  org.apache.avro.io.DatumReader<T>createDatumReader(org.apache.avro.Schema writer, + org.apache.avro.Schema reader) + +
            +          Factory for DatumReader instances.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.impl.AvroCellDecoder
            decodeAvro, decodeCell, decodeValue, getPayload
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +SpecificCellDecoder

            +
            +public SpecificCellDecoder(CellSpec cellSpec)
+                    throws IOException
            +
            +
            Initializes a cell decoder that creates specific Avro types. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createDatumReader

            +
            +protected org.apache.avro.io.DatumReader<T> createDatumReader(org.apache.avro.Schema writer,
+                                                              org.apache.avro.Schema reader)
            +
            +
            Factory for DatumReader instances. + + Sub-classes must create DatumReader implementations for specific or generic records. +

            +

            +
            Specified by:
            createDatumReader in class AvroCellDecoder<T>
            +
            +
            +
            Parameters:
            writer - Writer schema.
            reader - Reader schema. +
            Returns:
            a new DatumReader instance for the specified writer/reader schema combination.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/AbstractKijiTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/AbstractKijiTable.html new file mode 100644 index 00000000..da46f1bc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/AbstractKijiTable.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.AbstractKijiTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.AbstractKijiTable

            +
            + + + + + + + + + +
            +Packages that use AbstractKijiTable
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of AbstractKijiTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of AbstractKijiTable in org.kiji.schema.impl
            + classHBaseKijiTable + +
            +          A KijiTable that exposes the underlying HBase implementation.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/AvroCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/AvroCellDecoder.html new file mode 100644 index 00000000..ac663f71 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/AvroCellDecoder.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.AvroCellDecoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.AvroCellDecoder

            +
            + + + + + + + + + +
            +Packages that use AvroCellDecoder
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of AvroCellDecoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Subclasses of AvroCellDecoder in org.kiji.schema.impl
            + classGenericCellDecoder<T> + +
            +          Decodes cells encoded using Avro into generic types.
            + classSpecificCellDecoder<T> + +
            +          Decodes cells encoded using Avro into specific types.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/AvroCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/AvroCellEncoder.html new file mode 100644 index 00000000..52bf90e7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/AvroCellEncoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.AvroCellEncoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.AvroCellEncoder

            +
            +No usage of org.kiji.schema.impl.AvroCellEncoder +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/CounterCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/CounterCellDecoder.html new file mode 100644 index 00000000..f024cbee --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/CounterCellDecoder.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.CounterCellDecoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.CounterCellDecoder

            +
            + + + + + + + + + +
            +Packages that use CounterCellDecoder
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of CounterCellDecoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return CounterCellDecoder
            +static CounterCellDecoderCounterCellDecoder.get() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/CounterCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/CounterCellEncoder.html new file mode 100644 index 00000000..21d89dee --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/CounterCellEncoder.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.CounterCellEncoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.CounterCellEncoder

            +
            + + + + + + + + + +
            +Packages that use CounterCellEncoder
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of CounterCellEncoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return CounterCellEncoder
            +static CounterCellEncoderCounterCellEncoder.get() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultHBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultHBaseAdminFactory.html new file mode 100644 index 00000000..1e4a5415 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultHBaseAdminFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultHBaseAdminFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultHBaseAdminFactory

            +
            +No usage of org.kiji.schema.impl.DefaultHBaseAdminFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultHBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultHBaseFactory.html new file mode 100644 index 00000000..95d9ca9d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultHBaseFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultHBaseFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultHBaseFactory

            +
            +No usage of org.kiji.schema.impl.DefaultHBaseFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultHTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultHTableInterfaceFactory.html new file mode 100644 index 00000000..0c55e640 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultHTableInterfaceFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultHTableInterfaceFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultHTableInterfaceFactory

            +
            +No usage of org.kiji.schema.impl.DefaultHTableInterfaceFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultKijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultKijiCellEncoderFactory.html new file mode 100644 index 00000000..c7defd99 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultKijiCellEncoderFactory.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultKijiCellEncoderFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultKijiCellEncoderFactory

            +
            + + + + + + + + + +
            +Packages that use DefaultKijiCellEncoderFactory
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of DefaultKijiCellEncoderFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return DefaultKijiCellEncoderFactory
            +static DefaultKijiCellEncoderFactoryDefaultKijiCellEncoderFactory.get() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultKijiCounter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultKijiCounter.html new file mode 100644 index 00000000..432dfc89 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultKijiCounter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultKijiCounter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultKijiCounter

            +
            +No usage of org.kiji.schema.impl.DefaultKijiCounter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html new file mode 100644 index 00000000..e8c1910a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultKijiTableFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultKijiTableFactory

            +
            +No usage of org.kiji.schema.impl.DefaultKijiTableFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/GenericCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/GenericCellDecoder.html new file mode 100644 index 00000000..872c977a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/GenericCellDecoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.GenericCellDecoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.GenericCellDecoder

            +
            +No usage of org.kiji.schema.impl.GenericCellDecoder +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseAdminFactory.html new file mode 100644 index 00000000..6b91af73 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseAdminFactory.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Interface org.kiji.schema.impl.HBaseAdminFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.impl.HBaseAdminFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseAdminFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseAdminFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return HBaseAdminFactory
            + HBaseAdminFactoryHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            +  +

            + + + + + +
            +Uses of HBaseAdminFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement HBaseAdminFactory
            + classDefaultHBaseAdminFactory + +
            +          Factory for HBaseAdmin that creates concrete HBaseAdmin instances.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HBaseAdminFactory
            +static HBaseAdminFactoryDefaultHBaseAdminFactory.get() + +
            +           
            + HBaseAdminFactoryDefaultHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html new file mode 100644 index 00000000..239f4fed --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseDataRequestAdapter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseDataRequestAdapter

            +
            +No usage of org.kiji.schema.impl.HBaseDataRequestAdapter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseEntityId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseEntityId.html new file mode 100644 index 00000000..935b171f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseEntityId.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseEntityId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseEntityId

            +
            +No usage of org.kiji.schema.impl.HBaseEntityId +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKiji.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKiji.html new file mode 100644 index 00000000..3375f89d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKiji.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKiji (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKiji

            +
            +No usage of org.kiji.schema.impl.HBaseKiji +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiAdmin.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiAdmin.html new file mode 100644 index 00000000..8be9c51e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiAdmin.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiAdmin (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiAdmin

            +
            +No usage of org.kiji.schema.impl.HBaseKijiAdmin +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiFactory.html new file mode 100644 index 00000000..5f2831b6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiFactory

            +
            +No usage of org.kiji.schema.impl.HBaseKijiFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiRowData.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiRowData.html new file mode 100644 index 00000000..e82c1036 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiRowData.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiRowData (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiRowData

            +
            + + + + + + + + + +
            +Packages that use HBaseKijiRowData
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseKijiRowData in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HBaseKijiRowData
            + voidHBaseKijiRowData.merge(HBaseKijiRowData kijiRowData) + +
            +          Merges in the data from another HBaseKijiRowData instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html new file mode 100644 index 00000000..af9ba029 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html @@ -0,0 +1,219 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiRowScanner.Options (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiRowScanner.Options

            +
            + + + + + + + + + +
            +Packages that use HBaseKijiRowScanner.Options
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseKijiRowScanner.Options in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HBaseKijiRowScanner.Options
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory) + +
            +          Sets the cell decoder factory to use when reading cells from the scanner.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withDataRequest(KijiDataRequest dataRequest) + +
            +          Sets the data request used to generate the KijiRowScanner.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withHBaseResultScanner(ResultScanner hbaseResultScanner) + +
            +          Sets the HBase result scanner the KijiRowScanner will wrap.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withTable(HBaseKijiTable table) + +
            +          Sets the table being scanned.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type HBaseKijiRowScanner.Options
            HBaseKijiRowScanner(HBaseKijiRowScanner.Options options) + +
            +          Creates a new KijiRowScanner instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html new file mode 100644 index 00000000..8c4a2995 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiRowScanner (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiRowScanner

            +
            +No usage of org.kiji.schema.impl.HBaseKijiRowScanner +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiTable.html new file mode 100644 index 00000000..245a0d15 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiTable.html @@ -0,0 +1,244 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiTable

            +
            + + + + + + + + + +
            +Packages that use HBaseKijiTable
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseKijiTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HBaseKijiTable
            +static HBaseKijiTableHBaseKijiTable.downcast(KijiTable kijiTable) + +
            +          We know that all KijiTables are really HBaseKijiTables + instances.
            + HBaseKijiTableHBaseKijiRowScanner.Options.getTable() + +
            +          Gets the table being scanned.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HBaseKijiTable
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withTable(HBaseKijiTable table) + +
            +          Sets the table being scanned.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type HBaseKijiTable
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiTableReader(HBaseKijiTable table) + +
            +          Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase.
            HBaseKijiTableWriter(HBaseKijiTable table) + +
            +          Creates a non-buffered kiji table writer that sends modifications directly to Kiji.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html new file mode 100644 index 00000000..be4b6b66 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiTableReader (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiTableReader

            +
            +No usage of org.kiji.schema.impl.HBaseKijiTableReader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html new file mode 100644 index 00000000..47ddf989 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiTableWriter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiTableWriter

            +
            +No usage of org.kiji.schema.impl.HBaseKijiTableWriter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseMetaTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseMetaTable.html new file mode 100644 index 00000000..49578acc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseMetaTable.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseMetaTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseMetaTable

            +
            +No usage of org.kiji.schema.impl.HBaseMetaTable +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseSchemaTable.html new file mode 100644 index 00000000..37a36902 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseSchemaTable.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseSchemaTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseSchemaTable

            +
            +No usage of org.kiji.schema.impl.HBaseSchemaTable +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseSystemTable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseSystemTable.html new file mode 100644 index 00000000..7f8c41b6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseSystemTable.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseSystemTable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseSystemTable

            +
            +No usage of org.kiji.schema.impl.HBaseSystemTable +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html new file mode 100644 index 00000000..e7917946 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseTableKeyValueDatabase (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseTableKeyValueDatabase

            +
            +No usage of org.kiji.schema.impl.HBaseTableKeyValueDatabase +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html new file mode 100644 index 00000000..37b54951 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HColumnDescriptorComparator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HColumnDescriptorComparator

            +
            +No usage of org.kiji.schema.impl.HColumnDescriptorComparator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html new file mode 100644 index 00000000..a4db911d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HTableDescriptorComparator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HTableDescriptorComparator

            +
            +No usage of org.kiji.schema.impl.HTableDescriptorComparator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HTableInterfaceFactory.html new file mode 100644 index 00000000..f2219557 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HTableInterfaceFactory.html @@ -0,0 +1,339 @@ + + + + + + + +Uses of Interface org.kiji.schema.impl.HTableInterfaceFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.impl.HTableInterfaceFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use HTableInterfaceFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HTableInterfaceFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return HTableInterfaceFactory
            + HTableInterfaceFactoryHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            +  +

            + + + + + +
            +Uses of HTableInterfaceFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement HTableInterfaceFactory
            + classDefaultHTableInterfaceFactory + +
            +          Factory for HTableInterface that creates concrete HTable instances.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HTableInterfaceFactory
            +static HTableInterfaceFactoryDefaultHTableInterfaceFactory.get() + +
            +           
            + HTableInterfaceFactoryDefaultHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HTableInterfaceFactory
            +static voidHBaseSystemTable.install(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Installs a Kiji system table into a running HBase instance.
            +static voidHBaseSchemaTable.install(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static HTableInterfaceHBaseMetaTable.newMetaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates an HTableInterface for the specified table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaHashTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema hash table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaIdTable(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema ID table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaV5Table(KijiConfiguration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema V5 table.
            +static HTableInterfaceHBaseSystemTable.newSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Creates a new HTableInterface for the Kiji system table.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type HTableInterfaceFactory
            HBaseMetaTable(KijiConfiguration kijiConf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseSchemaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            HBaseSystemTable(KijiConfiguration kijiConf, + HTableInterfaceFactory factory) + +
            +          Connect to the HBase system table inside a Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html new file mode 100644 index 00000000..56d3fa25 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HashPrefixedEntityId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HashPrefixedEntityId

            +
            + + + + + + + + + +
            +Packages that use HashPrefixedEntityId
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HashPrefixedEntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HashPrefixedEntityId
            +static HashPrefixedEntityIdHashPrefixedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified HBase row key.
            +static HashPrefixedEntityIdHashPrefixedEntityId.fromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HashedEntityId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HashedEntityId.html new file mode 100644 index 00000000..ffb05494 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/HashedEntityId.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HashedEntityId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HashedEntityId

            +
            + + + + + + + + + +
            +Packages that use HashedEntityId
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HashedEntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HashedEntityId
            +static HashedEntityIdHashedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified HBase row key.
            +static HashedEntityIdHashedEntityId.fromKijiRowKey(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/InvalidColumnNameException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/InvalidColumnNameException.html new file mode 100644 index 00000000..e75b50b3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/InvalidColumnNameException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.InvalidColumnNameException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.InvalidColumnNameException

            +
            +No usage of org.kiji.schema.impl.InvalidColumnNameException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/KijiColumnPager.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/KijiColumnPager.html new file mode 100644 index 00000000..dbee7540 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/KijiColumnPager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.KijiColumnPager (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.KijiColumnPager

            +
            +No usage of org.kiji.schema.impl.KijiColumnPager +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/KijiColumnPagingNotEnabledException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/KijiColumnPagingNotEnabledException.html new file mode 100644 index 00000000..ea137119 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/KijiColumnPagingNotEnabledException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.KijiColumnPagingNotEnabledException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.KijiColumnPagingNotEnabledException

            +
            +No usage of org.kiji.schema.impl.KijiColumnPagingNotEnabledException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/KijiDataBuffer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/KijiDataBuffer.html new file mode 100644 index 00000000..c89075a7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/KijiDataBuffer.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.KijiDataBuffer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.KijiDataBuffer

            +
            + + + + + + + + + +
            +Packages that use KijiDataBuffer
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiDataBuffer in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiDataBuffer
            + KijiDataBuffer<T>KijiDataBuffer.add(EntityId id, + T value) + +
            +          Adds a buffer element to the buffer and associates it with the specified entity.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/MetadataRestorer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/MetadataRestorer.html new file mode 100644 index 00000000..5259f43e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/MetadataRestorer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.MetadataRestorer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.MetadataRestorer

            +
            +No usage of org.kiji.schema.impl.MetadataRestorer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/RawEntityId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/RawEntityId.html new file mode 100644 index 00000000..e37bf1ac --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/RawEntityId.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.RawEntityId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.RawEntityId

            +
            + + + + + + + + + +
            +Packages that use RawEntityId
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of RawEntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return RawEntityId
            +static RawEntityIdRawEntityId.fromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates a RawEntityId from the specified HBase row key.
            +static RawEntityIdRawEntityId.fromKijiRowKey(byte[] kijiRowKey) + +
            +          Creates a RawEntityId from the specified Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/SpecificCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/SpecificCellDecoder.html new file mode 100644 index 00000000..e10f2788 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/class-use/SpecificCellDecoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.SpecificCellDecoder (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.SpecificCellDecoder

            +
            +No usage of org.kiji.schema.impl.SpecificCellDecoder +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-frame.html new file mode 100644 index 00000000..68b11ea5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-frame.html @@ -0,0 +1,129 @@ + + + + + + + +org.kiji.schema.impl (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.schema.impl + + + + +
            +Interfaces  + +
            +HBaseAdminFactory +
            +HTableInterfaceFactory
            + + + + + + +
            +Classes  + +
            +AbstractKijiTable +
            +AvroCellDecoder +
            +AvroCellEncoder +
            +CounterCellDecoder +
            +CounterCellEncoder +
            +DefaultHBaseAdminFactory +
            +DefaultHBaseFactory +
            +DefaultHTableInterfaceFactory +
            +DefaultKijiCellEncoderFactory +
            +DefaultKijiCounter +
            +DefaultKijiTableFactory +
            +GenericCellDecoder +
            +HashedEntityId +
            +HashPrefixedEntityId +
            +HBaseDataRequestAdapter +
            +HBaseEntityId +
            +HBaseKiji +
            +HBaseKijiAdmin +
            +HBaseKijiFactory +
            +HBaseKijiRowData +
            +HBaseKijiRowScanner +
            +HBaseKijiRowScanner.Options +
            +HBaseKijiTable +
            +HBaseKijiTableReader +
            +HBaseKijiTableWriter +
            +HBaseMetaTable +
            +HBaseSchemaTable +
            +HBaseSystemTable +
            +HBaseTableKeyValueDatabase +
            +HColumnDescriptorComparator +
            +HTableDescriptorComparator +
            +KijiColumnPager +
            +KijiDataBuffer +
            +MetadataRestorer +
            +RawEntityId +
            +SpecificCellDecoder
            + + + + + + +
            +Exceptions  + +
            +InvalidColumnNameException +
            +KijiColumnPagingNotEnabledException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-summary.html new file mode 100644 index 00000000..09ee7388 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-summary.html @@ -0,0 +1,361 @@ + + + + + + + +org.kiji.schema.impl (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.impl +

            +Implementations for the main KijiSchema classes and interfaces. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + +
            +Interface Summary
            HBaseAdminFactoryFactory for HBaseAdmin.
            HTableInterfaceFactoryFactory for HTableInterface instances.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AbstractKijiTableMain handle for a Kiji table with basic functionality.
            AvroCellDecoder<T>Base class for decoders that read Kiji cells encoded using Avro.
            AvroCellEncoderSerializes a KijiCell.
            CounterCellDecoderCell decoder for counters.
            CounterCellEncoderEncoder for Kiji counters.
            DefaultHBaseAdminFactoryFactory for HBaseAdmin that creates concrete HBaseAdmin instances.
            DefaultHBaseFactoryFactory for HBase instances based on URIs.
            DefaultHTableInterfaceFactoryFactory for HTableInterface that creates concrete HTable instances.
            DefaultKijiCellEncoderFactoryFactory for cell encoders.
            DefaultKijiCounterThe default implementation of a Kiji counter, which contains the data in a counter cell + of a column.
            DefaultKijiTableFactoryThe default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open().
            GenericCellDecoder<T>Decodes cells encoded using Avro into generic types.
            HashedEntityIdImplements the hashed row key format.
            HashPrefixedEntityIdImplements the hash-prefixed row key format.
            HBaseDataRequestAdapterWraps a KijiDataRequest to expose methods that generate meaningful objects in HBase + land, like Puts and Gets.
            HBaseEntityIdEntity ID encapsulating an HBase row key.
            HBaseKijiKiji instance class that contains configuration and table + information.
            HBaseKijiAdminAdministration API for managing a Kiji instance that uses HBase as its underlying data store.
            HBaseKijiFactoryFactory for constructing instances of HBaseKiji.
            HBaseKijiRowDataAn implementation of KijiRowData that wraps an HBase Result object.
            HBaseKijiRowScannerThe internal implementation of KijiRowScanner that reads from HTables.
            HBaseKijiRowScanner.OptionsA class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            HBaseKijiTableA KijiTable that exposes the underlying HBase implementation.
            HBaseKijiTableReaderReads from a kiji table by sending the requests directly to the HBase tables.
            HBaseKijiTableWriterMakes modifications to a Kiji table by sending requests directly to HBase from the local client.
            HBaseMetaTableAn implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            HBaseSchemaTable + Mapping between schema IDs, hashes and Avro schema objects.
            HBaseSystemTableThe Kiji system table that is stored in HBase.
            HBaseTableKeyValueDatabaseManages key-value pairs on a per table basis.
            HColumnDescriptorComparatorComparator for HColumnDescriptors.
            HTableDescriptorComparatorCompares HTableDescriptors.
            KijiColumnPagerFetches new pages of column data in Kiji, and maintains state for which page each column is on.
            KijiDataBuffer<T>A buffer used to hold data entries waiting to be written to a KijiTable.
            MetadataRestorerMetadata restorer backups up meta info to MetadataBackup records and can restore metadata to the + meta and schema tables.
            RawEntityIdImplements the raw row key format.
            SpecificCellDecoder<T>Decodes cells encoded using Avro into specific types.
            +  + +

            + + + + + + + + + + + + + +
            +Exception Summary
            InvalidColumnNameExceptionThrown when kiji encounters a column name that is not valid.
            KijiColumnPagingNotEnabledExceptionThrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column.
            +  + +

            +

            +Package org.kiji.schema.impl Description +

            + +

            +Implementations for the main KijiSchema classes and interfaces. + +

            + Users generally shouldn't need to reference any of these classes directly, but rather use the + classes presented by the org.kiji.schema package. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-tree.html new file mode 100644 index 00000000..dbb957dc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-tree.html @@ -0,0 +1,204 @@ + + + + + + + +org.kiji.schema.impl Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-use.html new file mode 100644 index 00000000..1cc88525 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/impl/package-use.html @@ -0,0 +1,274 @@ + + + + + + + +Uses of Package org.kiji.schema.impl (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.impl

            +
            + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.impl
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.impl used by org.kiji.schema
            HBaseAdminFactory + +
            +          Factory for HBaseAdmin.
            HTableInterfaceFactory + +
            +          Factory for HTableInterface instances.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.impl used by org.kiji.schema.impl
            AbstractKijiTable + +
            +          Main handle for a Kiji table with basic functionality.
            AvroCellDecoder + +
            +          Base class for decoders that read Kiji cells encoded using Avro.
            CounterCellDecoder + +
            +          Cell decoder for counters.
            CounterCellEncoder + +
            +          Encoder for Kiji counters.
            DefaultKijiCellEncoderFactory + +
            +          Factory for cell encoders.
            HashedEntityId + +
            +          Implements the hashed row key format.
            HashPrefixedEntityId + +
            +          Implements the hash-prefixed row key format.
            HBaseAdminFactory + +
            +          Factory for HBaseAdmin.
            HBaseKijiRowData + +
            +          An implementation of KijiRowData that wraps an HBase Result object.
            HBaseKijiRowScanner.Options + +
            +          A class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            HBaseKijiTable + +
            +          A KijiTable that exposes the underlying HBase implementation.
            HTableInterfaceFactory + +
            +          Factory for HTableInterface instances.
            KijiDataBuffer + +
            +          A buffer used to hold data entries waiting to be written to a KijiTable.
            RawEntityId + +
            +          Implements the raw row key format.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/ColumnNameTranslator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/ColumnNameTranslator.html new file mode 100644 index 00000000..856ee508 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/ColumnNameTranslator.html @@ -0,0 +1,354 @@ + + + + + + + +ColumnNameTranslator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class ColumnNameTranslator

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.ColumnNameTranslator
+
            +
            +
            +
            @ApiAudience.Public
+public final class ColumnNameTranslator
            extends Object
            + + +

            +Translates between HTable and Kiji table column names. + +

            This class defines a mapping between names of HBase HTable families/qualifiers and + Kiji table family/qualifiers.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static StringSEPARATOR + +
            +          Used to separate the Kiji family from the Kiji qualifier in an HBase qualifier.
            +  + + + + + + + + + + +
            +Constructor Summary
            ColumnNameTranslator(KijiTableLayout tableLayout) + +
            +          Creates a new ColumnNameTranslator instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiTableLayoutgetTableLayout() + +
            +           
            + HBaseColumnNametoHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            + KijiColumnNametoKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SEPARATOR

            +
            +public static final String SEPARATOR
            +
            +
            Used to separate the Kiji family from the Kiji qualifier in an HBase qualifier. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +ColumnNameTranslator

            +
            +public ColumnNameTranslator(KijiTableLayout tableLayout)
            +
            +
            Creates a new ColumnNameTranslator instance. +

            +

            +
            Parameters:
            tableLayout - The layout of the table to translate column names for.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toKijiColumnName

            +
            +public KijiColumnName toKijiColumnName(HBaseColumnName hbaseColumnName)
+                                throws NoSuchColumnException
            +
            +
            Translates an HBase column name to a Kiji column name. +

            +

            +
            Parameters:
            hbaseColumnName - The HBase column name. +
            Returns:
            The Kiji column name. +
            Throws: +
            NoSuchColumnException - If the column name cannot be found.
            +
            +
            +
            + +

            +toHBaseColumnName

            +
            +public HBaseColumnName toHBaseColumnName(KijiColumnName kijiColumnName)
+                                  throws NoSuchColumnException
            +
            +
            Translates a Kiji column name into an HBase column name. +

            +

            +
            Parameters:
            kijiColumnName - The Kiji column name. +
            Returns:
            The HBase column name. +
            Throws: +
            NoSuchColumnException - If the column name cannot be found.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout()
            +
            +
            + +
            Returns:
            the table layout.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/InvalidLayoutException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/InvalidLayoutException.html new file mode 100644 index 00000000..4b128f01 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/InvalidLayoutException.html @@ -0,0 +1,280 @@ + + + + + + + +InvalidLayoutException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class InvalidLayoutException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.layout.InvalidLayoutException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Direct Known Subclasses:
            SchemaClassNotFoundException
            +
            +
            +
            +
            @ApiAudience.Public
+public class InvalidLayoutException
            extends IOException
            + + +

            +Thrown when an invalid Kiji layout is encountered. Possible reasons why a layout may be + invalid include: +

              +
            • Invalid data schemas.
              • +
            • Missing family or column names.
              • +
            • The family or column ids were not assigned.
              • +
            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            InvalidLayoutException(KijiTableLayout tableLayout, + String reason) + +
            +          Constructs an exception indicated a table layout is invalid.
            InvalidLayoutException(String reason) + +
            +          Creates a new InvalidLayoutException with the specified reason.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +InvalidLayoutException

            +
            +public InvalidLayoutException(String reason)
            +
            +
            Creates a new InvalidLayoutException with the specified reason. +

            +

            +
            Parameters:
            reason - A message describing the reason the layout is invalid.
            +
            +
            + +

            +InvalidLayoutException

            +
            +public InvalidLayoutException(KijiTableLayout tableLayout,
+                              String reason)
            +
            +
            Constructs an exception indicated a table layout is invalid. +

            +

            +
            Parameters:
            tableLayout - The table layout that is invalid.
            reason - A message describing the reason the layout is invalid.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html new file mode 100644 index 00000000..1c7e4c20 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html @@ -0,0 +1,351 @@ + + + + + + + +KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
+
            +
            +
            Enclosing class:
            KijiTableLayout.LocalityGroupLayout.FamilyLayout
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            extends Object
            + + +

            +Concrete layout of a column. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc desc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout reference) + +
            +          Builds a new column layout instance from a descriptor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + ColumnDescgetDesc() + +
            +           
            + KijiTableLayout.LocalityGroupLayout.FamilyLayoutgetFamily() + +
            +           
            + ColumnIdgetId() + +
            +           
            + StringgetName() + +
            +           
            + Set<String>getNames() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout

            +
            +public KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc desc,
+                                                                     KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout reference)
+                                                              throws InvalidLayoutException
            +
            +
            Builds a new column layout instance from a descriptor. +

            +

            +
            Parameters:
            desc - Column descriptor.
            reference - Optional reference layout, or null. +
            Throws: +
            InvalidLayoutException - if the layout is invalid or inconsistent.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDesc

            +
            +public ColumnDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this column.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the primary name for the column.
            +
            +
            +
            + +

            +getNames

            +
            +public Set<String> getNames()
            +
            +
            + +
            Returns:
            the name and aliases for the column.
            +
            +
            +
            + +

            +getId

            +
            +public ColumnId getId()
            +
            +
            + +
            Returns:
            the ID associated to this column.
            +
            +
            +
            + +

            +getFamily

            +
            +public KijiTableLayout.LocalityGroupLayout.FamilyLayout getFamily()
            +
            +
            + +
            Returns:
            the family this column belongs to.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html new file mode 100644 index 00000000..aa167cd1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html @@ -0,0 +1,468 @@ + + + + + + + +KijiTableLayout.LocalityGroupLayout.FamilyLayout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout.LocalityGroupLayout.FamilyLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout
+
            +
            +
            Enclosing class:
            KijiTableLayout.LocalityGroupLayout
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout.LocalityGroupLayout.FamilyLayout
            extends Object
            + + +

            +Concrete layout of a family. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            + classKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout + +
            +          Concrete layout of a column.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc familyDesc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout reference) + +
            +          Builds a new family layout instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + com.google.common.collect.BiMap<ColumnId,String>getColumnIdNameMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>getColumnMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>getColumns() + +
            +           
            + FamilyDescgetDesc() + +
            +           
            + ColumnIdgetId() + +
            +           
            + KijiTableLayout.LocalityGroupLayoutgetLocalityGroup() + +
            +           
            + StringgetName() + +
            +           
            + Set<String>getNames() + +
            +           
            + booleanisGroupType() + +
            +           
            + booleanisMapType() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableLayout.LocalityGroupLayout.FamilyLayout

            +
            +public KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc familyDesc,
+                                                        KijiTableLayout.LocalityGroupLayout.FamilyLayout reference)
+                                                 throws InvalidLayoutException
            +
            +
            Builds a new family layout instance. +

            +

            +
            Parameters:
            familyDesc - Descriptor of the family.
            reference - Optional reference family layout, or null. +
            Throws: +
            InvalidLayoutException - if the layout is invalid or inconsistent.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDesc

            +
            +public FamilyDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this family.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the primary name for the family.
            +
            +
            +
            + +

            +getNames

            +
            +public Set<String> getNames()
            +
            +
            + +
            Returns:
            the family name and aliases.
            +
            +
            +
            + +

            +getId

            +
            +public ColumnId getId()
            +
            +
            + +
            Returns:
            the column ID assigned to this family.
            +
            +
            +
            + +

            +getColumns

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout> getColumns()
            +
            +
            + +
            Returns:
            the columns in this family.
            +
            +
            +
            + +

            +getColumnMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout> getColumnMap()
            +
            +
            + +
            Returns:
            the mapping from column names (no aliases) to column layouts.
            +
            +
            +
            + +

            +getColumnIdNameMap

            +
            +public com.google.common.collect.BiMap<ColumnId,String> getColumnIdNameMap()
            +
            +
            + +
            Returns:
            the bidirectional mapping between column names (no aliases) and IDs.
            +
            +
            +
            + +

            +getLocalityGroup

            +
            +public KijiTableLayout.LocalityGroupLayout getLocalityGroup()
            +
            +
            + +
            Returns:
            the locality group this family belongs to.
            +
            +
            +
            + +

            +isGroupType

            +
            +public boolean isGroupType()
            +
            +
            + +
            Returns:
            whether this is a group-type family.
            +
            +
            +
            + +

            +isMapType

            +
            +public boolean isMapType()
            +
            +
            + +
            Returns:
            whether this is a map-type family.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html new file mode 100644 index 00000000..ea135834 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html @@ -0,0 +1,428 @@ + + + + + + + +KijiTableLayout.LocalityGroupLayout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout.LocalityGroupLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout
+
            +
            +
            Enclosing class:
            KijiTableLayout
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout.LocalityGroupLayout
            extends Object
            + + +

            +Concrete layout of a locality group. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            + classKijiTableLayout.LocalityGroupLayout.FamilyLayout + +
            +          Concrete layout of a family.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc lgDesc, + KijiTableLayout.LocalityGroupLayout reference) + +
            +          Constructs a locality group layout.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + LocalityGroupDescgetDesc() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilies() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>getFamilyIdNameMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilyMap() + +
            +           
            + ColumnIdgetId() + +
            +           
            + StringgetName() + +
            +           
            + Set<String>getNames() + +
            +           
            + KijiTableLayoutgetTableLayout() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableLayout.LocalityGroupLayout

            +
            +public KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc lgDesc,
+                                           KijiTableLayout.LocalityGroupLayout reference)
+                                    throws InvalidLayoutException
            +
            +
            Constructs a locality group layout. +

            +

            +
            Parameters:
            lgDesc - Locality group descriptor.
            reference - Optional reference locality group, or null. +
            Throws: +
            InvalidLayoutException - if the layout is invalid or inconsistent.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout()
            +
            +
            + +
            Returns:
            the table layout this locality group belongs to.
            +
            +
            +
            + +

            +getDesc

            +
            +public LocalityGroupDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this locality group.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the locality group primary name.
            +
            +
            +
            + +

            +getNames

            +
            +public Set<String> getNames()
            +
            +
            + +
            Returns:
            the locality group name and aliases.
            +
            +
            +
            + +

            +getId

            +
            +public ColumnId getId()
            +
            +
            + +
            Returns:
            the ID associated to this locality group.
            +
            +
            +
            + +

            +getFamilies

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilies()
            +
            +
            + +
            Returns:
            the families in this locality group, in no particular order.
            +
            +
            +
            + +

            +getFamilyMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilyMap()
            +
            +
            + +
            Returns:
            the mapping from family names and aliases to family layouts.
            +
            +
            +
            + +

            +getFamilyIdNameMap

            +
            +public com.google.common.collect.BiMap<ColumnId,String> getFamilyIdNameMap()
            +
            +
            + +
            Returns:
            the bidirectional mapping between family names (no alias) and IDs.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.html new file mode 100644 index 00000000..addb2c04 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayout.html @@ -0,0 +1,872 @@ + + + + + + + +KijiTableLayout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout
            extends Object
            + + +

            +Layout of a Kiji table. + +

            + Kiji uses the term layout to describe the structure of a table. + Kiji does not use the term schema to avoid confusion with Avro schemas or XML schemas. +

            + +

            + KijiTableLayout wraps a layout descriptor represented as a + TableLayoutDesc Avro record. + KijiTableLayout provides strict validation and accessors to navigate through the layout. +

            + +

            Overall structure

            +

            At the top-level, a table contains: +

              +
            • the table name and description;
              • +
            • how row keys are encoded;
              • +
            • the table locality groups.
              • +
            +

            + +

            Each locality group has: +

              +
            • a primary name, unique within the table, a description and some name aliases;
              • +
            • whether the data is to be stored in memory or on disk;
              • +
            • data retention lifetime;
              • +
            • maximum number of versions to keep;
              • +
            • type of compression;
              • +
            • column families stored in this locality group
              • +
            +

            + +

            Each column family has: +

              +
            • a primary name, globally unique within the table, + a description and some name aliases;
              • +
            • for map-type families, the Avro schema of the cell values;
              • +
            • for group-type families, the collection of columns in the group.
              • +
            +

            + +

            Each column in a group-type family has: +

              +
            • a primary name, unique within the family, a description and some name aliases;
              • +
            • an Avro schema.
              • +
            +

            + +

            Layout descriptors

            + + Layout descriptors are represented using + TableLayoutDesc Avro records. + Layout descriptors come in two flavors: concrete layouts and layout updates. + +

            Concrete layout descriptors

            + A concrete layout descriptors is an absolute, standalone description of a table layout, which + does not reference or build upon any previous version of the table layout. Column IDs have + been assigned to all locality groups, families and columns. + +

            Layout update descriptors

            + A table layout update descriptor builds on a reference table layout, and describes layout + modification to apply on the reference layout. + The reference table layout is specified by writing the ID of the reference layout + (TableLayoutDesc.layout_id) into the TableLayoutDesc.reference_layout. + This mechanism prevents race conditions when updating the layout of a table. + The first layout of a newly created table has no reference layout. + +

            During a layout update, the user may delete or declare new locality groups, families and/or + columns. The user may also modify existing locality groups, families and/or columns. + +

            The result of applying a layout update on top of a concrete reference layout is a new + concrete layout. + +

            Names

            + +

            Layout entities are uniquely identified through their primary names. + Name aliases can be freely updated, as long as uniqueness requirements are met. + Primary name updates must be explicitly annotated by setting the renamedFrom field of + the entity being renamed. + The name of a table cannot be changed. + +

            Names of tables, locality groups, families and column qualifiers must be valid identifiers. + Name validation occurs in KijiNameValidator. + +

            Validation rules

            + +
              +
            • Table names, locality group names, family names, and column names in a group-type family + must be valid identifiers (no punctuation or symbols). + Note: map-type family qualifiers are free-form, but do never appear in a table layout. +
            • Locality group names and aliases must be unique within the table. +
            • Family names and aliases must be unique within the table. +
            • Group-type family qualifiers must be unique within the family. +
            • The type of a family (map-type or group-type) cannot be changed. +
            • A family cannot be moved into a different locality group. +
            • The encoding of Kiji cells (hash, UID, final) cannot be modified. +
            • The schema of a Kiji cell can only be changed to a schema that is compatible with + all the former schemas of the column. Schema compatibility requires that the new schema + allows decoding all former schemas associated to the column or the map-type family. +
            + +

            Row keys encoding

            + + A row in a Kiji table is identified by its Kiji row key. Kiji row keys are converted into HBase + row keys according to the row key encoding specified in the table layout: +
              +
            • Raw encoding: the user has direct control over the encoding of row keys in the HBase + table. In other words, the HBase row key is exactly the Kiji row key. + See RawEntityId. +
              • +
            • Hashed: the HBase row key is computed as a hash of the Kiji row key. + See HashedEntityId. +
              • +
            • Hash-prefixed: the HBase row key is computed as the concatenation of a hash of the + Kiji row key and the Kiji row key itself. + See HashPrefixedEntityId. +
              • +
            + + Hashing allows to spread the rows evenly across all the regions in the table. + +

            Cell schema

            + + Kiji cells are encoded according to a schema specified via + CellSchema Avro records. + Kiji provides various cell encoding schemes: +
              +
            • Hash: each Kiji cell is encoded as a hash of the Avro schema, followed by the binary + encoding of the Avro value. +
              • +
            • UID: each Kiji cell is encoded as the unique ID of the Avro schema, followed by the + binary encoding of the Avro value. +
              • +
            • Final: each Kiji cell is encoded as the binary encoding of the Avro value. +
              • +
            + See KijiCellEncoder + and KijiCellDecoder + for more implementation details. + +

            Column IDs

            + + For storage efficiency purposes, Kiji family and column names are translated into short + HBase column names. + The translation happens in + ColumnNameTranslator + and relies on + ColumnId. + Column IDs are assigned automatically by KijiTableLayout. + The user may specify column IDs manually. KijiTableLayout checks the consistency of column IDs. + +

            Column IDs cannot be changed (a column ID change is equivalent to deleting the existing column + and then re-creating it as a new empty column). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            + classKijiTableLayout.LocalityGroupLayout + +
            +          Concrete layout of a locality group.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableLayout(TableLayoutDesc desc, + KijiTableLayout reference) + +
            +          Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiTableLayoutcreateFromEffectiveJson(InputStream istream) + +
            +          Loads a table layout from the specified JSON text.
            +static KijiTableLayoutcreateFromEffectiveJsonResource(String resource) + +
            +          Loads a table layout from the specified resource as JSON.
            + booleanequals(Object other) + +
            +          
            + booleanexists(KijiColumnName column) + +
            +          Reports whether a column exists.
            + SchemaStoragegetCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            + CellSchemagetCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            + CellSpecgetCellSpec(KijiColumnName column) + +
            +           
            + Set<KijiColumnName>getColumnNames() + +
            +           
            + TableLayoutDescgetDesc() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilies() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilyMap() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>getLocalityGroupIdNameMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout>getLocalityGroupMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout>getLocalityGroups() + +
            +           
            + StringgetName() + +
            +           
            + org.apache.avro.SchemagetSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            + inthashCode() + +
            +          
            +static org.apache.avro.SchemareadAvroSchema(CellSchema avro) + +
            +          Reads the Avro schema from the table layout.
            +static TableLayoutDescreadTableLayoutDescFromJSON(InputStream istream) + +
            +          Reads a table layout descriptor from its JSON serialized form.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiTableLayout

            +
            +public KijiTableLayout(TableLayoutDesc desc,
+                       KijiTableLayout reference)
+                throws InvalidLayoutException
            +
            +
            Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout. +

            +

            +
            Parameters:
            desc - Avro layout descriptor (relative to the reference layout).
            reference - Optional reference layout, or null. +
            Throws: +
            InvalidLayoutException - if the descriptor is invalid or inconsistent wrt reference.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDesc

            +
            +public TableLayoutDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this table layout.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the table name.
            +
            +
            +
            + +

            +getLocalityGroups

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout> getLocalityGroups()
            +
            +
            + +
            Returns:
            the locality groups in the table, in no particular order.
            +
            +
            +
            + +

            +getLocalityGroupIdNameMap

            +
            +public com.google.common.collect.BiMap<ColumnId,String> getLocalityGroupIdNameMap()
            +
            +
            + +
            Returns:
            the bidirectional mapping between locality group names (no alias) and IDs.
            +
            +
            +
            + +

            +getLocalityGroupMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout> getLocalityGroupMap()
            +
            +
            + +
            Returns:
            the map from locality group names and aliases to layouts.
            +
            +
            +
            + +

            +getFamilyMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilyMap()
            +
            +
            + +
            Returns:
            the mapping from family names and aliases to family layouts in the table.
            +
            +
            +
            + +

            +getFamilies

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilies()
            +
            +
            + +
            Returns:
            all the families in the table, in no particular order.
            +
            +
            +
            + +

            +getColumnNames

            +
            +public Set<KijiColumnName> getColumnNames()
            +
            +
            + +
            Returns:
            all the primary column names in the table, including map-type families.
            +
            +
            +
            + +

            +getCellSchema

            +
            +public CellSchema getCellSchema(KijiColumnName columnName)
+                         throws NoSuchColumnException
            +
            +
            Gets the schema for a column. +

            +

            +
            Parameters:
            columnName - The name of the column to get the schema for. +
            Returns:
            the schema of the specified column. +
            Throws: +
            NoSuchColumnException - if the column does not exist.
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema(KijiColumnName columnName)
+                                 throws InvalidLayoutException,
+                                        NoSuchColumnException
            +
            +
            Reports the schema of the specified column. +

            +

            +
            Parameters:
            columnName - Column name. +
            Returns:
            the schema of the column. +
            Throws: +
            InvalidLayoutException - if the layout is invalid. +
            NoSuchColumnException - if the column does not exist.
            +
            +
            +
            + +

            +getCellFormat

            +
            +public SchemaStorage getCellFormat(KijiColumnName column)
+                            throws NoSuchColumnException
            +
            +
            Reports the cell format for the specified column. +

            +

            +
            Parameters:
            column - Column name. +
            Returns:
            the cell format for the column. +
            Throws: +
            NoSuchColumnException - if the column does not exist.
            +
            +
            +
            + +

            +getCellSpec

            +
            +public CellSpec getCellSpec(KijiColumnName column)
+                     throws IOException
            +
            +
            +
            Parameters:
            column - Column to look up. +
            Returns:
            the cell specification for a given column. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +exists

            +
            +public boolean exists(KijiColumnName column)
            +
            +
            Reports whether a column exists. +

            +

            +
            Parameters:
            column - Column name. +
            Returns:
            whether the specified column exists.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +readAvroSchema

            +
            +public static org.apache.avro.Schema readAvroSchema(CellSchema avro)
+                                             throws InvalidLayoutException
            +
            +
            Reads the Avro schema from the table layout. +

            +

            +
            Parameters:
            avro - The portion of the table layout record to read from. +
            Returns:
            The avro schema, or null if the schema is type "counter". +
            Throws: +
            InvalidLayoutException - if the table layout is invalid and the schema can't be read.
            +
            +
            +
            + +

            +createFromEffectiveJsonResource

            +
            +public static KijiTableLayout createFromEffectiveJsonResource(String resource)
+                                                       throws IOException
            +
            +
            Loads a table layout from the specified resource as JSON. +

            +

            +
            Parameters:
            resource - Path of the resource containing the JSON layout description. +
            Returns:
            the parsed table layout. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +createFromEffectiveJson

            +
            +public static KijiTableLayout createFromEffectiveJson(InputStream istream)
+                                               throws IOException
            +
            +
            Loads a table layout from the specified JSON text. +

            +

            +
            Parameters:
            istream - Input stream containing the JSON text. +
            Returns:
            the parsed table layout. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +readTableLayoutDescFromJSON

            +
            +public static TableLayoutDesc readTableLayoutDescFromJSON(InputStream istream)
+                                                   throws IOException
            +
            +
            Reads a table layout descriptor from its JSON serialized form. +

            +

            +
            Parameters:
            istream - JSON input stream. +
            Returns:
            the decoded table layout descriptor. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayoutDatabase.html new file mode 100644 index 00000000..170fe537 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/KijiTableLayoutDatabase.html @@ -0,0 +1,431 @@ + + + + + + + +KijiTableLayoutDatabase (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Interface KijiTableLayoutDatabase

            +
            +
            All Known Implementing Classes:
            HBaseMetaTable, HBaseTableLayoutDatabase, KijiMetaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiTableLayoutDatabase
            + + +

            +A database of Kiji table layouts. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiTableLayoutgetTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + List<KijiTableLayout>getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            + voidlayoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +          Restores a table layout history from a backup.
            + List<TableLayoutBackupEntry>layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            + List<String>listTables() + +
            +          Lists the tables in this Kiji instance.
            + voidremoveAllTableLayoutVersions(String table) + +
            +          Removes all layout information for a particular table.
            + voidremoveRecentTableLayoutVersions(String table, + int numVersions) + +
            +          Removes the most recent layout information for a given table.
            + KijiTableLayoutupdateTableLayout(String table, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +listTables

            +
            +List<String> listTables()
+                        throws IOException
            +
            +
            Lists the tables in this Kiji instance. +

            +

            + +
            Returns:
            The list of table names. +
            Throws: +
            IOException - If the list of tables cannot be retrieved.
            +
            +
            +
            + +

            +updateTableLayout

            +
            +KijiTableLayout updateTableLayout(String table,
+                                  TableLayoutDesc update)
+                                  throws IOException
            +
            +
            Sets a table's layout. Also calls validateAndAssignLayout(). +

            +

            +
            Parameters:
            table - The name of the Kiji table to affect.
            update - Descriptor for the layout update. +
            Returns:
            the new effective layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableLayout

            +
            +KijiTableLayout getTableLayout(String table)
+                               throws IOException
            +
            +
            Gets the most recent versions of the layout for a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            The table's layout. +
            Throws: +
            IOException - If there is an error or no such table.
            +
            +
            +
            + +

            +getTableLayoutVersions

            +
            +List<KijiTableLayout> getTableLayoutVersions(String table,
+                                             int numVersions)
+                                             throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the table layout. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the layout for the table, sorted by + most-recent-first. If there are no layouts, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedTableLayoutVersions

            +
            +NavigableMap<Long,KijiTableLayout> getTimedTableLayoutVersions(String table,
+                                                               int numVersions)
+                                                               throws IOException
            +
            +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values the most recent versions of the layout for the table, and + keys the corresponding timestamps, ordered from most recent first to least recent last. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +layoutsToBackup

            +
            +List<TableLayoutBackupEntry> layoutsToBackup(String table)
+                                             throws IOException
            +
            +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableLayoutBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllTableLayoutVersions

            +
            +void removeAllTableLayoutVersions(String table)
+                                  throws IOException
            +
            +
            Removes all layout information for a particular table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeRecentTableLayoutVersions

            +
            +void removeRecentTableLayoutVersions(String table,
+                                     int numVersions)
+                                     throws IOException
            +
            +
            Removes the most recent layout information for a given table. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +layoutsFromBackup

            +
            +void layoutsFromBackup(String tableName,
+                       List<TableLayoutBackupEntry> tableBackup)
+                       throws IOException
            +
            +
            Restores a table layout history from a backup. +

            +

            +
            Parameters:
            tableName - The name of the table to restore layouts for.
            tableBackup - Table layout backup entries to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/SchemaClassNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/SchemaClassNotFoundException.html new file mode 100644 index 00000000..7cb2ee16 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/SchemaClassNotFoundException.html @@ -0,0 +1,253 @@ + + + + + + + +SchemaClassNotFoundException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class SchemaClassNotFoundException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.layout.InvalidLayoutException
+                  extended by org.kiji.schema.layout.SchemaClassNotFoundException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class SchemaClassNotFoundException
            extends InvalidLayoutException
            + + +

            +Thrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path). +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            SchemaClassNotFoundException(String message) + +
            +          Creates a new SchemaClassNotFoundException with the specified detail message..
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +SchemaClassNotFoundException

            +
            +public SchemaClassNotFoundException(String message)
            +
            +
            Creates a new SchemaClassNotFoundException with the specified detail message.. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/TableLayoutSerializer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/TableLayoutSerializer.html new file mode 100644 index 00000000..f063a6f1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/TableLayoutSerializer.html @@ -0,0 +1,393 @@ + + + + + + + +TableLayoutSerializer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class TableLayoutSerializer

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.TableLayoutSerializer
+
            +
            +
            +
            @ApiAudience.Framework
+public final class TableLayoutSerializer
            extends Object
            + + +

            +Serialize TableLayout instances into job configurations. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringCONF_INPUT_TABLE_LAYOUT + +
            +          The configuration variable that stores the avro json-encoded input table layout.
            +static StringCONF_OUTPUT_TABLE_LAYOUT + +
            +          The configuration variable that stores output table layout.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiTableLayoutreadInputTableLayout(Configuration conf) + +
            +          Reads an input table layout from the configuration.
            +static KijiTableLayoutreadOutputTableLayout(Configuration conf) + +
            +          Reads an output table layout from the configuration.
            +static KijiTableLayoutreadTableLayout(String confKey, + Configuration conf) + +
            +          Reads a table layout from the configuration.
            +static voidserializeInputTableLayout(KijiTableLayout tableLayout, + Configuration conf) + +
            +          Serializes the table layout into a configuration object for input.
            +static voidserializeOutputTableLayout(KijiTableLayout tableLayout, + Configuration conf) + +
            +          Serializes the table layout into a configuration object for output.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +CONF_INPUT_TABLE_LAYOUT

            +
            +public static final String CONF_INPUT_TABLE_LAYOUT
            +
            +
            The configuration variable that stores the avro json-encoded input table layout. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +CONF_OUTPUT_TABLE_LAYOUT

            +
            +public static final String CONF_OUTPUT_TABLE_LAYOUT
            +
            +
            The configuration variable that stores output table layout. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +readTableLayout

            +
            +public static KijiTableLayout readTableLayout(String confKey,
+                                              Configuration conf)
+                                       throws IOException
            +
            +
            Reads a table layout from the configuration. +

            +

            +
            Parameters:
            confKey - The configuration key for the table layout.
            conf - The configuration storing the table layout. +
            Returns:
            the TableLayout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +serializeInputTableLayout

            +
            +public static void serializeInputTableLayout(KijiTableLayout tableLayout,
+                                             Configuration conf)
+                                      throws IOException
            +
            +
            Serializes the table layout into a configuration object for input. +

            +

            +
            Parameters:
            tableLayout - The table layout to serialize.
            conf - The configuration object to store the layout into. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +serializeOutputTableLayout

            +
            +public static void serializeOutputTableLayout(KijiTableLayout tableLayout,
+                                              Configuration conf)
+                                       throws IOException
            +
            +
            Serializes the table layout into a configuration object for output. +

            +

            +
            Parameters:
            tableLayout - The table layout to serialize.
            conf - The configuration object to store the layout into. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +readInputTableLayout

            +
            +public static KijiTableLayout readInputTableLayout(Configuration conf)
+                                            throws IOException
            +
            +
            Reads an input table layout from the configuration. +

            +

            +
            Parameters:
            conf - The configuration storing the table layout. +
            Returns:
            the TableLayout for the table being mapped over. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +readOutputTableLayout

            +
            +public static KijiTableLayout readOutputTableLayout(Configuration conf)
+                                             throws IOException
            +
            +
            Reads an output table layout from the configuration. +

            +

            +
            Parameters:
            conf - The configuration storing the table layout. +
            Returns:
            the TableLayout for the table being mapped over. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/ColumnNameTranslator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/ColumnNameTranslator.html new file mode 100644 index 00000000..6cacc1a3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/ColumnNameTranslator.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.ColumnNameTranslator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.ColumnNameTranslator

            +
            + + + + + + + + + +
            +Packages that use ColumnNameTranslator
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of ColumnNameTranslator in org.kiji.schema.filter
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type ColumnNameTranslator
            + FilterKijiColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + ColumnNameTranslator columnNameTranslator) + +
            +          Expresses a KijiColumnFilter in terms of an equivalent HBase filter, translating the + KijiColumnNames to the corresponding HBaseColumnName.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/InvalidLayoutException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/InvalidLayoutException.html new file mode 100644 index 00000000..449a7c68 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/InvalidLayoutException.html @@ -0,0 +1,325 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.InvalidLayoutException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.InvalidLayoutException

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use InvalidLayoutException
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of InvalidLayoutException in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that throw InvalidLayoutException
            + voidKijiDataRequestValidator.validate(KijiTableLayout tableLayout) + +
            +          Validates the data request against the given table layout.
            +  +

            + + + + + +
            +Uses of InvalidLayoutException in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Subclasses of InvalidLayoutException in org.kiji.schema.layout
            + classSchemaClassNotFoundException + +
            +          Thrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path).
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that throw InvalidLayoutException
            + org.apache.avro.SchemaKijiTableLayout.getSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            +static org.apache.avro.SchemaKijiTableLayout.readAvroSchema(CellSchema avro) + +
            +          Reads the Avro schema from the table layout.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.layout that throw InvalidLayoutException
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc desc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout reference) + +
            +          Builds a new column layout instance from a descriptor.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc familyDesc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout reference) + +
            +          Builds a new family layout instance.
            KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc lgDesc, + KijiTableLayout.LocalityGroupLayout reference) + +
            +          Constructs a locality group layout.
            KijiTableLayout(TableLayoutDesc desc, + KijiTableLayout reference) + +
            +          Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout.
            +  +

            + + + + + +
            +Uses of InvalidLayoutException in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that throw InvalidLayoutException
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            +static org.apache.avro.SchemaCellSpec.readAvroSchema(CellSchema cellSchema) + +
            +          Reads the Avro schema from the table layout.
            + CellSpecCellSpec.setCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html new file mode 100644 index 00000000..b19e3ac9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html @@ -0,0 +1,204 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>KijiTableLayout.LocalityGroupLayout.FamilyLayout.getColumnMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>KijiTableLayout.LocalityGroupLayout.FamilyLayout.getColumns() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout(ColumnDesc desc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout reference) + +
            +          Builds a new column layout instance from a descriptor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html new file mode 100644 index 00000000..bb871f45 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html @@ -0,0 +1,236 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayout.LocalityGroupLayout.FamilyLayout
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout.LocalityGroupLayout.FamilyLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiTableLayout.LocalityGroupLayout.FamilyLayout
            + KijiTableLayout.LocalityGroupLayout.FamilyLayoutKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.getFamily() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout.LocalityGroupLayout.FamilyLayout
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.getFamilies() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.LocalityGroupLayout.getFamilies() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.getFamilyMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.LocalityGroupLayout.getFamilyMap() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type KijiTableLayout.LocalityGroupLayout.FamilyLayout
            KijiTableLayout.LocalityGroupLayout.FamilyLayout(FamilyDesc familyDesc, + KijiTableLayout.LocalityGroupLayout.FamilyLayout reference) + +
            +          Builds a new family layout instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html new file mode 100644 index 00000000..2dbe8ad6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html @@ -0,0 +1,220 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayout.LocalityGroupLayout
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout.LocalityGroupLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiTableLayout.LocalityGroupLayout
            + KijiTableLayout.LocalityGroupLayoutKijiTableLayout.LocalityGroupLayout.FamilyLayout.getLocalityGroup() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout.LocalityGroupLayout
            + Map<String,KijiTableLayout.LocalityGroupLayout>KijiTableLayout.getLocalityGroupMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout>KijiTableLayout.getLocalityGroups() + +
            +           
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type KijiTableLayout.LocalityGroupLayout
            KijiTableLayout.LocalityGroupLayout(LocalityGroupDesc lgDesc, + KijiTableLayout.LocalityGroupLayout reference) + +
            +          Constructs a locality group layout.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.html new file mode 100644 index 00000000..ebe47db0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayout.html @@ -0,0 +1,762 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiTableLayout
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableLayout
            + KijiTableLayoutKijiTable.getLayout() + +
            +           
            + KijiTableLayoutKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiTableLayout
            + voidKijiAdmin.createTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore) + +
            +          Creates a Kiji table in an HBase instance.
            + voidKijiAdmin.createTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + byte[][] splitKeys) + +
            +          Creates a Kiji table in an HBase instance.
            + voidKijiAdmin.createTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + int numRegions) + +
            +          Creates a Kiji table in an HBase instance.
            + voidKijiDataRequestValidator.validate(KijiTableLayout tableLayout) + +
            +          Validates the data request against the given table layout.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.filter
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.filter with parameters of type KijiTableLayout
            KijiRowFilterApplicator(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableLayout
            + KijiTableLayoutHBaseKijiTable.getLayout() + +
            +          
            + KijiTableLayoutHBaseKijiRowData.getTableLayout() + +
            +          Gets the layout of the table this row data belongs to.
            + KijiTableLayoutHBaseMetaTable.getTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + KijiTableLayoutHBaseKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutHBaseKijiAdmin.setTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            + KijiTableLayoutHBaseMetaTable.updateTableLayout(String table, + TableLayoutDesc layoutUpdate) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KijiTableLayout
            + List<KijiTableLayout>HBaseMetaTable.getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>HBaseMetaTable.getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiTableLayout
            + voidHBaseDataRequestAdapter.applyToScan(Scan scan, + KijiTableLayout tableLayout) + +
            +          Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one.
            + voidHBaseKijiAdmin.createTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore) + +
            +          Creates a Kiji table in an HBase instance.
            + voidHBaseKijiAdmin.createTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + byte[][] splitKeys) + +
            +          Creates a Kiji table in an HBase instance.
            + voidHBaseKijiAdmin.createTable(String tableName, + KijiTableLayout tableLayout, + boolean isRestore, + int numRegions) + +
            +          Creates a Kiji table in an HBase instance.
            + GetHBaseDataRequestAdapter.toGet(EntityId entityId, + KijiTableLayout tableLayout) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + GetHBaseDataRequestAdapter.toGet(EntityId entityId, + KijiTableLayout tableLayout, + int pageIndex) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + ScanHBaseDataRequestAdapter.toScan(KijiTableLayout tableLayout) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            + ScanHBaseDataRequestAdapter.toScan(KijiTableLayout tableLayout, + HBaseScanOptions scanOptions) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTableLayout
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            KijiColumnPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HTableInterface htable) + +
            +          Creates a new KijiColumnPager.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiTableLayout
            +static KijiTableLayoutKijiTableLayout.createFromEffectiveJson(InputStream istream) + +
            +          Loads a table layout from the specified JSON text.
            +static KijiTableLayoutKijiTableLayout.createFromEffectiveJsonResource(String resource) + +
            +          Loads a table layout from the specified resource as JSON.
            + KijiTableLayoutColumnNameTranslator.getTableLayout() + +
            +           
            + KijiTableLayoutKijiTableLayout.LocalityGroupLayout.getTableLayout() + +
            +           
            + KijiTableLayoutKijiTableLayoutDatabase.getTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            +static KijiTableLayoutTableLayoutSerializer.readInputTableLayout(Configuration conf) + +
            +          Reads an input table layout from the configuration.
            +static KijiTableLayoutTableLayoutSerializer.readOutputTableLayout(Configuration conf) + +
            +          Reads an output table layout from the configuration.
            +static KijiTableLayoutTableLayoutSerializer.readTableLayout(String confKey, + Configuration conf) + +
            +          Reads a table layout from the configuration.
            + KijiTableLayoutKijiTableLayoutDatabase.updateTableLayout(String table, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout
            + List<KijiTableLayout>KijiTableLayoutDatabase.getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>KijiTableLayoutDatabase.getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type KijiTableLayout
            +static voidTableLayoutSerializer.serializeInputTableLayout(KijiTableLayout tableLayout, + Configuration conf) + +
            +          Serializes the table layout into a configuration object for input.
            +static voidTableLayoutSerializer.serializeOutputTableLayout(KijiTableLayout tableLayout, + Configuration conf) + +
            +          Serializes the table layout into a configuration object for output.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type KijiTableLayout
            ColumnNameTranslator(KijiTableLayout tableLayout) + +
            +          Creates a new ColumnNameTranslator instance.
            InvalidLayoutException(KijiTableLayout tableLayout, + String reason) + +
            +          Constructs an exception indicated a table layout is invalid.
            KijiTableLayout(TableLayoutDesc desc, + KijiTableLayout reference) + +
            +          Constructs a KijiTableLayout from an Avro descriptor and an optional reference layout.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return KijiTableLayout
            + KijiTableLayoutHBaseTableLayoutDatabase.getTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + KijiTableLayoutHBaseTableLayoutDatabase.updateTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return types with arguments of type KijiTableLayout
            + List<KijiTableLayout>HBaseTableLayoutDatabase.getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>HBaseTableLayoutDatabase.getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type KijiTableLayout
            + HTableDescriptorHTableSchemaTranslator.toHTableDescriptor(String kijiInstanceName, + KijiTableLayout tableLayout) + +
            +          Translates a Kiji table layout into an HColumnDescriptor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html new file mode 100644 index 00000000..35bf44c1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html @@ -0,0 +1,257 @@ + + + + + + + +Uses of Interface org.kiji.schema.layout.KijiTableLayoutDatabase (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.layout.KijiTableLayoutDatabase

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiTableLayoutDatabase
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of KijiTableLayoutDatabase in org.kiji.schema
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema that implement KijiTableLayoutDatabase
            + classKijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            +  +

            + + + + + +
            +Uses of KijiTableLayoutDatabase in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableLayoutDatabase
            + classHBaseMetaTable + +
            +          An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTableLayoutDatabase
            HBaseMetaTable(HTableInterface htable, + KijiTableLayoutDatabase tableLayoutDatabase, + KijiTableKeyValueDatabase tableKeyValueDatabase) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  +

            + + + + + +
            +Uses of KijiTableLayoutDatabase in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.layout.impl that implement KijiTableLayoutDatabase
            + classHBaseTableLayoutDatabase + +
            +          Manages Kiji table layouts using a column family in an HBase table as a backing store.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html new file mode 100644 index 00000000..e977db20 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.SchemaClassNotFoundException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.SchemaClassNotFoundException

            +
            +No usage of org.kiji.schema.layout.SchemaClassNotFoundException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/TableLayoutSerializer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/TableLayoutSerializer.html new file mode 100644 index 00000000..57237efe --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/class-use/TableLayoutSerializer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.TableLayoutSerializer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.TableLayoutSerializer

            +
            +No usage of org.kiji.schema.layout.TableLayoutSerializer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/CellSpec.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/CellSpec.html new file mode 100644 index 00000000..ae0edb3f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/CellSpec.html @@ -0,0 +1,557 @@ + + + + + + + +CellSpec (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class CellSpec

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.CellSpec
+
            +
            +
            +
            @ApiAudience.Private
+public final class CellSpec
            extends Object
            + + +

            +Specification of a Kiji cell. + + Contains everything needed to encode or decode a given column. + Wraps a CellSchema Avro record to avoid re-parsing JSON Avro schemas every time, and + associate it with a schema table to resolve schema IDs or hashes. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            CellSpec() + +
            +          Initializes a new, unspecified CellSpec.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static CellSpecfromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecfromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            + org.apache.avro.SchemagetAvroSchema() + +
            +           
            + CellSchemagetCellSchema() + +
            +           
            + KijiSchemaTablegetSchemaTable() + +
            +           
            + booleanisAvro() + +
            +           
            + booleanisCounter() + +
            +           
            +static CellSpecnewCounter() + +
            +           
            +static org.apache.avro.SchemareadAvroSchema(CellSchema cellSchema) + +
            +          Reads the Avro schema from the table layout.
            + CellSpecsetCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            + CellSpecsetReaderSchema(org.apache.avro.Schema readerSchema) + +
            +          Sets the Avro reader schema.
            + CellSpecsetSchemaStorage(SchemaStorage schemaStorage) + +
            +          Sets the schema storage.
            + CellSpecsetSchemaTable(KijiSchemaTable schemaTable) + +
            +          Sets the schema table.
            + CellSpecsetType(SchemaType schemaType) + +
            +          Sets the cell type.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +CellSpec

            +
            +public CellSpec()
            +
            +
            Initializes a new, unspecified CellSpec. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +newCounter

            +
            +public static CellSpec newCounter()
            +
            +
            + +
            Returns:
            a new CellSpec for a counter cell.
            +
            +
            +
            + +

            +fromCellSchema

            +
            +public static CellSpec fromCellSchema(CellSchema cellSchema,
+                                      KijiSchemaTable schemaTable)
+                               throws InvalidLayoutException
            +
            +
            +
            Parameters:
            cellSchema - CellSchema record to initialize the CellSpec from.
            schemaTable - Schema table to resolve schema hashes or UIDs. +
            Returns:
            a new CellSpec initialized from a CellSchema Avro descriptor. +
            Throws: +
            InvalidLayoutException - if the cell specification is invalid.
            +
            +
            +
            + +

            +fromCellSchema

            +
            +public static CellSpec fromCellSchema(CellSchema cellSchema)
+                               throws InvalidLayoutException
            +
            +
            Creates a CellSpec from a CellSchema record. +

            +

            +
            Parameters:
            cellSchema - CellSchema record. +
            Returns:
            a new CellSpec initialized from the given CellSchema. +
            Throws: +
            InvalidLayoutException - on layout error.
            +
            +
            +
            + +

            +setCellSchema

            +
            +public CellSpec setCellSchema(CellSchema cellSchema)
+                       throws InvalidLayoutException
            +
            +
            Sets the cell schema. +

            +

            +
            Parameters:
            cellSchema - CellSchema to initialize the CellSpec from. +
            Returns:
            this. +
            Throws: +
            InvalidLayoutException - on layout error.
            +
            +
            +
            + +

            +setSchemaStorage

            +
            +public CellSpec setSchemaStorage(SchemaStorage schemaStorage)
            +
            +
            Sets the schema storage. + + Does not make sense for counter cells. +

            +

            +
            Parameters:
            schemaStorage - Schema storage (hash, UID or final). +
            Returns:
            this.
            +
            +
            +
            + +

            +setType

            +
            +public CellSpec setType(SchemaType schemaType)
            +
            +
            Sets the cell type. +

            +

            +
            Parameters:
            schemaType - Cell type (counter, inline Avro or Avro class). +
            Returns:
            this.
            +
            +
            +
            + +

            +setReaderSchema

            +
            +public CellSpec setReaderSchema(org.apache.avro.Schema readerSchema)
            +
            +
            Sets the Avro reader schema. + + Does not make sense for counter cells. +

            +

            +
            Parameters:
            readerSchema - Avro reader schema. +
            Returns:
            this.
            +
            +
            +
            + +

            +setSchemaTable

            +
            +public CellSpec setSchemaTable(KijiSchemaTable schemaTable)
            +
            +
            Sets the schema table. +

            +

            +
            Parameters:
            schemaTable - Schema table. +
            Returns:
            this.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public KijiSchemaTable getSchemaTable()
            +
            +
            + +
            Returns:
            the schema table to resolve schema hashes or IDs.
            +
            +
            +
            + +

            +isCounter

            +
            +public boolean isCounter()
            +
            +
            + +
            Returns:
            whether this cell is a counter.
            +
            +
            +
            + +

            +isAvro

            +
            +public boolean isAvro()
            +
            +
            + +
            Returns:
            whether this cell is encoded with Avro.
            +
            +
            +
            + +

            +getCellSchema

            +
            +public CellSchema getCellSchema()
            +
            +
            + +
            Returns:
            the underlying CellSchema Avro record. May be null.
            +
            +
            +
            + +

            +getAvroSchema

            +
            +public org.apache.avro.Schema getAvroSchema()
            +
            +
            + +
            Returns:
            the cell Avro schema. Valid for Avro cells only.
            +
            +
            +
            + +

            +readAvroSchema

            +
            +public static org.apache.avro.Schema readAvroSchema(CellSchema cellSchema)
+                                             throws InvalidLayoutException
            +
            +
            Reads the Avro schema from the table layout. +

            +

            +
            Parameters:
            cellSchema - The portion of the table layout record to read from. +
            Returns:
            the Avro schema, or null for a counter. +
            Throws: +
            InvalidLayoutException - if the specification or the schema is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/ColumnId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/ColumnId.html new file mode 100644 index 00000000..184c07ae --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/ColumnId.html @@ -0,0 +1,559 @@ + + + + + + + +ColumnId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class ColumnId

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.ColumnId
+
            +
            +
            +
            @ApiAudience.Private
+public final class ColumnId
            extends Object
            + + +

            +

            A very short physical identifier for a column family or qualifier to be used in HBase.

            + +

            Since HBase is a sparse storage system, every cell's data must be stored along with + its full address: its row key, family name, column qualifier, and timestamp. Because + of this, it is important to keep the names of families and qualifiers as short as + possible.

            + +

            A ColumnId is the physical byte[] that is used as a family or qualifier name in + HBase. It is an encoded number using a 64-character alphabet with the more significant + digits to the right. This class allows you to convert between the integers and the + UTF-8 encoded physical names. For example:

            + + + + + + + + + + + + + + + + + +
            idname
            1B
            1BA
            1BAA
            2C
            25Z
            26a
            51z
            520
            619
            62+
            63/
            64AB
            65BB
            66CB
            + +

            The benefit here is that until a user has defined at least 64 column names in their + layout, all of the names used in HBase will only be one byte. The next 64 names will + only be two bytes, and so on. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringALPHABET + +
            +          The alphabet used to generate the short physical names.
            +static intBITS_PER_DIGIT + +
            +          The base 2 logarithm of the size of the alphabet (64), which is the number of bits + we can encode with a single digit.
            +static intRADIX + +
            +          The size of the alphabet for a digit, which is the radix of our printed number.
            +static intUNASSIGNED + +
            +          The special value reserved to mean that a symbolic name has not been assigned a column id.
            +static Map<Character,Integer>VALUE_MAP + +
            +          A map from characters in the alphabet to the integer it represents.
            +  + + + + + + + + + + +
            +Constructor Summary
            ColumnId(int id) + +
            +          Constructs a column id that encodes the given integer.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            +static ColumnIdfromByteArray(byte[] encoded) + +
            +          Translates HBase column names to ColumnIds.
            +static ColumnIdfromString(String encoded) + +
            +          Translates HBase column names to ColumnIds.
            + intgetId() + +
            +           
            + inthashCode() + +
            +          
            + byte[]toByteArray() + +
            +          Translates ColumnIds to HBase column names.
            + StringtoString() + +
            +          Gets the id as a string of digits from our alphabet.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +UNASSIGNED

            +
            +public static final int UNASSIGNED
            +
            +
            The special value reserved to mean that a symbolic name has not been assigned a column id. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +ALPHABET

            +
            +public static final String ALPHABET
            +
            +
            The alphabet used to generate the short physical names. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +RADIX

            +
            +public static final int RADIX
            +
            +
            The size of the alphabet for a digit, which is the radix of our printed number. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +BITS_PER_DIGIT

            +
            +public static final int BITS_PER_DIGIT
            +
            +
            The base 2 logarithm of the size of the alphabet (64), which is the number of bits + we can encode with a single digit. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +VALUE_MAP

            +
            +public static final Map<Character,Integer> VALUE_MAP
            +
            +
            A map from characters in the alphabet to the integer it represents. +

            +

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

            +ColumnId

            +
            +public ColumnId(int id)
            +
            +
            Constructs a column id that encodes the given integer. +

            +

            +
            Parameters:
            id - The integer identifier for this column.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +fromByteArray

            +
            +public static ColumnId fromByteArray(byte[] encoded)
            +
            +
            Translates HBase column names to ColumnIds. The HBase byte arrays are UTF-8 encoded + numbers from our base-64 alphabet. +

            +

            +
            Parameters:
            encoded - The family or qualifier bytes from HBase. +
            Returns:
            A ColumnId from the byte array.
            +
            +
            +
            + +

            +fromString

            +
            +public static ColumnId fromString(String encoded)
            +
            +
            Translates HBase column names to ColumnIds. The HBase names are UTF-8 encoded + numbers from our base-64 alphabet. +

            +

            +
            Parameters:
            encoded - The family or qualifier bytes from HBase. +
            Returns:
            A ColumnId from the encoded name.
            +
            +
            +
            + +

            +getId

            +
            +public int getId()
            +
            +
            + +
            Returns:
            the column id.
            +
            +
            +
            + +

            +toByteArray

            +
            +public byte[] toByteArray()
            +
            +

            Translates ColumnIds to HBase column names.

            + +

            Encodes to a byte array making it as short as possible. We use characters that + HBase allows (no control characters and no colon).

            +

            +

            + +
            Returns:
            The column id encoded as an HBase-friendly byte array.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            Gets the id as a string of digits from our alphabet. +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            + +
            Returns:
            The digit string, with the significant digits on the right.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html new file mode 100644 index 00000000..ee58c86d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html @@ -0,0 +1,638 @@ + + + + + + + +HBaseTableLayoutDatabase (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class HBaseTableLayoutDatabase

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.HBaseTableLayoutDatabase
+
            +
            +
            All Implemented Interfaces:
            KijiTableLayoutDatabase
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseTableLayoutDatabase
            extends Object
            implements KijiTableLayoutDatabase
            + + +

            +

            Manages Kiji table layouts using a column family in an HBase table as a backing store.

            + +

            + The HTable row key is the name of the table, and the row has 3 columns: +

          • the layout update, as specified by the user/submitter;
            • +
          • the effective layout after applying the update;
            • +
          • a hash of the effective layout.
            • +

            + +

            + Layouts and layout updates are encoded as Kiji cells, using Avro schema hashes, and as + TableLayoutDesc Avro records. +

            + +

            A static method, getHColumnDescriptor returns the description of an + HColumn that should be used to construct the HTable for the backing store.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringQUALIFIER_LAYOUT + +
            +          HBase column qualifier used to store absolute layouts.
            +static StringQUALIFIER_LAYOUT_ID + +
            +          HBase column qualifier used to store layout IDs.
            +static StringQUALIFIER_UPDATE + +
            +          HBase column qualifier used to store layout updates.
            +  + + + + + + + + + + +
            +Constructor Summary
            HBaseTableLayoutDatabase(HTableInterface htable, + String family, + KijiSchemaTable schemaTable) + +
            +          Creates a new HBaseTableLayoutDatabase instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static HColumnDescriptorgetHColumnDescriptor(String family) + +
            +          Gets the description of an HColumn suitable for storing the table layout database.
            + KijiTableLayoutgetTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + List<KijiTableLayout>getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            + voidlayoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> layoutBackup) + +
            +          Restores a table layout history from a backup.
            + List<TableLayoutBackupEntry>layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            + List<String>listTables() + +
            +          Lists the tables in this Kiji instance.
            + voidremoveAllTableLayoutVersions(String table) + +
            +          Removes all layout information for a particular table.
            + voidremoveRecentTableLayoutVersions(String table, + int numVersions) + +
            +          Removes the most recent layout information for a given table.
            + KijiTableLayoutupdateTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +QUALIFIER_UPDATE

            +
            +public static final String QUALIFIER_UPDATE
            +
            +
            HBase column qualifier used to store layout updates. + Layout updates are binary encoded TableLayoutDesc records. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +QUALIFIER_LAYOUT

            +
            +public static final String QUALIFIER_LAYOUT
            +
            +
            HBase column qualifier used to store absolute layouts. + Table layouts are binary encoded TableLayoutDesc records. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +QUALIFIER_LAYOUT_ID

            +
            +public static final String QUALIFIER_LAYOUT_ID
            +
            +
            HBase column qualifier used to store layout IDs. + Currently, IDs are assigned using a long counter starting at 1, and encoded as a string. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +HBaseTableLayoutDatabase

            +
            +public HBaseTableLayoutDatabase(HTableInterface htable,
+                                String family,
+                                KijiSchemaTable schemaTable)
+                         throws IOException
            +
            +
            Creates a new HBaseTableLayoutDatabase instance. + +

            This class does not take ownership of the HTable. The caller should close it when + it is no longer needed.

            +

            +

            +
            Parameters:
            htable - The HTable used to store the layout data.
            family - The name of the column family within the HTable used to store layout data.
            schemaTable - The Kiji schema table. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +updateTableLayout

            +
            +public KijiTableLayout updateTableLayout(String tableName,
+                                         TableLayoutDesc update)
+                                  throws IOException
            +
            +
            Sets a table's layout. Also calls validateAndAssignLayout(). +

            +

            +
            Specified by:
            updateTableLayout in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            tableName - The name of the Kiji table to affect.
            update - Descriptor for the layout update. +
            Returns:
            the new effective layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout(String table)
+                               throws IOException
            +
            +
            Gets the most recent versions of the layout for a table. +

            +

            +
            Specified by:
            getTableLayout in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            The table's layout. +
            Throws: +
            IOException - If there is an error or no such table.
            +
            +
            +
            + +

            +getTableLayoutVersions

            +
            +public List<KijiTableLayout> getTableLayoutVersions(String table,
+                                                    int numVersions)
+                                             throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the table layout. +

            +

            +
            Specified by:
            getTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the layout for the table, sorted by + most-recent-first. If there are no layouts, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedTableLayoutVersions

            +
            +public NavigableMap<Long,KijiTableLayout> getTimedTableLayoutVersions(String table,
+                                                                      int numVersions)
+                                                               throws IOException
            +
            +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +

            +

            +
            Specified by:
            getTimedTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values the most recent versions of the layout for the table, and + keys the corresponding timestamps, ordered from most recent first to least recent last. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllTableLayoutVersions

            +
            +public void removeAllTableLayoutVersions(String table)
+                                  throws IOException
            +
            +
            Removes all layout information for a particular table. +

            +

            +
            Specified by:
            removeAllTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeRecentTableLayoutVersions

            +
            +public void removeRecentTableLayoutVersions(String table,
+                                            int numVersions)
+                                     throws IOException
            +
            +
            Removes the most recent layout information for a given table. +

            +

            +
            Specified by:
            removeRecentTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +listTables

            +
            +public List<String> listTables()
+                        throws IOException
            +
            +
            Lists the tables in this Kiji instance. +

            +

            +
            Specified by:
            listTables in interface KijiTableLayoutDatabase
            +
            +
            + +
            Returns:
            The list of table names. +
            Throws: +
            IOException - If the list of tables cannot be retrieved.
            +
            +
            +
            + +

            +getHColumnDescriptor

            +
            +public static HColumnDescriptor getHColumnDescriptor(String family)
            +
            +
            Gets the description of an HColumn suitable for storing the table layout database. +

            +

            +
            +
            +
            +
            Parameters:
            family - The family within the HTable used to store layout data. +
            Returns:
            The HColumn descriptor.
            +
            +
            +
            + +

            +layoutsToBackup

            +
            +public List<TableLayoutBackupEntry> layoutsToBackup(String table)
+                                             throws IOException
            +
            +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +

            +

            +
            Specified by:
            layoutsToBackup in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableLayoutBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +layoutsFromBackup

            +
            +public void layoutsFromBackup(String tableName,
+                              List<TableLayoutBackupEntry> layoutBackup)
+                       throws IOException
            +
            +
            Restores a table layout history from a backup. +

            +

            +
            Specified by:
            layoutsFromBackup in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            tableName - The name of the table to restore layouts for.
            layoutBackup - Table layout backup entries to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/HTableSchemaTranslator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/HTableSchemaTranslator.html new file mode 100644 index 00000000..fb2033d4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/HTableSchemaTranslator.html @@ -0,0 +1,269 @@ + + + + + + + +HTableSchemaTranslator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class HTableSchemaTranslator

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.HTableSchemaTranslator
+
            +
            +
            +
            @ApiAudience.Private
+public final class HTableSchemaTranslator
            extends Object
            + + +

            +Translates between KijiTableLayouts and HTableDescriptors. + +

            A Kiji table has a layout with locality groups, families, and columns. An HTable + only has HColumns. This classes maps between the Kiji layout components and the HTable + schema components, which ultimately determines how we map Kiji data onto an HTable.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HTableSchemaTranslator() + +
            +          Creates a new HTableSchemaTranslator instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + HTableDescriptortoHTableDescriptor(String kijiInstanceName, + KijiTableLayout tableLayout) + +
            +          Translates a Kiji table layout into an HColumnDescriptor.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HTableSchemaTranslator

            +
            +public HTableSchemaTranslator()
            +
            +
            Creates a new HTableSchemaTranslator instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +toHTableDescriptor

            +
            +public HTableDescriptor toHTableDescriptor(String kijiInstanceName,
+                                           KijiTableLayout tableLayout)
            +
            +
            Translates a Kiji table layout into an HColumnDescriptor. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance the table lives in.
            tableLayout - The Kiji table layout. +
            Returns:
            The HTableDescriptor to use for storing the Kiji table data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/CellSpec.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/CellSpec.html new file mode 100644 index 00000000..10a72c30 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/CellSpec.html @@ -0,0 +1,388 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.CellSpec (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.CellSpec

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use CellSpec
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type CellSpec
            + KijiCellDecoder<?>GenericCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + KijiCellEncoderKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            + KijiCellDecoder<?>SpecificCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + + + + + +
            +<T> KijiCellDecoder<T>
            +            		KijiCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type CellSpec
            + KijiCellEncoderDefaultKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type CellSpec
            AvroCellDecoder(CellSpec cellSpec) + +
            +          Initializes an abstract KijiAvroCellDecoder.
            AvroCellEncoder(CellSpec cellSpec) + +
            +          Creates a new KijiCellEncoder instance.
            GenericCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates generic Avro types.
            SpecificCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates specific Avro types.
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return CellSpec
            + CellSpecKijiTableLayout.getCellSpec(KijiColumnName column) + +
            +           
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return CellSpec
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            +static CellSpecCellSpec.newCounter() + +
            +           
            + CellSpecCellSpec.setCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            + CellSpecCellSpec.setReaderSchema(org.apache.avro.Schema readerSchema) + +
            +          Sets the Avro reader schema.
            + CellSpecCellSpec.setSchemaStorage(SchemaStorage schemaStorage) + +
            +          Sets the schema storage.
            + CellSpecCellSpec.setSchemaTable(KijiSchemaTable schemaTable) + +
            +          Sets the schema table.
            + CellSpecCellSpec.setType(SchemaType schemaType) + +
            +          Sets the cell type.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/ColumnId.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/ColumnId.html new file mode 100644 index 00000000..ded36df8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/ColumnId.html @@ -0,0 +1,266 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.ColumnId (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.ColumnId

            +
            + + + + + + + + + + + + + +
            +Packages that use ColumnId
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of ColumnId in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return ColumnId
            + ColumnIdKijiTableLayout.LocalityGroupLayout.getId() + +
            +           
            + ColumnIdKijiTableLayout.LocalityGroupLayout.FamilyLayout.getId() + +
            +           
            + ColumnIdKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.getId() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type ColumnId
            + com.google.common.collect.BiMap<ColumnId,String>KijiTableLayout.LocalityGroupLayout.FamilyLayout.getColumnIdNameMap() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>KijiTableLayout.LocalityGroupLayout.getFamilyIdNameMap() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>KijiTableLayout.getLocalityGroupIdNameMap() + +
            +           
            +  +

            + + + + + +
            +Uses of ColumnId in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return ColumnId
            +static ColumnIdColumnId.fromByteArray(byte[] encoded) + +
            +          Translates HBase column names to ColumnIds.
            +static ColumnIdColumnId.fromString(String encoded) + +
            +          Translates HBase column names to ColumnIds.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html new file mode 100644 index 00000000..8c5fec51 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.HBaseTableLayoutDatabase

            +
            +No usage of org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html new file mode 100644 index 00000000..0959bd3b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.HTableSchemaTranslator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.HTableSchemaTranslator

            +
            +No usage of org.kiji.schema.layout.impl.HTableSchemaTranslator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-frame.html new file mode 100644 index 00000000..aa3ba34f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-frame.html @@ -0,0 +1,39 @@ + + + + + + + +org.kiji.schema.layout.impl (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.schema.layout.impl + + + + +
            +Classes  + +
            +CellSpec +
            +ColumnId +
            +HBaseTableLayoutDatabase +
            +HTableSchemaTranslator
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-summary.html new file mode 100644 index 00000000..7db8bb13 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-summary.html @@ -0,0 +1,190 @@ + + + + + + + +org.kiji.schema.layout.impl (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.layout.impl +

            +Implementation for Kiji table layout management. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            CellSpecSpecification of a Kiji cell.
            ColumnIdA very short physical identifier for a column family or qualifier to be used in HBase.
            HBaseTableLayoutDatabaseManages Kiji table layouts using a column family in an HBase table as a backing store.
            HTableSchemaTranslatorTranslates between KijiTableLayouts and HTableDescriptors.
            +  + +

            +

            +Package org.kiji.schema.layout.impl Description +

            + +

            +Implementation for Kiji table layout management. + +

            + Users generally shouldn't need to reference any of these classes directly, but rather use the + classes presented by the org.kiji.schema package. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-tree.html new file mode 100644 index 00000000..4454e05b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-tree.html @@ -0,0 +1,155 @@ + + + + + + + +org.kiji.schema.layout.impl Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.layout.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-use.html new file mode 100644 index 00000000..f22f45a9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/impl/package-use.html @@ -0,0 +1,240 @@ + + + + + + + +Uses of Package org.kiji.schema.layout.impl (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.layout.impl

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.layout.impl
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema
            CellSpec + +
            +          Specification of a Kiji cell.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema.impl
            CellSpec + +
            +          Specification of a Kiji cell.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema.layout
            CellSpec + +
            +          Specification of a Kiji cell.
            ColumnId + +
            +          A very short physical identifier for a column family or qualifier to be used in HBase.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema.layout.impl
            CellSpec + +
            +          Specification of a Kiji cell.
            ColumnId + +
            +          A very short physical identifier for a column family or qualifier to be used in HBase.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-frame.html new file mode 100644 index 00000000..d1b77c42 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-frame.html @@ -0,0 +1,61 @@ + + + + + + + +org.kiji.schema.layout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.schema.layout + + + + +
            +Interfaces  + +
            +KijiTableLayoutDatabase
            + + + + + + +
            +Classes  + +
            +ColumnNameTranslator +
            +KijiTableLayout +
            +TableLayoutSerializer
            + + + + + + +
            +Exceptions  + +
            +InvalidLayoutException +
            +SchemaClassNotFoundException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-summary.html new file mode 100644 index 00000000..413fc64e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-summary.html @@ -0,0 +1,234 @@ + + + + + + + +org.kiji.schema.layout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.layout +

            +Kiji table layouts. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            KijiTableLayoutDatabaseA database of Kiji table layouts.
            +  + +

            + + + + + + + + + + + + + + + + + +
            +Class Summary
            ColumnNameTranslatorTranslates between HTable and Kiji table column names.
            KijiTableLayoutLayout of a Kiji table.
            TableLayoutSerializerSerialize TableLayout instances into job configurations.
            +  + +

            + + + + + + + + + + + + + +
            +Exception Summary
            InvalidLayoutExceptionThrown when an invalid Kiji layout is encountered.
            SchemaClassNotFoundExceptionThrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path).
            +  + +

            +

            +Package org.kiji.schema.layout Description +

            + +

            +Kiji table layouts. + +

            + A Kiji table has a layout that describes the locality groups, families, and + columns it contains. + + This package contains code for serializing the layout metadata to and from JSON or binary Avro + records, and persisting it into the Kiji system tables in HBase. + + Kiji table layouts are persisted in the KijiMetaTable. + Kiji records the history of the layouts of each table. + When updating the layout of a table, Kiji validates the new layout against the current layout + of the table. + + Kiji table layouts are serialized to descriptors as TableLayoutDesc + Avro records (see the Avro record definitions in src/main/avro/Layout.avdl). + + Kiji table layouts are internally represented as KijiTableLayout + instances. KijiTableLayout wraps layout + descriptors, validate layout updates, assigns column IDs and provides convenience accessors. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-tree.html new file mode 100644 index 00000000..83e67398 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-tree.html @@ -0,0 +1,168 @@ + + + + + + + +org.kiji.schema.layout Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.layout +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-use.html new file mode 100644 index 00000000..100ee5f4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/layout/package-use.html @@ -0,0 +1,307 @@ + + + + + + + +Uses of Package org.kiji.schema.layout (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.layout

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.layout
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema
            InvalidLayoutException + +
            +          Thrown when an invalid Kiji layout is encountered.
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayoutDatabase + +
            +          A database of Kiji table layouts.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.filter
            ColumnNameTranslator + +
            +          Translates between HTable and Kiji table column names.
            KijiTableLayout + +
            +          Layout of a Kiji table.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.impl
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayoutDatabase + +
            +          A database of Kiji table layouts.
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.layout
            InvalidLayoutException + +
            +          Thrown when an invalid Kiji layout is encountered.
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayout.LocalityGroupLayout + +
            +          Concrete layout of a locality group.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout + +
            +          Concrete layout of a family.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout + +
            +          Concrete layout of a column.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.layout.impl
            InvalidLayoutException + +
            +          Thrown when an invalid Kiji layout is encountered.
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayoutDatabase + +
            +          A database of Kiji table layouts.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/DistributedCacheJars.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/DistributedCacheJars.html new file mode 100644 index 00000000..60ca05c3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/DistributedCacheJars.html @@ -0,0 +1,330 @@ + + + + + + + +DistributedCacheJars (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class DistributedCacheJars

            +
            +java.lang.Object
+  extended by org.kiji.schema.mapreduce.DistributedCacheJars
+
            +
            +Deprecated. +

            +

            +
            @ApiAudience.Public
+@Deprecated
+public final class DistributedCacheJars
            extends Object
            + + +

            +Utility class for dealing with Java JAR files and the hadoop distributed cache. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidaddJarsToDistributedCache(Job job, + File jarDirectory) + +
            +          Deprecated. Adds the jars from a directory into the distributed cache of a job.
            +static voidaddJarsToDistributedCache(Job job, + String jarDirectory) + +
            +          Deprecated. Adds the jars from a directory into the distributed cache of a job.
            +static List<String>deDuplicateJarNames(List<String> jarList) + +
            +          Deprecated. Takes a list of paths and returns a list of paths with unique filenames.
            +static List<String>getJarsFromConfiguration(Configuration conf) + +
            +          Deprecated. Lists all jars in the variable tmpjars of this Configuration.
            +static List<String>getJarsFromDirectory(Configuration conf, + File jarDirectory) + +
            +          Deprecated.  
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +addJarsToDistributedCache

            +
            +public static void addJarsToDistributedCache(Job job,
+                                             String jarDirectory)
+                                      throws IOException
            +
            +
            Deprecated. 
            Adds the jars from a directory into the distributed cache of a job. +

            +

            +
            Parameters:
            job - The job to configure.
            jarDirectory - A path to a directory of jar files. +
            Throws: +
            IOException - If there is a problem reading from the file system.
            +
            +
            +
            + +

            +addJarsToDistributedCache

            +
            +public static void addJarsToDistributedCache(Job job,
+                                             File jarDirectory)
+                                      throws IOException
            +
            +
            Deprecated. 
            Adds the jars from a directory into the distributed cache of a job. +

            +

            +
            Parameters:
            job - The job to configure.
            jarDirectory - A path to a directory of jar files. +
            Throws: +
            IOException - If there is a problem reading from the file system.
            +
            +
            +
            + +

            +getJarsFromConfiguration

            +
            +public static List<String> getJarsFromConfiguration(Configuration conf)
            +
            +
            Deprecated. 
            Lists all jars in the variable tmpjars of this Configuration. +

            +

            +
            Parameters:
            conf - The Configuration to get jar names from +
            Returns:
            A list of jars.
            +
            +
            +
            + +

            +getJarsFromDirectory

            +
            +public static List<String> getJarsFromDirectory(Configuration conf,
+                                                File jarDirectory)
+                                         throws IOException
            +
            +
            Deprecated. 
            +
            Parameters:
            conf - Configuration to get FileSystem from
            jarDirectory - The directory of jars to get. +
            Returns:
            A list of qualified paths to the jars in jarDirectory. +
            Throws: +
            IOException - if there's a problem.
            +
            +
            +
            + +

            +deDuplicateJarNames

            +
            +public static List<String> deDuplicateJarNames(List<String> jarList)
            +
            +
            Deprecated. 
            Takes a list of paths and returns a list of paths with unique filenames. +

            +

            +
            Parameters:
            jarList - A list of jars to de-dupe. +
            Returns:
            A de-duplicated list of jars.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/KijiConfKeys.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/KijiConfKeys.html new file mode 100644 index 00000000..eb2b9b21 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/KijiConfKeys.html @@ -0,0 +1,277 @@ + + + + + + + +KijiConfKeys (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class KijiConfKeys

            +
            +java.lang.Object
+  extended by org.kiji.schema.mapreduce.KijiConfKeys
+
            +
            +Deprecated. +

            +

            +
            @Deprecated
+public final class KijiConfKeys
            extends Object
            + + +

            +Configuration keys used by KijiMR in Hadoop Configuration objects. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringINPUT_DATA_REQUEST + +
            +          Deprecated. Serialized input data request.
            +static StringINPUT_TABLE_URI + +
            +          Deprecated. URI of the input table to read from.
            +static StringOUTPUT_KIJI_TABLE_URI + +
            +          Deprecated. URI of the output Kiji table to write to.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +INPUT_TABLE_URI

            +
            +public static final String INPUT_TABLE_URI
            +
            +
            Deprecated. 
            URI of the input table to read from. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +OUTPUT_KIJI_TABLE_URI

            +
            +public static final String OUTPUT_KIJI_TABLE_URI
            +
            +
            Deprecated. 
            URI of the output Kiji table to write to. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +INPUT_DATA_REQUEST

            +
            +public static final String INPUT_DATA_REQUEST
            +
            +
            Deprecated. 
            Serialized input data request. +

            +

            +
            See Also:
            Constant Field Values
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html new file mode 100644 index 00000000..326b65d2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html @@ -0,0 +1,472 @@ + + + + + + + +KijiTableInputFormat.KijiTableRecordReader (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class KijiTableInputFormat.KijiTableRecordReader

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.RecordReader<EntityId,KijiRowData>
+      extended by org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Enclosing class:
            KijiTableInputFormat
            +
            +
            +
            +
            public static class KijiTableInputFormat.KijiTableRecordReader
            extends RecordReader<EntityId,KijiRowData>
            + + +

            +Hadoop record reader for Kiji table rows. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +protected  ConfigurationmConf + +
            +          Hadoop Configuration object containing settings.
            +protected  KijiDataRequestmDataRequest + +
            +          Data request.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableInputFormat.KijiTableRecordReader(Configuration conf) + +
            +          Creates a new RecordReader for this input format.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + EntityIdgetCurrentKey() + +
            +          
            + KijiRowDatagetCurrentValue() + +
            +          
            + floatgetProgress() + +
            +          
            + voidinitialize(InputSplit split, + TaskAttemptContext context) + +
            +          
            + booleannextKeyValue() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +mDataRequest

            +
            +protected final KijiDataRequest mDataRequest
            +
            +
            Data request. +

            +

            +
            +
            +
            + +

            +mConf

            +
            +protected final Configuration mConf
            +
            +
            Hadoop Configuration object containing settings. +

            +

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

            +KijiTableInputFormat.KijiTableRecordReader

            +
            +public KijiTableInputFormat.KijiTableRecordReader(Configuration conf)
            +
            +
            Creates a new RecordReader for this input format. This RecordReader will perform the actual + reads from Kiji. +

            +

            +
            Parameters:
            conf - The configuration object for this Kiji.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(InputSplit split,
+                       TaskAttemptContext context)
+                throws IOException
            +
            +
            +

            +

            +
            Specified by:
            initialize in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getCurrentKey

            +
            +public EntityId getCurrentKey()
+                       throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getCurrentKey in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getCurrentValue

            +
            +public KijiRowData getCurrentValue()
+                            throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getCurrentValue in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getProgress

            +
            +public float getProgress()
+                  throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getProgress in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +nextKeyValue

            +
            +public boolean nextKeyValue()
+                     throws IOException
            +
            +
            +

            +

            +
            Specified by:
            nextKeyValue in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/KijiTableInputFormat.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/KijiTableInputFormat.html new file mode 100644 index 00000000..6357bf7a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/KijiTableInputFormat.html @@ -0,0 +1,401 @@ + + + + + + + +KijiTableInputFormat (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class KijiTableInputFormat

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.InputFormat<EntityId,KijiRowData>
+      extended by org.kiji.schema.mapreduce.KijiTableInputFormat
+
            +
            +
            All Implemented Interfaces:
            Configurable
            +
            +
            +Deprecated. +

            +

            +
            @Deprecated
+public class KijiTableInputFormat
            extends InputFormat<EntityId,KijiRowData>
            implements Configurable
            + + +

            +InputFormat for Hadoop MapReduce jobs reading from a Kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTableInputFormat.KijiTableRecordReader + +
            +          Deprecated. Hadoop record reader for Kiji table rows.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableInputFormat() + +
            +          Deprecated.  
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidconfigureJob(Job job, + KijiURI tableURI, + KijiDataRequest dataRequest, + String startRow, + String endRow) + +
            +          Deprecated. Configures a Hadoop M/R job to read from a given table.
            + RecordReader<EntityId,KijiRowData>createRecordReader(InputSplit split, + TaskAttemptContext context) + +
            +          Deprecated. 
            + ConfigurationgetConf() + +
            +          Deprecated. 
            + List<InputSplit>getSplits(JobContext context) + +
            +          Deprecated. 
            + voidsetConf(Configuration conf) + +
            +          Deprecated. 
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableInputFormat

            +
            +public KijiTableInputFormat()
            +
            +
            Deprecated. 
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(Configuration conf)
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            setConf in interface Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public Configuration getConf()
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            getConf in interface Configurable
            +
            +
            +
            +
            +
            +
            + +

            +createRecordReader

            +
            +public RecordReader<EntityId,KijiRowData> createRecordReader(InputSplit split,
+                                                             TaskAttemptContext context)
+                                                      throws IOException
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            createRecordReader in class InputFormat<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getSplits

            +
            +public List<InputSplit> getSplits(JobContext context)
+                           throws IOException
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            getSplits in class InputFormat<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +configureJob

            +
            +public static void configureJob(Job job,
+                                KijiURI tableURI,
+                                KijiDataRequest dataRequest,
+                                String startRow,
+                                String endRow)
+                         throws IOException
            +
            +
            Deprecated. 
            Configures a Hadoop M/R job to read from a given table. +

            +

            +
            +
            +
            +
            Parameters:
            job - Job to configure.
            tableURI - URI of the table to read from.
            dataRequest - Data request.
            startRow - Minimum row key to process.
            endRow - Maximum row Key to process. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html new file mode 100644 index 00000000..d6628b28 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.DistributedCacheJars (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.DistributedCacheJars

            +
            +No usage of org.kiji.schema.mapreduce.DistributedCacheJars +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/KijiConfKeys.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/KijiConfKeys.html new file mode 100644 index 00000000..15fcc69d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/KijiConfKeys.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.KijiConfKeys (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.KijiConfKeys

            +
            +No usage of org.kiji.schema.mapreduce.KijiConfKeys +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html new file mode 100644 index 00000000..02899e58 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader

            +
            +No usage of org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html new file mode 100644 index 00000000..9a69393c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.KijiTableInputFormat (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.KijiTableInputFormat

            +
            +No usage of org.kiji.schema.mapreduce.KijiTableInputFormat +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-frame.html new file mode 100644 index 00000000..e62ece22 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-frame.html @@ -0,0 +1,39 @@ + + + + + + + +org.kiji.schema.mapreduce (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.schema.mapreduce + + + + +
            +Classes  + +
            +DistributedCacheJars +
            +KijiConfKeys +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-summary.html new file mode 100644 index 00000000..7a9707a9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-summary.html @@ -0,0 +1,197 @@ + + + + + + + +org.kiji.schema.mapreduce (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +@Deprecated +

            +Package org.kiji.schema.mapreduce +

            +Kiji map-reduce utilities. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            DistributedCacheJarsDeprecated.
            KijiConfKeysDeprecated.
            KijiTableInputFormatDeprecated.
            KijiTableInputFormat.KijiTableRecordReaderHadoop record reader for Kiji table rows.
            +  + +

            +

            +Package org.kiji.schema.mapreduce Description +

            + +

            +Kiji map-reduce utilities. + +

            This package provides support for building map-reduce jobs that read from and/or write to + a Kiji table. For reading from Kiji, use KijiTableInputFormat. For writing to + kiji use org.kiji.schema.mapreduce.KijiTableOutputFormat.

            + +

            December 20, 2012: Note that this package is deprecated; the KijiMapReduce framework + (https://github.com/kijiproject/kiji-mapreduce) will contain revamped versions of these + and additional MapReduce integration points. Users investing heavily in MapReduce + should pay attention to development on this new project at https://jira.kiji.org and the + user and developer mailing lists user@ and dev@kiji.org. After KijiMapReduce is released, + this package will disappear.

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-tree.html new file mode 100644 index 00000000..d0b85a84 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.schema.mapreduce Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.mapreduce +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-use.html new file mode 100644 index 00000000..836366ea --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/mapreduce/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.schema.mapreduce (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.mapreduce

            +
            +No usage of org.kiji.schema.mapreduce +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-frame.html new file mode 100644 index 00000000..043558f1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-frame.html @@ -0,0 +1,174 @@ + + + + + + + +org.kiji.schema (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.schema + + + + +
            +Interfaces  + +
            +HBaseFactory +
            +Kiji +
            +KijiAdmin +
            +KijiCellDecoder +
            +KijiCellDecoderFactory +
            +KijiCellEncoder +
            +KijiCellEncoderFactory +
            +KijiCounter +
            +KijiDeleter +
            +KijiFactory +
            +KijiIncrementer +
            +KijiPutter +
            +KijiRowData +
            +KijiRowScanner +
            +KijiTable +
            +KijiTableFactory +
            +KijiTableKeyValueDatabase +
            +KijiTableReader +
            +KijiTableWriter
            + + + + + + +
            +Classes  + +
            +EntityId +
            +EntityIdFactory +
            +GenericCellDecoderFactory +
            +HBaseColumnName +
            +HBaseFactory.Provider +
            +HBaseScanOptions +
            +Kiji.Factory +
            +KijiCell +
            +KijiColumnName +
            +KijiConfiguration +
            +KijiDataRequest +
            +KijiDataRequest.Column +
            +KijiDataRequestValidator +
            +KijiInstaller +
            +KijiManagedHBaseTableName +
            +KijiMetaTable +
            +KijiRowKeySplitter +
            +KijiSchemaTable +
            +KijiSchemaTable.SchemaEntry +
            +KijiSystemTable +
            +KijiTablePool +
            +KijiTablePool.Options +
            +KijiTableReader.KijiScannerOptions +
            +KijiURI +
            +SpecificCellDecoderFactory
            + + + + + + +
            +Exceptions  + +
            +IncompatibleKijiVersionException +
            +KijiAlreadyExistsException +
            +KijiDataRequestException +
            +KijiEncodingException +
            +KijiInvalidNameException +
            +KijiNotInstalledException +
            +KijiTableNotFoundException +
            +KijiTablePool.NoCapacityException +
            +KijiURIException +
            +NoCellDataException +
            +NoSuchColumnException +
            +NotAKijiManagedTableException +
            +TableKeyNotFoundException
            + + + + + + +
            +Errors  + +
            +InternalKijiError
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-summary.html new file mode 100644 index 00000000..b261b878 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-summary.html @@ -0,0 +1,475 @@ + + + + + + + +org.kiji.schema (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema +

            +The main package for users of KijiSchema. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Interface Summary
            HBaseFactoryFactory for HBase instances based on URIs.
            KijiProvides a handle to a Kiji instance that contains configuration and + table information.
            KijiAdminAdministration API for managing a Kiji instance.
            KijiCellDecoder<T>Interface for Kiji cell decoders.
            KijiCellDecoderFactoryInterface for factories of KijiCellDecoder instances.
            KijiCellEncoderInterface for Kiji cell encoders.
            KijiCellEncoderFactoryInterface for factories of KijiCellEncoder instances.
            KijiCounterDeprecated. KijiCounter will be merged into KijiCell.
            KijiDeleterInterface for performing deletes on a Kiji table.
            KijiFactoryFactory for Kiji instances.
            KijiIncrementerInterface for performing increments on a Kiji table.
            KijiPutterInterface for performing puts on a Kiji table.
            KijiRowDataThe input data for a single entity in Kiji.
            KijiRowScannerInterface for scanning over rows read from a Kiji table.
            KijiTableInterface for Kiji Tables.
            KijiTableFactoryFactory for KijiTable instances.
            KijiTableKeyValueDatabaseA database of per table key-value pairs.
            KijiTableReaderInterface for reading data from a kiji table.
            KijiTableWriterInterface for modifying a Kiji table.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            EntityIdEntityId is used to identify a particular row in a Kiji table.
            EntityIdFactoryFactory class for creating EntityIds.
            GenericCellDecoderFactoryFactory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas.
            HBaseColumnNameAn HBase column name.
            HBaseFactory.ProviderProvider for the default HBaseFactory.
            HBaseScanOptionsCustomizable parameters for KijiRowScanners backed by an HBase scan.
            Kiji.FactoryProvider for the default Kiji factory.
            KijiCell<T>The data held in one cell of a kiji table.
            KijiColumnNameA Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiConfigurationDeprecated.
            KijiDataRequestDescribes a request for columns of data to read from a Kiji table.
            KijiDataRequest.ColumnDescribes a request for a Kiji Table column.
            KijiDataRequestValidatorThis class validates a KijiDataRequest against the layout + of a Kiji table to make sure it contains all of the columns requested.
            KijiInstallerInstalls or uninstalls Kiji instances from an HBase cluster.
            KijiManagedHBaseTableNameMultiple instances of Kiji can be installed on a single HBase + cluster.
            KijiMetaTableThe kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiRowKeySplitterUtility class for splitting the Kiji row key space.
            KijiSchemaTableThe Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSchemaTable.SchemaEntryAssociation between a schema and its ID.
            KijiSystemTableThe Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiTablePoolMaintains a pool of opened KijiTables.
            KijiTablePool.OptionsDescribes the options that can be configured on the KijiTablePool.
            KijiTableReader.KijiScannerOptionsOptions for KijiRowScanners.
            KijiURIURI that fully qualifies a Kiji instance/table/column.
            SpecificCellDecoderFactoryFactory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Exception Summary
            IncompatibleKijiVersionExceptionThrown when there is an attempt to operate on a Kiji instance whose data format version + is incompatible with the Kiji client version.
            KijiAlreadyExistsExceptionThrown when installing an instance or creating a table that already exists.
            KijiDataRequestExceptionThrown when there is an error validating a KijiDataRequest against a Kiji table.
            KijiEncodingExceptionRuntime exception thrown when encoding a cell's content fails.
            KijiInvalidNameExceptionThrown when a Kiji instance or table layout name is invalid.
            KijiNotInstalledExceptionThrown when attempting to open a non existing/not installed Kiji instance.
            KijiTableNotFoundExceptionThrown when an attempt to access a table fails because it does not exist.
            KijiTablePool.NoCapacityExceptionThrown when an attempt to get a table connection fails because there is no room in the pool.
            KijiURIExceptionThrown when parsing a bogus Kiji URI.
            NoCellDataExceptionThrown when attempting to read data from a cell that doesn't exist.
            NoSuchColumnExceptionThrown when attempting to access a column that does not exist.
            NotAKijiManagedTableExceptionThrown when Kiji encounters an HBase table that is not managed by Kiji.
            TableKeyNotFoundExceptionThrown when a key is not found in a map-like API implemented by one of the + Kiji tables, the system or meta table for example.
            +  + +

            + + + + + + + + + +
            +Error Summary
            InternalKijiErrorThrown when there is something wrong with the internal Kiji + implementation.
            +  + +

            +

            +Package org.kiji.schema Description +

            + +

            +The main package for users of KijiSchema. + +

            + KijiSchema provides layout and schema management on top of HBase. KijiSchema also allows + for the use of both structured and unstructured data in HBase using Avro serialization. +

            + +

            + Classes of note: +

            + + +

            + Related Documentation: +

            + +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-tree.html new file mode 100644 index 00000000..366a2498 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-tree.html @@ -0,0 +1,222 @@ + + + + + + + +org.kiji.schema Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-use.html new file mode 100644 index 00000000..01fb57b0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/package-use.html @@ -0,0 +1,793 @@ + + + + + + + +Uses of Package org.kiji.schema (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            org.kiji.schema.mapreduceKiji map-reduce utilities. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            EntityIdFactory + +
            +          Factory class for creating EntityIds.
            HBaseFactory + +
            +          Factory for HBase instances based on URIs.
            HBaseScanOptions + +
            +          Customizable parameters for KijiRowScanners backed by an HBase scan.
            Kiji + +
            +          Provides a handle to a Kiji instance that contains configuration and + table information.
            KijiAdmin + +
            +          Administration API for managing a Kiji instance.
            KijiCell + +
            +          The data held in one cell of a kiji table.
            KijiCellDecoder + +
            +          Interface for Kiji cell decoders.
            KijiCellDecoderFactory + +
            +          Interface for factories of KijiCellDecoder instances.
            KijiCellEncoder + +
            +          Interface for Kiji cell encoders.
            KijiColumnName + +
            +          A Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiConfiguration + +
            +          Deprecated. 
            KijiCounter + +
            +          Deprecated. KijiCounter will be merged into KijiCell.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiDataRequest.Column + +
            +          Describes a request for a Kiji Table column.
            KijiDeleter + +
            +          Interface for performing deletes on a Kiji table.
            KijiFactory + +
            +          Factory for Kiji instances.
            KijiIncrementer + +
            +          Interface for performing increments on a Kiji table.
            KijiInvalidNameException + +
            +          Thrown when a Kiji instance or table layout name is invalid.
            KijiManagedHBaseTableName + +
            +          Multiple instances of Kiji can be installed on a single HBase + cluster.
            KijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiPutter + +
            +          Interface for performing puts on a Kiji table.
            KijiRowData + +
            +          The input data for a single entity in Kiji.
            KijiRowScanner + +
            +          Interface for scanning over rows read from a Kiji table.
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSystemTable + +
            +          The Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiTable + +
            +          Interface for Kiji Tables.
            KijiTableFactory + +
            +          Factory for KijiTable instances.
            KijiTableKeyValueDatabase + +
            +          A database of per table key-value pairs.
            KijiTablePool.Options + +
            +          Describes the options that can be configured on the KijiTablePool.
            KijiTableReader + +
            +          Interface for reading data from a kiji table.
            KijiTableReader.KijiScannerOptions + +
            +          Options for KijiRowScanners.
            KijiTableWriter + +
            +          Interface for modifying a Kiji table.
            KijiURI + +
            +          URI that fully qualifies a Kiji instance/table/column.
            KijiURIException + +
            +          Thrown when parsing a bogus Kiji URI.
            NotAKijiManagedTableException + +
            +          Thrown when Kiji encounters an HBase table that is not managed by Kiji.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.filter
            HBaseColumnName + +
            +          An HBase column name.
            KijiCell + +
            +          The data held in one cell of a kiji table.
            KijiColumnName + +
            +          A Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            NoSuchColumnException + +
            +          Thrown when attempting to access a column that does not exist.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.impl
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            EntityIdFactory + +
            +          Factory class for creating EntityIds.
            HBaseFactory + +
            +          Factory for HBase instances based on URIs.
            HBaseScanOptions + +
            +          Customizable parameters for KijiRowScanners backed by an HBase scan.
            Kiji + +
            +          Provides a handle to a Kiji instance that contains configuration and + table information.
            KijiAdmin + +
            +          Administration API for managing a Kiji instance.
            KijiCell + +
            +          The data held in one cell of a kiji table.
            KijiCellDecoder + +
            +          Interface for Kiji cell decoders.
            KijiCellDecoderFactory + +
            +          Interface for factories of KijiCellDecoder instances.
            KijiCellEncoder + +
            +          Interface for Kiji cell encoders.
            KijiCellEncoderFactory + +
            +          Interface for factories of KijiCellEncoder instances.
            KijiConfiguration + +
            +          Deprecated. 
            KijiCounter + +
            +          Deprecated. KijiCounter will be merged into KijiCell.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiDeleter + +
            +          Interface for performing deletes on a Kiji table.
            KijiFactory + +
            +          Factory for Kiji instances.
            KijiIncrementer + +
            +          Interface for performing increments on a Kiji table.
            KijiManagedHBaseTableName + +
            +          Multiple instances of Kiji can be installed on a single HBase + cluster.
            KijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiPutter + +
            +          Interface for performing puts on a Kiji table.
            KijiRowData + +
            +          The input data for a single entity in Kiji.
            KijiRowScanner + +
            +          Interface for scanning over rows read from a Kiji table.
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSchemaTable.SchemaEntry + +
            +          Association between a schema and its ID.
            KijiSystemTable + +
            +          The Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiTable + +
            +          Interface for Kiji Tables.
            KijiTableFactory + +
            +          Factory for KijiTable instances.
            KijiTableKeyValueDatabase + +
            +          A database of per table key-value pairs.
            KijiTableReader + +
            +          Interface for reading data from a kiji table.
            KijiTableReader.KijiScannerOptions + +
            +          Options for KijiRowScanners.
            KijiTableWriter + +
            +          Interface for modifying a Kiji table.
            KijiURI + +
            +          URI that fully qualifies a Kiji instance/table/column.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.layout
            HBaseColumnName + +
            +          An HBase column name.
            KijiColumnName + +
            +          A Kiji column name is composed of one or two parts: a family and a qualifier.
            NoSuchColumnException + +
            +          Thrown when attempting to access a column that does not exist.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.layout.impl
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            +  +

            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.mapreduce
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiRowData + +
            +          The input data for a single entity in Kiji.
            KijiURI + +
            +          URI that fully qualifies a Kiji instance/table/column.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.tools
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            Kiji + +
            +          Provides a handle to a Kiji instance that contains configuration and + table information.
            KijiURI + +
            +          URI that fully qualifies a Kiji instance/table/column.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.util
            Kiji + +
            +          Provides a handle to a Kiji instance that contains configuration and + table information.
            KijiInvalidNameException + +
            +          Thrown when a Kiji instance or table layout name is invalid.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/BaseTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/BaseTool.html new file mode 100644 index 00000000..648971fb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/BaseTool.html @@ -0,0 +1,597 @@ + + + + + + + +BaseTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class BaseTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            Direct Known Subclasses:
            InstallTool, UninstallTool, VersionTool, VersionValidatedTool
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Extensible
+public abstract class BaseTool
            extends Configured
            implements KijiTool
            + + +

            +Base class for all command line tools. A kiji command line tool operates on a kiji instance, + specified through a KijiURI via the command-line (with a default value pointing to the + default kiji instance found in the hbase cluster specified by whatever hbase configuration is + on the classpath). If the kiji URI for the instance specifies more elements than the zookeeper + connection information and instance name they will be ignored. + + A command line tool, executed via KijiToolLauncher, will perform these steps when run: +

              +
            1. Parse command-line flags to the tool and set the appropriate fields. Subclasses + wishing to add flags to a tool should use the Flag annotation.
              2. +
            2. Use the kiji URI specified via the command line (or using the default + kiji://.env/default to initialize the instance's configuration with + hbase connection parameters and hbase resources.
              3. +
            3. Run the validateFlags() method. Subclasses wishing to validate custom + command-line arguments should override this method + but take care to call super.validateFlags()
              4. +
            4. Run the setup() method. Subclasses wishing to implement custom setup logic + should override this method but take care to call super.setup()
              5. +
            5. Run the run(java.util.List) method. Subclasses should implement their main + command logic here. The argument to run is a String list of + arguments passed that were not arguments to the Hadoop framework or flags specified via + Flag annotations.
              6. +
            6. Run the cleanup() method. Subclasses wishing to implement custom cleanup + logic should override this method but take care to call super.cleanup. + cleanup will run even if there is an exception while executing setup + or run. +
            + + Tools needing to prompt the user for a yes/no answer should use the yesNoPrompt() method. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            BaseTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + PrintStreamgetPrintStream() + +
            +          The output print stream the tool should be writing to.
            +protected  KijiURIgetURI() + +
            +          Returns the kiji URI of the target this tool operates on.
            +protected  booleanisInteractive() + +
            +          Whether or not this tool is being run interactively.
            +protected abstract  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            + voidsetPrintStream(PrintStream printStream) + +
            +          Set the output print stream the tool should write to.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidsetURI(KijiURI uri) + +
            +          Sets the kiji URI of the target this tool operates on.
            + inttoolMain(List<String> args) + +
            +          Invoke the functionality of this tool, as supplied through its + implementation of the abstract methods of this class.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +protected  booleanyesNoPrompt() + +
            +          Prompts the user for a yes or no answer until they provide a valid response + (y/n/yes/no case insensitive) and reports the result.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.tools.KijiTool
            getCategory, getDescription, getName
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +BaseTool

            +
            +public BaseTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +yesNoPrompt

            +
            +protected final boolean yesNoPrompt()
+                             throws IOException
            +
            +
            Prompts the user for a yes or no answer until they provide a valid response + (y/n/yes/no case insensitive) and reports the result. If yesNoPrompt is called in + non-interactive mode, an IllegalstateException is thrown. +

            +

            +
            +
            +
            + +
            Returns:
            true if the user answer yes, false if the user answered no. +
            Throws: +
            IOException - if there is a problem reading from the terminal.
            +
            +
            +
            + +

            +toolMain

            +
            +public int toolMain(List<String> args)
+             throws Exception
            +
            +
            Invoke the functionality of this tool, as supplied through its + implementation of the abstract methods of this class. +

            +

            +
            Specified by:
            toolMain in interface KijiTool
            +
            +
            +
            Parameters:
            args - the command-line arguments to the tool not including the + tool name itself. +
            Returns:
            0 on success, non-zero on failure. +
            Throws: +
            Exception - if there's an error inside the tool.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected abstract int run(List<String> nonFlagArgs)
+                    throws Exception
            +
            +
            Runs the tool. +

            +

            +
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getURI

            +
            +protected KijiURI getURI()
            +
            +
            Returns the kiji URI of the target this tool operates on. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji URI of the target this tool operates on.
            +
            +
            +
            + +

            +setURI

            +
            +protected void setURI(KijiURI uri)
            +
            +
            Sets the kiji URI of the target this tool operates on. +

            +

            +
            +
            +
            +
            Parameters:
            uri - The kiji URI of the target this tool should operate on.
            +
            +
            +
            + +

            +setPrintStream

            +
            +public void setPrintStream(PrintStream printStream)
            +
            +
            Set the output print stream the tool should write to. If you don't set it, + it will default to STDOUT. +

            +

            +
            +
            +
            +
            Parameters:
            printStream - The output print stream to use.
            +
            +
            +
            + +

            +getPrintStream

            +
            +public PrintStream getPrintStream()
            +
            +
            The output print stream the tool should be writing to. +

            +

            +
            +
            +
            + +
            Returns:
            The print stream the tool should write to.
            +
            +
            +
            + +

            +isInteractive

            +
            +protected final boolean isInteractive()
            +
            +
            Whether or not this tool is being run interactively. +

            +

            +
            +
            +
            + +
            Returns:
            Whether or not this tool is being run interactively.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/CreateTableTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/CreateTableTool.html new file mode 100644 index 00000000..83339d4c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/CreateTableTool.html @@ -0,0 +1,482 @@ + + + + + + + +CreateTableTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class CreateTableTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.CreateTableTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class CreateTableTool
            extends VersionValidatedTool
            + + +

            +Command-line tool for creating kiji tables in kiji instances. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            CreateTableTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, setPrintStream, setup, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +CreateTableTool

            +
            +public CreateTableTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/DeleteTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/DeleteTool.html new file mode 100644 index 00000000..afde1081 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/DeleteTool.html @@ -0,0 +1,530 @@ + + + + + + + +DeleteTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class DeleteTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.DeleteTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DeleteTool
            extends VersionValidatedTool
            + + +

            +Command-line tool to delete kiji tables, rows, and cells. + + --instance to select a kiji instance. + if unspecified, uses default instance name + + --table to select a kiji table. + required for all delete commands + + --row to select a kiji row. + required for family, qualifier, and timestamp flags to operate + + --family to select a kiji family. + required for qualifier flag to operate + + --qualifer to select a kiji column. + required for exact-timestamp and most-recent flags to operate + + --upto-timestamp to select values with timestamp equal or lesser. + + --exact-timestamp to select a value with a specific timestamp. + + --most-recent to select the most recent value in a cell. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DeleteTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, setPrintStream, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +DeleteTool

            +
            +public DeleteTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/FlushTableTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/FlushTableTool.html new file mode 100644 index 00000000..867b3195 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/FlushTableTool.html @@ -0,0 +1,509 @@ + + + + + + + +FlushTableTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class FlushTableTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.FlushTableTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class FlushTableTool
            extends VersionValidatedTool
            + + +

            +Command-line tool for flushing kiji meta and user tables in hbase. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            FlushTableTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, setPrintStream, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +FlushTableTool

            +
            +public FlushTableTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/HelpTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/HelpTool.html new file mode 100644 index 00000000..4408a2dd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/HelpTool.html @@ -0,0 +1,367 @@ + + + + + + + +HelpTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class HelpTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.HelpTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HelpTool
            extends Configured
            implements KijiTool
            + + +

            +Command-line tool for displaying help on available tools. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HelpTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            + inttoolMain(List<String> args) + +
            +          The main logic of your tool.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +HelpTool

            +
            +public HelpTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            Specified by:
            getName in interface KijiTool
            +
            +
            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            +
            Specified by:
            getDescription in interface KijiTool
            +
            +
            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            +
            Specified by:
            getCategory in interface KijiTool
            +
            +
            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +toolMain

            +
            +public int toolMain(List<String> args)
+             throws Exception
            +
            +
            The main logic of your tool. +

            +

            +
            Specified by:
            toolMain in interface KijiTool
            +
            +
            +
            Parameters:
            args - the arguments on the command line (excluding the tool name itself). +
            Returns:
            The program exit code. 0 should indicate success. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/IncrementTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/IncrementTool.html new file mode 100644 index 00000000..762a60c8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/IncrementTool.html @@ -0,0 +1,482 @@ + + + + + + + +IncrementTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class IncrementTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.IncrementTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class IncrementTool
            extends VersionValidatedTool
            + + +

            +Command-line tool to increment a counter in a cell of a kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            IncrementTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, setPrintStream, setup, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +IncrementTool

            +
            +public IncrementTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/InstallTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/InstallTool.html new file mode 100644 index 00000000..3c4fd6ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/InstallTool.html @@ -0,0 +1,392 @@ + + + + + + + +InstallTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class InstallTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.InstallTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class InstallTool
            extends BaseTool
            + + +

            +A command-line tool for installing kiji instances on hbase clusters. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            InstallTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, getURI, isInteractive, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +InstallTool

            +
            +public InstallTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/KijiTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/KijiTool.html new file mode 100644 index 00000000..22868ef2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/KijiTool.html @@ -0,0 +1,318 @@ + + + + + + + +KijiTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Interface KijiTool

            +
            +
            All Superinterfaces:
            Configurable
            +
            +
            +
            All Known Implementing Classes:
            BaseTool, CreateTableTool, DeleteTool, FlushTableTool, HelpTool, IncrementTool, InstallTool, LayoutTool, LsTool, MetadataTool, PutTool, SynthesizeUserDataTool, UninstallTool, VersionTool, VersionValidatedTool
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface KijiTool
            extends Configurable
            + + +

            +Base interface to be implemented by command-line tools that are launched through + the bin/kiji script. These tools are instantiated and run by the + KijiToolLauncher. + +

            To register a tool to use with bin/kiji, you must also put the complete + name of the implementing class in a resource in your jar file at: + META-INF/services/org.kiji.schema.tools.KijiTool. You may publish multiple + tools in this way; put each class name on its own line in this file. You can put + this file in src/test/resources/ in your Maven project, and it will be + incorporated into your jar.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +           
            + StringgetDescription() + +
            +           
            + StringgetName() + +
            +           
            + inttoolMain(List<String> args) + +
            +          The main logic of your tool.
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +String getName()
            +
            +
            +
            +
            +
            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +String getDescription()
            +
            +
            +
            +
            +
            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +String getCategory()
            +
            +
            +
            +
            +
            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +toolMain

            +
            +int toolMain(List<String> args)
+             throws Exception
            +
            +
            The main logic of your tool. +

            +

            +
            +
            +
            +
            Parameters:
            args - the arguments on the command line (excluding the tool name itself). +
            Returns:
            The program exit code. 0 should indicate success. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/KijiToolLauncher.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/KijiToolLauncher.html new file mode 100644 index 00000000..20be0457 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/KijiToolLauncher.html @@ -0,0 +1,342 @@ + + + + + + + +KijiToolLauncher (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class KijiToolLauncher

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.KijiToolLauncher
+
            +
            +
            All Implemented Interfaces:
            Configurable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiToolLauncher
            extends Configured
            + + +

            +Main entry point to launch Kiji tools. + +

            All tools launched through bin/kiji <tool> are detected and + instantiated through this module. Tools should implement the KijiTool + interface. In addition, each tool must advertise itself by adding a line to + a resource file contained in its jar at + META-INF/services/org.kiji.schema.tools.KijiTool. + This path can be added to your build by providing it under src/main/resources.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiToolLauncher() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidmain(String[] args) + +
            +          Program entry point.
            + intrun(KijiTool tool, + String[] args) + +
            +          Programmatic entry point to the tool launcher if a tool is already selected.
            + intrun(String[] args) + +
            +          Programmatic entry point to the tool launcher.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiToolLauncher

            +
            +public KijiToolLauncher()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +run

            +
            +public int run(String[] args)
+        throws Exception
            +
            +
            Programmatic entry point to the tool launcher. Locates a tool to run + based on the name provided as the first argument, then invokes it. + Hadoop property-based arguments will be parsed by KijiToolLauncher.run() + in a manner similar to Hadoop's ToolRunner. +

            +

            +
            Parameters:
            args - The command-line arguments. The first one should be the + name of the tool to run. +
            Returns:
            0 on program success, non-zero on error. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +public int run(KijiTool tool,
+               String[] args)
+        throws Exception
            +
            +
            Programmatic entry point to the tool launcher if a tool is already selected. + Hadoop property-based arguments will be parsed by KijiToolLauncher.run() + in a manner similar to Hadoop's ToolRunner. +

            +

            +
            Parameters:
            tool - The KijiTool to run.
            args - The command-line arguments, excluding the name of the tool to run. +
            Returns:
            0 on program success, non-zero on error. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. This method does not return; it calls System.exit() with the + return code from the called tool. +

            +

            +
            Parameters:
            args - The command-line arguments, starting with the name of the tool to run. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/LayoutTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/LayoutTool.html new file mode 100644 index 00000000..432172ae --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/LayoutTool.html @@ -0,0 +1,506 @@ + + + + + + + +LayoutTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class LayoutTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.LayoutTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class LayoutTool
            extends VersionValidatedTool
            + + +

            +Command-line tool for interacting with table layouts. Actions include reading a layout, + setting a table layout, and viewing a table's layout history. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            LayoutTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            +protected static booleanfileSystemSpecified(Path path) + +
            +          Determines whether a path has its filesystem explicitly specified.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, setPrintStream, setup, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +LayoutTool

            +
            +public LayoutTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +fileSystemSpecified

            +
            +protected static boolean fileSystemSpecified(Path path)
            +
            +
            Determines whether a path has its filesystem explicitly specified. Did it start + with "hdfs://" or "file://"? +

            +

            +
            Parameters:
            path - The path to check. +
            Returns:
            Whether a file system was explicitly specified in the path.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/LsTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/LsTool.html new file mode 100644 index 00000000..954e5451 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/LsTool.html @@ -0,0 +1,545 @@ + + + + + + + +LsTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class LsTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.LsTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class LsTool
            extends VersionValidatedTool
            + + +

            +Command-line tool to explore kiji table data like the 'ls' command of a unix shell. + + List all kiji tables: + kiji ls + + List all kiji instances: + kiji ls --instances + + List all families in a kiji table foo: + kiji ls --table=foo + + List all data in the info:email and derived:domain columns of a table foo: + kiji ls --table=foo --columns=info:email,derived:domain + + List all data in the info:email and derived:domain columns of a table foo in row bar: + kiji ls --table=foo --columns=info:email,derived:domain --entity-id=bar +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            LsTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  Set<String>getInstanceNames() + +
            +          Returns a set of instance names.
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected static StringparseInstanceName(String kijiTableName) + +
            +          Parses a table name for a kiji instance name.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, setPrintStream, setup, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +LsTool

            +
            +public LsTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +getInstanceNames

            +
            +protected Set<String> getInstanceNames()
+                                throws IOException
            +
            +
            Returns a set of instance names. +

            +

            + +
            Returns:
            The set of instance names +
            Throws: +
            IOException - if there is an error retrieving the HBase tables
            +
            +
            +
            + +

            +parseInstanceName

            +
            +protected static String parseInstanceName(String kijiTableName)
            +
            +
            Parses a table name for a kiji instance name. +

            +

            +
            Parameters:
            kijiTableName - The table name to parse +
            Returns:
            instance name (or null if none found)
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Description copied from class: BaseTool
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/MetadataTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/MetadataTool.html new file mode 100644 index 00000000..75c5f486 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/MetadataTool.html @@ -0,0 +1,454 @@ + + + + + + + +MetadataTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class MetadataTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.MetadataTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            public class MetadataTool
            extends VersionValidatedTool
            + + +

            +A tool to backup and restore Metadata. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            MetadataTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +MetadataTool

            +
            +public MetadataTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/PutTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/PutTool.html new file mode 100644 index 00000000..99af99b2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/PutTool.html @@ -0,0 +1,457 @@ + + + + + + + +PutTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class PutTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.PutTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class PutTool
            extends VersionValidatedTool
            + + +

            +Command-line tool for putting an Avro value into a kiji cell. The value is specified by the + user as a JSON string that matches the Avro-JSON-encoding of a piece of Avro data. The user + must also specify an Avro schema (as a JSON string) when writing a value with this tool. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            PutTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +PutTool

            +
            +public PutTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/RequiredFlagException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/RequiredFlagException.html new file mode 100644 index 00000000..c7035f83 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/RequiredFlagException.html @@ -0,0 +1,250 @@ + + + + + + + +RequiredFlagException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class RequiredFlagException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.tools.RequiredFlagException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class RequiredFlagException
            extends Exception
            + + +

            +Thrown to indicate that a flag is required but not supplied. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            RequiredFlagException(String flagName) + +
            +          Creates a new RequiredFlagException for the specified flag name.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +RequiredFlagException

            +
            +public RequiredFlagException(String flagName)
            +
            +
            Creates a new RequiredFlagException for the specified flag name. +

            +

            +
            Parameters:
            flagName - The name of the flag without the '--'.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/SynthesizeUserDataTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/SynthesizeUserDataTool.html new file mode 100644 index 00000000..81a44489 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/SynthesizeUserDataTool.html @@ -0,0 +1,482 @@ + + + + + + + +SynthesizeUserDataTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class SynthesizeUserDataTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+              extended by org.kiji.schema.tools.SynthesizeUserDataTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class SynthesizeUserDataTool
            extends VersionValidatedTool
            + + +

            +Synthesize some user data into a kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            SynthesizeUserDataTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.VersionValidatedTool
            openKiji
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, setPrintStream, setup, setURI, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +SynthesizeUserDataTool

            +
            +public SynthesizeUserDataTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/ToolUtils.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/ToolUtils.html new file mode 100644 index 00000000..d5709be0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/ToolUtils.html @@ -0,0 +1,272 @@ + + + + + + + +ToolUtils (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class ToolUtils

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.ToolUtils
+
            +
            +
            +
            @ApiAudience.Framework
+public final class ToolUtils
            extends Object
            + + +

            +Utility class providing static methods used by command-line tools. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static EntityIdcreateEntityIdFromUserInputs(String entityId, + String entityHash, + RowKeyFormat format) + +
            +          Create an EntityId from the --entity-id and --entity-hash arguments to a kiji tool.
            +static byte[]parseRowKeyFlag(String flag) + +
            +          Parses a flag describing a row key.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +createEntityIdFromUserInputs

            +
            +public static EntityId createEntityIdFromUserInputs(String entityId,
+                                                    String entityHash,
+                                                    RowKeyFormat format)
+                                             throws IOException
            +
            +
            Create an EntityId from the --entity-id and --entity-hash arguments to a kiji tool. + It is an error for both (or neither) of these to be specified. + + It is also an error to specify entityHash for a table where hashRowKeys is false. + "Unspecified" means null or the empty string (""). + "Specified" means a non-null, non-empty string. +

            +

            +
            Parameters:
            entityId - The unhashed entity name which should be turned into an EntityId.
            entityHash - The hashed entity name which should be used directly.
            format - Format used to encode row keys. +
            Returns:
            the entity id as specified in the flags. +
            Throws: +
            RuntimeException - if arguments are invalid. +
            IOException - on I/O error.
            +
            +
            +
            + +

            +parseRowKeyFlag

            +
            +public static byte[] parseRowKeyFlag(String flag)
+                              throws IOException
            +
            +
            Parses a flag describing a row key. + + Row keys can be specified as: +
              +
            • a sequence of bytes, in hexadecimal representation, e.g. "hex:00dead00beef" +
            • a UTF8 encoded text row key, e.g. "row-key" or "utf8:row-key". +
            +

            +

            +
            Parameters:
            flag - Row key description. +
            Returns:
            the byte array as specified in the flag. +
            Throws: +
            IOException - if unable to decode the flag.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/UninstallTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/UninstallTool.html new file mode 100644 index 00000000..29def0a6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/UninstallTool.html @@ -0,0 +1,392 @@ + + + + + + + +UninstallTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class UninstallTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.UninstallTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class UninstallTool
            extends BaseTool
            + + +

            +A command-line tool for uninstalling kiji instances from an hbase cluster. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            UninstallTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, getURI, isInteractive, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +UninstallTool

            +
            +public UninstallTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/VersionTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/VersionTool.html new file mode 100644 index 00000000..3b39293a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/VersionTool.html @@ -0,0 +1,474 @@ + + + + + + + +VersionTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class VersionTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class VersionTool
            extends BaseTool
            + + +

            +Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            VersionTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  KijiopenKiji() + +
            +          Opens a kiji instance.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +VersionTool

            +
            +public VersionTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +openKiji

            +
            +protected Kiji openKiji()
+                 throws IOException
            +
            +
            Opens a kiji instance. + Subclasses should override this method with validation logic as needed. + Subclasses should write a useful message to getPrintStream() if they generate + an IOException. +

            +

            + +
            Returns:
            The opened kiji. +
            Throws: +
            IOException - if there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/VersionValidatedTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/VersionValidatedTool.html new file mode 100644 index 00000000..9878ae07 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/VersionValidatedTool.html @@ -0,0 +1,375 @@ + + + + + + + +VersionValidatedTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class VersionValidatedTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionValidatedTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            Direct Known Subclasses:
            CreateTableTool, DeleteTool, FlushTableTool, IncrementTool, LayoutTool, LsTool, MetadataTool, PutTool, SynthesizeUserDataTool
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Extensible
+public abstract class VersionValidatedTool
            extends BaseTool
            + + +

            +Base class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool. Subclasses of this tool will first check that the data format + version of the kiji instance in hbase matches that of the client. If not, the tool + will exit early. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected VersionValidatedTool() + +
            +          Constructor.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            +protected  KijigetKiji() + +
            +          Retrieves the kiji instance used by this tool.
            +protected  KijiopenKiji() + +
            +          Opens a kiji instance.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, getURI, isInteractive, run, setPrintStream, setup, setURI, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.tools.KijiTool
            getCategory, getDescription, getName
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +VersionValidatedTool

            +
            +protected VersionValidatedTool()
            +
            +
            Constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +openKiji

            +
            +protected Kiji openKiji()
+                 throws IOException
            +
            +
            Opens a kiji instance. + Subclasses should override this method with validation logic as needed. + Subclasses should write a useful message to getPrintStream() if they generate + an IOException. +

            +

            +
            +
            +
            + +
            Returns:
            The opened kiji. +
            Throws: +
            IOException - if there is an error.
            +
            +
            +
            + +

            +getKiji

            +
            +protected Kiji getKiji()
+                throws IOException
            +
            +
            Retrieves the kiji instance used by this tool. On the first call to this method, + the kiji instance will be opened and will remain open until cleanup() is called. +

            +

            + +
            Returns:
            The kiji instance. +
            Throws: +
            IOException - if there is an error loading the kiji.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/BaseTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/BaseTool.html new file mode 100644 index 00000000..89d87cb6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/BaseTool.html @@ -0,0 +1,280 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.BaseTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.BaseTool

            +
            + + + + + + + + + +
            +Packages that use BaseTool
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of BaseTool in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of BaseTool in org.kiji.schema.tools
            + classCreateTableTool + +
            +          Command-line tool for creating kiji tables in kiji instances.
            + classDeleteTool + +
            +          Command-line tool to delete kiji tables, rows, and cells.
            + classFlushTableTool + +
            +          Command-line tool for flushing kiji meta and user tables in hbase.
            + classIncrementTool + +
            +          Command-line tool to increment a counter in a cell of a kiji table.
            + classInstallTool + +
            +          A command-line tool for installing kiji instances on hbase clusters.
            + classLayoutTool + +
            +          Command-line tool for interacting with table layouts.
            + classLsTool + +
            +          Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            + classMetadataTool + +
            +          A tool to backup and restore Metadata.
            + classPutTool + +
            +          Command-line tool for putting an Avro value into a kiji cell.
            + classSynthesizeUserDataTool + +
            +          Synthesize some user data into a kiji table.
            + classUninstallTool + +
            +          A command-line tool for uninstalling kiji instances from an hbase cluster.
            + classVersionTool + +
            +          Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            + classVersionValidatedTool + +
            +          Base class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/CreateTableTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/CreateTableTool.html new file mode 100644 index 00000000..96835656 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/CreateTableTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.CreateTableTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.CreateTableTool

            +
            +No usage of org.kiji.schema.tools.CreateTableTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/DeleteTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/DeleteTool.html new file mode 100644 index 00000000..ec1978da --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/DeleteTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.DeleteTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.DeleteTool

            +
            +No usage of org.kiji.schema.tools.DeleteTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/FlushTableTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/FlushTableTool.html new file mode 100644 index 00000000..eeffe12d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/FlushTableTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.FlushTableTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.FlushTableTool

            +
            +No usage of org.kiji.schema.tools.FlushTableTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/HelpTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/HelpTool.html new file mode 100644 index 00000000..ba7d5432 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/HelpTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.HelpTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.HelpTool

            +
            +No usage of org.kiji.schema.tools.HelpTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/IncrementTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/IncrementTool.html new file mode 100644 index 00000000..11b33a2f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/IncrementTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.IncrementTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.IncrementTool

            +
            +No usage of org.kiji.schema.tools.IncrementTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/InstallTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/InstallTool.html new file mode 100644 index 00000000..92c03835 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/InstallTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.InstallTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.InstallTool

            +
            +No usage of org.kiji.schema.tools.InstallTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/KijiTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/KijiTool.html new file mode 100644 index 00000000..635c906e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/KijiTool.html @@ -0,0 +1,313 @@ + + + + + + + +Uses of Interface org.kiji.schema.tools.KijiTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.tools.KijiTool

            +
            + + + + + + + + + +
            +Packages that use KijiTool
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of KijiTool in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.schema.tools that implement KijiTool
            + classBaseTool + +
            +          Base class for all command line tools.
            + classCreateTableTool + +
            +          Command-line tool for creating kiji tables in kiji instances.
            + classDeleteTool + +
            +          Command-line tool to delete kiji tables, rows, and cells.
            + classFlushTableTool + +
            +          Command-line tool for flushing kiji meta and user tables in hbase.
            + classHelpTool + +
            +          Command-line tool for displaying help on available tools.
            + classIncrementTool + +
            +          Command-line tool to increment a counter in a cell of a kiji table.
            + classInstallTool + +
            +          A command-line tool for installing kiji instances on hbase clusters.
            + classLayoutTool + +
            +          Command-line tool for interacting with table layouts.
            + classLsTool + +
            +          Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            + classMetadataTool + +
            +          A tool to backup and restore Metadata.
            + classPutTool + +
            +          Command-line tool for putting an Avro value into a kiji cell.
            + classSynthesizeUserDataTool + +
            +          Synthesize some user data into a kiji table.
            + classUninstallTool + +
            +          A command-line tool for uninstalling kiji instances from an hbase cluster.
            + classVersionTool + +
            +          Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            + classVersionValidatedTool + +
            +          Base class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type KijiTool
            + intKijiToolLauncher.run(KijiTool tool, + String[] args) + +
            +          Programmatic entry point to the tool launcher if a tool is already selected.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/KijiToolLauncher.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/KijiToolLauncher.html new file mode 100644 index 00000000..b1de9b4d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/KijiToolLauncher.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.KijiToolLauncher (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.KijiToolLauncher

            +
            +No usage of org.kiji.schema.tools.KijiToolLauncher +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/LayoutTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/LayoutTool.html new file mode 100644 index 00000000..9f732c9c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/LayoutTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.LayoutTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.LayoutTool

            +
            +No usage of org.kiji.schema.tools.LayoutTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/LsTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/LsTool.html new file mode 100644 index 00000000..86d76aae --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/LsTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.LsTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.LsTool

            +
            +No usage of org.kiji.schema.tools.LsTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/MetadataTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/MetadataTool.html new file mode 100644 index 00000000..55b3e349 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/MetadataTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.MetadataTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.MetadataTool

            +
            +No usage of org.kiji.schema.tools.MetadataTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/PutTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/PutTool.html new file mode 100644 index 00000000..0e6c359a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/PutTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.PutTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.PutTool

            +
            +No usage of org.kiji.schema.tools.PutTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/RequiredFlagException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/RequiredFlagException.html new file mode 100644 index 00000000..2e9c5473 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/RequiredFlagException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.RequiredFlagException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.RequiredFlagException

            +
            +No usage of org.kiji.schema.tools.RequiredFlagException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html new file mode 100644 index 00000000..1d783048 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.SynthesizeUserDataTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.SynthesizeUserDataTool

            +
            +No usage of org.kiji.schema.tools.SynthesizeUserDataTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/ToolUtils.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/ToolUtils.html new file mode 100644 index 00000000..a037918c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/ToolUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.ToolUtils (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.ToolUtils

            +
            +No usage of org.kiji.schema.tools.ToolUtils +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/UninstallTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/UninstallTool.html new file mode 100644 index 00000000..8e754ac7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/UninstallTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.UninstallTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.UninstallTool

            +
            +No usage of org.kiji.schema.tools.UninstallTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/VersionTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/VersionTool.html new file mode 100644 index 00000000..4ea32b1e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/VersionTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.VersionTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.VersionTool

            +
            +No usage of org.kiji.schema.tools.VersionTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/VersionValidatedTool.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/VersionValidatedTool.html new file mode 100644 index 00000000..98abe85c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/class-use/VersionValidatedTool.html @@ -0,0 +1,246 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.VersionValidatedTool (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.VersionValidatedTool

            +
            + + + + + + + + + +
            +Packages that use VersionValidatedTool
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of VersionValidatedTool in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of VersionValidatedTool in org.kiji.schema.tools
            + classCreateTableTool + +
            +          Command-line tool for creating kiji tables in kiji instances.
            + classDeleteTool + +
            +          Command-line tool to delete kiji tables, rows, and cells.
            + classFlushTableTool + +
            +          Command-line tool for flushing kiji meta and user tables in hbase.
            + classIncrementTool + +
            +          Command-line tool to increment a counter in a cell of a kiji table.
            + classLayoutTool + +
            +          Command-line tool for interacting with table layouts.
            + classLsTool + +
            +          Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            + classMetadataTool + +
            +          A tool to backup and restore Metadata.
            + classPutTool + +
            +          Command-line tool for putting an Avro value into a kiji cell.
            + classSynthesizeUserDataTool + +
            +          Synthesize some user data into a kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-frame.html new file mode 100644 index 00000000..d38b001f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-frame.html @@ -0,0 +1,87 @@ + + + + + + + +org.kiji.schema.tools (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.schema.tools + + + + +
            +Interfaces  + +
            +KijiTool
            + + + + + + +
            +Classes  + +
            +BaseTool +
            +CreateTableTool +
            +DeleteTool +
            +FlushTableTool +
            +HelpTool +
            +IncrementTool +
            +InstallTool +
            +KijiToolLauncher +
            +LayoutTool +
            +LsTool +
            +MetadataTool +
            +PutTool +
            +SynthesizeUserDataTool +
            +ToolUtils +
            +UninstallTool +
            +VersionTool +
            +VersionValidatedTool
            + + + + + + +
            +Exceptions  + +
            +RequiredFlagException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-summary.html new file mode 100644 index 00000000..5c3f293f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-summary.html @@ -0,0 +1,270 @@ + + + + + + + +org.kiji.schema.tools (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.tools +

            +Package containing implementations, abstract base classes, + and exceptions for kiji command-line tools. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            KijiToolBase interface to be implemented by command-line tools that are launched through + the bin/kiji script.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            BaseToolBase class for all command line tools.
            CreateTableToolCommand-line tool for creating kiji tables in kiji instances.
            DeleteToolCommand-line tool to delete kiji tables, rows, and cells.
            FlushTableToolCommand-line tool for flushing kiji meta and user tables in hbase.
            HelpToolCommand-line tool for displaying help on available tools.
            IncrementToolCommand-line tool to increment a counter in a cell of a kiji table.
            InstallToolA command-line tool for installing kiji instances on hbase clusters.
            KijiToolLauncherMain entry point to launch Kiji tools.
            LayoutToolCommand-line tool for interacting with table layouts.
            LsToolCommand-line tool to explore kiji table data like the 'ls' command of a unix shell.
            MetadataToolA tool to backup and restore Metadata.
            PutToolCommand-line tool for putting an Avro value into a kiji cell.
            SynthesizeUserDataToolSynthesize some user data into a kiji table.
            ToolUtilsUtility class providing static methods used by command-line tools.
            UninstallToolA command-line tool for uninstalling kiji instances from an hbase cluster.
            VersionToolCommand-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            VersionValidatedToolBase class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            RequiredFlagExceptionThrown to indicate that a flag is required but not supplied.
            +  + +

            +

            +Package org.kiji.schema.tools Description +

            + +

            +Package containing implementations, abstract base classes, + and exceptions for kiji command-line tools. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-tree.html new file mode 100644 index 00000000..93cada55 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-tree.html @@ -0,0 +1,175 @@ + + + + + + + +org.kiji.schema.tools Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.tools +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-use.html new file mode 100644 index 00000000..ff165d6b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/package-use.html @@ -0,0 +1,186 @@ + + + + + + + +Uses of Package org.kiji.schema.tools (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.tools

            +
            + + + + + + + + + +
            +Packages that use org.kiji.schema.tools
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.tools used by org.kiji.schema.tools
            BaseTool + +
            +          Base class for all command line tools.
            KijiTool + +
            +          Base interface to be implemented by command-line tools that are launched through + the bin/kiji script.
            VersionValidatedTool + +
            +          Base class for command-line tools that require compatibility with the data format version of the + kiji instance used by the tool.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/DictionaryLoader.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/DictionaryLoader.html new file mode 100644 index 00000000..2db747ef --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/DictionaryLoader.html @@ -0,0 +1,291 @@ + + + + + + + +DictionaryLoader (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class DictionaryLoader

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.DictionaryLoader
+
            +
            +
            +
            @ApiAudience.Private
+public final class DictionaryLoader
            extends Object
            + + +

            +Loads a dictionary file, which is simply a list of words, one per line. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DictionaryLoader() + +
            +          Creates a new DictionaryLoader instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + List<String>load(InputStream inputStream) + +
            +          Loads the dictionary from an input stream.
            + List<String>load(String filename) + +
            +          Loads the dictionary from a file.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DictionaryLoader

            +
            +public DictionaryLoader()
            +
            +
            Creates a new DictionaryLoader instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +load

            +
            +public List<String> load(String filename)
+                  throws IOException
            +
            +
            Loads the dictionary from a file. +

            +

            +
            Parameters:
            filename - The path to a file of words, one per line. +
            Returns:
            The list of words from the file. +
            Throws: +
            IOException - If there is an error reading the words from the file.
            +
            +
            +
            + +

            +load

            +
            +public List<String> load(InputStream inputStream)
+                  throws IOException
            +
            +
            Loads the dictionary from an input stream. +

            +

            +
            Parameters:
            inputStream - The input stream of words, one per line. +
            Returns:
            The list of words from the stream. +
            Throws: +
            IOException - If there is an error reading the words from the stream.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/EmailSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/EmailSynthesizer.html new file mode 100644 index 00000000..8617119a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/EmailSynthesizer.html @@ -0,0 +1,326 @@ + + + + + + + +EmailSynthesizer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class EmailSynthesizer

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.EmailSynthesizer
+
            +
            +
            All Implemented Interfaces:
            Synthesizer<String>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class EmailSynthesizer
            extends Object
            implements Synthesizer<String>
            + + +

            +Synthesizes a random email address. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EmailSynthesizer(Random random, + List<String> nameDictionary) + +
            +          Creates a new email synthesizer.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static StringformatEmail(String username, + String domain) + +
            +          Construct an email address string.
            + Stringsynthesize() + +
            +          Synthesizes a piece of data.
            + StringsynthesizeDomain() + +
            +          Synthesize a random domain using the market share probabilities.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EmailSynthesizer

            +
            +public EmailSynthesizer(Random random,
+                        List<String> nameDictionary)
            +
            +
            Creates a new email synthesizer. +

            +

            +
            Parameters:
            random - A random number generator.
            nameDictionary - A dictionary of names for the email addresses.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +public String synthesize()
            +
            +
            Description copied from interface: Synthesizer
            +
            Synthesizes a piece of data. +

            +

            +
            Specified by:
            synthesize in interface Synthesizer<String>
            +
            +
            + +
            Returns:
            The synthesized data.
            +
            +
            +
            + +

            +synthesizeDomain

            +
            +public String synthesizeDomain()
            +
            +
            Synthesize a random domain using the market share probabilities. +

            +

            +
            +
            +
            + +
            Returns:
            A synthesized domain string.
            +
            +
            +
            + +

            +formatEmail

            +
            +public static String formatEmail(String username,
+                                 String domain)
            +
            +
            Construct an email address string. +

            +

            +
            +
            +
            +
            Parameters:
            username - The part before the '@' symbol.
            domain - The part after the '@' symbol. +
            Returns:
            An email address (<username>@<domain>).
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/NGramSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/NGramSynthesizer.html new file mode 100644 index 00000000..1a9dc5fb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/NGramSynthesizer.html @@ -0,0 +1,274 @@ + + + + + + + +NGramSynthesizer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class NGramSynthesizer

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.NGramSynthesizer
+
            +
            +
            All Implemented Interfaces:
            Synthesizer<String>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class NGramSynthesizer
            extends Object
            implements Synthesizer<String>
            + + +

            +Generates n-grams. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NGramSynthesizer(WordSynthesizer wordSynthesizer, + int n) + +
            +          Constructs a new n-gram synthesizer.
            +  + + + + + + + + + + + +
            +Method Summary
            + Stringsynthesize() + +
            +          Synthesizes a piece of data.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +NGramSynthesizer

            +
            +public NGramSynthesizer(WordSynthesizer wordSynthesizer,
+                        int n)
            +
            +
            Constructs a new n-gram synthesizer. +

            +

            +
            Parameters:
            wordSynthesizer - A synthesizer to generate the words in the n-grams.
            n - The number of words in the n-gram.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +public String synthesize()
            +
            +
            Description copied from interface: Synthesizer
            +
            Synthesizes a piece of data. +

            +

            +
            Specified by:
            synthesize in interface Synthesizer<String>
            +
            +
            + +
            Returns:
            The synthesized data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/Synthesizer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/Synthesizer.html new file mode 100644 index 00000000..f6cd2ddc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/Synthesizer.html @@ -0,0 +1,221 @@ + + + + + + + +Synthesizer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Interface Synthesizer<T>

            +
            +
            Type Parameters:
            T - The type of data to be synthesized.
            +
            +
            All Known Implementing Classes:
            EmailSynthesizer, NGramSynthesizer, WordSynthesizer
            +
            +
            +
            +
            @ApiAudience.Private
+@Inheritance.Sealed
+public interface Synthesizer<T>
            + + +

            +Synthesizers create objects from nothing. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + Tsynthesize() + +
            +          Synthesizes a piece of data.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +T synthesize()
            +
            +
            Synthesizes a piece of data. +

            +

            + +
            Returns:
            The synthesized data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/WordSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/WordSynthesizer.html new file mode 100644 index 00000000..81c76177 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/WordSynthesizer.html @@ -0,0 +1,273 @@ + + + + + + + +WordSynthesizer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class WordSynthesizer

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.WordSynthesizer
+
            +
            +
            All Implemented Interfaces:
            Synthesizer<String>
            +
            +
            +
            +
            public class WordSynthesizer
            extends Object
            implements Synthesizer<String>
            + + +

            +Synthesizes random words from a dictionary. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            WordSynthesizer(Random random, + List<String> dictionary) + +
            +          Constructs a word synthesizer.
            +  + + + + + + + + + + + +
            +Method Summary
            + Stringsynthesize() + +
            +          Synthesizes a piece of data.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +WordSynthesizer

            +
            +public WordSynthesizer(Random random,
+                       List<String> dictionary)
            +
            +
            Constructs a word synthesizer. +

            +

            +
            Parameters:
            random - A random number generator.
            dictionary - A vocabulary of words to use when synthesizing.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +public String synthesize()
            +
            +
            Description copied from interface: Synthesizer
            +
            Synthesizes a piece of data. +

            +

            +
            Specified by:
            synthesize in interface Synthesizer<String>
            +
            +
            + +
            Returns:
            The synthesized data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html new file mode 100644 index 00000000..1550b949 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.DictionaryLoader (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.DictionaryLoader

            +
            +No usage of org.kiji.schema.tools.synth.DictionaryLoader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html new file mode 100644 index 00000000..d575e59e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.EmailSynthesizer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.EmailSynthesizer

            +
            +No usage of org.kiji.schema.tools.synth.EmailSynthesizer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html new file mode 100644 index 00000000..981f98c6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.NGramSynthesizer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.NGramSynthesizer

            +
            +No usage of org.kiji.schema.tools.synth.NGramSynthesizer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/Synthesizer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/Synthesizer.html new file mode 100644 index 00000000..d0a3babe --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/Synthesizer.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Interface org.kiji.schema.tools.synth.Synthesizer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.tools.synth.Synthesizer

            +
            + + + + + + + + + +
            +Packages that use Synthesizer
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables. 
            +  +

            + + + + + +
            +Uses of Synthesizer in org.kiji.schema.tools.synth
            +  +

            + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.schema.tools.synth that implement Synthesizer
            + classEmailSynthesizer + +
            +          Synthesizes a random email address.
            + classNGramSynthesizer + +
            +          Generates n-grams.
            + classWordSynthesizer + +
            +          Synthesizes random words from a dictionary.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html new file mode 100644 index 00000000..060bb80c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html @@ -0,0 +1,180 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.WordSynthesizer (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.WordSynthesizer

            +
            + + + + + + + + + +
            +Packages that use WordSynthesizer
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables. 
            +  +

            + + + + + +
            +Uses of WordSynthesizer in org.kiji.schema.tools.synth
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.tools.synth with parameters of type WordSynthesizer
            NGramSynthesizer(WordSynthesizer wordSynthesizer, + int n) + +
            +          Constructs a new n-gram synthesizer.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-frame.html new file mode 100644 index 00000000..f5199e43 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-frame.html @@ -0,0 +1,50 @@ + + + + + + + +org.kiji.schema.tools.synth (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.schema.tools.synth + + + + +
            +Interfaces  + +
            +Synthesizer
            + + + + + + +
            +Classes  + +
            +DictionaryLoader +
            +EmailSynthesizer +
            +NGramSynthesizer +
            +WordSynthesizer
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-summary.html new file mode 100644 index 00000000..057187d2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-summary.html @@ -0,0 +1,199 @@ + + + + + + + +org.kiji.schema.tools.synth (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.tools.synth +

            +Classes to assist when synthesizing sample data for use in kiji tables. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            Synthesizer<T>Synthesizers create objects from nothing.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            DictionaryLoaderLoads a dictionary file, which is simply a list of words, one per line.
            EmailSynthesizerSynthesizes a random email address.
            NGramSynthesizerGenerates n-grams.
            WordSynthesizerSynthesizes random words from a dictionary.
            +  + +

            +

            +Package org.kiji.schema.tools.synth Description +

            + +

            +Classes to assist when synthesizing sample data for use in kiji tables. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-tree.html new file mode 100644 index 00000000..e585ca8c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.schema.tools.synth Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.tools.synth +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-use.html new file mode 100644 index 00000000..aa5ed285 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/tools/synth/package-use.html @@ -0,0 +1,177 @@ + + + + + + + +Uses of Package org.kiji.schema.tools.synth (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.tools.synth

            +
            + + + + + + + + + +
            +Packages that use org.kiji.schema.tools.synth
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.tools.synth used by org.kiji.schema.tools.synth
            Synthesizer + +
            +          Synthesizers create objects from nothing.
            WordSynthesizer + +
            +          Synthesizes random words from a dictionary.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/AvroUtils.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/AvroUtils.html new file mode 100644 index 00000000..7a0c99f6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/AvroUtils.html @@ -0,0 +1,228 @@ + + + + + + + +AvroUtils (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class AvroUtils

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.AvroUtils
+
            +
            +
            +
            @ApiAudience.Private
+public final class AvroUtils
            extends Object
            + + +

            +General purpose Avro utilities. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static org.apache.avro.SchemagetOptionalType(org.apache.avro.Schema schema) + +
            +          Reports whether the given schema is an optional type (ie.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getOptionalType

            +
            +public static org.apache.avro.Schema getOptionalType(org.apache.avro.Schema schema)
            +
            +
            Reports whether the given schema is an optional type (ie. a union { null, Type }). +

            +

            +
            Parameters:
            schema - The schema to test. +
            Returns:
            the optional type, if the specified schema describes an optional type, null otherwise.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ByteArrayFormatter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ByteArrayFormatter.html new file mode 100644 index 00000000..2bbb5531 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ByteArrayFormatter.html @@ -0,0 +1,326 @@ + + + + + + + +ByteArrayFormatter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ByteArrayFormatter

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ByteArrayFormatter
+
            +
            +
            +
            @ApiAudience.Private
+public final class ByteArrayFormatter
            extends Object
            + + +

            +Utility class to format byte arrays. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static byte[]parseHex(String hex) + +
            +          Parses a string hexadecimal representation of a byte array.
            +static byte[]parseHex(String hex, + char separator) + +
            +          Parses a string hexadecimal representation of a byte array with separator.
            +static StringtoHex(byte[] bytes) + +
            +          Formats a byte array as a sequence of hex-digits with no separator.
            +static StringtoHex(byte[] bytes, + char separator) + +
            +          Formats a byte array as a sequence of 2 hex-digits bytes with the specified separator.
            +static StringtoURL(byte[] bytes) + +
            +          Formats a byte array as a URL.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +toHex

            +
            +public static String toHex(byte[] bytes)
            +
            +
            Formats a byte array as a sequence of hex-digits with no separator. +

            +

            +
            Parameters:
            bytes - Byte array to format. +
            Returns:
            the hex string representation of the byte array.
            +
            +
            +
            + +

            +toHex

            +
            +public static String toHex(byte[] bytes,
+                           char separator)
            +
            +
            Formats a byte array as a sequence of 2 hex-digits bytes with the specified separator. +

            +

            +
            Parameters:
            bytes - Byte array to format.
            separator - Separator used between each byte. +
            Returns:
            string the hex representation of the byte array.
            +
            +
            +
            + +

            +toURL

            +
            +public static String toURL(byte[] bytes)
            +
            +
            Formats a byte array as a URL. +

            +

            +
            Parameters:
            bytes - Byte array to format; +
            Returns:
            the URL encoding of the byte array.
            +
            +
            +
            + +

            +parseHex

            +
            +public static byte[] parseHex(String hex,
+                              char separator)
+                       throws IOException
            +
            +
            Parses a string hexadecimal representation of a byte array with separator. +

            +

            +
            Parameters:
            hex - String hexadecimal representation of the byte array to parse.
            separator - Separator used in the string. +
            Returns:
            the parsed byte array. +
            Throws: +
            IOException - on parse error.
            +
            +
            +
            + +

            +parseHex

            +
            +public static byte[] parseHex(String hex)
+                       throws IOException
            +
            +
            Parses a string hexadecimal representation of a byte array. +

            +

            +
            Parameters:
            hex - String hexadecimal representation of the byte array to parse. +
            Returns:
            the parsed byte array. +
            Throws: +
            IOException - on parse error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ByteStreamArray.EncodingException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ByteStreamArray.EncodingException.html new file mode 100644 index 00000000..c138bf5e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ByteStreamArray.EncodingException.html @@ -0,0 +1,250 @@ + + + + + + + +ByteStreamArray.EncodingException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ByteStreamArray.EncodingException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.util.ByteStreamArray.EncodingException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Enclosing class:
            ByteStreamArray
            +
            +
            +
            +
            @ApiAudience.Private
+public static final class ByteStreamArray.EncodingException
            extends IOException
            + + +

            +Raised when decoding some data fails (eg. a variable-length integer). +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            ByteStreamArray.EncodingException() + +
            +           
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +ByteStreamArray.EncodingException

            +
            +public ByteStreamArray.EncodingException()
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ByteStreamArray.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ByteStreamArray.html new file mode 100644 index 00000000..e3d7843b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ByteStreamArray.html @@ -0,0 +1,483 @@ + + + + + + + +ByteStreamArray (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ByteStreamArray

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ByteStreamArray
+
            +
            +
            +
            @ApiAudience.Private
+public final class ByteStreamArray
            extends Object
            + + +

            +Wraps a byte array of binary-encoded data into a byte stream. + + Provides various binary decoding functions. + Heavily inspired from protocol buffer's CodedOutputStream and Avro's BinaryDecoder. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classByteStreamArray.EncodingException + +
            +          Raised when decoding some data fails (eg.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            ByteStreamArray(byte[] bytes) + +
            +          Constructs a new stream of byte.
            ByteStreamArray(byte[] bytes, + int offset) + +
            +          Constructs a new stream of byte.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]getBytes() + +
            +           
            + intgetOffset() + +
            +           
            +static byte[]longToVarInt64(long number) + +
            +          Serializes a long integer into bytes using the zig-zag variable-length encoding scheme.
            +static byte[]longToZigZagVarInt64(long number) + +
            +          Serializes a long integer into bytes using the zig-zag variable-length encoding scheme.
            + byte[]readBytes(int nbytes) + +
            +          Reads the specified number of bytes in the stream.
            + longreadVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            + longreadZigZagVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            +static intsizeOfLongAsVarInt64(long number) + +
            +          Reports the size of the zig-zag encoding of the specified long integer.
            + voidskip(int nbytes) + +
            +          Skips some bytes.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ByteStreamArray

            +
            +public ByteStreamArray(byte[] bytes,
+                       int offset)
            +
            +
            Constructs a new stream of byte. +

            +

            +
            Parameters:
            bytes - Array of byte to wrap into a stream.
            offset - Offset of the stream head.
            +
            +
            + +

            +ByteStreamArray

            +
            +public ByteStreamArray(byte[] bytes)
            +
            +
            Constructs a new stream of byte. +

            +

            +
            Parameters:
            bytes - Array of byte to wrap into a stream.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +sizeOfLongAsVarInt64

            +
            +public static int sizeOfLongAsVarInt64(long number)
            +
            +
            Reports the size of the zig-zag encoding of the specified long integer. +

            +

            +
            Parameters:
            number - Long integer to encode. +
            Returns:
            Number of bytes required to encode the long using the zig-zag var-int64 encoding. + Between 1 and 10 bytes.
            +
            +
            +
            + +

            +longToVarInt64

            +
            +public static byte[] longToVarInt64(long number)
            +
            +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +

            +

            +
            Parameters:
            number - Long integer to encode. +
            Returns:
            Zig-zag encoded long, as an array of up to 10 bytes.
            +
            +
            +
            + +

            +longToZigZagVarInt64

            +
            +public static byte[] longToZigZagVarInt64(long number)
            +
            +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +

            +

            +
            Parameters:
            number - Long integer to encode. +
            Returns:
            Zig-zag encoded long, as an array of up to 10 bytes.
            +
            +
            +
            + +

            +readVarInt64

            +
            +public long readVarInt64()
+                  throws ByteStreamArray.EncodingException
            +
            +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +

            +

            + +
            Returns:
            the read integer as a long. +
            Throws: +
            ByteStreamArray.EncodingException - on decoding error.
            +
            +
            +
            + +

            +readZigZagVarInt64

            +
            +public long readZigZagVarInt64()
+                        throws ByteStreamArray.EncodingException
            +
            +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +

            +

            + +
            Returns:
            the read integer as a long. +
            Throws: +
            ByteStreamArray.EncodingException - on decoding error.
            +
            +
            +
            + +

            +skip

            +
            +public void skip(int nbytes)
            +
            +
            Skips some bytes. +

            +

            +
            Parameters:
            nbytes - Number of bytes to skip.
            +
            +
            +
            + +

            +readBytes

            +
            +public byte[] readBytes(int nbytes)
            +
            +
            Reads the specified number of bytes in the stream. +

            +

            +
            Parameters:
            nbytes - Number of bytes to read. +
            Returns:
            Bytes read.
            +
            +
            +
            + +

            +getBytes

            +
            +public byte[] getBytes()
            +
            +
            + +
            Returns:
            a copy of the wrapped byte array.
            +
            +
            +
            + +

            +getOffset

            +
            +public int getOffset()
            +
            +
            + +
            Returns:
            the current offset in the wrapped byte array.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/BytesKey.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/BytesKey.html new file mode 100644 index 00000000..9f29ee01 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/BytesKey.html @@ -0,0 +1,330 @@ + + + + + + + +BytesKey (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class BytesKey

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.BytesKey
+
            +
            +
            +
            @ApiAudience.Framework
+public final class BytesKey
            extends Object
            + + +

            +Wraps an array of bytes into an object that can be used as key in a hash map. + The wrapper assumes the byte array is immutable (ie. does not copy the byte array). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            BytesKey(byte[] bytes) + +
            +          Wraps the given byte array.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +           
            + byte[]getBytes() + +
            +           
            + inthashCode() + +
            +           
            + StringtoString() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +BytesKey

            +
            +public BytesKey(byte[] bytes)
            +
            +
            Wraps the given byte array. +

            +

            +
            Parameters:
            bytes - Byte array to wrap.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getBytes

            +
            +public byte[] getBytes()
            +
            +
            + +
            Returns:
            The byte array.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Clock.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Clock.html new file mode 100644 index 00000000..3c57ef94 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Clock.html @@ -0,0 +1,249 @@ + + + + + + + +Clock (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Clock

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Clock
+
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract class Clock
            extends Object
            + + +

            +An interface for a wall clock. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static ClockgetDefaultClock() + +
            +           
            +abstract  longgetTime() + +
            +          Gets the current time.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTime

            +
            +public abstract long getTime()
            +
            +
            Gets the current time. +

            +

            + +
            Returns:
            The current time.
            +
            +
            +
            + +

            +getDefaultClock

            +
            +public static Clock getDefaultClock()
            +
            +
            + +
            Returns:
            a default clock instance that uses the system clock.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/CounterManager.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/CounterManager.html new file mode 100644 index 00000000..07f7f463 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/CounterManager.html @@ -0,0 +1,216 @@ + + + + + + + +CounterManager (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Interface CounterManager

            +
            +
            +
            @ApiAudience.Private
+@Inheritance.Sealed
+public interface CounterManager
            + + +

            +Interface for for objects that hold a collection of MapReduce counters. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + CountergetCounter(Enum<?> name) + +
            +          Gets a counter by name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getCounter

            +
            +Counter getCounter(Enum<?> name)
            +
            +
            Gets a counter by name. +

            +

            +
            Parameters:
            name - The name of the counter. +
            Returns:
            A counter.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Debug.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Debug.html new file mode 100644 index 00000000..bdc60dfa --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Debug.html @@ -0,0 +1,226 @@ + + + + + + + +Debug (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Debug

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Debug
+
            +
            +
            +
            @ApiAudience.Private
+public final class Debug
            extends Object
            + + +

            +Debugging utilities. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static StringgetStackTrace() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getStackTrace

            +
            +public static String getStackTrace()
            +
            +
            + +
            Returns:
            a string representation of the current stack trace.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/FromJson.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/FromJson.html new file mode 100644 index 00000000..48b4d63f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/FromJson.html @@ -0,0 +1,289 @@ + + + + + + + +FromJson (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class FromJson

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.FromJson
+
            +
            +
            +
            @ApiAudience.Private
+public final class FromJson
            extends Object
            + + +

            +Decode a JSON string into an Avro record. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static ObjectfromAvroJsonString(String json, + org.apache.avro.Schema schema) + +
            +          Standard Avro JSON decoder.
            +static ObjectfromJsonNode(org.codehaus.jackson.JsonNode json, + org.apache.avro.Schema schema) + +
            +          Decodes a JSON node as an Avro value.
            +static ObjectfromJsonString(String json, + org.apache.avro.Schema schema) + +
            +          Decodes a JSON encoded record.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +fromJsonNode

            +
            +public static Object fromJsonNode(org.codehaus.jackson.JsonNode json,
+                                  org.apache.avro.Schema schema)
+                           throws IOException
            +
            +
            Decodes a JSON node as an Avro value. + + Comply with specified default values when decoding records with missing fields. +

            +

            +
            Parameters:
            json - JSON node to decode.
            schema - Avro schema of the value to decode. +
            Returns:
            the decoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +fromJsonString

            +
            +public static Object fromJsonString(String json,
+                                    org.apache.avro.Schema schema)
+                             throws IOException
            +
            +
            Decodes a JSON encoded record. +

            +

            +
            Parameters:
            json - JSON tree to decode, encoded as a string.
            schema - Avro schema of the value to decode. +
            Returns:
            the decoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +fromAvroJsonString

            +
            +public static Object fromAvroJsonString(String json,
+                                        org.apache.avro.Schema schema)
+                                 throws IOException
            +
            +
            Standard Avro JSON decoder. +

            +

            +
            Parameters:
            json - JSON string to decode.
            schema - Schema of the value to decode. +
            Returns:
            the decoded value. +
            Throws: +
            IOException - on error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Functions.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Functions.html new file mode 100644 index 00000000..4e64c6ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Functions.html @@ -0,0 +1,235 @@ + + + + + + + +Functions (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Functions

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Functions
+
            +
            +
            +
            @ApiAudience.Private
+public final class Functions
            extends Object
            + + +

            +A collection of useful functions. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<K,V> com.google.common.base.Function<Map<? extends K,? extends V>,Map<K,V>>
            +            		unmodifiableMap() + +
            +          Returns a function that makes a map immutable.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +unmodifiableMap

            +
            +public static <K,V> com.google.common.base.Function<Map<? extends K,? extends V>,Map<K,V>> unmodifiableMap()
            +
            +
            Returns a function that makes a map immutable. +

            +

            +
            Type Parameters:
            K - The map key type.
            V - The map value type. +
            Returns:
            A function returns an immutable version of a map.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Hasher.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Hasher.html new file mode 100644 index 00000000..653c25dc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Hasher.html @@ -0,0 +1,288 @@ + + + + + + + +Hasher (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Hasher

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Hasher
+
            +
            +
            +
            @ApiAudience.Private
+public final class Hasher
            extends Object
            + + +

            +A thread-safe utility for computing hashes of strings. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static intHASH_SIZE_BYTES + +
            +          The number of bytes in a hash.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static byte[]hash(byte[] input) + +
            +          Hashes the input byte array.
            +static byte[]hash(String input) + +
            +          Hashes the input string.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +HASH_SIZE_BYTES

            +
            +public static final int HASH_SIZE_BYTES
            +
            +
            The number of bytes in a hash. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +hash

            +
            +public static byte[] hash(String input)
            +
            +
            Hashes the input string. +

            +

            +
            Parameters:
            input - The string to hash. +
            Returns:
            The 128-bit MD5 hash of the input.
            +
            +
            +
            + +

            +hash

            +
            +public static byte[] hash(byte[] input)
            +
            +
            Hashes the input byte array. +

            +

            +
            Parameters:
            input - The bytes to hash. +
            Returns:
            The 128-bit MD5 hash of the input.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/JavaIdentifiers.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/JavaIdentifiers.html new file mode 100644 index 00000000..7d583968 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/JavaIdentifiers.html @@ -0,0 +1,260 @@ + + + + + + + +JavaIdentifiers (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class JavaIdentifiers

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.JavaIdentifiers
+
            +
            +
            +
            @ApiAudience.Private
+public final class JavaIdentifiers
            extends Object
            + + +

            +A utility class for dealing with identifiers in the Java language. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static booleanisValidClassName(String className) + +
            +          Determines whether a string could be the name of a Java class.
            +static booleanisValidIdentifier(String identifier) + +
            +          Determines whether a string is a valid Java identifier.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +isValidIdentifier

            +
            +public static boolean isValidIdentifier(String identifier)
            +
            +
            Determines whether a string is a valid Java identifier. + +

            A valid Java identifier may not start with a number, but may contain any + combination of letters, digits, underscores, or dollar signs.

            + +

            See the + Java Language Specification

            +

            +

            +
            Parameters:
            identifier - The identifier to test for validity. +
            Returns:
            Whether the identifier was valid.
            +
            +
            +
            + +

            +isValidClassName

            +
            +public static boolean isValidClassName(String className)
            +
            +
            Determines whether a string could be the name of a Java class. + +

            If this method returns true, it does not necessarily mean that the Java class with + className exists; it only means that one could write a Java class with + that fully-qualified name.

            +

            +

            +
            Parameters:
            className - A string to test. +
            Returns:
            Whether the class name was valid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/KijiNameValidator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/KijiNameValidator.html new file mode 100644 index 00000000..6c8f6cba --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/KijiNameValidator.html @@ -0,0 +1,424 @@ + + + + + + + +KijiNameValidator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class KijiNameValidator

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.KijiNameValidator
+
            +
            +
            +
            @ApiAudience.Private
+public final class KijiNameValidator
            extends Object
            + + +

            +A utility class for validating layout names, + (including table names, locality group names, family names, and column names) + and Kiji instance names. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static PatternVALID_ALIAS_PATTERN + +
            +          Regular expression that defines a valid alias for a layout name.
            +static PatternVALID_INSTANCE_PATTERN + +
            +          Regular expression that defines a valid instance name.
            +static PatternVALID_LAYOUT_NAME_PATTERN + +
            +          Regular expression that defines a valid layout name (family, qualifier, table, etc).
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static booleanisValidAlias(CharSequence name) + +
            +           
            +static booleanisValidKijiName(CharSequence name) + +
            +           
            +static booleanisValidLayoutName(CharSequence name) + +
            +           
            +static voidvalidateAlias(CharSequence name) + +
            +          Validates characters that may be used in an alias for a qualifier, family, or + locality group.
            +static voidvalidateKijiName(CharSequence name) + +
            +          Determines whether a string is a valid Kiji instance name.
            +static voidvalidateLayoutName(CharSequence name) + +
            +          Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +VALID_INSTANCE_PATTERN

            +
            +public static final Pattern VALID_INSTANCE_PATTERN
            +
            +
            Regular expression that defines a valid instance name. +

            +

            +
            +
            +
            + +

            +VALID_LAYOUT_NAME_PATTERN

            +
            +public static final Pattern VALID_LAYOUT_NAME_PATTERN
            +
            +
            Regular expression that defines a valid layout name (family, qualifier, table, etc). +

            +

            +
            +
            +
            + +

            +VALID_ALIAS_PATTERN

            +
            +public static final Pattern VALID_ALIAS_PATTERN
            +
            +
            Regular expression that defines a valid alias for a layout name. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +isValidLayoutName

            +
            +public static boolean isValidLayoutName(CharSequence name)
            +
            +
            +
            Parameters:
            name - the name to check. +
            Returns:
            true if name is a valid name for a table, locality group, family, + or column name, and false otherwise.
            +
            +
            +
            + +

            +validateLayoutName

            +
            +public static void validateLayoutName(CharSequence name)
+                               throws KijiInvalidNameException
            +
            +
            Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names. +

            +

            +
            Parameters:
            name - The string to validate as a layout name. +
            Throws: +
            KijiInvalidNameException - If the name is invalid.
            +
            +
            +
            + +

            +isValidAlias

            +
            +public static boolean isValidAlias(CharSequence name)
            +
            +
            +
            Parameters:
            name - the name to check. +
            Returns:
            true if name is a valid alias for a table, locality group, family, + or column name, and false otherwise.
            +
            +
            +
            + +

            +validateAlias

            +
            +public static void validateAlias(CharSequence name)
+                          throws KijiInvalidNameException
            +
            +
            Validates characters that may be used in an alias for a qualifier, family, or + locality group. This is a superset of valid characters for a layout name. +

            +

            +
            Parameters:
            name - The string to validate as a layout name alias. +
            Throws: +
            KijiInvalidNameException - If the name is invalid.
            +
            +
            +
            + +

            +isValidKijiName

            +
            +public static boolean isValidKijiName(CharSequence name)
            +
            +
            +
            Parameters:
            name - the name to check. +
            Returns:
            true if name is a valid name for a Kiji instance and false otherwise.
            +
            +
            +
            + +

            +validateKijiName

            +
            +public static void validateKijiName(CharSequence name)
+                             throws KijiInvalidNameException
            +
            +
            Determines whether a string is a valid Kiji instance name. +

            +

            +
            Parameters:
            name - The string to validate as a Kiji instance name. +
            Throws: +
            KijiInvalidNameException - If the name is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Lock.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Lock.html new file mode 100644 index 00000000..5a857e56 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Lock.html @@ -0,0 +1,291 @@ + + + + + + + +Lock (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Interface Lock

            +
            +
            All Superinterfaces:
            Closeable
            +
            +
            +
            All Known Implementing Classes:
            ZooKeeperLock
            +
            +
            +
            +
            @ApiAudience.Private
+@Inheritance.Sealed
+public interface Lock
            extends Closeable
            + + +

            +Lock interface. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidlock() + +
            +          Unconditionally acquires the lock.
            + booleanlock(double timeout) + +
            +          Acquires the lock.
            + voidunlock() + +
            +          Releases the lock.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +lock

            +
            +void lock()
+          throws IOException
            +
            +
            Unconditionally acquires the lock. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +lock

            +
            +boolean lock(double timeout)
+             throws IOException
            +
            +
            Acquires the lock. +

            +

            +
            +
            +
            +
            Parameters:
            timeout - Deadline, in seconds, to acquire the lock. 0 means no timeout. +
            Returns:
            whether the lock is acquired (ie. false means timeout). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +unlock

            +
            +void unlock()
+            throws IOException
            +
            +
            Releases the lock. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/LockFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/LockFactory.html new file mode 100644 index 00000000..c0224c46 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/LockFactory.html @@ -0,0 +1,222 @@ + + + + + + + +LockFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Interface LockFactory

            +
            +
            All Known Implementing Classes:
            ZooKeeperLockFactory
            +
            +
            +
            +
            @ApiAudience.Private
+@Inheritance.Sealed
+public interface LockFactory
            + + +

            +Factory for Lock instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + Lockcreate(String name) + +
            +          Creates a new lock with the specified name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +Lock create(String name)
+            throws IOException
            +
            +
            Creates a new lock with the specified name. +

            +

            +
            Parameters:
            name - Lock name (eg. a ZooKeeper node path). +
            Returns:
            the lock with the specified name. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/NumberParser.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/NumberParser.html new file mode 100644 index 00000000..79d6a47b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/NumberParser.html @@ -0,0 +1,273 @@ + + + + + + + +NumberParser (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class NumberParser

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.NumberParser
+
            +
            +
            +
            @ApiAudience.Private
+public final class NumberParser
            extends Object
            + + +

            +Utility for parsing strings to numbers. It allows certain numbers to be + represented by easy-to-write strings. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static intparseInt(String intToParse) + +
            +          This parseInt allows Integer.MAX_VALUE to be written as a convenient string.
            +static longparseLong(String longToParse) + +
            +          This parseLong allows Long.MAX_VALUE to be written as a convenient string.
            +static StringprintInt(int intToPrint) + +
            +          Converts an integer to a string that uses "infinity" as Integer.MAX_VALUE.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +parseInt

            +
            +public static int parseInt(String intToParse)
            +
            +
            This parseInt allows Integer.MAX_VALUE to be written as a convenient string. +

            +

            +
            Parameters:
            intToParse - The string representation of an int to parse. +
            Returns:
            The parsed int.
            +
            +
            +
            + +

            +printInt

            +
            +public static String printInt(int intToPrint)
            +
            +
            Converts an integer to a string that uses "infinity" as Integer.MAX_VALUE. +

            +

            +
            Parameters:
            intToPrint - The integer to print. +
            Returns:
            The integer as a string, or "infinity".
            +
            +
            +
            + +

            +parseLong

            +
            +public static long parseLong(String longToParse)
            +
            +
            This parseLong allows Long.MAX_VALUE to be written as a convenient string. +

            +

            +
            Parameters:
            longToParse - The string representation of a long to parse. +
            Returns:
            The parsed long.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ReferenceCountable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ReferenceCountable.html new file mode 100644 index 00000000..1640869b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ReferenceCountable.html @@ -0,0 +1,250 @@ + + + + + + + +ReferenceCountable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Interface ReferenceCountable<T>

            +
            +
            Type Parameters:
            T - Type of the resource.
            +
            +
            All Known Subinterfaces:
            Kiji
            +
            +
            +
            All Known Implementing Classes:
            HBaseKiji
            +
            +
            +
            +
            public interface ReferenceCountable<T>
            + + +

            +Interface for reference-countable resources. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidrelease() + +
            +          Notifies this resource that we are no longer interested in it.
            + Tretain() + +
            +          Expresses interest in retaining this resource.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +retain

            +
            +T retain()
            +
            +
            Expresses interest in retaining this resource. + + The resource will not be disposed until a call to release() happens +

            +

            + +
            Returns:
            the retained resource.
            +
            +
            +
            + +

            +release

            +
            +void release()
+             throws IOException
            +
            +
            Notifies this resource that we are no longer interested in it. + + This resource may be disposed if no other entity has expressed interest in using it. +

            +

            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ReferenceCountableUtils.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ReferenceCountableUtils.html new file mode 100644 index 00000000..584a508c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ReferenceCountableUtils.html @@ -0,0 +1,233 @@ + + + + + + + +ReferenceCountableUtils (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ReferenceCountableUtils

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ReferenceCountableUtils
+
            +
            +
            +
            public final class ReferenceCountableUtils
            extends Object
            + + +

            +Utilities to work with ReferenceCountable resources. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static + + + + +
            +<T> void
            +            		releaseQuietly(ReferenceCountable<T> resource) + +
            +          Releases a given resource, logging and swallowing I/O errors if needed.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +releaseQuietly

            +
            +public static <T> void releaseQuietly(ReferenceCountable<T> resource)
            +
            +
            Releases a given resource, logging and swallowing I/O errors if needed. +

            +

            +
            Type Parameters:
            T - Type of the resource to release.
            Parameters:
            resource - Release this resource quietly.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Resources.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Resources.html new file mode 100644 index 00000000..4d229e2f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/Resources.html @@ -0,0 +1,252 @@ + + + + + + + +Resources (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Resources

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Resources
+
            +
            +
            +
            @ApiAudience.Private
+public final class Resources
            extends Object
            + + +

            +Utility for getting access to system resources. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static InputStreamopenSystemResource(String resourceFileName) + +
            +          Gets the named resource using the classloader, or null if it can not be found.
            +static BufferedReaderopenSystemTextResource(String resourceFileName) + +
            +          Gets the named resource using the classloader, or null if it can not be found.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +openSystemResource

            +
            +public static InputStream openSystemResource(String resourceFileName)
            +
            +
            Gets the named resource using the classloader, or null if it can not be found. + Clients should close streams returned by this method. +

            +

            +
            Parameters:
            resourceFileName - The resource to load from the classpath. +
            Returns:
            The loaded resource as an InputStream. If not found, returns null.
            +
            +
            +
            + +

            +openSystemTextResource

            +
            +public static BufferedReader openSystemTextResource(String resourceFileName)
            +
            +
            Gets the named resource using the classloader, or null if it can not be found. + Clients should close streams returned by this method. +

            +

            +
            Parameters:
            resourceFileName - The resource to load from the classpath. +
            Returns:
            The loaded resource as a BufferedReader. If not found, returns null.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/SplitKeyFile.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/SplitKeyFile.html new file mode 100644 index 00000000..4ce1fd1b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/SplitKeyFile.html @@ -0,0 +1,267 @@ + + + + + + + +SplitKeyFile (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class SplitKeyFile

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.SplitKeyFile
+
            +
            +
            +
            @ApiAudience.Private
+public final class SplitKeyFile
            extends Object
            + + +

            +Parses region boundaries split files. + +

          • The file contains one row key per line. +
          • Row keys are encoded in ASCII. +
          • Non printable characters must be escaped in hexadecimal "\x??". +
          • Backslash must be escaped (doubled) "\\" + +

            + If a file contains N split keys, N+1 regions will be created, since the first region will contain + everything before the first split key, and the last region will contain everything after the last + split key. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static List<byte[]>decodeRegionSplitList(InputStream inputStream) + +
            +          Constructs a split key file from an input stream.
            +static byte[]decodeRowKey(String encoded) + +
            +          Decodes a string encoded row key.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +decodeRegionSplitList

            +
            +public static List<byte[]> decodeRegionSplitList(InputStream inputStream)
+                                          throws IOException
            +
            +
            Constructs a split key file from an input stream. This object will take ownership of + the inputStream, which you should clean up by calling close(). +

            +

            +
            Parameters:
            inputStream - The file contents. +
            Returns:
            the region boundaries, as a list of row keys. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeRowKey

            +
            +public static byte[] decodeRowKey(String encoded)
+                           throws IOException
            +
            +
            Decodes a string encoded row key. +

            +

            +
            Parameters:
            encoded - Encoded row key. +
            Returns:
            the row key, as a byte array. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/TimestampComparator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/TimestampComparator.html new file mode 100644 index 00000000..8f186065 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/TimestampComparator.html @@ -0,0 +1,280 @@ + + + + + + + +TimestampComparator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class TimestampComparator

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.TimestampComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator<Long>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class TimestampComparator
            extends Object
            implements Comparator<Long>
            + + +

            +A comparator that sorts Longs in reverse chronological order. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static TimestampComparatorINSTANCE + +
            +          A singleton instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + intcompare(Long left, + Long right) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +INSTANCE

            +
            +public static final TimestampComparator INSTANCE
            +
            +
            A singleton instance. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(Long left,
+                   Long right)
            +
            +
            +
            Specified by:
            compare in interface Comparator<Long>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ToJson.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ToJson.html new file mode 100644 index 00000000..91b1fbb5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ToJson.html @@ -0,0 +1,341 @@ + + + + + + + +ToJson (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ToJson

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ToJson
+
            +
            +
            +
            @ApiAudience.Private
+public final class ToJson
            extends Object
            + + +

            +Encode an Avro record into JSON. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static StringtoAvroJsonString(org.apache.avro.generic.IndexedRecord record) + +
            +          Standard Avro/JSON encoder.
            +static StringtoAvroJsonString(Object value, + org.apache.avro.Schema schema) + +
            +          Standard Avro/JSON encoder.
            +static org.codehaus.jackson.JsonNodetoJsonNode(Object value, + org.apache.avro.Schema schema) + +
            +          Serializes a Java Avro value into JSON.
            +static StringtoJsonString(org.apache.avro.generic.IndexedRecord record) + +
            +          Encodes an Avro record into JSON.
            +static StringtoJsonString(Object value, + org.apache.avro.Schema schema) + +
            +          Encodes an Avro value into a JSON string.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +toJsonNode

            +
            +public static org.codehaus.jackson.JsonNode toJsonNode(Object value,
+                                                       org.apache.avro.Schema schema)
+                                                throws IOException
            +
            +
            Serializes a Java Avro value into JSON. + + When serializing records, fields whose value matches the fields' default value are omitted. +

            +

            +
            Parameters:
            value - the Java value to serialize.
            schema - Avro schema of the value to serialize. +
            Returns:
            the value encoded as a JSON tree. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toJsonString

            +
            +public static String toJsonString(Object value,
+                                  org.apache.avro.Schema schema)
+                           throws IOException
            +
            +
            Encodes an Avro value into a JSON string. + + Fields with default values are omitted. +

            +

            +
            Parameters:
            value - Avro value to encode.
            schema - Avro schema of the value. +
            Returns:
            Pretty string representation of the JSON-encoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toJsonString

            +
            +public static String toJsonString(org.apache.avro.generic.IndexedRecord record)
+                           throws IOException
            +
            +
            Encodes an Avro record into JSON. +

            +

            +
            Parameters:
            record - Avro record to encode. +
            Returns:
            Pretty JSON representation of the record. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toAvroJsonString

            +
            +public static String toAvroJsonString(Object value,
+                                      org.apache.avro.Schema schema)
+                               throws IOException
            +
            +
            Standard Avro/JSON encoder. +

            +

            +
            Parameters:
            value - Avro value to encode.
            schema - Avro schema of the value. +
            Returns:
            JSON-encoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toAvroJsonString

            +
            +public static String toAvroJsonString(org.apache.avro.generic.IndexedRecord record)
+                               throws IOException
            +
            +
            Standard Avro/JSON encoder. +

            +

            +
            Parameters:
            record - Avro record to encode. +
            Returns:
            JSON-encoded value. +
            Throws: +
            IOException - on error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/VersionInfo.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/VersionInfo.html new file mode 100644 index 00000000..aca8f748 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/VersionInfo.html @@ -0,0 +1,341 @@ + + + + + + + +VersionInfo (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class VersionInfo

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.VersionInfo
+
            +
            +
            +
            @ApiAudience.Public
+public final class VersionInfo
            extends Object
            + + +

            +Reads the version info from the jar manifest for this version of Kiji. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static StringDEFAULT_DEVELOPMENT_VERSION + +
            +          Fallback software version ID, in case the properties file is not generated/reachable.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static StringgetClientDataVersion() + +
            +          Gets the version of the Kiji data format assumed by the client.
            +static StringgetClusterDataVersion(Kiji kiji) + +
            +          Gets the version of the Kiji data format installed in the instance of the HBase cluster.
            +static StringgetSoftwareVersion() + +
            +          Gets the version of the Kiji client software.
            +static voidvalidateVersion(Kiji kiji) + +
            +          Validates that the client data version matches the data version installed on a Kiji instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +DEFAULT_DEVELOPMENT_VERSION

            +
            +public static final String DEFAULT_DEVELOPMENT_VERSION
            +
            +
            Fallback software version ID, in case the properties file is not generated/reachable. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getSoftwareVersion

            +
            +public static String getSoftwareVersion()
+                                 throws IOException
            +
            +
            Gets the version of the Kiji client software. +

            +

            + +
            Returns:
            The version string. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getClientDataVersion

            +
            +public static String getClientDataVersion()
            +
            +
            Gets the version of the Kiji data format assumed by the client. +

            +

            + +
            Returns:
            The version string.
            +
            +
            +
            + +

            +getClusterDataVersion

            +
            +public static String getClusterDataVersion(Kiji kiji)
+                                    throws IOException
            +
            +
            Gets the version of the Kiji data format installed in the instance of the HBase cluster. +

            +

            +
            Parameters:
            kiji - The kiji instance. +
            Returns:
            The version string. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +validateVersion

            +
            +public static void validateVersion(Kiji kiji)
+                            throws IOException
            +
            +
            Validates that the client data version matches the data version installed on a Kiji instance. +

            +

            +
            Parameters:
            kiji - The kiji instance. +
            Throws: +
            IOException - on I/O error, and in particular IncompatibleKijiVersionException + if the versions are incompatible.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ZooKeeperLock.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ZooKeeperLock.html new file mode 100644 index 00000000..2b24c640 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ZooKeeperLock.html @@ -0,0 +1,357 @@ + + + + + + + +ZooKeeperLock (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ZooKeeperLock

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ZooKeeperLock
+
            +
            +
            All Implemented Interfaces:
            Closeable, Lock
            +
            +
            +
            +
            @ApiAudience.Private
+public final class ZooKeeperLock
            extends Object
            implements Lock, Closeable
            + + +

            +Distributed lock on top of ZooKeeper. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            ZooKeeperLock(org.apache.zookeeper.ZooKeeper zookeeper, + File lockDir) + +
            +          Constructs a ZooKeeper lock object.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + voidlock() + +
            +          Unconditionally acquires the lock.
            + booleanlock(double timeout) + +
            +          Acquires the lock.
            + voidunlock() + +
            +          Releases the lock.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ZooKeeperLock

            +
            +public ZooKeeperLock(org.apache.zookeeper.ZooKeeper zookeeper,
+                     File lockDir)
            +
            +
            Constructs a ZooKeeper lock object. +

            +

            +
            Parameters:
            zookeeper - ZooKeeper client.
            lockDir - Path of the directory node to use for the lock.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +lock

            +
            +public void lock()
+          throws IOException
            +
            +
            Unconditionally acquires the lock. +

            +

            +
            Specified by:
            lock in interface Lock
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +lock

            +
            +public boolean lock(double timeout)
+             throws IOException
            +
            +
            Acquires the lock. +

            +

            +
            Specified by:
            lock in interface Lock
            +
            +
            +
            Parameters:
            timeout - Deadline, in seconds, to acquire the lock. 0 means no timeout. +
            Returns:
            whether the lock is acquired (ie. false means timeout). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +unlock

            +
            +public void unlock()
+            throws IOException
            +
            +
            Releases the lock. +

            +

            +
            Specified by:
            unlock in interface Lock
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ZooKeeperLockFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ZooKeeperLockFactory.html new file mode 100644 index 00000000..2dc6ef89 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/ZooKeeperLockFactory.html @@ -0,0 +1,320 @@ + + + + + + + +ZooKeeperLockFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ZooKeeperLockFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ZooKeeperLockFactory
+
            +
            +
            All Implemented Interfaces:
            LockFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class ZooKeeperLockFactory
            extends Object
            implements LockFactory
            + + +

            +Factory for ZooKeeperLock instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            ZooKeeperLockFactory(Configuration conf) + +
            +          Creates a factory for ZooKeeperLock.
            ZooKeeperLockFactory(org.apache.zookeeper.ZooKeeper zkClient) + +
            +          Creates a factory for ZooKeeperLock.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + Lockcreate(String name) + +
            +          Creates a new lock with the specified name.
            +static org.apache.zookeeper.ZooKeepernewZooKeeper(Configuration conf) + +
            +          Creates a ZooKeeper client.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ZooKeeperLockFactory

            +
            +public ZooKeeperLockFactory(org.apache.zookeeper.ZooKeeper zkClient)
            +
            +
            Creates a factory for ZooKeeperLock. +

            +

            +
            Parameters:
            zkClient - ZooKeeper client
            +
            +
            + +

            +ZooKeeperLockFactory

            +
            +public ZooKeeperLockFactory(Configuration conf)
+                     throws IOException
            +
            +
            Creates a factory for ZooKeeperLock. +

            +

            +
            Parameters:
            conf - ZooKeeper configuration. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newZooKeeper

            +
            +public static org.apache.zookeeper.ZooKeeper newZooKeeper(Configuration conf)
+                                                   throws IOException
            +
            +
            Creates a ZooKeeper client. +

            +

            +
            +
            +
            +
            Parameters:
            conf - Configuration. +
            Returns:
            a new ZooKeeper client. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +create

            +
            +public Lock create(String name)
            +
            +
            Creates a new lock with the specified name. +

            +

            +
            Specified by:
            create in interface LockFactory
            +
            +
            +
            Parameters:
            name - Lock name (eg. a ZooKeeper node path). +
            Returns:
            the lock with the specified name.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/AvroUtils.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/AvroUtils.html new file mode 100644 index 00000000..118de77d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/AvroUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.AvroUtils (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.AvroUtils

            +
            +No usage of org.kiji.schema.util.AvroUtils +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ByteArrayFormatter.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ByteArrayFormatter.html new file mode 100644 index 00000000..f53229c6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ByteArrayFormatter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ByteArrayFormatter (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ByteArrayFormatter

            +
            +No usage of org.kiji.schema.util.ByteArrayFormatter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html new file mode 100644 index 00000000..07e4cd22 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ByteStreamArray.EncodingException (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ByteStreamArray.EncodingException

            +
            + + + + + + + + + +
            +Packages that use ByteStreamArray.EncodingException
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of ByteStreamArray.EncodingException in org.kiji.schema.util
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util that throw ByteStreamArray.EncodingException
            + longByteStreamArray.readVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            + longByteStreamArray.readZigZagVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ByteStreamArray.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ByteStreamArray.html new file mode 100644 index 00000000..2c6bbf0e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ByteStreamArray.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ByteStreamArray (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ByteStreamArray

            +
            +No usage of org.kiji.schema.util.ByteStreamArray +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/BytesKey.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/BytesKey.html new file mode 100644 index 00000000..7b88d0aa --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/BytesKey.html @@ -0,0 +1,274 @@ + + + + + + + +Uses of Class org.kiji.schema.util.BytesKey (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.BytesKey

            +
            + + + + + + + + + + + + + +
            +Packages that use BytesKey
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of BytesKey in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return BytesKey
            + BytesKeyKijiSchemaTable.SchemaEntry.getHash() + +
            +           
            +abstract  BytesKeyKijiSchemaTable.getOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            + BytesKeyKijiSchemaTable.getSchemaHash(org.apache.avro.Schema schema) + +
            +          Computes a schema hash.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type BytesKey
            +abstract  org.apache.avro.SchemaKijiSchemaTable.getSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type BytesKey
            KijiSchemaTable.SchemaEntry(long id, + BytesKey hash, + org.apache.avro.Schema schema) + +
            +          Creates a new schema entry.
            +  +

            + + + + + +
            +Uses of BytesKey in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return BytesKey
            + BytesKeyHBaseSchemaTable.getOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type BytesKey
            + org.apache.avro.SchemaHBaseSchemaTable.getSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Clock.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Clock.html new file mode 100644 index 00000000..95b22d70 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Clock.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Clock (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Clock

            +
            + + + + + + + + + + + + + +
            +Packages that use Clock
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of Clock in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return Clock
            + ClockKijiTablePool.Options.getClock() + +
            +          Gets a clock.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type Clock
            + KijiTablePool.OptionsKijiTablePool.Options.withClock(Clock clock) + +
            +          Sets a clock.
            +  +

            + + + + + +
            +Uses of Clock in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.util that return Clock
            +static ClockClock.getDefaultClock() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/CounterManager.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/CounterManager.html new file mode 100644 index 00000000..f7e0e1e4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/CounterManager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface org.kiji.schema.util.CounterManager (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.util.CounterManager

            +
            +No usage of org.kiji.schema.util.CounterManager +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Debug.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Debug.html new file mode 100644 index 00000000..42c0b1cc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Debug.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Debug (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Debug

            +
            +No usage of org.kiji.schema.util.Debug +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/FromJson.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/FromJson.html new file mode 100644 index 00000000..f26c7e30 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/FromJson.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.FromJson (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.FromJson

            +
            +No usage of org.kiji.schema.util.FromJson +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Functions.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Functions.html new file mode 100644 index 00000000..3f7a996c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Functions.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Functions (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Functions

            +
            +No usage of org.kiji.schema.util.Functions +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Hasher.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Hasher.html new file mode 100644 index 00000000..14934471 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Hasher.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Hasher (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Hasher

            +
            +No usage of org.kiji.schema.util.Hasher +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/JavaIdentifiers.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/JavaIdentifiers.html new file mode 100644 index 00000000..f95327b9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/JavaIdentifiers.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.JavaIdentifiers (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.JavaIdentifiers

            +
            +No usage of org.kiji.schema.util.JavaIdentifiers +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/KijiNameValidator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/KijiNameValidator.html new file mode 100644 index 00000000..97c80e99 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/KijiNameValidator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.KijiNameValidator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.KijiNameValidator

            +
            +No usage of org.kiji.schema.util.KijiNameValidator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Lock.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Lock.html new file mode 100644 index 00000000..ae6a95d0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Lock.html @@ -0,0 +1,251 @@ + + + + + + + +Uses of Interface org.kiji.schema.util.Lock (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.util.Lock

            +
            + + + + + + + + + + + + + +
            +Packages that use Lock
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of Lock in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return Lock
            +static LockHBaseSchemaTable.newLock(KijiConfiguration conf, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type Lock
            HBaseSchemaTable(HTableInterface hashTable, + HTableInterface idTable, + Lock zkLock) + +
            +          Wrap an existing HBase table assumed to be where the schema data is stored.
            +  +

            + + + + + +
            +Uses of Lock in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.util that implement Lock
            + classZooKeeperLock + +
            +          Distributed lock on top of ZooKeeper.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util that return Lock
            + LockZooKeeperLockFactory.create(String name) + +
            +          Creates a new lock with the specified name.
            + LockLockFactory.create(String name) + +
            +          Creates a new lock with the specified name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/LockFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/LockFactory.html new file mode 100644 index 00000000..ddf01a59 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/LockFactory.html @@ -0,0 +1,285 @@ + + + + + + + +Uses of Interface org.kiji.schema.util.LockFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.util.LockFactory

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use LockFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of LockFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return LockFactory
            + LockFactoryHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  +

            + + + + + +
            +Uses of LockFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return LockFactory
            + LockFactoryDefaultHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type LockFactory
            +static voidHBaseSchemaTable.install(HBaseAdmin admin, + KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static LockHBaseSchemaTable.newLock(KijiConfiguration conf, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type LockFactory
            HBaseSchemaTable(KijiConfiguration kijiConf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            +  +

            + + + + + +
            +Uses of LockFactory in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.util that implement LockFactory
            + classZooKeeperLockFactory + +
            +          Factory for ZooKeeperLock instances.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/NumberParser.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/NumberParser.html new file mode 100644 index 00000000..e67b35cd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/NumberParser.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.NumberParser (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.NumberParser

            +
            +No usage of org.kiji.schema.util.NumberParser +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ReferenceCountable.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ReferenceCountable.html new file mode 100644 index 00000000..c1bd63f9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ReferenceCountable.html @@ -0,0 +1,248 @@ + + + + + + + +Uses of Interface org.kiji.schema.util.ReferenceCountable (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.util.ReferenceCountable

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use ReferenceCountable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of ReferenceCountable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of ReferenceCountable in org.kiji.schema
            + interfaceKiji + +
            +          Provides a handle to a Kiji instance that contains configuration and + table information.
            +  +

            + + + + + +
            +Uses of ReferenceCountable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement ReferenceCountable
            + classHBaseKiji + +
            +          Kiji instance class that contains configuration and table + information.
            +  +

            + + + + + +
            +Uses of ReferenceCountable in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.util with parameters of type ReferenceCountable
            +static + + + + +
            +<T> void
            +            		ReferenceCountableUtils.releaseQuietly(ReferenceCountable<T> resource) + +
            +          Releases a given resource, logging and swallowing I/O errors if needed.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ReferenceCountableUtils.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ReferenceCountableUtils.html new file mode 100644 index 00000000..1b031857 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ReferenceCountableUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ReferenceCountableUtils (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ReferenceCountableUtils

            +
            +No usage of org.kiji.schema.util.ReferenceCountableUtils +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Resources.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Resources.html new file mode 100644 index 00000000..604a9e1a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/Resources.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Resources (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Resources

            +
            +No usage of org.kiji.schema.util.Resources +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/SplitKeyFile.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/SplitKeyFile.html new file mode 100644 index 00000000..4057eaa1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/SplitKeyFile.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.SplitKeyFile (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.SplitKeyFile

            +
            +No usage of org.kiji.schema.util.SplitKeyFile +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/TimestampComparator.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/TimestampComparator.html new file mode 100644 index 00000000..a25321c2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/TimestampComparator.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.util.TimestampComparator (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.TimestampComparator

            +
            + + + + + + + + + +
            +Packages that use TimestampComparator
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of TimestampComparator in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.util declared as TimestampComparator
            +static TimestampComparatorTimestampComparator.INSTANCE + +
            +          A singleton instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ToJson.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ToJson.html new file mode 100644 index 00000000..d605accd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ToJson.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ToJson (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ToJson

            +
            +No usage of org.kiji.schema.util.ToJson +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/VersionInfo.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/VersionInfo.html new file mode 100644 index 00000000..a001aa6d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/VersionInfo.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.VersionInfo (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.VersionInfo

            +
            +No usage of org.kiji.schema.util.VersionInfo +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ZooKeeperLock.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ZooKeeperLock.html new file mode 100644 index 00000000..b6ddce72 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ZooKeeperLock.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ZooKeeperLock (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ZooKeeperLock

            +
            +No usage of org.kiji.schema.util.ZooKeeperLock +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ZooKeeperLockFactory.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ZooKeeperLockFactory.html new file mode 100644 index 00000000..31d17218 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/class-use/ZooKeeperLockFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ZooKeeperLockFactory (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ZooKeeperLockFactory

            +
            +No usage of org.kiji.schema.util.ZooKeeperLockFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-frame.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-frame.html new file mode 100644 index 00000000..79e70286 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-frame.html @@ -0,0 +1,99 @@ + + + + + + + +org.kiji.schema.util (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + +org.kiji.schema.util + + + + +
            +Interfaces  + +
            +CounterManager +
            +Lock +
            +LockFactory +
            +ReferenceCountable
            + + + + + + +
            +Classes  + +
            +AvroUtils +
            +ByteArrayFormatter +
            +BytesKey +
            +ByteStreamArray +
            +Clock +
            +Debug +
            +FromJson +
            +Functions +
            +Hasher +
            +JavaIdentifiers +
            +KijiNameValidator +
            +NumberParser +
            +ReferenceCountableUtils +
            +Resources +
            +SplitKeyFile +
            +TimestampComparator +
            +ToJson +
            +VersionInfo +
            +ZooKeeperLock +
            +ZooKeeperLockFactory
            + + + + + + +
            +Exceptions  + +
            +ByteStreamArray.EncodingException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-summary.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-summary.html new file mode 100644 index 00000000..ff8a0204 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-summary.html @@ -0,0 +1,291 @@ + + + + + + + +org.kiji.schema.util (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.util +

            +Package containing utility classes used throughout Kiji. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + +
            +Interface Summary
            CounterManagerInterface for for objects that hold a collection of MapReduce counters.
            LockLock interface.
            LockFactoryFactory for Lock instances.
            ReferenceCountable<T>Interface for reference-countable resources.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AvroUtilsGeneral purpose Avro utilities.
            ByteArrayFormatterUtility class to format byte arrays.
            BytesKeyWraps an array of bytes into an object that can be used as key in a hash map.
            ByteStreamArrayWraps a byte array of binary-encoded data into a byte stream.
            ClockAn interface for a wall clock.
            DebugDebugging utilities.
            FromJsonDecode a JSON string into an Avro record.
            FunctionsA collection of useful functions.
            HasherA thread-safe utility for computing hashes of strings.
            JavaIdentifiersA utility class for dealing with identifiers in the Java language.
            KijiNameValidatorA utility class for validating layout names, + (including table names, locality group names, family names, and column names) + and Kiji instance names.
            NumberParserUtility for parsing strings to numbers.
            ReferenceCountableUtilsUtilities to work with ReferenceCountable resources.
            ResourcesUtility for getting access to system resources.
            SplitKeyFileParses region boundaries split files.
            TimestampComparatorA comparator that sorts Longs in reverse chronological order.
            ToJsonEncode an Avro record into JSON.
            VersionInfoReads the version info from the jar manifest for this version of Kiji.
            ZooKeeperLockDistributed lock on top of ZooKeeper.
            ZooKeeperLockFactoryFactory for ZooKeeperLock instances.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            ByteStreamArray.EncodingExceptionRaised when decoding some data fails (eg.
            +  + +

            +

            +Package org.kiji.schema.util Description +

            + +

            +Package containing utility classes used throughout Kiji. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-tree.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-tree.html new file mode 100644 index 00000000..2675ef3e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-tree.html @@ -0,0 +1,171 @@ + + + + + + + +org.kiji.schema.util Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.util +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-use.html b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-use.html new file mode 100644 index 00000000..754aa6e4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/org/kiji/schema/util/package-use.html @@ -0,0 +1,275 @@ + + + + + + + +Uses of Package org.kiji.schema.util (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.util

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.util
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema
            BytesKey + +
            +          Wraps an array of bytes into an object that can be used as key in a hash map.
            Clock + +
            +          An interface for a wall clock.
            LockFactory + +
            +          Factory for Lock instances.
            ReferenceCountable + +
            +          Interface for reference-countable resources.
            +  +

            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema.impl
            BytesKey + +
            +          Wraps an array of bytes into an object that can be used as key in a hash map.
            Lock + +
            +          Lock interface.
            LockFactory + +
            +          Factory for Lock instances.
            ReferenceCountable + +
            +          Interface for reference-countable resources.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema.util
            ByteStreamArray.EncodingException + +
            +          Raised when decoding some data fails (eg.
            Clock + +
            +          An interface for a wall clock.
            Lock + +
            +          Lock interface.
            LockFactory + +
            +          Factory for Lock instances.
            ReferenceCountable + +
            +          Interface for reference-countable resources.
            TimestampComparator + +
            +          A comparator that sorts Longs in reverse chronological order.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/overview-frame.html b/apidocs/kiji-schema/1.0.0-rc3/overview-frame.html new file mode 100644 index 00000000..9c7e84f8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/overview-frame.html @@ -0,0 +1,63 @@ + + + + + + + +Overview List (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + + + + +
            +
            + + + + + +
            All Classes +

            + +Packages +
            +org.apache.hadoop.hbase.mapreduce +
            +org.kiji.schema +
            +org.kiji.schema.avro +
            +org.kiji.schema.filter +
            +org.kiji.schema.impl +
            +org.kiji.schema.layout +
            +org.kiji.schema.layout.impl +
            +org.kiji.schema.mapreduce +
            +org.kiji.schema.tools +
            +org.kiji.schema.tools.synth +
            +org.kiji.schema.util +
            +

            + +

            +  + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/overview-summary.html b/apidocs/kiji-schema/1.0.0-rc3/overview-summary.html new file mode 100644 index 00000000..bbff12aa --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/overview-summary.html @@ -0,0 +1,198 @@ + + + + + + + +Overview (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +kiji-schema 1.0.0-rc3 API +

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages
            org.apache.hadoop.hbase.mapreduce 
            org.kiji.schemaThe main package for users of KijiSchema.
            org.kiji.schema.avro 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables.
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces.
            org.kiji.schema.layoutKiji table layouts.
            org.kiji.schema.layout.implImplementation for Kiji table layout management.
            org.kiji.schema.mapreduceKiji map-reduce utilities.
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools.
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables.
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji.
            + +

            + 

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/overview-tree.html b/apidocs/kiji-schema/1.0.0-rc3/overview-tree.html new file mode 100644 index 00000000..3e49638f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/overview-tree.html @@ -0,0 +1,335 @@ + + + + + + + +Class Hierarchy (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.apache.hadoop.hbase.mapreduce, org.kiji.schema, org.kiji.schema.avro, org.kiji.schema.filter, org.kiji.schema.impl, org.kiji.schema.layout, org.kiji.schema.layout.impl, org.kiji.schema.mapreduce, org.kiji.schema.tools, org.kiji.schema.tools.synth, org.kiji.schema.util
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/package-list b/apidocs/kiji-schema/1.0.0-rc3/package-list new file mode 100644 index 00000000..13b707ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/package-list @@ -0,0 +1,11 @@ +org.apache.hadoop.hbase.mapreduce +org.kiji.schema +org.kiji.schema.avro +org.kiji.schema.filter +org.kiji.schema.impl +org.kiji.schema.layout +org.kiji.schema.layout.impl +org.kiji.schema.mapreduce +org.kiji.schema.tools +org.kiji.schema.tools.synth +org.kiji.schema.util diff --git a/apidocs/kiji-schema/1.0.0-rc3/resources/inherit.gif b/apidocs/kiji-schema/1.0.0-rc3/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/kiji-schema/1.0.0-rc3/resources/inherit.gif differ diff --git a/apidocs/kiji-schema/1.0.0-rc3/serialized-form.html b/apidocs/kiji-schema/1.0.0-rc3/serialized-form.html new file mode 100644 index 00000000..13fae3cc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/serialized-form.html @@ -0,0 +1,661 @@ + + + + + + + +Serialized Form (kiji-schema 1.0.0-rc3 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Serialized Form

            +
            +
            + + + + + +
            +Package org.apache.hadoop.hbase.mapreduce
            + +

            + + + + + +
            +Class org.apache.hadoop.hbase.mapreduce.ImportTsv.TsvParser.BadTsvLineException extends Exception implements Serializable
            + +

            +serialVersionUID: 1L + +

            +

            + + + + + +
            +Package org.kiji.schema
            + +

            + + + + + +
            +Class org.kiji.schema.IncompatibleKijiVersionException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.InternalKijiError extends Error implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiAlreadyExistsException extends RuntimeException implements Serializable
            + +

            + + + + + +
            +Serialized Fields
            + +

            +mURI

            +
            +KijiURI mURI
            +
            +
            URI of the entity that already exists. +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiDataRequest extends Object implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mColumns

            +
            +HashMap<K,V> mColumns
            +
            +
            Map from full column name to Column describing the request. This is not a java.util.Map + because java.util.map isn't serializable. +

            +

            +
            +
            +
            +

            +mMinTimestamp

            +
            +long mMinTimestamp
            +
            +
            The minimum timestamp of cells to be read (inclusive). +

            +

            +
            +
            +
            +

            +mMaxTimestamp

            +
            +long mMaxTimestamp
            +
            +
            The maximum timestamp of cells to be read (exclusive). +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiDataRequest.Column extends Object implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mFamily

            +
            +String mFamily
            +
            +
            The column family requested. +

            +

            +
            +
            +
            +

            +mKey

            +
            +String mKey
            +
            +
            The column qualifier requested (may be null, which means any qualifier). +

            +

            +
            +
            +
            +

            +mMaxVersions

            +
            +int mMaxVersions
            +
            +
            The maximum number of versions from the column to read (of the most recent). +

            +

            +
            +
            +
            +

            +mFilter

            +
            +KijiColumnFilter mFilter
            +
            +
            A column filter (may be null). +

            +

            +
            +
            +
            +

            +mPageSize

            +
            +int mPageSize
            +
            +
            The number of cells per page (zero means no paging). +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiDataRequestException extends RuntimeException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiEncodingException extends RuntimeException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiInvalidNameException extends Exception implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiNotInstalledException extends RuntimeException implements Serializable
            + +

            + + + + + +
            +Serialized Fields
            + +

            +mInstanceName

            +
            +String mInstanceName
            +
            +
            The instance name of the missing Kiji instance. +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiTableNotFoundException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiTablePool.NoCapacityException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiURIException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.NoCellDataException extends Exception implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.NoSuchColumnException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.NotAKijiManagedTableException extends Exception implements Serializable
            + +

            + + + + + +
            +Serialized Fields
            + +

            +mHBaseTableName

            +
            +String mHBaseTableName
            +
            +
            The name of the HBase table. +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.TableKeyNotFoundException extends RuntimeException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.filter
            + +

            + + + + + +
            +Class org.kiji.schema.filter.KijiColumnFilter extends Object implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.filter.RegexQualifierColumnFilter extends KijiColumnFilter implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mRegularExpression

            +
            +String mRegularExpression
            +
            +
            +
            +
            +
            + + + + + +
            +Package org.kiji.schema.impl
            + +

            + + + + + +
            +Class org.kiji.schema.impl.InvalidColumnNameException extends RuntimeException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.impl.KijiColumnPagingNotEnabledException extends IOException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.layout
            + +

            + + + + + +
            +Class org.kiji.schema.layout.InvalidLayoutException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.layout.SchemaClassNotFoundException extends InvalidLayoutException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.tools
            + +

            + + + + + +
            +Class org.kiji.schema.tools.RequiredFlagException extends Exception implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.util
            + +

            + + + + + +
            +Class org.kiji.schema.util.ByteStreamArray.EncodingException extends IOException implements Serializable
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc3/stylesheet.css b/apidocs/kiji-schema/1.0.0-rc3/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc3/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/apidocs/kiji-schema/1.0.0-rc4/allclasses-frame.html b/apidocs/kiji-schema/1.0.0-rc4/allclasses-frame.html new file mode 100644 index 00000000..8fa8f45c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/allclasses-frame.html @@ -0,0 +1,454 @@ + + + + + + + +All Classes (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            AbstractKijiTable +
            +AndRowFilter +
            +AvroCellDecoder +
            +AvroCellEncoder +
            +AvroUtils +
            +BaseTool +
            +ByteArrayFormatter +
            +BytesKey +
            +ByteStreamArray +
            +ByteStreamArray.EncodingException +
            +CellSchema +
            +CellSchema.Builder +
            +CellSpec +
            +Clock +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +ColumnId +
            +ColumnNameTranslator +
            +ColumnValueEqualsRowFilter +
            +ComponentType +
            +CompressionType +
            +CounterCellDecoder +
            +CounterCellEncoder +
            +CreateTableTool +
            +Debug +
            +DecodedCell +
            +DefaultHBaseAdminFactory +
            +DefaultHBaseFactory +
            +DefaultHTableInterfaceFactory +
            +DefaultKijiCellEncoderFactory +
            +DefaultKijiTableFactory +
            +DeleteTool +
            +DictionaryLoader +
            +DistributedCacheJars +
            +EmailSynthesizer +
            +EntityId +
            +EntityIdException +
            +EntityIdFactory +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +FlushTableTool +
            +FormattedEntityId +
            +FromJson +
            +GenericCellDecoder +
            +GenericCellDecoderFactory +
            +GenericTableMapReduceUtil +
            +HasColumnDataRowFilter +
            +HashedEntityId +
            +Hasher +
            +HashPrefixedEntityId +
            +HashSpec +
            +HashSpec.Builder +
            +HashType +
            +HBaseAdminFactory +
            +HBaseColumnName +
            +HBaseDataRequestAdapter +
            +HBaseEntityId +
            +HBaseFactory +
            +HBaseFactory.Provider +
            +HBaseKiji +
            +HBaseKijiFactory +
            +HBaseKijiPager +
            +HBaseKijiRowData +
            +HBaseKijiRowScanner +
            +HBaseKijiRowScanner.Options +
            +HBaseKijiTable +
            +HBaseKijiTableReader +
            +HBaseKijiTableWriter +
            +HBaseMetaTable +
            +HBaseScanOptions +
            +HBaseSchemaTable +
            +HBaseSystemTable +
            +HBaseTableKeyValueDatabase +
            +HBaseTableLayoutDatabase +
            +HColumnDescriptorComparator +
            +HelpTool +
            +HTableDescriptorComparator +
            +HTableInterfaceFactory +
            +HTableSchemaTranslator +
            +IncompatibleKijiVersionException +
            +IncrementTool +
            +InstallTool +
            +InternalKijiError +
            +InvalidColumnNameException +
            +InvalidLayoutException +
            +JavaIdentifiers +
            +KConstants +
            +KeyValueBackupEntry +
            +KeyValueBackupEntry.Builder +
            +Kiji +
            +Kiji.Factory +
            +KijiAlreadyExistsException +
            +KijiCell +
            +KijiCell.CellType +
            +KijiCellDecoder +
            +KijiCellDecoderFactory +
            +KijiCellEncoder +
            +KijiCellEncoderFactory +
            +KijiColumnFilter +
            +KijiColumnFilter.Context +
            +KijiColumnName +
            +KijiColumnPagingNotEnabledException +
            +KijiConfKeys +
            +KijiDataRequest +
            +KijiDataRequest.Column +
            +KijiDataRequestBuilder +
            +KijiDataRequestBuilder.ColumnsDef +
            +KijiDataRequestException +
            +KijiDataRequestValidator +
            +KijiDeleter +
            +KijiEncodingException +
            +KijiFactory +
            +KijiIncrementer +
            +KijiInstaller +
            +KijiInvalidNameException +
            +KijiManagedHBaseTableName +
            +KijiMetaTable +
            +KijiNameValidator +
            +KijiNotInstalledException +
            +KijiPager +
            +KijiPaginationFilter +
            +KijiPutter +
            +KijiRegion +
            +KijiRowData +
            +KijiRowFilter +
            +KijiRowFilter.Context +
            +KijiRowFilterApplicator +
            +KijiRowKeySplitter +
            +KijiRowScanner +
            +KijiSchemaTable +
            +KijiSchemaTable.SchemaEntry +
            +KijiSystemTable +
            +KijiTable +
            +KijiTableFactory +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader +
            +KijiTableKeyValueDatabase +
            +KijiTableLayout +
            +KijiTableLayoutDatabase +
            +KijiTableLayoutRecords +
            +KijiTableLayoutRecords.Callback +
            +KijiTableNotFoundException +
            +KijiTablePool +
            +KijiTablePool.NoCapacityException +
            +KijiTablePool.Options +
            +KijiTableReader +
            +KijiTableReader.KijiScannerOptions +
            +KijiTableWriter +
            +KijiTool +
            +KijiToolLauncher +
            +KijiURI +
            +KijiURI.KijiURIBuilder +
            +KijiURIException +
            +LayoutTool +
            +LocalityGroupDesc +
            +LocalityGroupDesc.Builder +
            +Lock +
            +LockFactory +
            +LsTool +
            +MD5Hash +
            +MetadataBackup +
            +MetadataBackup.Builder +
            +MetadataRestorer +
            +MetadataTool +
            +NGramSynthesizer +
            +NoCellDataException +
            +NoSuchColumnException +
            +NotAKijiManagedTableException +
            +OrRowFilter +
            +ProtocolVersion +
            +PutTool +
            +RawEntityId +
            +ReferenceCountable +
            +RegexQualifierColumnFilter +
            +RequiredFlagException +
            +Resources +
            +ResourceUtils +
            +RowKeyComponent +
            +RowKeyComponent.Builder +
            +RowKeyEncoding +
            +RowKeyFormat +
            +RowKeyFormat.Builder +
            +RowKeyFormat2 +
            +RowKeyFormat2.Builder +
            +SchemaClassNotFoundException +
            +SchemaStorage +
            +SchemaTableEntry +
            +SchemaTableEntry.Builder +
            +SchemaType +
            +SpaceSeparatedMapParser +
            +SpecificCellDecoder +
            +SpecificCellDecoderFactory +
            +SplitKeyFile +
            +StripValueRowFilter +
            +Synthesizer +
            +SynthesizeUserDataTool +
            +TableBackup +
            +TableBackup.Builder +
            +TableKeyNotFoundException +
            +TableLayoutBackupEntry +
            +TableLayoutBackupEntry.Builder +
            +TableLayoutDesc +
            +TableLayoutDesc.Builder +
            +TimestampComparator +
            +ToJson +
            +ToolUtils +
            +UninstallTool +
            +VersionInfo +
            +VersionTool +
            +WordSynthesizer +
            +ZooKeeperLock +
            +ZooKeeperLockFactory +
            +
            + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/allclasses-noframe.html b/apidocs/kiji-schema/1.0.0-rc4/allclasses-noframe.html new file mode 100644 index 00000000..20c0edd3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/allclasses-noframe.html @@ -0,0 +1,454 @@ + + + + + + + +All Classes (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +All Classes +
            + + + + + +
            AbstractKijiTable +
            +AndRowFilter +
            +AvroCellDecoder +
            +AvroCellEncoder +
            +AvroUtils +
            +BaseTool +
            +ByteArrayFormatter +
            +BytesKey +
            +ByteStreamArray +
            +ByteStreamArray.EncodingException +
            +CellSchema +
            +CellSchema.Builder +
            +CellSpec +
            +Clock +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +ColumnId +
            +ColumnNameTranslator +
            +ColumnValueEqualsRowFilter +
            +ComponentType +
            +CompressionType +
            +CounterCellDecoder +
            +CounterCellEncoder +
            +CreateTableTool +
            +Debug +
            +DecodedCell +
            +DefaultHBaseAdminFactory +
            +DefaultHBaseFactory +
            +DefaultHTableInterfaceFactory +
            +DefaultKijiCellEncoderFactory +
            +DefaultKijiTableFactory +
            +DeleteTool +
            +DictionaryLoader +
            +DistributedCacheJars +
            +EmailSynthesizer +
            +EntityId +
            +EntityIdException +
            +EntityIdFactory +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +FlushTableTool +
            +FormattedEntityId +
            +FromJson +
            +GenericCellDecoder +
            +GenericCellDecoderFactory +
            +GenericTableMapReduceUtil +
            +HasColumnDataRowFilter +
            +HashedEntityId +
            +Hasher +
            +HashPrefixedEntityId +
            +HashSpec +
            +HashSpec.Builder +
            +HashType +
            +HBaseAdminFactory +
            +HBaseColumnName +
            +HBaseDataRequestAdapter +
            +HBaseEntityId +
            +HBaseFactory +
            +HBaseFactory.Provider +
            +HBaseKiji +
            +HBaseKijiFactory +
            +HBaseKijiPager +
            +HBaseKijiRowData +
            +HBaseKijiRowScanner +
            +HBaseKijiRowScanner.Options +
            +HBaseKijiTable +
            +HBaseKijiTableReader +
            +HBaseKijiTableWriter +
            +HBaseMetaTable +
            +HBaseScanOptions +
            +HBaseSchemaTable +
            +HBaseSystemTable +
            +HBaseTableKeyValueDatabase +
            +HBaseTableLayoutDatabase +
            +HColumnDescriptorComparator +
            +HelpTool +
            +HTableDescriptorComparator +
            +HTableInterfaceFactory +
            +HTableSchemaTranslator +
            +IncompatibleKijiVersionException +
            +IncrementTool +
            +InstallTool +
            +InternalKijiError +
            +InvalidColumnNameException +
            +InvalidLayoutException +
            +JavaIdentifiers +
            +KConstants +
            +KeyValueBackupEntry +
            +KeyValueBackupEntry.Builder +
            +Kiji +
            +Kiji.Factory +
            +KijiAlreadyExistsException +
            +KijiCell +
            +KijiCell.CellType +
            +KijiCellDecoder +
            +KijiCellDecoderFactory +
            +KijiCellEncoder +
            +KijiCellEncoderFactory +
            +KijiColumnFilter +
            +KijiColumnFilter.Context +
            +KijiColumnName +
            +KijiColumnPagingNotEnabledException +
            +KijiConfKeys +
            +KijiDataRequest +
            +KijiDataRequest.Column +
            +KijiDataRequestBuilder +
            +KijiDataRequestBuilder.ColumnsDef +
            +KijiDataRequestException +
            +KijiDataRequestValidator +
            +KijiDeleter +
            +KijiEncodingException +
            +KijiFactory +
            +KijiIncrementer +
            +KijiInstaller +
            +KijiInvalidNameException +
            +KijiManagedHBaseTableName +
            +KijiMetaTable +
            +KijiNameValidator +
            +KijiNotInstalledException +
            +KijiPager +
            +KijiPaginationFilter +
            +KijiPutter +
            +KijiRegion +
            +KijiRowData +
            +KijiRowFilter +
            +KijiRowFilter.Context +
            +KijiRowFilterApplicator +
            +KijiRowKeySplitter +
            +KijiRowScanner +
            +KijiSchemaTable +
            +KijiSchemaTable.SchemaEntry +
            +KijiSystemTable +
            +KijiTable +
            +KijiTableFactory +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader +
            +KijiTableKeyValueDatabase +
            +KijiTableLayout +
            +KijiTableLayoutDatabase +
            +KijiTableLayoutRecords +
            +KijiTableLayoutRecords.Callback +
            +KijiTableNotFoundException +
            +KijiTablePool +
            +KijiTablePool.NoCapacityException +
            +KijiTablePool.Options +
            +KijiTableReader +
            +KijiTableReader.KijiScannerOptions +
            +KijiTableWriter +
            +KijiTool +
            +KijiToolLauncher +
            +KijiURI +
            +KijiURI.KijiURIBuilder +
            +KijiURIException +
            +LayoutTool +
            +LocalityGroupDesc +
            +LocalityGroupDesc.Builder +
            +Lock +
            +LockFactory +
            +LsTool +
            +MD5Hash +
            +MetadataBackup +
            +MetadataBackup.Builder +
            +MetadataRestorer +
            +MetadataTool +
            +NGramSynthesizer +
            +NoCellDataException +
            +NoSuchColumnException +
            +NotAKijiManagedTableException +
            +OrRowFilter +
            +ProtocolVersion +
            +PutTool +
            +RawEntityId +
            +ReferenceCountable +
            +RegexQualifierColumnFilter +
            +RequiredFlagException +
            +Resources +
            +ResourceUtils +
            +RowKeyComponent +
            +RowKeyComponent.Builder +
            +RowKeyEncoding +
            +RowKeyFormat +
            +RowKeyFormat.Builder +
            +RowKeyFormat2 +
            +RowKeyFormat2.Builder +
            +SchemaClassNotFoundException +
            +SchemaStorage +
            +SchemaTableEntry +
            +SchemaTableEntry.Builder +
            +SchemaType +
            +SpaceSeparatedMapParser +
            +SpecificCellDecoder +
            +SpecificCellDecoderFactory +
            +SplitKeyFile +
            +StripValueRowFilter +
            +Synthesizer +
            +SynthesizeUserDataTool +
            +TableBackup +
            +TableBackup.Builder +
            +TableKeyNotFoundException +
            +TableLayoutBackupEntry +
            +TableLayoutBackupEntry.Builder +
            +TableLayoutDesc +
            +TableLayoutDesc.Builder +
            +TimestampComparator +
            +ToJson +
            +ToolUtils +
            +UninstallTool +
            +VersionInfo +
            +VersionTool +
            +WordSynthesizer +
            +ZooKeeperLock +
            +ZooKeeperLockFactory +
            +
            + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/constant-values.html b/apidocs/kiji-schema/1.0.0-rc4/constant-values.html new file mode 100644 index 00000000..8d0d0190 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/constant-values.html @@ -0,0 +1,577 @@ + + + + + + + +Constant Field Values (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Constant Field Values

            +
            +
            +Contents + + + + + + +
            +org.kiji.*
            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.KConstants
            +public static final longBEGINNING_OF_TIME0L
            +public static final StringDEFAULT_INSTANCE_NAME"default"
            +public static final StringDEFAULT_URI"kiji://.env/default"
            +public static final longEND_OF_TIME9223372036854775807L
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.KijiDataRequest
            +public static final longserialVersionUID1L
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.KijiDataRequest.Column
            +public static final longserialVersionUID1L
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.KijiRowKeySplitter
            +public static final intHBASE_ROW_KEY_RESOLUTION16
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.KijiURI
            +public static final intDEFAULT_ZOOKEEPER_CLIENT_PORT2181
            +public static final StringENV_URI_STRING".env"
            +public static final StringKIJI_SCHEME"kiji"
            +public static final StringUNSET_URI_STRING".unset"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.hbase.KijiManagedHBaseTableName
            +public static final StringKIJI_COMPONENT"kiji"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.impl.HBaseSchemaTable
            +public static final StringSCHEMA_COLUMN_FAMILY"schema"
            +public static final StringSCHEMA_COLUMN_QUALIFIER""
            +public static final StringSCHEMA_COUNTER_ROW_NAME"counter"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.impl.HBaseSystemTable
            +public static final StringDEFAULTS_PROPERTIES_FILE"org/kiji/schema/system-default.properties"
            +public static final StringKEY_DATA_VERSION"data-version"
            +public static final StringVALUE_COLUMN_FAMILY"value"
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.layout.ColumnNameTranslator
            +public static final StringSEPARATOR":"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.layout.impl.ColumnId
            +public static final StringALPHABET"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
            +public static final intBITS_PER_DIGIT6
            +public static final intRADIX64
            +public static final intUNASSIGNED0
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.layout.impl.HBaseTableLayoutDatabase
            +public static final StringQUALIFIER_LAYOUT"layout"
            +public static final StringQUALIFIER_LAYOUT_ID"layout_id"
            +public static final StringQUALIFIER_UPDATE"update"
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.mapreduce.KijiConfKeys
            +public static final StringINPUT_DATA_REQUEST"kiji.input.request"
            +public static final StringINPUT_TABLE_URI"kiji.input.table.uri"
            +public static final StringOUTPUT_KIJI_TABLE_URI"kiji.output.table.uri"
            + +

            + +

            + + + + + + + + + + + + + + + + + +
            org.kiji.schema.tools.BaseTool
            +public static final intFAILURE1
            +public static final intSUCCESS0
            + +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            org.kiji.schema.tools.ToolUtils
            +public static final StringBYTES_SPEC_PREFIX_HEX"hex:"
            +public static final StringBYTES_SPEC_PREFIX_URL"url:"
            +public static final StringBYTES_SPEC_PREFIX_UTF8"utf8:"
            +public static final StringHBASE_ROW_KEY_SPEC_PREFIX"hbase="
            +public static final StringKIJI_ROW_KEY_SPEC_PREFIX"kiji="
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.util.Hasher
            +public static final intHASH_SIZE_BYTES16
            + +

            + +

            + + + + + + + + + + + + +
            org.kiji.schema.util.VersionInfo
            +public static final StringDEFAULT_DEVELOPMENT_VERSION"development"
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/deprecated-list.html b/apidocs/kiji-schema/1.0.0-rc4/deprecated-list.html new file mode 100644 index 00000000..e1015f65 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/deprecated-list.html @@ -0,0 +1,552 @@ + + + + + + + +Deprecated List (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Deprecated API

            +
            +
            +Contents + + + + + + + + + + + + + + + +
            +Deprecated Classes
            org.kiji.schema.mapreduce.DistributedCacheJars +
            +           
            org.kiji.schema.mapreduce.KijiConfKeys +
            +           
            org.kiji.schema.mapreduce.KijiTableInputFormat +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Deprecated Fields
            org.kiji.schema.avro.FamilyDesc.aliases +
            +           
            org.kiji.schema.avro.ColumnDesc.aliases +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.aliases +
            +           
            org.kiji.schema.avro.SchemaTableEntry.avro_schema +
            +           
            org.kiji.schema.avro.ColumnDesc.column_schema +
            +           
            org.kiji.schema.avro.FamilyDesc.columns +
            +           
            org.kiji.schema.avro.RowKeyFormat2.components +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.compression_type +
            +           
            org.kiji.schema.avro.FamilyDesc.delete +
            +           
            org.kiji.schema.avro.ColumnDesc.delete +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.delete +
            +           
            org.kiji.schema.avro.FamilyDesc.description +
            +           
            org.kiji.schema.avro.TableLayoutDesc.description +
            +           
            org.kiji.schema.avro.ColumnDesc.description +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.description +
            +           
            org.kiji.schema.avro.FamilyDesc.enabled +
            +           
            org.kiji.schema.avro.ColumnDesc.enabled +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.enabled +
            +           
            org.kiji.schema.avro.RowKeyFormat2.encoding +
            +           
            org.kiji.schema.avro.RowKeyFormat.encoding +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.families +
            +           
            org.kiji.schema.avro.SchemaTableEntry.hash +
            +           
            org.kiji.schema.avro.HashSpec.hash_size +
            +           
            org.kiji.schema.avro.RowKeyFormat.hash_size +
            +           
            org.kiji.schema.avro.HashSpec.hash_type +
            +           
            org.kiji.schema.avro.RowKeyFormat.hash_type +
            +           
            org.kiji.schema.avro.FamilyDesc.id +
            +           
            org.kiji.schema.avro.ColumnDesc.id +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.id +
            +           
            org.kiji.schema.avro.SchemaTableEntry.id +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.in_memory +
            +           
            org.kiji.schema.avro.KeyValueBackupEntry.key +
            +           
            org.kiji.schema.avro.TableBackup.key_values +
            +           
            org.kiji.schema.avro.TableLayoutDesc.keys_format +
            +           
            org.kiji.schema.avro.TableLayoutBackupEntry.layout +
            +           
            org.kiji.schema.avro.TableLayoutDesc.layout_id +
            +           
            org.kiji.schema.avro.MetadataBackup.layout_version +
            +           
            org.kiji.schema.avro.TableBackup.layouts +
            +           
            org.kiji.schema.avro.TableLayoutDesc.locality_groups +
            +           
            org.kiji.schema.avro.FamilyDesc.map_schema +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.max_versions +
            +           
            org.kiji.schema.avro.MetadataBackup.meta_table +
            +           
            org.kiji.schema.avro.FamilyDesc.name +
            +           
            org.kiji.schema.avro.TableBackup.name +
            +           
            org.kiji.schema.avro.TableLayoutDesc.name +
            +           
            org.kiji.schema.avro.ColumnDesc.name +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.name +
            +           
            org.kiji.schema.avro.RowKeyComponent.name +
            +           
            org.kiji.schema.avro.RowKeyFormat2.nullable_start_index +
            +           
            org.kiji.schema.avro.RowKeyFormat2.range_scan_start_index +
            +           
            org.kiji.schema.avro.TableLayoutDesc.reference_layout +
            +           
            org.kiji.schema.avro.FamilyDesc.renamed_from +
            +           
            org.kiji.schema.avro.ColumnDesc.renamed_from +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.renamed_from +
            +           
            org.kiji.schema.avro.RowKeyFormat2.salt +
            +           
            org.kiji.schema.avro.MetadataBackup.schema_table +
            +           
            org.kiji.schema.avro.CellSchema.storage +
            +           
            org.kiji.schema.avro.HashSpec.suppress_key_materialization +
            +           
            org.kiji.schema.avro.TableLayoutBackupEntry.timestamp +
            +           
            org.kiji.schema.avro.KeyValueBackupEntry.timestamp +
            +           
            org.kiji.schema.avro.LocalityGroupDesc.ttl_seconds +
            +           
            org.kiji.schema.avro.CellSchema.type +
            +           
            org.kiji.schema.avro.RowKeyComponent.type +
            +           
            org.kiji.schema.avro.TableLayoutBackupEntry.update +
            +           
            org.kiji.schema.avro.CellSchema.value +
            +           
            org.kiji.schema.avro.KeyValueBackupEntry.value +
            +           
            org.kiji.schema.avro.TableLayoutDesc.version +
            +           
            +  +

            + + + + + + + + +
            +Deprecated Methods
            org.kiji.schema.Kiji.getConf() +
            +           
            +  +

            + + + + + + + + + + + +
            +Deprecated Constructors
            org.kiji.schema.impl.HBaseKijiRowData(EntityId, KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) +
            +           
            org.kiji.schema.impl.HBaseKijiRowData(KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree   Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/help-doc.html b/apidocs/kiji-schema/1.0.0-rc4/help-doc.html new file mode 100644 index 00000000..2c7f55b9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/help-doc.html @@ -0,0 +1,224 @@ + + + + + + + +API Help (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +How This API Document Is Organized

            +
            +This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.

            +Overview

            +
            + +

            +The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

            +

            +Package

            +
            + +

            +Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:

              +
            • Interfaces (italic)
            • Classes
            • Enums
            • Exceptions
            • Errors
            • Annotation Types
            +
            +

            +Class/Interface

            +
            + +

            +Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

              +
            • Class inheritance diagram
            • Direct Subclasses
            • All Known Subinterfaces
            • All Known Implementing Classes
            • Class/interface declaration
            • Class/interface description +

              +

            • Nested Class Summary
            • Field Summary
            • Constructor Summary
            • Method Summary +

              +

            • Field Detail
            • Constructor Detail
            • Method Detail
            +Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
            + +

            +Annotation Type

            +
            + +

            +Each annotation type has its own separate page with the following sections:

              +
            • Annotation Type declaration
            • Annotation Type description
            • Required Element Summary
            • Optional Element Summary
            • Element Detail
            +
            + +

            +Enum

            +
            + +

            +Each enum has its own separate page with the following sections:

              +
            • Enum declaration
            • Enum description
            • Enum Constant Summary
            • Enum Constant Detail
            +
            +

            +Use

            +
            +Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.
            +

            +Tree (Class Hierarchy)

            +
            +There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.
              +
            • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
            • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
            +
            +

            +Deprecated API

            +
            +The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
            +

            +Index

            +
            +The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
            +

            +Prev/Next

            +These links take you to the next or previous class, interface, package, or related page.

            +Frames/No Frames

            +These links show and hide the HTML frames. All pages are available with or without frames. +

            +

            +Serialized Form

            +Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description. +

            +

            +Constant Field Values

            +The Constant Field Values page lists the static final fields and their values. +

            + + +This help file applies to API documentation generated using the standard doclet. + +
            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index   Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/index-all.html b/apidocs/kiji-schema/1.0.0-rc4/index-all.html new file mode 100644 index 00000000..ff652a3a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/index-all.html @@ -0,0 +1,5257 @@ + + + + + + + +Index (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +A B C D E F G H I J K L M N O P Q R S T U V W Y Z
            +

            +A

            +
            +
            AbstractKijiTable - Class in org.kiji.schema.impl
            Main handle for a Kiji table with basic functionality.
            AbstractKijiTable(Kiji, String) - +Constructor for class org.kiji.schema.impl.AbstractKijiTable +
            Creates a new KijiTable instance. +
            add(String, String) - +Method in class org.kiji.schema.KijiDataRequestBuilder.ColumnsDef +
            Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object. +
            add(KijiColumnName) - +Method in class org.kiji.schema.KijiDataRequestBuilder.ColumnsDef +
            Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object. +
            addAllDependencyJars(Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            Like TableMapReduceUtil.addDependencyJars() but this catches some + missing ones like google's guava library. +
            addColumnName(KijiColumnName) - +Method in class org.kiji.schema.KijiURI.KijiURIBuilder +
            Adds the column name to the Kiji URI column names. +
            addColumnNames(Collection<KijiColumnName>) - +Method in class org.kiji.schema.KijiURI.KijiURIBuilder +
            Adds the column names to the Kiji URI column names. +
            addColumns(KijiDataRequestBuilder.ColumnsDef) - +Method in class org.kiji.schema.KijiDataRequestBuilder +
            Adds another set of column definitions to this KijiDataRequest builder. +
            addFamily(String) - +Method in class org.kiji.schema.KijiDataRequestBuilder.ColumnsDef +
            Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object. +
            addJarsToDistributedCache(Job, String) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Adds the jars from a directory into the distributed cache of a job. +
            addJarsToDistributedCache(Job, File) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Adds the jars from a directory into the distributed cache of a job. +
            aliases - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            aliases - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            aliases - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            ALPHABET - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The alphabet used to generate the short physical names. +
            AndRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter for a conjunction (AND operator) of other filters.
            AndRowFilter(List<? extends KijiRowFilter>) - +Constructor for class org.kiji.schema.filter.AndRowFilter +
            Creates a new AndRowFilter instance. +
            applyTo(Scan) - +Method in class org.kiji.schema.filter.KijiRowFilterApplicator +
            Applies the row filter to an HBase scan object. +
            applyToScan(Scan, KijiTableLayout) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one. +
            avro_schema - +Variable in class org.kiji.schema.avro.SchemaTableEntry +
            Deprecated.  +
            AvroCellDecoder<T> - Class in org.kiji.schema.impl
            Base class for decoders that read Kiji cells encoded using Avro.
            AvroCellDecoder(CellSpec) - +Constructor for class org.kiji.schema.impl.AvroCellDecoder +
            Initializes an abstract KijiAvroCellDecoder. +
            AvroCellEncoder - Class in org.kiji.schema.impl
            Serializes a KijiCell.
            AvroCellEncoder(CellSpec) - +Constructor for class org.kiji.schema.impl.AvroCellEncoder +
            Creates a new KijiCellEncoder instance. +
            AvroUtils - Class in org.kiji.schema.util
            General purpose Avro utilities.
            +
            +

            +B

            +
            +
            BaseTool - Class in org.kiji.schema.tools
            Base class for all Kiji command line tools.
            BaseTool() - +Constructor for class org.kiji.schema.tools.BaseTool +
              +
            BEGINNING_OF_TIME - +Static variable in class org.kiji.schema.KConstants +
              +
            BITS_PER_DIGIT - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The base 2 logarithm of the size of the alphabet (64), which is the number of bits + we can encode with a single digit. +
            build() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.HashSpec.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.RowKeyComponent.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
              +
            build() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
              +
            build() - +Method in class org.kiji.schema.KijiDataRequestBuilder +
            Construct a new KijiDataRequest based on the configuration specified in this builder + and its associated column builders. +
            build() - +Method in class org.kiji.schema.KijiURI.KijiURIBuilder +
            Builds the configured KijiURI. +
            builder() - +Static method in class org.kiji.schema.KijiDataRequest +
            Creates a new KijiDataRequestBuilder. +
            bulkGet(List<EntityId>, KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Retrieves data from a list of rows in the kiji table. +
            bulkGet(List<EntityId>, KijiDataRequest) - +Method in interface org.kiji.schema.KijiTableReader +
            Retrieves data from a list of rows in the kiji table. +
            ByteArrayFormatter - Class in org.kiji.schema.util
            Utility class to format byte arrays.
            BYTES_SPEC_PREFIX_HEX - +Static variable in class org.kiji.schema.tools.ToolUtils +
            Prefix to specify a sequence of bytes in hexadecimal, as in: "00dead88beefaa". +
            BYTES_SPEC_PREFIX_URL - +Static variable in class org.kiji.schema.tools.ToolUtils +
            Prefix to specify a sequence of bytes as a URL, as in: "URL%20encoded". +
            BYTES_SPEC_PREFIX_UTF8 - +Static variable in class org.kiji.schema.tools.ToolUtils +
            Optional prefix to specify a sequence of bytes in UTF-8, as in: "utf-8 \x00 encoded". +
            BytesKey - Class in org.kiji.schema.util
            Wraps an array of bytes into an object that can be used as key in a hash map.
            BytesKey(byte[]) - +Constructor for class org.kiji.schema.util.BytesKey +
            Wraps the given byte array. +
            ByteStreamArray - Class in org.kiji.schema.util
            Wraps a byte array of binary-encoded data into a byte stream.
            ByteStreamArray(byte[], int) - +Constructor for class org.kiji.schema.util.ByteStreamArray +
            Constructs a new stream of byte. +
            ByteStreamArray(byte[]) - +Constructor for class org.kiji.schema.util.ByteStreamArray +
            Constructs a new stream of byte. +
            ByteStreamArray.EncodingException - Exception in org.kiji.schema.util
            Raised when decoding some data fails (eg.
            ByteStreamArray.EncodingException() - +Constructor for exception org.kiji.schema.util.ByteStreamArray.EncodingException +
              +
            +
            +

            +C

            +
            +
            CellSchema - Class in org.kiji.schema.avro
             
            CellSchema() - +Constructor for class org.kiji.schema.avro.CellSchema +
            Default constructor. +
            CellSchema(SchemaStorage, SchemaType, String) - +Constructor for class org.kiji.schema.avro.CellSchema +
            All-args constructor. +
            CellSchema.Builder - Class in org.kiji.schema.avro
            RecordBuilder for CellSchema instances.
            CellSpec - Class in org.kiji.schema.layout.impl
            Specification of a Kiji cell.
            CellSpec() - +Constructor for class org.kiji.schema.layout.impl.CellSpec +
            Initializes a new, unspecified CellSpec. +
            cleanup() - +Method in class org.kiji.schema.tools.BaseTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.CreateTableTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.FlushTableTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.LayoutTool +
            Cleans up any open file handles, connections, etc. +
            cleanup() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Cleans up any open file handles, connections, etc. +
            clearAliases() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'aliases' field +
            clearAliases() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'aliases' field +
            clearAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'aliases' field +
            clearAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Clears the value of the 'avro_schema' field +
            clearColumns() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'columns' field +
            clearColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'column_schema' field +
            clearComponents() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Clears the value of the 'components' field +
            clearCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'compression_type' field +
            clearDelete() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'delete' field +
            clearDelete() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'delete' field +
            clearDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'delete' field +
            clearDescription() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'description' field +
            clearDescription() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'description' field +
            clearDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'description' field +
            clearDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'description' field +
            clearEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'enabled' field +
            clearEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'enabled' field +
            clearEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'enabled' field +
            clearEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Clears the value of the 'encoding' field +
            clearEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Clears the value of the 'encoding' field +
            clearFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'families' field +
            clearHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Clears the value of the 'hash' field +
            clearHashSize() - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Clears the value of the 'hash_size' field +
            clearHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Clears the value of the 'hash_size' field +
            clearHashType() - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Clears the value of the 'hash_type' field +
            clearHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Clears the value of the 'hash_type' field +
            clearId() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'id' field +
            clearId() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'id' field +
            clearId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'id' field +
            clearId() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Clears the value of the 'id' field +
            clearInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'in_memory' field +
            clearKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Clears the value of the 'key' field +
            clearKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'keys_format' field +
            clearKeyValues() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Clears the value of the 'key_values' field +
            clearLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Clears the value of the 'layout' field +
            clearLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'layout_id' field +
            clearLayouts() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Clears the value of the 'layouts' field +
            clearLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Clears the value of the 'layout_version' field +
            clearLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'locality_groups' field +
            clearMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'map_schema' field +
            clearMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'max_versions' field +
            clearMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Clears the value of the 'meta_table' field +
            clearName() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.RowKeyComponent.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Clears the value of the 'name' field +
            clearName() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'name' field +
            clearNullableStartIndex() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Clears the value of the 'nullable_start_index' field +
            clearRangeScanStartIndex() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Clears the value of the 'range_scan_start_index' field +
            clearReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'reference_layout' field +
            clearRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Clears the value of the 'renamed_from' field +
            clearRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Clears the value of the 'renamed_from' field +
            clearRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'renamed_from' field +
            clearSalt() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Clears the value of the 'salt' field +
            clearSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Clears the value of the 'schema_table' field +
            clearStorage() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Clears the value of the 'storage' field +
            clearSuppressKeyMaterialization() - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Clears the value of the 'suppress_key_materialization' field +
            clearTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Clears the value of the 'timestamp' field +
            clearTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Clears the value of the 'timestamp' field +
            clearTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Clears the value of the 'ttl_seconds' field +
            clearType() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Clears the value of the 'type' field +
            clearType() - +Method in class org.kiji.schema.avro.RowKeyComponent.Builder +
            Clears the value of the 'type' field +
            clearUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Clears the value of the 'update' field +
            clearValue() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Clears the value of the 'value' field +
            clearValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Clears the value of the 'value' field +
            clearVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Clears the value of the 'version' field +
            Clock - Class in org.kiji.schema.util
            An interface for a wall clock.
            close() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiPager +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner +
            Closes this scanner and releases any system resources associated with it. +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
              +
            close() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            +
            close() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Flushes and closes the KijiSchemaTable. +
            close() - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            +
            close() - +Method in class org.kiji.schema.KijiMetaTable +
            +
            close() - +Method in interface org.kiji.schema.KijiRowScanner +
            Closes this scanner and releases any system resources associated with it. +
            close() - +Method in class org.kiji.schema.KijiSchemaTable +
            Flushes and closes the KijiSchemaTable. +
            close() - +Method in class org.kiji.schema.KijiTablePool +
            Closes the tables in the pool. +
            close() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            close() - +Method in class org.kiji.schema.util.ZooKeeperLock +
            +
            closeOrLog(Closeable) - +Static method in class org.kiji.schema.util.ResourceUtils +
            Closes the specified resource, logging and swallowing I/O errors if needed. +
            column_schema - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            ColumnDesc - Class in org.kiji.schema.avro
             
            ColumnDesc() - +Constructor for class org.kiji.schema.avro.ColumnDesc +
            Default constructor. +
            ColumnDesc(Integer, String, List<String>, Boolean, String, CellSchema, Boolean, String) - +Constructor for class org.kiji.schema.avro.ColumnDesc +
            All-args constructor. +
            ColumnDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for ColumnDesc instances.
            ColumnId - Class in org.kiji.schema.layout.impl
            A very short physical identifier for a column family or qualifier to be used in HBase.
            ColumnId(int) - +Constructor for class org.kiji.schema.layout.impl.ColumnId +
            Constructs a column id that encodes the given integer. +
            ColumnNameTranslator - Class in org.kiji.schema.layout
            Translates between HTable and Kiji table column names.
            ColumnNameTranslator(KijiTableLayout) - +Constructor for class org.kiji.schema.layout.ColumnNameTranslator +
            Creates a new ColumnNameTranslator instance. +
            columns - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            ColumnValueEqualsRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value.
            ColumnValueEqualsRowFilter(String, String, DecodedCell<?>) - +Constructor for class org.kiji.schema.filter.ColumnValueEqualsRowFilter +
            Creates a new ColumnValueEqualsRowFilter instance. +
            compare(HColumnDescriptor, HColumnDescriptor) - +Method in class org.kiji.schema.impl.HColumnDescriptorComparator +
              +
            compare(HTableDescriptor, HTableDescriptor) - +Method in class org.kiji.schema.impl.HTableDescriptorComparator +
              +
            compare(Long, Long) - +Method in class org.kiji.schema.util.TimestampComparator +
              +
            compareTo(KijiColumnName) - +Method in class org.kiji.schema.KijiColumnName +
            +
            compareTo(ProtocolVersion) - +Method in class org.kiji.schema.util.ProtocolVersion +
            +
            components - +Variable in class org.kiji.schema.avro.RowKeyFormat2 +
            Deprecated.  +
            ComponentType - Enum in org.kiji.schema.avro
             
            compression_type - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            CompressionType - Enum in org.kiji.schema.avro
             
            configureJob(Job, KijiURI, KijiDataRequest, String, String) - +Static method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated. Configures a Hadoop M/R job to read from a given table. +
            containsCell(String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Determines whether a particular column has data in this row with the specified timestamp. +
            containsCell(String, String, long) - +Method in interface org.kiji.schema.KijiRowData +
            Determines whether a particular column has data in this row with the specified timestamp. +
            containsColumn(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Determines whether a particular column has data in this row. +
            containsColumn(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Determines whether a particular column family has data in this row. +
            containsColumn(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Determines whether a particular column has data in this row. +
            containsColumn(String) - +Method in interface org.kiji.schema.KijiRowData +
            Determines whether a particular column family has data in this row. +
            convertStringToScan(String) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            This method is just like the package-private version in TableMapReduceUtil, + except that it disables block caching by default. +
            CounterCellDecoder - Class in org.kiji.schema.impl
            Cell decoder for counters.
            CounterCellEncoder - Class in org.kiji.schema.impl
            Encoder for Kiji counters.
            create(KijiRowFilter, KijiTableLayout, KijiSchemaTable) - +Static method in class org.kiji.schema.filter.KijiRowFilterApplicator +
            Creates a new KijiRowFilterApplicator instance. +
            create(CellSpec) - +Method in class org.kiji.schema.GenericCellDecoderFactory +
            Creates a new Kiji cell decoder. +
            create(Configuration) - +Method in class org.kiji.schema.impl.DefaultHBaseAdminFactory +
            Creates a new HBaseAdmin instance. +
            create(Configuration, String) - +Method in class org.kiji.schema.impl.DefaultHTableInterfaceFactory +
            Creates a new HTableInterface instance. +
            create(CellSpec) - +Method in class org.kiji.schema.impl.DefaultKijiCellEncoderFactory +
            Creates a new Kiji cell encoder. +
            create(Configuration) - +Method in interface org.kiji.schema.impl.HBaseAdminFactory +
            Creates a new HBaseAdmin instance. +
            create(Configuration, String) - +Method in interface org.kiji.schema.impl.HTableInterfaceFactory +
            Creates a new HTableInterface instance. +
            create(CellSpec) - +Method in interface org.kiji.schema.KijiCellDecoderFactory +
            Creates a new Kiji cell decoder. +
            create(CellSpec) - +Method in interface org.kiji.schema.KijiCellEncoderFactory +
            Creates a new Kiji cell encoder. +
            create(String) - +Static method in class org.kiji.schema.KijiDataRequest +
            Factory method for a simple KijiDataRequest for the most recent version + of each qualifier in one column family. +
            create(String, String) - +Static method in class org.kiji.schema.KijiDataRequest +
            Factory method for a simple KijiDataRequest for the most recent + version of a specific family:qualifier. +
            create() - +Static method in class org.kiji.schema.KijiDataRequestBuilder.ColumnsDef +
              +
            create(CellSpec) - +Method in class org.kiji.schema.SpecificCellDecoderFactory +
            Creates a new Kiji cell decoder. +
            create() - +Static method in class org.kiji.schema.tools.SpaceSeparatedMapParser +
              +
            create(String) - +Method in interface org.kiji.schema.util.LockFactory +
            Creates a new lock with the specified name. +
            create(String) - +Method in class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a new lock with the specified name. +
            createDatumReader(Schema, Schema) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Factory for DatumReader instances. +
            createDatumReader(Schema, Schema) - +Method in class org.kiji.schema.impl.GenericCellDecoder +
            Factory for DatumReader instances. +
            createDatumReader(Schema, Schema) - +Method in class org.kiji.schema.impl.SpecificCellDecoder +
            Factory for DatumReader instances. +
            createEntityIdFromUserInputs(String, KijiTableLayout) - +Static method in class org.kiji.schema.tools.ToolUtils +
            Parses a command-line flag specifying an entity ID. +
            createFromEffectiveJson(InputStream) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Loads a table layout from the specified JSON text. +
            createFromEffectiveJsonResource(String) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Loads a table layout from the specified resource as JSON. +
            createRecordReader(InputSplit, TaskAttemptContext) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            createTable(String, KijiTableLayout) - +Method in class org.kiji.schema.impl.HBaseKiji +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, int) - +Method in class org.kiji.schema.impl.HBaseKiji +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, byte[][]) - +Method in class org.kiji.schema.impl.HBaseKiji +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout) - +Method in interface org.kiji.schema.Kiji +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, int) - +Method in interface org.kiji.schema.Kiji +
            Creates a Kiji table in an HBase instance. +
            createTable(String, KijiTableLayout, byte[][]) - +Method in interface org.kiji.schema.Kiji +
            Creates a Kiji table in an HBase instance. +
            CreateTableTool - Class in org.kiji.schema.tools
            Command-line tool for creating kiji tables in kiji instances.
            CreateTableTool() - +Constructor for class org.kiji.schema.tools.CreateTableTool +
              +
            createUpdatedLayout(TableLayoutDesc, KijiTableLayout) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Creates and returns a new KijiTableLayout instance as specified by composing updates described + by a TableLayoutDesc with the original + KijiTableLayout. +
            +
            +

            +D

            +
            +
            Debug - Class in org.kiji.schema.util
            Debugging utilities.
            decodeAvro(ByteBuffer, Schema, Schema, T) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Decodes the data payload given the reader and writer schema. +
            decodeCell(byte[]) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeCell(byte[]) - +Method in class org.kiji.schema.impl.CounterCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeCell(byte[]) - +Method in interface org.kiji.schema.KijiCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            DecodedCell<T> - Class in org.kiji.schema
            Content of a Kiji cell.
            DecodedCell(Schema, T) - +Constructor for class org.kiji.schema.DecodedCell +
            Initializes a DecodedCell instance. +
            decodeRegionSplitList(InputStream) - +Static method in class org.kiji.schema.util.SplitKeyFile +
            Constructs a split key file from an input stream. +
            decodeRowKey(String) - +Static method in class org.kiji.schema.util.SplitKeyFile +
            Decodes a string encoded row key. +
            decodeSchemaEntry(byte[]) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Decodes a binary-encoded Avro schema entry. +
            decodeValue(byte[]) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeValue(byte[]) - +Method in class org.kiji.schema.impl.CounterCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            decodeValue(byte[]) - +Method in interface org.kiji.schema.KijiCellDecoder +
            Decodes a Kiji cell from its binary-encoded form. +
            deDuplicateJarNames(List<String>) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Takes a list of paths and returns a list of paths with unique filenames. +
            DEFAULT_DEVELOPMENT_VERSION - +Static variable in class org.kiji.schema.util.VersionInfo +
            Fallback software version ID, in case the properties file is not generated/reachable. +
            DEFAULT_INSTANCE_NAME - +Static variable in class org.kiji.schema.KConstants +
            Default kiji instance name. +
            DEFAULT_URI - +Static variable in class org.kiji.schema.KConstants +
            Default Kiji URI. +
            DEFAULT_ZOOKEEPER_CLIENT_PORT - +Static variable in class org.kiji.schema.KijiURI +
            Default Zookeeper port. +
            DefaultHBaseAdminFactory - Class in org.kiji.schema.impl
            Factory for HBaseAdmin that creates concrete HBaseAdmin instances.
            DefaultHBaseFactory - Class in org.kiji.schema.impl
            Factory for HBase instances based on URIs.
            DefaultHBaseFactory() - +Constructor for class org.kiji.schema.impl.DefaultHBaseFactory +
            Public constructor for use by the service loader. +
            DefaultHTableInterfaceFactory - Class in org.kiji.schema.impl
            Factory for HTableInterface that creates concrete HTable instances.
            DefaultKijiCellEncoderFactory - Class in org.kiji.schema.impl
            Factory for cell encoders.
            DefaultKijiTableFactory - Class in org.kiji.schema.impl
            The default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open().
            DefaultKijiTableFactory(Kiji) - +Constructor for class org.kiji.schema.impl.DefaultKijiTableFactory +
            Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance. +
            DEFAULTS_PROPERTIES_FILE - +Static variable in class org.kiji.schema.impl.HBaseSystemTable +
            The name of the file that stores the current system table defaults that are loaded + at installation time. +
            delete - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            delete - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            delete - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            deleteCell(EntityId, String, String) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes the most recent version of the cell in a column. +
            deleteCell(EntityId, String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes a single cell with a specified timestamp. +
            deleteCell(EntityId, String, String) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes the most recent version of the cell in a column. +
            deleteCell(EntityId, String, String, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes a single cell with a specified timestamp. +
            deleteColumn(EntityId, String, String) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all versions of all cells in a column. +
            deleteColumn(EntityId, String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +
            deleteColumn(EntityId, String, String) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all versions of all cells in a column. +
            deleteColumn(EntityId, String, String, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +
            deleteFamily(EntityId, String) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all versions of all cells in a family. +
            deleteFamily(EntityId, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +
            deleteFamily(EntityId, String) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all versions of all cells in a family. +
            deleteFamily(EntityId, String, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +
            deleteRow(EntityId) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Deletes an entire row. +
            deleteRow(EntityId, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +
            deleteRow(EntityId) - +Method in interface org.kiji.schema.KijiDeleter +
            Deletes an entire row. +
            deleteRow(EntityId, long) - +Method in interface org.kiji.schema.KijiDeleter +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +
            deleteTable(String) - +Method in class org.kiji.schema.impl.HBaseKiji +
            Deletes a Kiji table. +
            deleteTable(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Remove all metadata, including layouts, for a particular table. +
            deleteTable(String) - +Method in interface org.kiji.schema.Kiji +
            Deletes a Kiji table. +
            deleteTable(String) - +Method in class org.kiji.schema.KijiMetaTable +
            Remove all metadata, including layouts, for a particular table. +
            DeleteTool - Class in org.kiji.schema.tools
            Command-line tool to delete Kiji tables, rows, and cells.
            DeleteTool() - +Constructor for class org.kiji.schema.tools.DeleteTool +
              +
            description - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            description - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            description - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            description - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            DictionaryLoader - Class in org.kiji.schema.tools.synth
            Loads a dictionary file, which is simply a list of words, one per line.
            DictionaryLoader() - +Constructor for class org.kiji.schema.tools.synth.DictionaryLoader +
            Creates a new DictionaryLoader instance. +
            DistributedCacheJars - Class in org.kiji.schema.mapreduce
            Deprecated. 
            downcast(KijiTable) - +Static method in class org.kiji.schema.impl.HBaseKijiTable +
            We know that all KijiTables are really HBaseKijiTables + instances. +
            +
            +

            +E

            +
            +
            EmailSynthesizer - Class in org.kiji.schema.tools.synth
            Synthesizes a random email address.
            EmailSynthesizer(Random, List<String>) - +Constructor for class org.kiji.schema.tools.synth.EmailSynthesizer +
            Creates a new email synthesizer. +
            enabled - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            enabled - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            enabled - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            encode(DecodedCell<?>) - +Method in class org.kiji.schema.impl.AvroCellEncoder +
            Encodes the specified Kiji cell. +
            encode(T) - +Method in class org.kiji.schema.impl.AvroCellEncoder +
            Encodes the specified value. +
            encode(DecodedCell<?>) - +Method in class org.kiji.schema.impl.CounterCellEncoder +
            Encodes the specified Kiji cell. +
            encode(T) - +Method in class org.kiji.schema.impl.CounterCellEncoder +
            Encodes the specified value. +
            encode(DecodedCell<?>) - +Method in interface org.kiji.schema.KijiCellEncoder +
            Encodes the specified Kiji cell. +
            encode(T) - +Method in interface org.kiji.schema.KijiCellEncoder +
            Encodes the specified value. +
            encodeSchemaEntry(SchemaTableEntry) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Encodes an Avro schema entry into binary. +
            encoding - +Variable in class org.kiji.schema.avro.RowKeyFormat +
            Deprecated.  +
            encoding - +Variable in class org.kiji.schema.avro.RowKeyFormat2 +
            Deprecated.  +
            END_OF_TIME - +Static variable in class org.kiji.schema.KConstants +
              +
            EntityId - Class in org.kiji.schema
            EntityId is used to identify a particular row in a Kiji table.
            EntityId() - +Constructor for class org.kiji.schema.EntityId +
              +
            EntityIdException - Exception in org.kiji.schema
            Thrown when kiji encounters a row key component name that is not valid.
            EntityIdException(String) - +Constructor for exception org.kiji.schema.EntityIdException +
            Creates a new EntityIdException with the specified detail message. +
            EntityIdFactory - Class in org.kiji.schema
            Factory class for creating EntityIds.
            EntityIdFactory() - +Constructor for class org.kiji.schema.EntityIdFactory +
              +
            ENV_URI_STRING - +Static variable in class org.kiji.schema.KijiURI +
            String to specify a value through the local environment. +
            equals(Object) - +Method in class org.kiji.schema.DecodedCell +
            Determines whether the data contained in this DecodedCell is equivalent to another. +
            equals(Object) - +Method in class org.kiji.schema.EntityId +
            +
            equals(Object) - +Method in class org.kiji.schema.hbase.HBaseColumnName +
            +
            equals(Object) - +Method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
              +
            equals(Object) - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiColumnName +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiDataRequest.Column +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiDataRequest +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            +
            equals(Object) - +Method in class org.kiji.schema.KijiURI +
            +
            equals(Object) - +Method in class org.kiji.schema.layout.impl.ColumnId +
            +
            equals(Object) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            +
            equals(Object) - +Method in class org.kiji.schema.util.BytesKey +
              +
            equals(Object) - +Method in class org.kiji.schema.util.ProtocolVersion +
            +
            exists(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Reports whether a column exists. +
            exportMetadata(String, Kiji) - +Method in class org.kiji.schema.impl.MetadataRestorer +
            Exports all Kiji metadata to an Avro file with the specified filename. +
            +
            +

            +F

            +
            +
            FAILURE - +Static variable in class org.kiji.schema.tools.BaseTool +
            Failure tool exit code. +
            families - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            FamilyDesc - Class in org.kiji.schema.avro
             
            FamilyDesc() - +Constructor for class org.kiji.schema.avro.FamilyDesc +
            Default constructor. +
            FamilyDesc(Integer, String, List<String>, Boolean, String, CellSchema, List<ColumnDesc>, Boolean, String) - +Constructor for class org.kiji.schema.avro.FamilyDesc +
            All-args constructor. +
            FamilyDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for FamilyDesc instances.
            fileSystemSpecified(Path) - +Static method in class org.kiji.schema.tools.LayoutTool +
            Determines whether a path has its filesystem explicitly specified. +
            finalize() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            finalize() - +Method in class org.kiji.schema.impl.HBaseKiji +
            +
            finalize() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner +
            +
            finalize() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            +
            finalize() - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            +
            finalize() - +Method in class org.kiji.schema.KijiMetaTable +
            +
            finalize() - +Method in class org.kiji.schema.KijiTablePool +
              +
            flush() - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
              +
            flush() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Commits any pending additions to the schema table. +
            flush() - +Method in class org.kiji.schema.KijiSchemaTable +
            Commits any pending additions to the schema table. +
            FlushTableTool - Class in org.kiji.schema.tools
            Command-line tool for flushing Kiji meta and user tables in HBase.
            FlushTableTool() - +Constructor for class org.kiji.schema.tools.FlushTableTool +
              +
            formatEmail(String, String) - +Static method in class org.kiji.schema.tools.synth.EmailSynthesizer +
            Construct an email address string. +
            FormattedEntityId - Class in org.kiji.schema.impl
            Implements the Formatted Entity Id row key.
            fromAvroEntry(SchemaTableEntry) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Converts an Avro SchemaTableEntry into a SchemaEntry. +
            fromAvroJsonString(String, Schema) - +Static method in class org.kiji.schema.util.FromJson +
            Standard Avro JSON decoder. +
            fromBackup(Map<String, TableBackup>) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Restores metadata from a backup record. +
            fromBackup(List<SchemaTableEntry>) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Restores the schema entries from the specified backup record. +
            fromBackup(Map<String, TableBackup>) - +Method in class org.kiji.schema.KijiMetaTable +
            Restores metadata from a backup record. +
            fromBackup(List<SchemaTableEntry>) - +Method in class org.kiji.schema.KijiSchemaTable +
            Restores the schema entries from the specified backup record. +
            fromByteArray(byte[]) - +Static method in class org.kiji.schema.layout.impl.ColumnId +
            Translates HBase column names to ColumnIds. +
            fromCellSchema(CellSchema, KijiSchemaTable) - +Static method in class org.kiji.schema.layout.impl.CellSpec +
              +
            fromCellSchema(CellSchema) - +Static method in class org.kiji.schema.layout.impl.CellSpec +
            Creates a CellSpec from a CellSchema record. +
            fromHBaseRowKey(byte[], RowKeyFormat2) - +Static method in class org.kiji.schema.impl.FormattedEntityId +
            Creates a FormattedEntityId from the specified HBase row key. +
            fromHBaseRowKey(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashedEntityId +
            Creates a HashedEntityId from the specified HBase row key. +
            fromHBaseRowKey(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Creates a HashPrefixedEntityId from the specified HBase row key. +
            fromHBaseRowKey(byte[]) - +Static method in class org.kiji.schema.impl.RawEntityId +
            Creates a RawEntityId from the specified HBase row key. +
            FromJson - Class in org.kiji.schema.util
            Decode a JSON string into an Avro record.
            fromJsonNode(JsonNode, Schema) - +Static method in class org.kiji.schema.util.FromJson +
            Decodes a JSON node as an Avro value. +
            fromJsonString(String, Schema) - +Static method in class org.kiji.schema.util.FromJson +
            Decodes a JSON encoded record. +
            fromString(String) - +Static method in class org.kiji.schema.layout.impl.ColumnId +
            Translates HBase column names to ColumnIds. +
            +
            +

            +G

            +
            +
            GenericCellDecoder<T> - Class in org.kiji.schema.impl
            Decodes cells encoded using Avro into generic types.
            GenericCellDecoder(CellSpec) - +Constructor for class org.kiji.schema.impl.GenericCellDecoder +
            Initializes a cell decoder that creates generic Avro types. +
            GenericCellDecoderFactory - Class in org.kiji.schema
            Factory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas.
            GenericTableMapReduceUtil - Class in org.apache.hadoop.hbase.mapreduce
            Just like TableMapReduceUtil but fixes some missing dependency jars.
            GenericTableMapReduceUtil() - +Constructor for class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
              +
            get(int) - +Method in class org.kiji.schema.avro.CellSchema +
              +
            get(int) - +Method in class org.kiji.schema.avro.ColumnDesc +
              +
            get(int) - +Method in class org.kiji.schema.avro.FamilyDesc +
              +
            get(int) - +Method in class org.kiji.schema.avro.HashSpec +
              +
            get(int) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            get(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            get(int) - +Method in class org.kiji.schema.avro.MetadataBackup +
              +
            get(int) - +Method in class org.kiji.schema.avro.RowKeyComponent +
              +
            get(int) - +Method in class org.kiji.schema.avro.RowKeyFormat +
              +
            get(int) - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
              +
            get(int) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
              +
            get(int) - +Method in class org.kiji.schema.avro.TableBackup +
              +
            get(int) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            get(int) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
              +
            get() - +Static method in class org.kiji.schema.GenericCellDecoderFactory +
              +
            get() - +Static method in class org.kiji.schema.hbase.HBaseFactory.Provider +
              +
            get(String) - +Static method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Constructs using an HBase HTable name. +
            get() - +Static method in class org.kiji.schema.impl.CounterCellDecoder +
              +
            get() - +Static method in class org.kiji.schema.impl.CounterCellEncoder +
              +
            get() - +Static method in class org.kiji.schema.impl.DefaultHBaseAdminFactory +
              +
            get() - +Static method in class org.kiji.schema.impl.DefaultHTableInterfaceFactory +
              +
            get() - +Static method in class org.kiji.schema.impl.DefaultKijiCellEncoderFactory +
              +
            get(EntityId, KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Retrieves data from a single row in the kiji table. +
            get() - +Static method in class org.kiji.schema.Kiji.Factory +
              +
            get() - +Static method in class org.kiji.schema.KijiInstaller +
            Gets an instance of a KijiInstaller. +
            get(String) - +Method in class org.kiji.schema.KijiTablePool +
            Gets a previously opened table from the pool, or open a new connection. +
            get(EntityId, KijiDataRequest) - +Method in interface org.kiji.schema.KijiTableReader +
            Retrieves data from a single row in the kiji table. +
            get() - +Static method in class org.kiji.schema.SpecificCellDecoderFactory +
              +
            getAliases() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'aliases' field +
            getAliases() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'aliases' field. +
            getAliases() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'aliases' field +
            getAliases() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'aliases' field. +
            getAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'aliases' field +
            getAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'aliases' field. +
            getAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Gets the value of the 'avro_schema' field +
            getAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Gets the value of the 'avro_schema' field. +
            getAvroSchema() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            getBytes() - +Method in class org.kiji.schema.util.BytesKey +
              +
            getBytes() - +Method in class org.kiji.schema.util.ByteStreamArray +
              +
            getCacheBlocks() - +Method in class org.kiji.schema.hbase.HBaseScanOptions +
            Returns whether requested rows are cached server-side, + or null if using the HBase default. +
            getCategory() - +Method in class org.kiji.schema.tools.CreateTableTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.DeleteTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.FlushTableTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.HelpTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.IncrementTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.InstallTool +
            +
            getCategory() - +Method in interface org.kiji.schema.tools.KijiTool +
              +
            getCategory() - +Method in class org.kiji.schema.tools.LayoutTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.LsTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.MetadataTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.PutTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.UninstallTool +
            +
            getCategory() - +Method in class org.kiji.schema.tools.VersionTool +
            +
            getCell(String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the specified cell. +
            getCell(String, String, long) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the specified cell. +
            getCellDecoderFactory() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the cell decoder factory. +
            getCellFormat(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Reports the cell format for the specified column. +
            getCells(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all cells stored within the specified column. +
            getCells(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all cells stored within the specified column family. +
            getCells(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all cells stored within the specified column family. +
            getCells(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all cells stored within the specified column. +
            getCellSchema() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            getCellSchema(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Gets the schema for a column. +
            getCellSpec(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getClientBufferSize() - +Method in class org.kiji.schema.hbase.HBaseScanOptions +
            Returns the number of rows to request with each RPC, + or null if using the HBase default. +
            getClientDataVersion() - +Static method in class org.kiji.schema.util.VersionInfo +
            Gets the version of the Kiji instance format assumed by the client. +
            getClock() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets a clock. +
            getClusterDataVersion(Kiji) - +Static method in class org.kiji.schema.util.VersionInfo +
            Gets the version of the Kiji instance format installed on the HBase cluster. +
            getColumn(String, String) - +Method in class org.kiji.schema.KijiDataRequest +
            Gets a Column requested named "family:key", or + null if none exists. +
            getColumnIdNameMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getColumnMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getColumnName() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the column name. +
            getColumnNames() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getColumns() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'columns' field +
            getColumns() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'columns' field. +
            getColumns() - +Method in class org.kiji.schema.KijiDataRequest +
            Gets the collection of requested columns. +
            getColumns() - +Method in class org.kiji.schema.KijiURI +
              +
            getColumns() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'column_schema' field +
            getColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'column_schema' field. +
            getColumnsOrdered() - +Method in class org.kiji.schema.KijiURI +
              +
            getComponentByIndex(int) - +Method in class org.kiji.schema.EntityId +
            Get the individual components of the kiji Row Key representation. +
            getComponentByIndex(int) - +Method in class org.kiji.schema.impl.FormattedEntityId +
            Get the individual components of the kiji Row Key representation. +
            getComponentByIndex(int) - +Method in class org.kiji.schema.impl.HashedEntityId +
            Get the individual components of the kiji Row Key representation. +
            getComponentByIndex(int) - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Get the individual components of the kiji Row Key representation. +
            getComponentByIndex(int) - +Method in class org.kiji.schema.impl.HBaseEntityId +
            Get the individual components of the kiji Row Key representation. +
            getComponentByIndex(int) - +Method in class org.kiji.schema.impl.RawEntityId +
            Get the individual components of the kiji Row Key representation. +
            getComponents() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Gets the value of the 'components' field +
            getComponents() - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
            Gets the value of the 'components' field. +
            getComponents() - +Method in class org.kiji.schema.EntityId +
            Get the components of the row key as a List of Objects. +
            getComponents() - +Method in class org.kiji.schema.impl.FormattedEntityId +
            Get the components of the row key as a List of Objects. +
            getComponents() - +Method in class org.kiji.schema.impl.HashedEntityId +
            Get the components of the row key as a List of Objects. +
            getComponents() - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Get the components of the row key as a List of Objects. +
            getComponents() - +Method in class org.kiji.schema.impl.HBaseEntityId +
            Get the components of the row key as a List of Objects. +
            getComponents() - +Method in class org.kiji.schema.impl.RawEntityId +
            Get the components of the row key as a List of Objects. +
            getCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'compression_type' field +
            getCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'compression_type' field. +
            getConf() - +Method in class org.kiji.schema.impl.HBaseKiji +
            +
            getConf() - +Method in interface org.kiji.schema.Kiji +
            Deprecated.  +
            getConf() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            getCurrentKey() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            getCurrentValue() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            getData() - +Method in class org.kiji.schema.DecodedCell +
              +
            getData() - +Method in class org.kiji.schema.KijiCell +
              +
            getDataRequest() - +Method in class org.kiji.schema.filter.ColumnValueEqualsRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.HasColumnDataRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.KijiRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.filter.StripValueRowFilter +
            Describes the data the filter requires to determine whether a row should be accepted. +
            getDataRequest() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the data request. +
            getDataVersion() - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Gets the version of kiji installed. +
            getDataVersion() - +Method in class org.kiji.schema.KijiSystemTable +
            Gets the version of kiji installed. +
            getDefaultClock() - +Static method in class org.kiji.schema.util.Clock +
              +
            getDelete() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'delete' field +
            getDelete() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'delete' field. +
            getDelete() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'delete' field +
            getDelete() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'delete' field. +
            getDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'delete' field +
            getDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'delete' field. +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getDesc() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getDescription() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'description' field +
            getDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'description' field. +
            getDescription() - +Method in class org.kiji.schema.tools.CreateTableTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.DeleteTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.FlushTableTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.HelpTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.IncrementTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.InstallTool +
            +
            getDescription() - +Method in interface org.kiji.schema.tools.KijiTool +
              +
            getDescription() - +Method in class org.kiji.schema.tools.LayoutTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.LsTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.MetadataTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.PutTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.UninstallTool +
            +
            getDescription() - +Method in class org.kiji.schema.tools.VersionTool +
            +
            getEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'enabled' field +
            getEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'enabled' field. +
            getEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'enabled' field +
            getEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'enabled' field. +
            getEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'enabled' field +
            getEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'enabled' field. +
            getEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Gets the value of the 'encoding' field +
            getEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Gets the value of the 'encoding' field. +
            getEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Gets the value of the 'encoding' field +
            getEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
            Gets the value of the 'encoding' field. +
            getEncoding(Object) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Find the encoding of the row key given the format. +
            getEndKey() - +Method in interface org.kiji.schema.KijiRegion +
            Gets the end key (exclusive) of this region. +
            getEntityId(Object...) - +Method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID from a list of key components. +
            getEntityId(List<Object>) - +Method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID from a list of key components. +
            getEntityId(Object...) - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            Creates an entity id from a list of components. +
            getEntityId(List<Object>, RowKeyFormat2) - +Static method in class org.kiji.schema.impl.FormattedEntityId +
            Creates a FormattedEntityId from the specified Kiji row key. +
            getEntityId(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashedEntityId +
            Creates a HashedEntityId from the specified Kiji row key. +
            getEntityId(byte[], RowKeyFormat) - +Static method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Creates a HashPrefixedEntityId from the specified Kiji row key. +
            getEntityId() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the entity id for this row. +
            getEntityId(Object...) - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            Creates an entity id from a list of components. +
            getEntityId(byte[]) - +Static method in class org.kiji.schema.impl.RawEntityId +
            Creates a RawEntityId from the specified Kiji row key. +
            getEntityId() - +Method in interface org.kiji.schema.KijiRowData +
            Gets the entity id for this row. +
            getEntityId(Object...) - +Method in interface org.kiji.schema.KijiTable +
            Creates an entity id from a list of components. +
            getEntityIdFromHBaseRowKey(byte[]) - +Method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID from an HBase row key. +
            getFactory(RowKeyFormat) - +Static method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID factory for the specified row key format. +
            getFactory(RowKeyFormat2) - +Static method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID factory for the specified row key format. +
            getFactory(KijiTableLayout) - +Static method in class org.kiji.schema.EntityIdFactory +
            Creates an entity ID factory for the row key format given by the specified + table layout. +
            getFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'families' field +
            getFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'families' field. +
            getFamilies() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getFamilies() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getFamily() - +Method in class org.kiji.schema.hbase.HBaseColumnName +
            Gets the HBase column family. +
            getFamily() - +Method in class org.kiji.schema.KijiCell +
              +
            getFamily() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column family. +
            getFamily() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the name of the requested column family. +
            getFamily() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getFamilyAsString() - +Method in class org.kiji.schema.hbase.HBaseColumnName +
            Gets the HBase column family as a string. +
            getFamilyBytes() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column family as a byte array. +
            getFamilyIdNameMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getFamilyMap() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getFamilyMap() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getFilter() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the column filter, or null if no filter was specified. +
            getHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Gets the value of the 'hash' field +
            getHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Gets the value of the 'hash' field. +
            getHash() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
              +
            getHashSize() - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Gets the value of the 'hash_size' field +
            getHashSize() - +Method in class org.kiji.schema.avro.HashSpec +
            Gets the value of the 'hash_size' field. +
            getHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Gets the value of the 'hash_size' field +
            getHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Gets the value of the 'hash_size' field. +
            getHashSize(Object) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Get the hash size for a given row key format. +
            getHashType() - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Gets the value of the 'hash_type' field +
            getHashType() - +Method in class org.kiji.schema.avro.HashSpec +
            Gets the value of the 'hash_type' field. +
            getHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Gets the value of the 'hash_type' field +
            getHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Gets the value of the 'hash_type' field. +
            getHBaseAdmin() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Gets the current HBaseAdmin instance for this Kiji. +
            getHBaseAdminFactory(KijiURI) - +Method in interface org.kiji.schema.hbase.HBaseFactory +
            Reports a factory for HBaseAdmin for a given HBase instance. +
            getHBaseAdminFactory(KijiURI) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            Reports a factory for HBaseAdmin for a given HBase instance. +
            getHBaseCellValue(KijiColumnName, DecodedCell<?>) - +Method in class org.kiji.schema.filter.KijiRowFilter.Context +
            Converts a Kiji cell value into an HBase cell value. +
            getHBaseColumnName(KijiColumnName) - +Method in interface org.kiji.schema.filter.KijiColumnFilter.Context +
            Converts a Kiji column name to an HBase column name. +
            getHBaseColumnName(KijiColumnName) - +Method in class org.kiji.schema.filter.KijiRowFilter.Context +
            Converts a Kiji column name to an HBase column family name. +
            getHBaseResult() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the HBase result backing this KijiRowData. +
            getHBaseResultScanner() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the HBase result scanner. +
            getHBaseRowKey() - +Method in class org.kiji.schema.EntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey(String) - +Method in class org.kiji.schema.filter.KijiRowFilter.Context +
            Converts a Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.FormattedEntityId +
              +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.HashedEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.HBaseEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseRowKey() - +Method in class org.kiji.schema.impl.RawEntityId +
            Translates this Kiji row key into an HBase row key. +
            getHBaseScanOptions() - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Gets the HBaseScanOptions set in these options. +
            getHBaseTableName() - +Method in exception org.kiji.schema.NotAKijiManagedTableException +
            Gets the name of the HBase table that is not managed by Kiji. +
            getHColumnDescriptor(String) - +Static method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets the description of an HColumn suitable for storing the table layout database. +
            getHTable() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
              +
            getHTableInterfaceFactory(KijiURI) - +Method in interface org.kiji.schema.hbase.HBaseFactory +
            Reports a factory for HTableInterface for a given HBase instance. +
            getHTableInterfaceFactory(KijiURI) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            Reports a factory for HTableInterface for a given HBase instance. +
            getId() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Gets the value of the 'id' field +
            getId() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Gets the value of the 'id' field. +
            getId() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
              +
            getId() - +Method in class org.kiji.schema.layout.impl.ColumnId +
              +
            getId() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getId() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getId() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getIdlePollPeriod() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the amount of time between sweeps of the pool for removing idle connections. +
            getIdleTimeout() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the amount of time a connection may be idle before being removed from the pool. +
            getInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'in_memory' field +
            getInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'in_memory' field. +
            getInstance() - +Method in class org.kiji.schema.KijiURI +
              +
            getInstanceName() - +Method in exception org.kiji.schema.KijiNotInstalledException +
              +
            getInstanceNames(KijiURI) - +Static method in class org.kiji.schema.tools.LsTool +
            Returns a set of instance names. +
            getJarsFromConfiguration(Configuration) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated. Lists all jars in the variable tmpjars of this Configuration. +
            getJarsFromDirectory(Configuration, File) - +Static method in class org.kiji.schema.mapreduce.DistributedCacheJars +
            Deprecated.   +
            getKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Gets the value of the 'key' field +
            getKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Gets the value of the 'key' field. +
            getKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'keys_format' field +
            getKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'keys_format' field. +
            getKeyValues() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Gets the value of the 'key_values' field +
            getKeyValues() - +Method in class org.kiji.schema.avro.TableBackup +
            Gets the value of the 'key_values' field. +
            getKiji() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            getKiji() - +Method in interface org.kiji.schema.KijiTable +
              +
            getKijiInstanceName() - +Method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Gets the name of the Kiji instance this named table belongs to. +
            getKijiRowFilter() - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Gets the row filter set in these options. +
            getKijiRowKey() - +Method in class org.kiji.schema.impl.HashedEntityId +
              +
            getKijiRowKey() - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
              +
            getKijiTableName(String, String) - +Static method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table. +
            getKijiTableName() - +Method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Gets the name of the Kiji table. +
            getLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Gets the value of the 'layout' field +
            getLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Gets the value of the 'layout' field. +
            getLayout() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            +
            getLayout() - +Method in interface org.kiji.schema.KijiTable +
              +
            getLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'layout_id' field +
            getLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'layout_id' field. +
            getLayouts() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Gets the value of the 'layouts' field +
            getLayouts() - +Method in class org.kiji.schema.avro.TableBackup +
            Gets the value of the 'layouts' field. +
            getLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Gets the value of the 'layout_version' field +
            getLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup +
            Gets the value of the 'layout_version' field. +
            getLocalityGroup() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getLocalityGroupIdNameMap() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getLocalityGroupMap() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'locality_groups' field +
            getLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'locality_groups' field. +
            getLocalityGroups() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getLocations() - +Method in interface org.kiji.schema.KijiRegion +
            Gets the locations of this region in hostname:port form, if available. +
            getLockFactory(KijiURI, Configuration) - +Method in interface org.kiji.schema.hbase.HBaseFactory +
            Creates a lock factory for a given Kiji instance. +
            getLockFactory(KijiURI, Configuration) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            Creates a lock factory for a given Kiji instance. +
            getMajorVersion() - +Method in class org.kiji.schema.util.ProtocolVersion +
            Returns the major version (first digit) in this version. +
            getMap() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets a map from kiji family to qualifier to timestamp to raw kiji-encoded bytes of a cell. +
            getMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'map_schema' field +
            getMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'map_schema' field. +
            getMaxSize() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the maximum number of connections to keep per table. +
            getMaxSupportedLayoutVersion() - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Returns the maximum layout version supported. +
            getMaxTimestamp() - +Method in class org.kiji.schema.KijiDataRequest +
            Gets the maximum timestamp for versions in this request (exclusive). +
            getMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'max_versions' field +
            getMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'max_versions' field. +
            getMaxVersions() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the max number of most recent versions in this column. +
            getMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Gets the value of the 'meta_table' field +
            getMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup +
            Gets the value of the 'meta_table' field. +
            getMetaTable() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Gets the meta table for this Kiji instance. +
            getMetaTable() - +Method in interface org.kiji.schema.Kiji +
            Gets the meta table for this Kiji instance. +
            getMetaTableName(String) - +Static method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table. +
            getMinorVersion() - +Method in class org.kiji.schema.util.ProtocolVersion +
            Returns the minor version (second digit) in this version. +
            getMinSize() - +Method in class org.kiji.schema.KijiTablePool.Options +
            Gets the minimum number of connections to keep per table. +
            getMinSupportedLayoutVersion() - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Returns the minimum layout version supported. +
            getMinTimestamp() - +Method in class org.kiji.schema.KijiDataRequest +
            Gets the minimum timestamp for versions in this request (inclusive). +
            getMostRecentCell(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the cell in the specified column with the latest timestamp. +
            getMostRecentCell(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the cell in the specified column with the latest timestamp. +
            getMostRecentCells(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the cells in the specified column family flattened to contain only the cells with + the latest timestamp in each column. +
            getMostRecentCells(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the cells in the specified column family flattened to contain only the cells with + the latest timestamp in each column. +
            getMostRecentValue(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the data stored within the specified column with the latest timestamp. +
            getMostRecentValue(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the data stored within the specified column with the latest timestamp. +
            getMostRecentValues(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all data stored within the specified column family flattened to contain only + the data with the latest timestamps in each column. +
            getMostRecentValues(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all data stored within the specified column family flattened to contain only + the data with the latest timestamps in each column. +
            getName() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.RowKeyComponent.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.RowKeyComponent +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.TableBackup +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'name' field +
            getName() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'name' field. +
            getName() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            getName() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the full name of the column. +
            getName() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the full name of the requested column. +
            getName() - +Method in interface org.kiji.schema.KijiTable +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getName() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getName() - +Method in class org.kiji.schema.tools.CreateTableTool +
            +
            getName() - +Method in class org.kiji.schema.tools.DeleteTool +
            +
            getName() - +Method in class org.kiji.schema.tools.FlushTableTool +
            +
            getName() - +Method in class org.kiji.schema.tools.HelpTool +
            +
            getName() - +Method in class org.kiji.schema.tools.IncrementTool +
            +
            getName() - +Method in class org.kiji.schema.tools.InstallTool +
            +
            getName() - +Method in interface org.kiji.schema.tools.KijiTool +
              +
            getName() - +Method in class org.kiji.schema.tools.LayoutTool +
            +
            getName() - +Method in class org.kiji.schema.tools.LsTool +
            +
            getName() - +Method in class org.kiji.schema.tools.MetadataTool +
            +
            getName() - +Method in class org.kiji.schema.tools.PutTool +
            +
            getName() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            +
            getName() - +Method in class org.kiji.schema.tools.UninstallTool +
            +
            getName() - +Method in class org.kiji.schema.tools.VersionTool +
            +
            getNames() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout +
              +
            getNames() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            getNames() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getNullableStartIndex() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Gets the value of the 'nullable_start_index' field +
            getNullableStartIndex() - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
            Gets the value of the 'nullable_start_index' field. +
            getOffset() - +Method in class org.kiji.schema.util.ByteStreamArray +
              +
            getOptionalType(Schema) - +Static method in class org.kiji.schema.util.AvroUtils +
            Reports whether the given schema is an optional type (ie. +
            getOrCreateSchemaHash(Schema) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema hash given an Avro schema object. +
            getOrCreateSchemaHash(Schema) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema hash given an Avro schema object. +
            getOrCreateSchemaId(Schema) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema ID given an Avro schema object. +
            getOrCreateSchemaId(Schema) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema ID given an Avro schema object. +
            getPager(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets a KijiPager for the specified column. +
            getPager(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets a KijiPager for the specified column family. +
            getPager(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets a KijiPager for the specified column. +
            getPager(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets a KijiPager for the specified column family. +
            getPageSize() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the number of cells to return per page of results. +
            getPayload(byte[]) - +Method in class org.kiji.schema.impl.AvroCellDecoder +
            Gets the portion of the encoded byte array from an HBase table cell that has the avro-encoded + data payload. +
            getPoolSize(String) - +Method in class org.kiji.schema.KijiTablePool +
            Gets the total number of connections, active and cached, for the specified table. +
            getPrintStream() - +Method in class org.kiji.schema.tools.BaseTool +
            The output print stream the tool should be writing to. +
            getPriority(Map<String, String>) - +Method in class org.kiji.schema.impl.DefaultHBaseFactory +
            +
            getPriority(Map<String, String>) - +Method in class org.kiji.schema.impl.HBaseKijiFactory +
            +
            getProgress() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            getProtocolName() - +Method in class org.kiji.schema.util.ProtocolVersion +
            Returns the protocol name associated with this version string. +
            getQualifier() - +Method in class org.kiji.schema.hbase.HBaseColumnName +
            Gets the HBase column qualifier. +
            getQualifier() - +Method in class org.kiji.schema.KijiCell +
              +
            getQualifier() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column qualifier, which may be null or empty. +
            getQualifier() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Gets the name of the requested column qualifier, which may be null if any qualifier + should be included. +
            getQualifierAsString() - +Method in class org.kiji.schema.hbase.HBaseColumnName +
            Gets the HBase column qualifier as a string. +
            getQualifierBytes() - +Method in class org.kiji.schema.KijiColumnName +
            Gets the name of the column qualifier as a byte array. +
            getQualifiers(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the set of column qualifiers that exist in a column family in this row. +
            getQualifiers(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the set of column qualifiers that exist in a column family in this row. +
            getRangeScanStartIndex() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Gets the value of the 'range_scan_start_index' field +
            getRangeScanStartIndex() - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
            Gets the value of the 'range_scan_start_index' field. +
            getReaderSchema(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +
            getReaderSchema(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +
            getReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'reference_layout' field +
            getReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'reference_layout' field. +
            getRegions() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            Return the regions in this table as a list. +
            getRegions() - +Method in interface org.kiji.schema.KijiTable +
            Return the regions in this table as an ordered list. +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Gets the value of the 'renamed_from' field +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc +
            Gets the value of the 'renamed_from' field. +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Gets the value of the 'renamed_from' field +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc +
            Gets the value of the 'renamed_from' field. +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'renamed_from' field +
            getRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'renamed_from' field. +
            getRevision() - +Method in class org.kiji.schema.util.ProtocolVersion +
            Returns the revision version (third digit) in this version. +
            getSalt() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Gets the value of the 'salt' field +
            getSalt() - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
            Gets the value of the 'salt' field. +
            getScanner(KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Gets a KijiRowScanner with the specified data request. +
            getScanner(KijiDataRequest, KijiTableReader.KijiScannerOptions) - +Method in class org.kiji.schema.impl.HBaseKijiTableReader +
            Gets a KijiRowScanner using the specified data request and options. +
            getScanner(KijiDataRequest) - +Method in interface org.kiji.schema.KijiTableReader +
            Gets a KijiRowScanner with the specified data request. +
            getScanner(KijiDataRequest, KijiTableReader.KijiScannerOptions) - +Method in interface org.kiji.schema.KijiTableReader +
            Gets a KijiRowScanner using the specified data request and options. +
            getSchema() - +Method in class org.kiji.schema.avro.CellSchema +
              +
            getSchema() - +Method in class org.kiji.schema.avro.ColumnDesc +
              +
            getSchema() - +Method in class org.kiji.schema.avro.FamilyDesc +
              +
            getSchema() - +Method in class org.kiji.schema.avro.HashSpec +
              +
            getSchema() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            getSchema() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            getSchema() - +Method in class org.kiji.schema.avro.MetadataBackup +
              +
            getSchema() - +Method in class org.kiji.schema.avro.RowKeyComponent +
              +
            getSchema() - +Method in class org.kiji.schema.avro.RowKeyFormat +
              +
            getSchema() - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
              +
            getSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry +
              +
            getSchema() - +Method in class org.kiji.schema.avro.TableBackup +
              +
            getSchema() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            getSchema() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
              +
            getSchema(long) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema given an ID. +
            getSchema(BytesKey) - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Looks up a schema given a hash. +
            getSchema(long) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema given an ID. +
            getSchema(BytesKey) - +Method in class org.kiji.schema.KijiSchemaTable +
            Looks up a schema given a hash. +
            getSchema() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
              +
            getSchema(KijiColumnName) - +Method in class org.kiji.schema.layout.KijiTableLayout +
            Reports the schema of the specified column. +
            getSchemaHash(Schema) - +Method in class org.kiji.schema.KijiSchemaTable +
            Computes a schema hash. +
            getSchemaHashTableName(String) - +Static method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table. +
            getSchemaIdTableName(String) - +Static method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table. +
            getSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Gets the value of the 'schema_table' field +
            getSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup +
            Gets the value of the 'schema_table' field. +
            getSchemaTable() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Gets the schema table for this Kiji instance. +
            getSchemaTable() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the schema table this kiji row data uses for decoding. +
            getSchemaTable() - +Method in interface org.kiji.schema.Kiji +
            Gets the schema table for this Kiji instance. +
            getSchemaTable() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            getSchemaV5TableName(String) - +Static method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table. +
            getServerPrefetchSize() - +Method in class org.kiji.schema.hbase.HBaseScanOptions +
            Returns the number of rows for servers to prefetch, + or null if using the HBase default. +
            getSoftwareVersion() - +Static method in class org.kiji.schema.util.VersionInfo +
            Gets the version of the Kiji client software. +
            getSplitKeys(int) - +Static method in class org.kiji.schema.KijiRowKeySplitter +
            Returns the split keys for the given number of regions. +
            getSplits(JobContext) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            getStackTrace() - +Static method in class org.kiji.schema.util.Debug +
              +
            getStartKey() - +Method in interface org.kiji.schema.KijiRegion +
            Gets the start key (inclusive) of this region. +
            getStartRow() - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Gets the start row set in these options. +
            getStopRow() - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Gets the stop row set in these options. +
            getStorage() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Gets the value of the 'storage' field +
            getStorage() - +Method in class org.kiji.schema.avro.CellSchema +
            Gets the value of the 'storage' field. +
            getSuppressKeyMaterialization() - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Gets the value of the 'suppress_key_materialization' field +
            getSuppressKeyMaterialization() - +Method in class org.kiji.schema.avro.HashSpec +
            Gets the value of the 'suppress_key_materialization' field. +
            getSystemTable() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Gets the system table for this Kiji instance. +
            getSystemTable() - +Method in interface org.kiji.schema.Kiji +
            Gets the system table for this Kiji instance. +
            getSystemTableName(String) - +Static method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table. +
            getTable() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Gets the table being scanned. +
            getTable() - +Method in class org.kiji.schema.KijiURI +
              +
            getTableLayout() - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the layout of the table this row data belongs to. +
            getTableLayout(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets the most recent versions of the layout for a table. +
            getTableLayout() - +Method in class org.kiji.schema.layout.ColumnNameTranslator +
              +
            getTableLayout(String) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets the most recent versions of the layout for a table. +
            getTableLayout() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout +
              +
            getTableLayout(String) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets the most recent versions of the layout for a table. +
            getTableLayoutVersions(String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the most recent specified number of versions of the table layout. +
            getTableLayoutVersions(String, int) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets a list of the most recent specified number of versions of the table layout. +
            getTableLayoutVersions(String, int) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets a list of the most recent specified number of versions of the table layout. +
            getTableName() - +Method in exception org.kiji.schema.KijiTableNotFoundException +
              +
            getTableNames() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Gets the list of Kiji table names. +
            getTableNames() - +Method in interface org.kiji.schema.Kiji +
            Gets the list of Kiji table names. +
            getTime() - +Method in class org.kiji.schema.util.Clock +
            Gets the current time. +
            getTimedTableLayoutVersions(String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +
            getTimedTableLayoutVersions(String, int) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +
            getTimedTableLayoutVersions(String, int) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +
            getTimedValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns a map of values associated with the specified table and key. +
            getTimedValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns a map of values associated with the specified table and key. +
            getTimedValues(String, String, int) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns a map of values associated with the specified table and key. +
            getTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Gets the value of the 'timestamp' field +
            getTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Gets the value of the 'timestamp' field. +
            getTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Gets the value of the 'timestamp' field +
            getTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Gets the value of the 'timestamp' field. +
            getTimestamp() - +Method in class org.kiji.schema.KijiCell +
              +
            getTimestamps(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the set of timestamps on cells that exist in a column. +
            getTimestamps(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the set of timestamps on cells that exist in a column. +
            getTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Gets the value of the 'ttl_seconds' field +
            getTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Gets the value of the 'ttl_seconds' field. +
            getType() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Gets the value of the 'type' field +
            getType() - +Method in class org.kiji.schema.avro.CellSchema +
            Gets the value of the 'type' field. +
            getType() - +Method in class org.kiji.schema.avro.RowKeyComponent.Builder +
            Gets the value of the 'type' field +
            getType() - +Method in class org.kiji.schema.avro.RowKeyComponent +
            Gets the value of the 'type' field. +
            getType() - +Method in class org.kiji.schema.KijiCell +
              +
            getUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Gets the value of the 'update' field +
            getUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Gets the value of the 'update' field. +
            getURI() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            getURI() - +Method in class org.kiji.schema.impl.HBaseKiji +
            +
            getURI() - +Method in interface org.kiji.schema.Kiji +
              +
            getURI() - +Method in exception org.kiji.schema.KijiAlreadyExistsException +
              +
            getURI() - +Method in interface org.kiji.schema.KijiTable +
              +
            getValue() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Gets the value of the 'value' field +
            getValue() - +Method in class org.kiji.schema.avro.CellSchema +
            Gets the value of the 'value' field. +
            getValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Gets the value of the 'value' field +
            getValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Gets the value of the 'value' field. +
            getValue(String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets the data stored within the specified column with the specified timestamp. +
            getValue(String, String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns the most recent value associated with the specified table and key. +
            getValue(String) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Gets the value associated with a property key. +
            getValue(String, String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns the most recent value associated with the specified table and key. +
            getValue(String, String, long) - +Method in interface org.kiji.schema.KijiRowData +
            Gets the data stored within the specified column with the specified timestamp. +
            getValue(String) - +Method in class org.kiji.schema.KijiSystemTable +
            Gets the value associated with a property key. +
            getValue(String, String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns the most recent value associated with the specified table and key. +
            getValues(String, String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all data stored within the specified column. +
            getValues(String) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Gets all data stored within the specified column family. +
            getValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +
            getValues(String, String, int) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +
            getValues(String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all data stored within the specified column family. +
            getValues(String, String) - +Method in interface org.kiji.schema.KijiRowData +
            Gets all data stored within the specified column. +
            getValues(String, String, int) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +
            getVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Gets the value of the 'version' field +
            getVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Gets the value of the 'version' field. +
            getWriterSchema() - +Method in class org.kiji.schema.DecodedCell +
              +
            getWriterSchema() - +Method in class org.kiji.schema.KijiCell +
              +
            getZookeeperClientPort() - +Method in class org.kiji.schema.KijiURI +
              +
            getZookeeperQuorum() - +Method in class org.kiji.schema.KijiURI +
              +
            getZookeeperQuorumOrdered() - +Method in class org.kiji.schema.KijiURI +
              +
            +
            +

            +H

            +
            +
            hasAliases() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'aliases' field has been set +
            hasAliases() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'aliases' field has been set +
            hasAliases() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'aliases' field has been set +
            hasAvroSchema() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Checks whether the 'avro_schema' field has been set +
            HasColumnDataRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter that excludes rows that have no data for some column columnName.
            HasColumnDataRowFilter(String, String) - +Constructor for class org.kiji.schema.filter.HasColumnDataRowFilter +
            Constructs a row filter that excludes rows that have no data in columnName. +
            HasColumnDataRowFilter(String) - +Constructor for class org.kiji.schema.filter.HasColumnDataRowFilter +
            Constructs a row filter that excludes rows that have no data in columnName. +
            hasColumns() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'columns' field has been set +
            hasColumnSchema() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'column_schema' field has been set +
            hasComponents() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Checks whether the 'components' field has been set +
            hasCompressionType() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'compression_type' field has been set +
            hasDelete() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'delete' field has been set +
            hasDelete() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'delete' field has been set +
            hasDelete() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'delete' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'description' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'description' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'description' field has been set +
            hasDescription() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'description' field has been set +
            hasEnabled() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'enabled' field has been set +
            hasEnabled() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'enabled' field has been set +
            hasEnabled() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'enabled' field has been set +
            hasEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Checks whether the 'encoding' field has been set +
            hasEncoding() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Checks whether the 'encoding' field has been set +
            hasFamilies() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'families' field has been set +
            hash - +Variable in class org.kiji.schema.avro.SchemaTableEntry +
            Deprecated.  +
            hash(String) - +Static method in class org.kiji.schema.util.Hasher +
            Hashes the input string. +
            hash(byte[]) - +Static method in class org.kiji.schema.util.Hasher +
            Hashes the input byte array. +
            hash_size - +Variable in class org.kiji.schema.avro.HashSpec +
            Deprecated.  +
            hash_size - +Variable in class org.kiji.schema.avro.RowKeyFormat +
            Deprecated.  +
            HASH_SIZE_BYTES - +Static variable in class org.kiji.schema.util.Hasher +
            The number of bytes in a hash. +
            hash_type - +Variable in class org.kiji.schema.avro.HashSpec +
            Deprecated.  +
            hash_type - +Variable in class org.kiji.schema.avro.RowKeyFormat +
            Deprecated.  +
            hasHash() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Checks whether the 'hash' field has been set +
            hasHashSize() - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Checks whether the 'hash_size' field has been set +
            hasHashSize() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Checks whether the 'hash_size' field has been set +
            hasHashType() - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Checks whether the 'hash_type' field has been set +
            hasHashType() - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Checks whether the 'hash_type' field has been set +
            hashCode() - +Method in class org.kiji.schema.DecodedCell +
            This operation is not supported. +
            hashCode() - +Method in class org.kiji.schema.EntityId +
            +
            hashCode() - +Method in class org.kiji.schema.hbase.HBaseColumnName +
            +
            hashCode() - +Method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
              +
            hashCode() - +Method in class org.kiji.schema.impl.AbstractKijiTable +
            +
            hashCode() - +Method in class org.kiji.schema.KijiColumnName +
            +
            hashCode() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            +
            hashCode() - +Method in class org.kiji.schema.KijiDataRequest +
            +
            hashCode() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            +
            hashCode() - +Method in class org.kiji.schema.KijiURI +
            +
            hashCode() - +Method in class org.kiji.schema.layout.impl.ColumnId +
            +
            hashCode() - +Method in class org.kiji.schema.layout.KijiTableLayout +
            +
            hashCode() - +Method in class org.kiji.schema.util.BytesKey +
              +
            hashCode() - +Method in class org.kiji.schema.util.ProtocolVersion +
            +
            HashedEntityId - Class in org.kiji.schema.impl
            Implements the hashed row key format.
            Hasher - Class in org.kiji.schema.util
            A thread-safe utility for computing hashes of strings.
            hashKijiRowKey(RowKeyFormat, byte[]) - +Static method in class org.kiji.schema.impl.HashedEntityId +
            Hashes a Kiji row key. +
            hashKijiRowKey(RowKeyFormat, byte[]) - +Static method in class org.kiji.schema.impl.HashPrefixedEntityId +
            Hashes a Kiji row key. +
            HashPrefixedEntityId - Class in org.kiji.schema.impl
            Implements the hash-prefixed row key format.
            hashSchema(Schema) - +Static method in class org.kiji.schema.KijiSchemaTable +
            Computes a hash of the specified Avro schema. +
            HashSpec - Class in org.kiji.schema.avro
             
            HashSpec() - +Constructor for class org.kiji.schema.avro.HashSpec +
            Default constructor. +
            HashSpec(HashType, Integer, Boolean) - +Constructor for class org.kiji.schema.avro.HashSpec +
            All-args constructor. +
            HashSpec.Builder - Class in org.kiji.schema.avro
            RecordBuilder for HashSpec instances.
            HashType - Enum in org.kiji.schema.avro
             
            hasId() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'id' field has been set +
            hasId() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'id' field has been set +
            hasId() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'id' field has been set +
            hasId() - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Checks whether the 'id' field has been set +
            hasInMemory() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'in_memory' field has been set +
            hasKey() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Checks whether the 'key' field has been set +
            hasKeysFormat() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'keys_format' field has been set +
            hasKeyValues() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Checks whether the 'key_values' field has been set +
            hasLayout() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Checks whether the 'layout' field has been set +
            hasLayoutId() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'layout_id' field has been set +
            hasLayouts() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Checks whether the 'layouts' field has been set +
            hasLayoutVersion() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Checks whether the 'layout_version' field has been set +
            hasLocalityGroups() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'locality_groups' field has been set +
            hasMapSchema() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'map_schema' field has been set +
            hasMaxVersions() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'max_versions' field has been set +
            hasMetaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Checks whether the 'meta_table' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.RowKeyComponent.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Checks whether the 'name' field has been set +
            hasName() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'name' field has been set +
            hasNext() - +Method in class org.kiji.schema.impl.HBaseKijiPager +
            +
            hasNullableStartIndex() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Checks whether the 'nullable_start_index' field has been set +
            hasRangeScanStartIndex() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Checks whether the 'range_scan_start_index' field has been set +
            hasReferenceLayout() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'reference_layout' field has been set +
            hasRenamedFrom() - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Checks whether the 'renamed_from' field has been set +
            hasRenamedFrom() - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Checks whether the 'renamed_from' field has been set +
            hasRenamedFrom() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'renamed_from' field has been set +
            hasSalt() - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Checks whether the 'salt' field has been set +
            hasSchemaTable() - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Checks whether the 'schema_table' field has been set +
            hasStorage() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Checks whether the 'storage' field has been set +
            hasSuppressKeyMaterialization() - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Checks whether the 'suppress_key_materialization' field has been set +
            hasTimestamp() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Checks whether the 'timestamp' field has been set +
            hasTimestamp() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Checks whether the 'timestamp' field has been set +
            hasTtlSeconds() - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Checks whether the 'ttl_seconds' field has been set +
            hasType() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Checks whether the 'type' field has been set +
            hasType() - +Method in class org.kiji.schema.avro.RowKeyComponent.Builder +
            Checks whether the 'type' field has been set +
            hasUpdate() - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Checks whether the 'update' field has been set +
            hasValue() - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Checks whether the 'value' field has been set +
            hasValue() - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Checks whether the 'value' field has been set +
            hasVerboseDebug() - +Method in class org.kiji.schema.tools.BaseTool +
            Whether or not this tool is being run with verbose debug messages. +
            hasVersion() - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Checks whether the 'version' field has been set +
            HBASE_ROW_KEY_RESOLUTION - +Static variable in class org.kiji.schema.KijiRowKeySplitter +
            Resolution (in number of bytes) when generating evenly spaced HBase row keys. +
            HBASE_ROW_KEY_SPEC_PREFIX - +Static variable in class org.kiji.schema.tools.ToolUtils +
            Prefix to specify an HBase row key from the command-line. +
            HBaseAdminFactory - Interface in org.kiji.schema.impl
            Factory for HBaseAdmin.
            HBaseColumnName - Class in org.kiji.schema.hbase
            An HBase column name.
            HBaseColumnName(byte[], byte[]) - +Constructor for class org.kiji.schema.hbase.HBaseColumnName +
            Creates a new HBaseColumnName instance. +
            HBaseDataRequestAdapter - Class in org.kiji.schema.impl
            Wraps a KijiDataRequest to expose methods that generate meaningful objects in HBase + land, like Puts and Gets.
            HBaseDataRequestAdapter(KijiDataRequest) - +Constructor for class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Wraps a KijiDataRequest. +
            HBaseEntityId - Class in org.kiji.schema.impl
            Entity ID encapsulating an HBase row key.
            HBaseEntityId(byte[]) - +Constructor for class org.kiji.schema.impl.HBaseEntityId +
            Creates an HBaseEntityId from the specified HBase row key. +
            HBaseFactory - Interface in org.kiji.schema.hbase
            Factory for HBase instances based on URIs.
            HBaseFactory.Provider - Class in org.kiji.schema.hbase
            Provider for the default HBaseFactory.
            HBaseKiji - Class in org.kiji.schema.impl
            Kiji instance class that contains configuration and table + information.
            HBaseKijiFactory - Class in org.kiji.schema.impl
            Factory for constructing instances of HBaseKiji.
            HBaseKijiFactory() - +Constructor for class org.kiji.schema.impl.HBaseKijiFactory +
              +
            HBaseKijiPager - Class in org.kiji.schema.impl
            Implementation of a KijiPager for HBase.
            HBaseKijiPager(EntityId, KijiDataRequest, KijiTableLayout, HBaseKijiTable, KijiColumnName) - +Constructor for class org.kiji.schema.impl.HBaseKijiPager +
            Initializes a HBaseKijiPager. +
            HBaseKijiRowData - Class in org.kiji.schema.impl
            An implementation of KijiRowData that wraps an HBase Result object.
            HBaseKijiRowData(EntityId, KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Deprecated.  +
            HBaseKijiRowData(KijiDataRequest, KijiCellDecoderFactory, KijiTableLayout, Result, KijiSchemaTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Deprecated.  +
            HBaseKijiRowData(EntityId, KijiDataRequest, HBaseKijiTable, Result) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Initializes a row data. +
            HBaseKijiRowData(KijiDataRequest, HBaseKijiTable, Result) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowData +
            Initializes a row data. +
            HBaseKijiRowScanner - Class in org.kiji.schema.impl
            The internal implementation of KijiRowScanner that reads from HTables.
            HBaseKijiRowScanner(HBaseKijiRowScanner.Options) - +Constructor for class org.kiji.schema.impl.HBaseKijiRowScanner +
            Creates a new KijiRowScanner instance. +
            HBaseKijiRowScanner.Options - Class in org.kiji.schema.impl
            A class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            HBaseKijiRowScanner.Options() - +Constructor for class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
              +
            HBaseKijiTable - Class in org.kiji.schema.impl
            A KijiTable that exposes the underlying HBase implementation.
            HBaseKijiTableReader - Class in org.kiji.schema.impl
            Reads from a kiji table by sending the requests directly to the HBase tables.
            HBaseKijiTableReader(HBaseKijiTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiTableReader +
            Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase. +
            HBaseKijiTableWriter - Class in org.kiji.schema.impl
            Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            HBaseKijiTableWriter(KijiTable) - +Constructor for class org.kiji.schema.impl.HBaseKijiTableWriter +
            Creates a non-buffered kiji table writer that sends modifications directly to Kiji. +
            HBaseMetaTable - Class in org.kiji.schema.impl
            An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            HBaseMetaTable(KijiURI, Configuration, KijiSchemaTable, HTableInterfaceFactory) - +Constructor for class org.kiji.schema.impl.HBaseMetaTable +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +
            HBaseMetaTable(HTableInterface, KijiSchemaTable) - +Constructor for class org.kiji.schema.impl.HBaseMetaTable +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +
            HBaseMetaTable(HTableInterface, KijiTableLayoutDatabase, KijiTableKeyValueDatabase) - +Constructor for class org.kiji.schema.impl.HBaseMetaTable +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +
            HBaseScanOptions - Class in org.kiji.schema.hbase
            Customizable parameters for KijiRowScanners backed by an HBase scan.
            HBaseScanOptions() - +Constructor for class org.kiji.schema.hbase.HBaseScanOptions +
            Creates a new HBaseScanOptions where all parameters will default to HBase values. +
            HBaseSchemaTable - Class in org.kiji.schema.impl
            + Mapping between schema IDs, hashes and Avro schema objects.
            HBaseSchemaTable(KijiURI, Configuration, HTableInterfaceFactory, LockFactory) - +Constructor for class org.kiji.schema.impl.HBaseSchemaTable +
            Open a connection to the HBase schema table for a Kiji instance. +
            HBaseSchemaTable(HTableInterface, HTableInterface, Lock) - +Constructor for class org.kiji.schema.impl.HBaseSchemaTable +
            Wrap an existing HBase table assumed to be where the schema data is stored. +
            HBaseSystemTable - Class in org.kiji.schema.impl
            The Kiji system table that is stored in HBase.
            HBaseSystemTable(KijiURI, Configuration, HTableInterfaceFactory) - +Constructor for class org.kiji.schema.impl.HBaseSystemTable +
            Connect to the HBase system table inside a Kiji instance. +
            HBaseSystemTable(HTableInterface) - +Constructor for class org.kiji.schema.impl.HBaseSystemTable +
            Wrap an existing HTable connection that is assumed to be the table that stores the + Kiji instance properties. +
            HBaseTableKeyValueDatabase - Class in org.kiji.schema.impl
            Manages key-value pairs on a per table basis.
            HBaseTableKeyValueDatabase(HTableInterface, String) - +Constructor for class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            This class manages the storage and retrieval of key-value pairs on a per table basis. +
            HBaseTableLayoutDatabase - Class in org.kiji.schema.layout.impl
            Manages Kiji table layouts using a column family in an HBase table as a backing store.
            HBaseTableLayoutDatabase(HTableInterface, String, KijiSchemaTable) - +Constructor for class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Creates a new HBaseTableLayoutDatabase instance. +
            HColumnDescriptorComparator - Class in org.kiji.schema.impl
            Comparator for HColumnDescriptors.
            HColumnDescriptorComparator() - +Constructor for class org.kiji.schema.impl.HColumnDescriptorComparator +
              +
            HelpTool - Class in org.kiji.schema.tools
            Command-line tool for displaying help on available tools.
            HelpTool() - +Constructor for class org.kiji.schema.tools.HelpTool +
              +
            HTableDescriptorComparator - Class in org.kiji.schema.impl
            Compares HTableDescriptors.
            HTableDescriptorComparator() - +Constructor for class org.kiji.schema.impl.HTableDescriptorComparator +
              +
            HTableInterfaceFactory - Interface in org.kiji.schema.impl
            Factory for HTableInterface instances.
            HTableSchemaTranslator - Class in org.kiji.schema.layout.impl
            Translates between KijiTableLayouts and HTableDescriptors.
            HTableSchemaTranslator() - +Constructor for class org.kiji.schema.layout.impl.HTableSchemaTranslator +
            Creates a new HTableSchemaTranslator instance. +
            +
            +

            +I

            +
            +
            id - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            id - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            id - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            id - +Variable in class org.kiji.schema.avro.SchemaTableEntry +
            Deprecated.  +
            in_memory - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            IncompatibleKijiVersionException - Exception in org.kiji.schema
            Thrown when there is an attempt to operate on a Kiji instance whose data format version + is incompatible with the Kiji client version.
            IncompatibleKijiVersionException(String) - +Constructor for exception org.kiji.schema.IncompatibleKijiVersionException +
            Creates a new IncompatibleKijiVersionException with the specified + detail message. +
            increment(EntityId, String, String, long) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Atomically increments a counter in a kiji table. +
            increment(EntityId, String, String, long) - +Method in interface org.kiji.schema.KijiIncrementer +
            Atomically increments a counter in a kiji table. +
            IncrementTool - Class in org.kiji.schema.tools
            Command-line tool to increment a counter in a cell of a kiji table.
            IncrementTool() - +Constructor for class org.kiji.schema.tools.IncrementTool +
              +
            initGenericTableMapperJob(String, Scan, Class<? extends TableMapper>, Class<?>, Class<?>, Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            This is just like the TableMapReduceUtil.initTableMapperJob but + it takes any classes for input and output keys instead of just + Writables. +
            initialize(InputSplit, TaskAttemptContext) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            initTableInput(String, Scan, Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            Configures the job with an HBase scan over a table as input. +
            initTableScan(Scan, Job) - +Static method in class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +
            Configures the job with an HBase scan. +
            INPUT_DATA_REQUEST - +Static variable in class org.kiji.schema.mapreduce.KijiConfKeys +
            Deprecated. Serialized input data request. +
            INPUT_TABLE_URI - +Static variable in class org.kiji.schema.mapreduce.KijiConfKeys +
            Deprecated. URI of the input table to read from. +
            install(HBaseAdmin, KijiURI) - +Static method in class org.kiji.schema.impl.HBaseMetaTable +
            Install the meta table into a Kiji instance. +
            install(HBaseAdmin, KijiURI, Configuration, HTableInterfaceFactory, LockFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Install the schema table into a Kiji instance. +
            install(HBaseAdmin, KijiURI, Configuration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSystemTable +
            Installs a Kiji system table into a running HBase instance. +
            install(KijiURI, Configuration) - +Method in class org.kiji.schema.KijiInstaller +
            Installs the specified Kiji instance. +
            install(KijiURI, HBaseFactory, Configuration) - +Method in class org.kiji.schema.KijiInstaller +
            Installs a Kiji instance. +
            InstallTool - Class in org.kiji.schema.tools
            A command-line tool for installing kiji instances on hbase clusters.
            InstallTool() - +Constructor for class org.kiji.schema.tools.InstallTool +
              +
            INSTANCE - +Static variable in class org.kiji.schema.util.TimestampComparator +
            A singleton instance. +
            InternalKijiError - Error in org.kiji.schema
            Thrown when there is something wrong with the internal Kiji + implementation.
            InternalKijiError(Throwable) - +Constructor for error org.kiji.schema.InternalKijiError +
            Creates a new InternalKijiError with the specified cause. +
            InternalKijiError(String) - +Constructor for error org.kiji.schema.InternalKijiError +
            Creates a new InternalKijiError with the specified detail message. +
            InvalidColumnNameException - Exception in org.kiji.schema.impl
            Thrown when kiji encounters a column name that is not valid.
            InvalidColumnNameException(String) - +Constructor for exception org.kiji.schema.impl.InvalidColumnNameException +
            Creates a new InvalidColumnNameException with the specified detail message. +
            InvalidLayoutException - Exception in org.kiji.schema.layout
            Thrown when an invalid Kiji layout is encountered.
            InvalidLayoutException(String) - +Constructor for exception org.kiji.schema.layout.InvalidLayoutException +
            Creates a new InvalidLayoutException with the specified reason. +
            InvalidLayoutException(KijiTableLayout, String) - +Constructor for exception org.kiji.schema.layout.InvalidLayoutException +
            Constructs an exception indicated a table layout is invalid. +
            isAvro() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            isCounter() - +Method in class org.kiji.schema.layout.impl.CellSpec +
              +
            isEmpty() - +Method in class org.kiji.schema.KijiDataRequest +
            Determines whether this data request has any columns. +
            isFullyQualified() - +Method in class org.kiji.schema.KijiColumnName +
            Determines whether the name refers to a qualified family (vs. +
            isGroupType() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            isInteractive() - +Method in class org.kiji.schema.tools.BaseTool +
            Whether or not this tool is being run interactively. +
            isKijiVersionCompatible(Kiji) - +Static method in class org.kiji.schema.util.VersionInfo +
            Validates that the client instance format version is compatible with the instance + format version installed on a Kiji instance. +
            isMapType() - +Method in class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout +
              +
            isPagingEnabled() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            Determines whether paging is enabled for this column. +
            isPagingEnabled() - +Method in class org.kiji.schema.KijiDataRequest +
            Determines whether paging is enabled on any of the columns in this request. +
            isTimestampInRange(long) - +Method in class org.kiji.schema.KijiDataRequest +
            Determines whether a timestamp ts is within the time range for this + request. +
            isValidAlias(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
              +
            isValidClassName(String) - +Static method in class org.kiji.schema.util.JavaIdentifiers +
            Determines whether a string could be the name of a Java class. +
            isValidIdentifier(String) - +Static method in class org.kiji.schema.util.JavaIdentifiers +
            Determines whether a string is a valid Java identifier. +
            isValidKijiName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
              +
            isValidLayoutName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
              +
            iterator() - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner +
            +
            +
            +

            +J

            +
            +
            JavaIdentifiers - Class in org.kiji.schema.util
            A utility class for dealing with identifiers in the Java language.
            +
            +

            +K

            +
            +
            KConstants - Class in org.kiji.schema
            Constants used by Kiji.
            key - +Variable in class org.kiji.schema.avro.KeyValueBackupEntry +
            Deprecated.  +
            KEY_DATA_VERSION - +Static variable in class org.kiji.schema.impl.HBaseSystemTable +
            The HBase row key that stores the installed Kiji data format version. +
            key_values - +Variable in class org.kiji.schema.avro.TableBackup +
            Deprecated.  +
            keys_format - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            keySet(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns a set view of keys contained in the map for the specified table. +
            keySet(String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns a set view of keys contained in the map for the specified table. +
            keySet(String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns a set view of keys contained in the map for the specified table. +
            KeyValueBackupEntry - Class in org.kiji.schema.avro
             
            KeyValueBackupEntry() - +Constructor for class org.kiji.schema.avro.KeyValueBackupEntry +
            Default constructor. +
            KeyValueBackupEntry(Long, String, ByteBuffer) - +Constructor for class org.kiji.schema.avro.KeyValueBackupEntry +
            All-args constructor. +
            KeyValueBackupEntry.Builder - Class in org.kiji.schema.avro
            RecordBuilder for KeyValueBackupEntry instances.
            keyValuesFromBackup(String, List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Restores all table's key value history from a backup. +
            keyValuesFromBackup(String, List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Restores all table's key value history from a backup. +
            keyValuesFromBackup(String, List<KeyValueBackupEntry>) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Restores all table's key value history from a backup. +
            keyValuesToBackup(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the TableKeyValueBackupEntries. +
            keyValuesToBackup(String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Gets a list of the TableKeyValueBackupEntries. +
            keyValuesToBackup(String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Gets a list of the TableKeyValueBackupEntries. +
            Kiji - Interface in org.kiji.schema
            Provides a handle to a Kiji instance that contains table information and access to + Kiji administrative functionality.
            Kiji.Factory - Class in org.kiji.schema
            Provider for the default Kiji factory.
            KIJI_COMPONENT - +Static variable in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            The first component of all HBase table names managed by Kiji. +
            KIJI_ROW_KEY_SPEC_PREFIX - +Static variable in class org.kiji.schema.tools.ToolUtils +
            Optional prefix to specify a Kiji row key from the command-line. +
            KIJI_SCHEME - +Static variable in class org.kiji.schema.KijiURI +
            URI/URL scheme used to fully qualify a Kiji table. +
            KIJI_SYSTEM_TABLES_REGEX - +Static variable in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Regexp matching Kiji system tables. +
            KijiAlreadyExistsException - Exception in org.kiji.schema
            Thrown when installing an instance or creating a table that already exists.
            KijiAlreadyExistsException(String, KijiURI) - +Constructor for exception org.kiji.schema.KijiAlreadyExistsException +
            Initializes a new exception object. +
            KijiCell<T> - Class in org.kiji.schema
            KijiCell represents a cell in a Kiji table.
            KijiCell(String, String, long, DecodedCell<T>) - +Constructor for class org.kiji.schema.KijiCell +
            Initializes a KijiCell. +
            KijiCell.CellType - Enum in org.kiji.schema
            Type of a Kiji cell.
            KijiCellDecoder<T> - Interface in org.kiji.schema
            Interface for Kiji cell decoders.
            KijiCellDecoderFactory - Interface in org.kiji.schema
            Interface for factories of KijiCellDecoder instances.
            KijiCellEncoder - Interface in org.kiji.schema
            Interface for Kiji cell encoders.
            KijiCellEncoderFactory - Interface in org.kiji.schema
            Interface for factories of KijiCellEncoder instances.
            KijiColumnFilter - Class in org.kiji.schema.filter
            A column filter provides a means of filtering cells from a column on the server side.
            KijiColumnFilter() - +Constructor for class org.kiji.schema.filter.KijiColumnFilter +
              +
            KijiColumnFilter.Context - Interface in org.kiji.schema.filter
            An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            KijiColumnName - Class in org.kiji.schema
            A Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiColumnName(String) - +Constructor for class org.kiji.schema.KijiColumnName +
            Constructs a column name from a string "family" or "family:qualifier". +
            KijiColumnName(String, String) - +Constructor for class org.kiji.schema.KijiColumnName +
            Constructs a column name from the two-part family:qualifier. +
            KijiColumnPagingNotEnabledException - Exception in org.kiji.schema.impl
            Thrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column.
            KijiColumnPagingNotEnabledException(String) - +Constructor for exception org.kiji.schema.impl.KijiColumnPagingNotEnabledException +
            Creates a new KijiColumnPagingNotEnabledException with the specified + detail message. +
            KijiConfKeys - Class in org.kiji.schema.mapreduce
            Deprecated. 
            KijiDataRequest - Class in org.kiji.schema
            Describes a request for columns of data to read from a Kiji table.
            KijiDataRequest.Column - Class in org.kiji.schema
            Describes a request for a Kiji Table column.
            KijiDataRequestBuilder - Class in org.kiji.schema
            Builds a request for columns of data to read from a Kiji table.
            KijiDataRequestBuilder.ColumnsDef - Class in org.kiji.schema
            Defines properties associated with one or more columns in a request for Kiji table columns.
            KijiDataRequestException - Exception in org.kiji.schema
            Thrown when there is an error validating a KijiDataRequest against a Kiji table.
            KijiDataRequestException(String) - +Constructor for exception org.kiji.schema.KijiDataRequestException +
            Creates a new KijiDataRequestException with the specified detail message. +
            KijiDataRequestValidator - Class in org.kiji.schema
            This class validates a KijiDataRequest against the layout + of a Kiji table to make sure it contains all of the columns requested.
            KijiDataRequestValidator(KijiDataRequest) - +Constructor for class org.kiji.schema.KijiDataRequestValidator +
            Construct a validator for a data request. +
            KijiDeleter - Interface in org.kiji.schema
            Interface for performing deletes on a Kiji table.
            KijiEncodingException - Exception in org.kiji.schema
            Runtime exception thrown when encoding a cell's content fails.
            KijiEncodingException(String) - +Constructor for exception org.kiji.schema.KijiEncodingException +
            Initializes an encoding exception. +
            KijiEncodingException(String, Throwable) - +Constructor for exception org.kiji.schema.KijiEncodingException +
            Initializes an encoding exception. +
            KijiEncodingException(Throwable) - +Constructor for exception org.kiji.schema.KijiEncodingException +
            Initializes an encoding exception. +
            KijiFactory - Interface in org.kiji.schema
            Factory for Kiji instances.
            KijiIncrementer - Interface in org.kiji.schema
            Interface for performing increments on a Kiji table.
            KijiInstaller - Class in org.kiji.schema
            Installs or uninstalls Kiji instances from an HBase cluster.
            KijiInvalidNameException - Exception in org.kiji.schema
            Thrown when a Kiji instance or table layout name is invalid.
            KijiInvalidNameException(String) - +Constructor for exception org.kiji.schema.KijiInvalidNameException +
            Creates a new KijiInvalidNameException with the specified detail message. +
            KijiManagedHBaseTableName - Class in org.kiji.schema.hbase
            Multiple instances of Kiji can be installed on a single HBase + cluster.
            KijiMetaTable - Class in org.kiji.schema
            The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiMetaTable() - +Constructor for class org.kiji.schema.KijiMetaTable +
            Creates a new KijiMetaTable instance. +
            KijiNameValidator - Class in org.kiji.schema.util
            A utility class for validating layout names, + (including table names, locality group names, family names, and column names) + and Kiji instance names.
            KijiNotInstalledException - Exception in org.kiji.schema
            Thrown when attempting to open a non existing/not installed Kiji instance.
            KijiNotInstalledException(String, String) - +Constructor for exception org.kiji.schema.KijiNotInstalledException +
            Creates a new KijiNotInstalledException with the specified + detail message. +
            KijiPager - Interface in org.kiji.schema
            Manages retrieving pages of values from a column in a Kiji table.
            KijiPaginationFilter - Class in org.kiji.schema.filter
            A KijiColumnFilter that allows for pagination of results given an offset, limit, and + other filters that are and-ed together.
            KijiPaginationFilter(int, int) - +Constructor for class org.kiji.schema.filter.KijiPaginationFilter +
            Initialize pagination filter with limit, offset, and other filters to fold in. +
            KijiPaginationFilter(int, int, KijiColumnFilter) - +Constructor for class org.kiji.schema.filter.KijiPaginationFilter +
            Initialize pagination filter with limit, offset, and other filters to fold in. +
            KijiPutter - Interface in org.kiji.schema
            Interface for performing puts on a Kiji table.
            KijiRegion - Interface in org.kiji.schema
            A KijiRegion specifies a logical region in a Kiji Table, bounded by + a start key (inclusive) and an end key (exclusive).
            KijiRowData - Interface in org.kiji.schema
            KijiRowData provides a way for applications to access data read from a Kiji table.
            KijiRowFilter - Class in org.kiji.schema.filter
            The abstract base class for filters that exclude data from KijiRows.
            KijiRowFilter() - +Constructor for class org.kiji.schema.filter.KijiRowFilter +
              +
            KijiRowFilter.Context - Class in org.kiji.schema.filter
            A helper class for converting between Kiji objects and their HBase counterparts.
            KijiRowFilter.Context() - +Constructor for class org.kiji.schema.filter.KijiRowFilter.Context +
              +
            KijiRowFilterApplicator - Class in org.kiji.schema.filter
            Applies a KijiRowFilter to various row-savvy objects.
            KijiRowKeySplitter - Class in org.kiji.schema
            Utility class for splitting the Kiji row key space.
            KijiRowScanner - Interface in org.kiji.schema
            Interface for scanning over rows read from a Kiji table.
            KijiSchemaTable - Class in org.kiji.schema
            The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSchemaTable() - +Constructor for class org.kiji.schema.KijiSchemaTable +
              +
            KijiSchemaTable.SchemaEntry - Class in org.kiji.schema
            Association between a schema and its ID.
            KijiSchemaTable.SchemaEntry(long, BytesKey, Schema) - +Constructor for class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            Creates a new schema entry. +
            KijiSystemTable - Class in org.kiji.schema
            The Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiSystemTable() - +Constructor for class org.kiji.schema.KijiSystemTable +
              +
            KijiTable - Interface in org.kiji.schema
            The KijiTable interface provides operations on KijiTables.
            KijiTableFactory - Interface in org.kiji.schema
            Factory for KijiTable instances.
            KijiTableInputFormat - Class in org.kiji.schema.mapreduce
            Deprecated. 
            KijiTableInputFormat() - +Constructor for class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.   +
            KijiTableInputFormat.KijiTableRecordReader - Class in org.kiji.schema.mapreduce
            Deprecated. Hadoop record reader for Kiji table rows.
            KijiTableInputFormat.KijiTableRecordReader(Configuration) - +Constructor for class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated. Creates a new RecordReader for this input format. +
            KijiTableKeyValueDatabase - Interface in org.kiji.schema
            A database of per table key-value pairs.
            KijiTableLayout - Class in org.kiji.schema.layout
            Layout of a Kiji table.
            KijiTableLayout.LocalityGroupLayout - Class in org.kiji.schema.layout
            Concrete layout of a locality group.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout - Class in org.kiji.schema.layout
            Concrete layout of a family.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout - Class in org.kiji.schema.layout
            Concrete layout of a column.
            KijiTableLayoutDatabase - Interface in org.kiji.schema.layout
            A database of Kiji table layouts.
            KijiTableLayoutRecords - Interface in org.kiji.schema.avro
             
            KijiTableLayoutRecords.Callback - Interface in org.kiji.schema.avro
             
            KijiTableNotFoundException - Exception in org.kiji.schema
            Thrown when an attempt to access a table fails because it does not exist.
            KijiTableNotFoundException(String) - +Constructor for exception org.kiji.schema.KijiTableNotFoundException +
            Creates a new KijiTableNotFoundException for the specified table. +
            KijiTablePool - Class in org.kiji.schema
            Maintains a pool of opened KijiTables.
            KijiTablePool(Kiji) - +Constructor for class org.kiji.schema.KijiTablePool +
            Constructs a new pool of Kiji tables. +
            KijiTablePool(KijiTableFactory) - +Constructor for class org.kiji.schema.KijiTablePool +
            Constructs a new pool of Kiji tables. +
            KijiTablePool(KijiTableFactory, KijiTablePool.Options) - +Constructor for class org.kiji.schema.KijiTablePool +
            Constructs a new pool of Kiji tables. +
            KijiTablePool.NoCapacityException - Exception in org.kiji.schema
            Thrown when an attempt to get a table connection fails because there is no room in the pool.
            KijiTablePool.NoCapacityException(String) - +Constructor for exception org.kiji.schema.KijiTablePool.NoCapacityException +
            Creates a new NoCapacityException with the specified detail message. +
            KijiTablePool.Options - Class in org.kiji.schema
            Describes the options that can be configured on the KijiTablePool.
            KijiTablePool.Options() - +Constructor for class org.kiji.schema.KijiTablePool.Options +
            Creates options with default values. +
            KijiTableReader - Interface in org.kiji.schema
            Interface for reading data from a Kiji table.
            KijiTableReader.KijiScannerOptions - Class in org.kiji.schema
            Options for KijiRowScanners.
            KijiTableReader.KijiScannerOptions() - +Constructor for class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Creates KijiScannerOptions with uninitialized options + and default HBaseScanOptions. +
            KijiTableWriter - Interface in org.kiji.schema
            + Interface for modifying a Kiji table.
            KijiTool - Interface in org.kiji.schema.tools
            Base interface to be implemented by command-line tools that are launched through + the bin/kiji script.
            KijiToolLauncher - Class in org.kiji.schema.tools
            Main entry point to launch Kiji tools.
            KijiToolLauncher() - +Constructor for class org.kiji.schema.tools.KijiToolLauncher +
              +
            KijiURI - Class in org.kiji.schema
            URI that uniquely identifies a Kiji instance, table, column(s).
            KijiURI.KijiURIBuilder - Class in org.kiji.schema
            Builder class for constructing KijiURIs.
            KijiURIException - Exception in org.kiji.schema
            Thrown when parsing a bogus Kiji URI.
            KijiURIException(String) - +Constructor for exception org.kiji.schema.KijiURIException +
            Creates a new KijiURIException. +
            KijiURIException(String, String) - +Constructor for exception org.kiji.schema.KijiURIException +
            Creates a new KijiURIException for the specified uri and detail message. +
            +
            +

            +L

            +
            +
            layout - +Variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Deprecated.  +
            layout_id - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            layout_version - +Variable in class org.kiji.schema.avro.MetadataBackup +
            Deprecated.  +
            layouts - +Variable in class org.kiji.schema.avro.TableBackup +
            Deprecated.  +
            layoutsFromBackup(String, List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
              +
            layoutsFromBackup(String, List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Restores a table layout history from a backup. +
            layoutsFromBackup(String, List<TableLayoutBackupEntry>) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Restores a table layout history from a backup. +
            layoutsToBackup(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +
            layoutsToBackup(String) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +
            layoutsToBackup(String) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +
            LayoutTool - Class in org.kiji.schema.tools
            Command-line tool for interacting with table layouts.
            LayoutTool() - +Constructor for class org.kiji.schema.tools.LayoutTool +
              +
            listTables() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Lists the tables in this Kiji instance. +
            listTables() - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Lists the tables in this Kiji instance. +
            listTables() - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Lists the tables in this Kiji instance. +
            load(String) - +Method in class org.kiji.schema.tools.synth.DictionaryLoader +
            Loads the dictionary from a file. +
            load(InputStream) - +Method in class org.kiji.schema.tools.synth.DictionaryLoader +
            Loads the dictionary from an input stream. +
            loadDefaults(String) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Load the system table with the key/value pairs from the properties file named by resource. +
            locality_groups - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            LocalityGroupDesc - Class in org.kiji.schema.avro
             
            LocalityGroupDesc() - +Constructor for class org.kiji.schema.avro.LocalityGroupDesc +
            Default constructor. +
            LocalityGroupDesc(Integer, String, List<String>, Boolean, String, Boolean, Integer, Integer, CompressionType, List<FamilyDesc>, Boolean, String) - +Constructor for class org.kiji.schema.avro.LocalityGroupDesc +
            All-args constructor. +
            LocalityGroupDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for LocalityGroupDesc instances.
            Lock - Interface in org.kiji.schema.util
            Lock interface.
            lock() - +Method in interface org.kiji.schema.util.Lock +
            Unconditionally acquires the lock. +
            lock(double) - +Method in interface org.kiji.schema.util.Lock +
            Acquires the lock. +
            lock() - +Method in class org.kiji.schema.util.ZooKeeperLock +
            Unconditionally acquires the lock. +
            lock(double) - +Method in class org.kiji.schema.util.ZooKeeperLock +
            Acquires the lock. +
            LockFactory - Interface in org.kiji.schema.util
            Factory for Lock instances.
            LOG - +Static variable in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
              +
            longToVarInt64(long) - +Static method in class org.kiji.schema.util.ByteStreamArray +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +
            longToZigZagVarInt64(long) - +Static method in class org.kiji.schema.util.ByteStreamArray +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +
            LsTool - Class in org.kiji.schema.tools
            Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            LsTool() - +Constructor for class org.kiji.schema.tools.LsTool +
              +
            +
            +

            +M

            +
            +
            main(String[]) - +Static method in class org.kiji.schema.tools.CreateTableTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.DeleteTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.FlushTableTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.IncrementTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.InstallTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.KijiToolLauncher +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.LayoutTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.LsTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.MetadataTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.PutTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.UninstallTool +
            Program entry point. +
            main(String[]) - +Static method in class org.kiji.schema.tools.VersionTool +
            Program entry point. +
            makeEmptyTableDescriptor(KijiManagedHBaseTableName) - +Static method in class org.kiji.schema.impl.HTableDescriptorComparator +
            Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout(). +
            map_schema - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            max_versions - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            mayProceed(String, Object...) - +Method in class org.kiji.schema.tools.BaseTool +
            Checks with the user whether the specified operation may proceed. +
            mConf - +Variable in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated. Hadoop Configuration object containing settings. +
            MD5Hash - Class in org.kiji.schema.avro
             
            MD5Hash() - +Constructor for class org.kiji.schema.avro.MD5Hash +
            Creates a new MD5Hash +
            MD5Hash(byte[]) - +Constructor for class org.kiji.schema.avro.MD5Hash +
            Creates a new MD5Hash with the given bytes +
            mDataRequest - +Variable in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated. Data request. +
            merge(HBaseKijiRowData) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Merges in the data from another HBaseKijiRowData instance. +
            merge(Put) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Merges in the data an HBase Put object. +
            merge(Collection<KeyValue>) - +Method in class org.kiji.schema.impl.HBaseKijiRowData +
            Merges in the data from a collection of KeyValues. +
            merge(KijiDataRequest) - +Method in class org.kiji.schema.KijiDataRequest +
            Creates a new data request representing the union of this data request and the + data request specified as an argument. +
            meta_table - +Variable in class org.kiji.schema.avro.MetadataBackup +
            Deprecated.  +
            MetadataBackup - Class in org.kiji.schema.avro
             
            MetadataBackup() - +Constructor for class org.kiji.schema.avro.MetadataBackup +
            Default constructor. +
            MetadataBackup(String, List<SchemaTableEntry>, Map<String, TableBackup>) - +Constructor for class org.kiji.schema.avro.MetadataBackup +
            All-args constructor. +
            MetadataBackup.Builder - Class in org.kiji.schema.avro
            RecordBuilder for MetadataBackup instances.
            MetadataRestorer - Class in org.kiji.schema.impl
            Metadata restorer backups up meta info to MetadataBackup records and can restore metadata to the + meta and schema tables.
            MetadataRestorer() - +Constructor for class org.kiji.schema.impl.MetadataRestorer +
              +
            MetadataTool - Class in org.kiji.schema.tools
            A tool to backup and restore Metadata.
            MetadataTool() - +Constructor for class org.kiji.schema.tools.MetadataTool +
              +
            modifyTableLayout(String, TableLayoutDesc) - +Method in class org.kiji.schema.impl.HBaseKiji +
            Sets the layout of a table. +
            modifyTableLayout(String, TableLayoutDesc, boolean, PrintStream) - +Method in class org.kiji.schema.impl.HBaseKiji +
            Sets the layout of a table, or print the results of setting the table layout if + dryRun is true. +
            modifyTableLayout(String, TableLayoutDesc) - +Method in interface org.kiji.schema.Kiji +
            Sets the layout of a table. +
            modifyTableLayout(String, TableLayoutDesc, boolean, PrintStream) - +Method in interface org.kiji.schema.Kiji +
            Sets the layout of a table, or print the results of setting the table layout if + dryRun is true. +
            +
            +

            +N

            +
            +
            name - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.RowKeyComponent +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.TableBackup +
            Deprecated.  +
            name - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            newBuilder() - +Static method in class org.kiji.schema.avro.CellSchema +
            Creates a new CellSchema RecordBuilder +
            newBuilder(CellSchema.Builder) - +Static method in class org.kiji.schema.avro.CellSchema +
            Creates a new CellSchema RecordBuilder by copying an existing Builder +
            newBuilder(CellSchema) - +Static method in class org.kiji.schema.avro.CellSchema +
            Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder +
            newBuilder(ColumnDesc.Builder) - +Static method in class org.kiji.schema.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder by copying an existing Builder +
            newBuilder(ColumnDesc) - +Static method in class org.kiji.schema.avro.ColumnDesc +
            Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder +
            newBuilder(FamilyDesc.Builder) - +Static method in class org.kiji.schema.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder by copying an existing Builder +
            newBuilder(FamilyDesc) - +Static method in class org.kiji.schema.avro.FamilyDesc +
            Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.HashSpec +
            Creates a new HashSpec RecordBuilder +
            newBuilder(HashSpec.Builder) - +Static method in class org.kiji.schema.avro.HashSpec +
            Creates a new HashSpec RecordBuilder by copying an existing Builder +
            newBuilder(HashSpec) - +Static method in class org.kiji.schema.avro.HashSpec +
            Creates a new HashSpec RecordBuilder by copying an existing HashSpec instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Creates a new KeyValueBackupEntry RecordBuilder +
            newBuilder(KeyValueBackupEntry.Builder) - +Static method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder +
            newBuilder(KeyValueBackupEntry) - +Static method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.LocalityGroupDesc +
            Creates a new LocalityGroupDesc RecordBuilder +
            newBuilder(LocalityGroupDesc.Builder) - +Static method in class org.kiji.schema.avro.LocalityGroupDesc +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder +
            newBuilder(LocalityGroupDesc) - +Static method in class org.kiji.schema.avro.LocalityGroupDesc +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.MetadataBackup +
            Creates a new MetadataBackup RecordBuilder +
            newBuilder(MetadataBackup.Builder) - +Static method in class org.kiji.schema.avro.MetadataBackup +
            Creates a new MetadataBackup RecordBuilder by copying an existing Builder +
            newBuilder(MetadataBackup) - +Static method in class org.kiji.schema.avro.MetadataBackup +
            Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.RowKeyComponent +
            Creates a new RowKeyComponent RecordBuilder +
            newBuilder(RowKeyComponent.Builder) - +Static method in class org.kiji.schema.avro.RowKeyComponent +
            Creates a new RowKeyComponent RecordBuilder by copying an existing Builder +
            newBuilder(RowKeyComponent) - +Static method in class org.kiji.schema.avro.RowKeyComponent +
            Creates a new RowKeyComponent RecordBuilder by copying an existing RowKeyComponent instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.RowKeyFormat +
            Creates a new RowKeyFormat RecordBuilder +
            newBuilder(RowKeyFormat.Builder) - +Static method in class org.kiji.schema.avro.RowKeyFormat +
            Creates a new RowKeyFormat RecordBuilder by copying an existing Builder +
            newBuilder(RowKeyFormat) - +Static method in class org.kiji.schema.avro.RowKeyFormat +
            Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.RowKeyFormat2 +
            Creates a new RowKeyFormat2 RecordBuilder +
            newBuilder(RowKeyFormat2.Builder) - +Static method in class org.kiji.schema.avro.RowKeyFormat2 +
            Creates a new RowKeyFormat2 RecordBuilder by copying an existing Builder +
            newBuilder(RowKeyFormat2) - +Static method in class org.kiji.schema.avro.RowKeyFormat2 +
            Creates a new RowKeyFormat2 RecordBuilder by copying an existing RowKeyFormat2 instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.SchemaTableEntry +
            Creates a new SchemaTableEntry RecordBuilder +
            newBuilder(SchemaTableEntry.Builder) - +Static method in class org.kiji.schema.avro.SchemaTableEntry +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder +
            newBuilder(SchemaTableEntry) - +Static method in class org.kiji.schema.avro.SchemaTableEntry +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.TableBackup +
            Creates a new TableBackup RecordBuilder +
            newBuilder(TableBackup.Builder) - +Static method in class org.kiji.schema.avro.TableBackup +
            Creates a new TableBackup RecordBuilder by copying an existing Builder +
            newBuilder(TableBackup) - +Static method in class org.kiji.schema.avro.TableBackup +
            Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Creates a new TableLayoutBackupEntry RecordBuilder +
            newBuilder(TableLayoutBackupEntry.Builder) - +Static method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder +
            newBuilder(TableLayoutBackupEntry) - +Static method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance +
            newBuilder() - +Static method in class org.kiji.schema.avro.TableLayoutDesc +
            Creates a new TableLayoutDesc RecordBuilder +
            newBuilder(TableLayoutDesc.Builder) - +Static method in class org.kiji.schema.avro.TableLayoutDesc +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder +
            newBuilder(TableLayoutDesc) - +Static method in class org.kiji.schema.avro.TableLayoutDesc +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance +
            newBuilder() - +Static method in class org.kiji.schema.KijiURI +
            Gets a builder configured with default Kiji URI fields. +
            newBuilder(KijiURI) - +Static method in class org.kiji.schema.KijiURI +
            Gets a builder configured with a Kiji URI. +
            newBuilder(String) - +Static method in class org.kiji.schema.KijiURI +
            Gets a builder configured with the Kiji URI. +
            newColumnsDef() - +Method in class org.kiji.schema.KijiDataRequestBuilder +
            Return a builder for columns associated with this KijiDataRequestBuilder. +
            newColumnsDef(KijiDataRequest.Column) - +Method in class org.kiji.schema.KijiDataRequestBuilder +
            Return a builder for columns, initialized from an existing + KijiDataRequest.Column. +
            newCounter() - +Static method in class org.kiji.schema.layout.impl.CellSpec +
              +
            newLayout(TableLayoutDesc) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Creates and returns a new KijiTableLayout instance as specified by an Avro TableLayoutDesc + description record. +
            newLock(KijiURI, LockFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates a lock for a given Kiji instance. +
            newMetaTable(KijiURI, Configuration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseMetaTable +
            Creates an HTableInterface for the specified table. +
            newSchemaHashTable(KijiURI, Configuration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates an HTable handle to the schema hash table. +
            newSchemaIdTable(KijiURI, Configuration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates an HTable handle to the schema ID table. +
            newSchemaV5Table(KijiURI, Configuration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Creates an HTable handle to the schema V5 table. +
            newSystemTable(KijiURI, Configuration, HTableInterfaceFactory) - +Static method in class org.kiji.schema.impl.HBaseSystemTable +
            Creates a new HTableInterface for the Kiji system table. +
            newZooKeeper(String) - +Static method in class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a ZooKeeper client. +
            next() - +Method in class org.kiji.schema.impl.HBaseKijiPager +
            +
            next(int) - +Method in class org.kiji.schema.impl.HBaseKijiPager +
            Gets the next page of results, with specified page size, for a column or family. +
            next(int) - +Method in interface org.kiji.schema.KijiPager +
            Gets the next page of results, with specified page size, for a column or family. +
            nextKeyValue() - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +
            Deprecated.  +
            NGramSynthesizer - Class in org.kiji.schema.tools.synth
            Generates n-grams.
            NGramSynthesizer(WordSynthesizer, int) - +Constructor for class org.kiji.schema.tools.synth.NGramSynthesizer +
            Constructs a new n-gram synthesizer. +
            NoCellDataException - Exception in org.kiji.schema
            Thrown when attempting to read data from a cell that doesn't exist.
            NoCellDataException(String) - +Constructor for exception org.kiji.schema.NoCellDataException +
            Creates a new NoCellDataException with the specified detail message. +
            NoSuchColumnException - Exception in org.kiji.schema
            Thrown when attempting to access a column that does not exist.
            NoSuchColumnException(String) - +Constructor for exception org.kiji.schema.NoSuchColumnException +
            Creates a new NoSuchColumnException with the specified detail message. +
            NotAKijiManagedTableException - Exception in org.kiji.schema
            Thrown when Kiji encounters an HBase table that is not managed by Kiji.
            NotAKijiManagedTableException(String, String) - +Constructor for exception org.kiji.schema.NotAKijiManagedTableException +
            Creates a new NotAKijiManagedTableException for the specified + table with the specified detail message. +
            nullable_start_index - +Variable in class org.kiji.schema.avro.RowKeyFormat2 +
            Deprecated.  +
            +
            +

            +O

            +
            +
            open(KijiURI) - +Method in class org.kiji.schema.impl.HBaseKijiFactory +
            Opens a Kiji instance by URI. +
            open(KijiURI, Configuration) - +Method in class org.kiji.schema.impl.HBaseKijiFactory +
            Opens a Kiji instance by URI. +
            open(KijiURI) - +Static method in class org.kiji.schema.Kiji.Factory +
            Opens a Kiji instance by URI. +
            open(KijiURI, Configuration) - +Static method in class org.kiji.schema.Kiji.Factory +
            Opens a Kiji instance by URI. +
            open(KijiURI) - +Method in interface org.kiji.schema.KijiFactory +
            Opens a Kiji instance by URI. +
            open(KijiURI, Configuration) - +Method in interface org.kiji.schema.KijiFactory +
            Opens a Kiji instance by URI. +
            openSystemResource(String) - +Static method in class org.kiji.schema.util.Resources +
            Gets the named resource using the classloader, or null if it can not be found. +
            openSystemTextResource(String) - +Static method in class org.kiji.schema.util.Resources +
            Gets the named resource using the classloader, or null if it can not be found. +
            openTable(String) - +Method in class org.kiji.schema.impl.DefaultKijiTableFactory +
            Opens a KijiTable by name. +
            openTable(String) - +Method in class org.kiji.schema.impl.HBaseKiji +
            Opens a KijiTable by name. +
            openTable(String) - +Method in interface org.kiji.schema.KijiTableFactory +
            Opens a KijiTable by name. +
            openTableReader() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            Opens a KijiTableReader for this table. +
            openTableReader() - +Method in interface org.kiji.schema.KijiTable +
            Opens a KijiTableReader for this table. +
            openTableWriter() - +Method in class org.kiji.schema.impl.HBaseKijiTable +
            Opens a KijiTableWriter for this table. +
            openTableWriter() - +Method in interface org.kiji.schema.KijiTable +
            Opens a KijiTableWriter for this table. +
            org.apache.hadoop.hbase.mapreduce - package org.apache.hadoop.hbase.mapreduce
             
            org.kiji.schema - package org.kiji.schema
            The main package for users of KijiSchema.
            org.kiji.schema.avro - package org.kiji.schema.avro
             
            org.kiji.schema.filter - package org.kiji.schema.filter
            Row level filters used when reading data from Kiji tables.
            org.kiji.schema.hbase - package org.kiji.schema.hbase
            HBase-specific KijiSchema behavior.
            org.kiji.schema.impl - package org.kiji.schema.impl
            Implementations for the main KijiSchema classes and interfaces.
            org.kiji.schema.layout - package org.kiji.schema.layout
            Kiji table layouts.
            org.kiji.schema.layout.impl - package org.kiji.schema.layout.impl
            Implementation for Kiji table layout management.
            org.kiji.schema.mapreduce - package org.kiji.schema.mapreduce
            Kiji MapReduce utilities.
            org.kiji.schema.tools - package org.kiji.schema.tools
            Package containing implementations, abstract base classes, + and exceptions for kiji command-line tools.
            org.kiji.schema.tools.synth - package org.kiji.schema.tools.synth
            Classes to assist when synthesizing sample data for use in kiji tables.
            org.kiji.schema.util - package org.kiji.schema.util
            Package containing utility classes used throughout Kiji.
            OrRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter for a disjunction (OR operator) of other filters.
            OrRowFilter(List<? extends KijiRowFilter>) - +Constructor for class org.kiji.schema.filter.OrRowFilter +
            Creates a new OrRowFilter instance. +
            OUTPUT_KIJI_TABLE_URI - +Static variable in class org.kiji.schema.mapreduce.KijiConfKeys +
            Deprecated. URI of the output Kiji table to write to. +
            +
            +

            +P

            +
            +
            parse(String) - +Method in class org.kiji.schema.tools.SpaceSeparatedMapParser +
            Parses a space-separated map into a Java map. +
            parse(String) - +Static method in class org.kiji.schema.util.ProtocolVersion +
            Static factory method that creates new ProtocolVersion instances. +
            parseBytesFlag(String) - +Static method in class org.kiji.schema.tools.ToolUtils +
            Parses a command-line flag specifying a byte array. +
            parseHex(String, char) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Parses a string hexadecimal representation of a byte array with separator. +
            parseHex(String) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Parses a string hexadecimal representation of a byte array. +
            parseInstanceName(String) - +Static method in class org.kiji.schema.tools.LsTool +
            Parses a table name for a kiji instance name. +
            parseJsonFormattedKeySpec(String, RowKeyFormat2, EntityIdFactory) - +Static method in class org.kiji.schema.tools.ToolUtils +
            Parses a JSON formatted row key specification. +
            parseKijiRowKey(String, EntityIdFactory, KijiTableLayout) - +Static method in class org.kiji.schema.tools.ToolUtils +
            Parses a Kiji row key specification from a command-line flag. +
            PRE_REGISTERED_SCHEMA_COUNT - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            Number of pre-allocated schemas. +
            PROTOCOL - +Static variable in interface org.kiji.schema.avro.KijiTableLayoutRecords.Callback +
              +
            PROTOCOL - +Static variable in interface org.kiji.schema.avro.KijiTableLayoutRecords +
              +
            ProtocolVersion - Class in org.kiji.schema.util
            Parses version information for a file format or wire protocol and provides + comparison / reporting functions.
            put(int, Object) - +Method in class org.kiji.schema.avro.CellSchema +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.ColumnDesc +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.FamilyDesc +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.HashSpec +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.MetadataBackup +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.RowKeyComponent +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.RowKeyFormat +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.TableBackup +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            put(int, Object) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
              +
            put(EntityId, String, String, T) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Puts data into a kiji table. +
            put(EntityId, String, String, long, T) - +Method in class org.kiji.schema.impl.HBaseKijiTableWriter +
            Puts data into a kiji table. +
            put(EntityId, String, String, T) - +Method in interface org.kiji.schema.KijiPutter +
            Puts data into a kiji table. +
            put(EntityId, String, String, long, T) - +Method in interface org.kiji.schema.KijiPutter +
            Puts data into a kiji table. +
            PutTool - Class in org.kiji.schema.tools
            Command-line tool for putting an Avro value into a kiji cell.
            PutTool() - +Constructor for class org.kiji.schema.tools.PutTool +
              +
            putValue(String, String, byte[]) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +
            putValue(String, byte[]) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Sets a value for a property key, which creates it if it doesn't exist. +
            putValue(String, String, byte[]) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +
            putValue(String, byte[]) - +Method in class org.kiji.schema.KijiSystemTable +
            Sets a value for a property key, which creates it if it doesn't exist. +
            putValue(String, String, byte[]) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +
            +
            +

            +Q

            +
            +
            QUALIFIER_LAYOUT - +Static variable in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            HBase column qualifier used to store absolute layouts. +
            QUALIFIER_LAYOUT_ID - +Static variable in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            HBase column qualifier used to store layout IDs. +
            QUALIFIER_UPDATE - +Static variable in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            HBase column qualifier used to store layout updates. +
            +
            +

            +R

            +
            +
            RADIX - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The size of the alphabet for a digit, which is the radix of our printed number. +
            range_scan_start_index - +Variable in class org.kiji.schema.avro.RowKeyFormat2 +
            Deprecated.  +
            RawEntityId - Class in org.kiji.schema.impl
            Implements the raw row key format.
            RE_AUTHORITY_GROUP - +Static variable in class org.kiji.schema.KijiURI +
            Pattern matching "(host1,host2,host3):port". +
            readAvroSchema(CellSchema) - +Static method in class org.kiji.schema.layout.impl.CellSpec +
            Reads the Avro schema from the table layout. +
            readAvroSchema(CellSchema) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Reads the Avro schema from the table layout. +
            readBytes(int) - +Method in class org.kiji.schema.util.ByteStreamArray +
            Reads the specified number of bytes in the stream. +
            readTableLayoutDescFromJSON(InputStream) - +Static method in class org.kiji.schema.layout.KijiTableLayout +
            Reads a table layout descriptor from its JSON serialized form. +
            readVarInt64() - +Method in class org.kiji.schema.util.ByteStreamArray +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +
            readZigZagVarInt64() - +Method in class org.kiji.schema.util.ByteStreamArray +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +
            reference_layout - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            ReferenceCountable<T> - Interface in org.kiji.schema.util
            Interface for reference-countable resources.
            RegexQualifierColumnFilter - Class in org.kiji.schema.filter
            A KijiColumnFilter that only allows qualifiers that match a given regular expression.
            RegexQualifierColumnFilter(String) - +Constructor for class org.kiji.schema.filter.RegexQualifierColumnFilter +
            Constructor. +
            release() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Notifies this resource that we are no longer interested in it. +
            release(KijiTable) - +Method in class org.kiji.schema.KijiTablePool +
            Releases a table back to the pool. +
            release() - +Method in interface org.kiji.schema.util.ReferenceCountable +
            Notifies this resource that we are no longer interested in it. +
            releaseOrLog(ReferenceCountable<T>) - +Static method in class org.kiji.schema.util.ResourceUtils +
            Releases the specified resource, logging and swallowing I/O errors if needed. +
            remove() - +Method in class org.kiji.schema.impl.HBaseKijiPager +
            +
            removeAllTableLayoutVersions(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes all layout information for a particular table. +
            removeAllTableLayoutVersions(String) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Removes all layout information for a particular table. +
            removeAllTableLayoutVersions(String) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Removes all layout information for a particular table. +
            removeAllValues(String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Deletes all key-value pairs associated with the specified table. +
            removeAllValues(String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Deletes all key-value pairs associated with the specified table. +
            removeAllValues(String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Deletes all key-value pairs associated with the specified table. +
            removeRecentTableLayoutVersions(String, int) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes the most recent layout information for a given table. +
            removeRecentTableLayoutVersions(String, int) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Removes the most recent layout information for a given table. +
            removeRecentTableLayoutVersions(String, int) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Removes the most recent layout information for a given table. +
            removeValues(String, String) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes all values associated with the specified table and key. +
            removeValues(String, String) - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Removes all values associated with the specified table and key. +
            removeValues(String, String) - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Removes all values associated with the specified table and key. +
            renamed_from - +Variable in class org.kiji.schema.avro.ColumnDesc +
            Deprecated.  +
            renamed_from - +Variable in class org.kiji.schema.avro.FamilyDesc +
            Deprecated.  +
            renamed_from - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            RequiredFlagException - Exception in org.kiji.schema.tools
            Thrown to indicate that a flag is required but not supplied.
            RequiredFlagException(String) - +Constructor for exception org.kiji.schema.tools.RequiredFlagException +
            Creates a new RequiredFlagException for the specified flag name. +
            resolve(String) - +Method in class org.kiji.schema.KijiURI +
            Resolve the path relative to this KijiURI. +
            Resources - Class in org.kiji.schema.util
            Utility for getting access to system resources.
            ResourceUtils - Class in org.kiji.schema.util
            Utilities to work with ReferenceCountable resources.
            restoreSchemas(MetadataBackup, Kiji) - +Method in class org.kiji.schema.impl.MetadataRestorer +
            Restores all SchemaTable entries from the metadata backup. +
            restoreTables(MetadataBackup, Kiji) - +Method in class org.kiji.schema.impl.MetadataRestorer +
            Restores all tables from the metadata backup into the running Kiji instance. +
            retain() - +Method in class org.kiji.schema.impl.HBaseKiji +
            Expresses interest in retaining this resource. +
            retain() - +Method in interface org.kiji.schema.util.ReferenceCountable +
            Expresses interest in retaining this resource. +
            RowKeyComponent - Class in org.kiji.schema.avro
             
            RowKeyComponent() - +Constructor for class org.kiji.schema.avro.RowKeyComponent +
            Default constructor. +
            RowKeyComponent(String, ComponentType) - +Constructor for class org.kiji.schema.avro.RowKeyComponent +
            All-args constructor. +
            RowKeyComponent.Builder - Class in org.kiji.schema.avro
            RecordBuilder for RowKeyComponent instances.
            RowKeyEncoding - Enum in org.kiji.schema.avro
             
            RowKeyFormat - Class in org.kiji.schema.avro
             
            RowKeyFormat() - +Constructor for class org.kiji.schema.avro.RowKeyFormat +
            Default constructor. +
            RowKeyFormat(RowKeyEncoding, HashType, Integer) - +Constructor for class org.kiji.schema.avro.RowKeyFormat +
            All-args constructor. +
            RowKeyFormat.Builder - Class in org.kiji.schema.avro
            RecordBuilder for RowKeyFormat instances.
            RowKeyFormat2 - Class in org.kiji.schema.avro
             
            RowKeyFormat2() - +Constructor for class org.kiji.schema.avro.RowKeyFormat2 +
            Default constructor. +
            RowKeyFormat2(RowKeyEncoding, HashSpec, Integer, Integer, List<RowKeyComponent>) - +Constructor for class org.kiji.schema.avro.RowKeyFormat2 +
            All-args constructor. +
            RowKeyFormat2.Builder - Class in org.kiji.schema.avro
            RecordBuilder for RowKeyFormat2 instances.
            run(List<String>) - +Method in class org.kiji.schema.tools.BaseTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.CreateTableTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.DeleteTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.FlushTableTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.IncrementTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.InstallTool +
            Runs the tool. +
            run(String[]) - +Method in class org.kiji.schema.tools.KijiToolLauncher +
            Programmatic entry point to the tool launcher. +
            run(KijiTool, String[]) - +Method in class org.kiji.schema.tools.KijiToolLauncher +
            Programmatic entry point to the tool launcher if a tool is already selected. +
            run(List<String>) - +Method in class org.kiji.schema.tools.LayoutTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.LsTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.MetadataTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.PutTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.UninstallTool +
            Runs the tool. +
            run(List<String>) - +Method in class org.kiji.schema.tools.VersionTool +
            Runs the tool. +
            +
            +

            +S

            +
            +
            salt - +Variable in class org.kiji.schema.avro.RowKeyFormat2 +
            Deprecated.  +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.CellSchema +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.ColumnDesc +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.ComponentType +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.CompressionType +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.FamilyDesc +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.HashSpec +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.HashType +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.KeyValueBackupEntry +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.LocalityGroupDesc +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.MD5Hash +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.MetadataBackup +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.RowKeyComponent +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.RowKeyEncoding +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.RowKeyFormat +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.RowKeyFormat2 +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.SchemaStorage +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.SchemaTableEntry +
              +
            SCHEMA$ - +Static variable in enum org.kiji.schema.avro.SchemaType +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.TableBackup +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
              +
            SCHEMA$ - +Static variable in class org.kiji.schema.avro.TableLayoutDesc +
              +
            SCHEMA_COLUMN_FAMILY - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            The column family in HBase used to store schema entries. +
            SCHEMA_COLUMN_QUALIFIER - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            The column qualifier in HBase used to store schema entries. +
            SCHEMA_COUNTER_ROW_NAME - +Static variable in class org.kiji.schema.impl.HBaseSchemaTable +
            Schema IDs are generated using a counter. +
            schema_table - +Variable in class org.kiji.schema.avro.MetadataBackup +
            Deprecated.  +
            SchemaClassNotFoundException - Exception in org.kiji.schema.layout
            Thrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path).
            SchemaClassNotFoundException(String) - +Constructor for exception org.kiji.schema.layout.SchemaClassNotFoundException +
            Creates a new SchemaClassNotFoundException with the specified detail message.. +
            SchemaStorage - Enum in org.kiji.schema.avro
             
            SchemaTableEntry - Class in org.kiji.schema.avro
             
            SchemaTableEntry() - +Constructor for class org.kiji.schema.avro.SchemaTableEntry +
            Default constructor. +
            SchemaTableEntry(Long, MD5Hash, String) - +Constructor for class org.kiji.schema.avro.SchemaTableEntry +
            All-args constructor. +
            SchemaTableEntry.Builder - Class in org.kiji.schema.avro
            RecordBuilder for SchemaTableEntry instances.
            SchemaType - Enum in org.kiji.schema.avro
             
            SEPARATOR - +Static variable in class org.kiji.schema.layout.ColumnNameTranslator +
            Used to separate the Kiji family from the Kiji qualifier in an HBase qualifier. +
            serialVersionUID - +Static variable in class org.kiji.schema.KijiDataRequest.Column +
            Serialization version. +
            serialVersionUID - +Static variable in class org.kiji.schema.KijiDataRequest +
            Serialization version. +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'aliases' field +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'aliases' field. +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'aliases' field +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'aliases' field. +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'aliases' field +
            setAliases(List<String>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'aliases' field. +
            setAvroSchema(String) - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Sets the value of the 'avro_schema' field +
            setAvroSchema(String) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Sets the value of the 'avro_schema' field. +
            setCacheBlocks(Boolean) - +Method in class org.kiji.schema.hbase.HBaseScanOptions +
            Sets whether rows requested are cached server-side for future use. +
            setCellSchema(CellSchema) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the cell schema. +
            setClientBufferSize(Integer) - +Method in class org.kiji.schema.hbase.HBaseScanOptions +
            Sets the number of rows that will be returned with each RPC when iterating + through a KijiRowScanner. +
            setColumns(List<ColumnDesc>) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'columns' field +
            setColumns(List<ColumnDesc>) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'columns' field. +
            setColumnSchema(CellSchema) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'column_schema' field +
            setColumnSchema(CellSchema) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'column_schema' field. +
            setComponents(List<RowKeyComponent>) - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Sets the value of the 'components' field +
            setComponents(List<RowKeyComponent>) - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
            Sets the value of the 'components' field. +
            setCompressionType(CompressionType) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'compression_type' field +
            setCompressionType(CompressionType) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'compression_type' field. +
            setConf(Configuration) - +Method in class org.kiji.schema.mapreduce.KijiTableInputFormat +
            Deprecated.  +
            setDataVersion(ProtocolVersion) - +Method in class org.kiji.schema.impl.HBaseSystemTable +
            Sets the version of kiji installed. +
            setDataVersion(ProtocolVersion) - +Method in class org.kiji.schema.KijiSystemTable +
            Sets the version of kiji installed. +
            setDelete(boolean) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'delete' field +
            setDelete(Boolean) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'delete' field. +
            setDelete(boolean) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'delete' field +
            setDelete(Boolean) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'delete' field. +
            setDelete(boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'delete' field +
            setDelete(Boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'delete' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'description' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'description' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'description' field. +
            setDescription(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'description' field +
            setDescription(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'description' field. +
            setEnabled(boolean) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'enabled' field +
            setEnabled(Boolean) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'enabled' field. +
            setEnabled(boolean) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'enabled' field +
            setEnabled(Boolean) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'enabled' field. +
            setEnabled(boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'enabled' field +
            setEnabled(Boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'enabled' field. +
            setEncoding(RowKeyEncoding) - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Sets the value of the 'encoding' field +
            setEncoding(RowKeyEncoding) - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Sets the value of the 'encoding' field. +
            setEncoding(RowKeyEncoding) - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Sets the value of the 'encoding' field +
            setEncoding(RowKeyEncoding) - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
            Sets the value of the 'encoding' field. +
            setFamilies(List<FamilyDesc>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'families' field +
            setFamilies(List<FamilyDesc>) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'families' field. +
            setHash(MD5Hash) - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Sets the value of the 'hash' field +
            setHash(MD5Hash) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Sets the value of the 'hash' field. +
            setHashSize(int) - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Sets the value of the 'hash_size' field +
            setHashSize(Integer) - +Method in class org.kiji.schema.avro.HashSpec +
            Sets the value of the 'hash_size' field. +
            setHashSize(int) - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Sets the value of the 'hash_size' field +
            setHashSize(Integer) - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Sets the value of the 'hash_size' field. +
            setHashType(HashType) - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Sets the value of the 'hash_type' field +
            setHashType(HashType) - +Method in class org.kiji.schema.avro.HashSpec +
            Sets the value of the 'hash_type' field. +
            setHashType(HashType) - +Method in class org.kiji.schema.avro.RowKeyFormat.Builder +
            Sets the value of the 'hash_type' field +
            setHashType(HashType) - +Method in class org.kiji.schema.avro.RowKeyFormat +
            Sets the value of the 'hash_type' field. +
            setHBaseScanOptions(HBaseScanOptions) - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Sets the HBaseScanOptions used by a HBase backed scanner. +
            setId(int) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'id' field +
            setId(Integer) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'id' field. +
            setId(int) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'id' field +
            setId(Integer) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'id' field. +
            setId(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'id' field +
            setId(Integer) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'id' field. +
            setId(long) - +Method in class org.kiji.schema.avro.SchemaTableEntry.Builder +
            Sets the value of the 'id' field +
            setId(Long) - +Method in class org.kiji.schema.avro.SchemaTableEntry +
            Sets the value of the 'id' field. +
            setInMemory(boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'in_memory' field +
            setInMemory(Boolean) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'in_memory' field. +
            setKey(String) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Sets the value of the 'key' field +
            setKey(String) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Sets the value of the 'key' field. +
            setKeysFormat(Object) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'keys_format' field +
            setKeysFormat(Object) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'keys_format' field. +
            setKeyValues(List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Sets the value of the 'key_values' field +
            setKeyValues(List<KeyValueBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup +
            Sets the value of the 'key_values' field. +
            setKijiRowFilter(KijiRowFilter) - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Sets the row filter used by the scanner, + and returns this KijiScannerOptions to allow chaining. +
            setLayout(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Sets the value of the 'layout' field +
            setLayout(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Sets the value of the 'layout' field. +
            setLayoutId(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'layout_id' field +
            setLayoutId(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'layout_id' field. +
            setLayouts(List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Sets the value of the 'layouts' field +
            setLayouts(List<TableLayoutBackupEntry>) - +Method in class org.kiji.schema.avro.TableBackup +
            Sets the value of the 'layouts' field. +
            setLayoutVersion(String) - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Sets the value of the 'layout_version' field +
            setLayoutVersion(String) - +Method in class org.kiji.schema.avro.MetadataBackup +
            Sets the value of the 'layout_version' field. +
            setLocalityGroups(List<LocalityGroupDesc>) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'locality_groups' field +
            setLocalityGroups(List<LocalityGroupDesc>) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'locality_groups' field. +
            setMapSchema(CellSchema) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'map_schema' field +
            setMapSchema(CellSchema) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'map_schema' field. +
            setMaxVersions(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'max_versions' field +
            setMaxVersions(Integer) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'max_versions' field. +
            setMetaTable(Map<String, TableBackup>) - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Sets the value of the 'meta_table' field +
            setMetaTable(Map<String, TableBackup>) - +Method in class org.kiji.schema.avro.MetadataBackup +
            Sets the value of the 'meta_table' field. +
            setName(String) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.RowKeyComponent.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.RowKeyComponent +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.TableBackup.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.TableBackup +
            Sets the value of the 'name' field. +
            setName(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'name' field +
            setName(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'name' field. +
            setNullableStartIndex(int) - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Sets the value of the 'nullable_start_index' field +
            setNullableStartIndex(Integer) - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
            Sets the value of the 'nullable_start_index' field. +
            setPrintStream(PrintStream) - +Method in class org.kiji.schema.tools.BaseTool +
            Set the output print stream the tool should write to. +
            setRangeScanStartIndex(int) - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Sets the value of the 'range_scan_start_index' field +
            setRangeScanStartIndex(Integer) - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
            Sets the value of the 'range_scan_start_index' field. +
            setReaderSchema(Schema) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the Avro reader schema. +
            setReferenceLayout(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'reference_layout' field +
            setReferenceLayout(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'reference_layout' field. +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.ColumnDesc.Builder +
            Sets the value of the 'renamed_from' field +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.ColumnDesc +
            Sets the value of the 'renamed_from' field. +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.FamilyDesc.Builder +
            Sets the value of the 'renamed_from' field +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.FamilyDesc +
            Sets the value of the 'renamed_from' field. +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'renamed_from' field +
            setRenamedFrom(String) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'renamed_from' field. +
            setSalt(HashSpec) - +Method in class org.kiji.schema.avro.RowKeyFormat2.Builder +
            Sets the value of the 'salt' field +
            setSalt(HashSpec) - +Method in class org.kiji.schema.avro.RowKeyFormat2 +
            Sets the value of the 'salt' field. +
            setSchemaStorage(SchemaStorage) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the schema storage. +
            setSchemaTable(List<SchemaTableEntry>) - +Method in class org.kiji.schema.avro.MetadataBackup.Builder +
            Sets the value of the 'schema_table' field +
            setSchemaTable(List<SchemaTableEntry>) - +Method in class org.kiji.schema.avro.MetadataBackup +
            Sets the value of the 'schema_table' field. +
            setSchemaTable(KijiSchemaTable) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the schema table. +
            setServerPrefetchSize(Integer) - +Method in class org.kiji.schema.hbase.HBaseScanOptions +
            Sets the number of rows for servers to prefetch. +
            setStartRow(EntityId) - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Sets the start row used by the scanner, + and returns this KijiScannerOptions to allow chaining. +
            setStopRow(EntityId) - +Method in class org.kiji.schema.KijiTableReader.KijiScannerOptions +
            Sets the stop row used by the scanner, + and returns this KijiScannerOptions to allow chaining. +
            setStorage(SchemaStorage) - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Sets the value of the 'storage' field +
            setStorage(SchemaStorage) - +Method in class org.kiji.schema.avro.CellSchema +
            Sets the value of the 'storage' field. +
            setSuppressKeyMaterialization(boolean) - +Method in class org.kiji.schema.avro.HashSpec.Builder +
            Sets the value of the 'suppress_key_materialization' field +
            setSuppressKeyMaterialization(Boolean) - +Method in class org.kiji.schema.avro.HashSpec +
            Sets the value of the 'suppress_key_materialization' field. +
            setTimestamp(long) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Sets the value of the 'timestamp' field +
            setTimestamp(Long) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Sets the value of the 'timestamp' field. +
            setTimestamp(long) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Sets the value of the 'timestamp' field +
            setTimestamp(Long) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Sets the value of the 'timestamp' field. +
            setTtlSeconds(int) - +Method in class org.kiji.schema.avro.LocalityGroupDesc.Builder +
            Sets the value of the 'ttl_seconds' field +
            setTtlSeconds(Integer) - +Method in class org.kiji.schema.avro.LocalityGroupDesc +
            Sets the value of the 'ttl_seconds' field. +
            setType(SchemaType) - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Sets the value of the 'type' field +
            setType(SchemaType) - +Method in class org.kiji.schema.avro.CellSchema +
            Sets the value of the 'type' field. +
            setType(ComponentType) - +Method in class org.kiji.schema.avro.RowKeyComponent.Builder +
            Sets the value of the 'type' field +
            setType(ComponentType) - +Method in class org.kiji.schema.avro.RowKeyComponent +
            Sets the value of the 'type' field. +
            setType(SchemaType) - +Method in class org.kiji.schema.layout.impl.CellSpec +
            Sets the cell type. +
            setup() - +Method in class org.kiji.schema.tools.BaseTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.CreateTableTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.FlushTableTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.InstallTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.LayoutTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.LsTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.MetadataTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.PutTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.UninstallTool +
            Called to initialize the tool just before running. +
            setup() - +Method in class org.kiji.schema.tools.VersionTool +
            Called to initialize the tool just before running. +
            setUpdate(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry.Builder +
            Sets the value of the 'update' field +
            setUpdate(TableLayoutDesc) - +Method in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Sets the value of the 'update' field. +
            setValue(String) - +Method in class org.kiji.schema.avro.CellSchema.Builder +
            Sets the value of the 'value' field +
            setValue(String) - +Method in class org.kiji.schema.avro.CellSchema +
            Sets the value of the 'value' field. +
            setValue(ByteBuffer) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry.Builder +
            Sets the value of the 'value' field +
            setValue(ByteBuffer) - +Method in class org.kiji.schema.avro.KeyValueBackupEntry +
            Sets the value of the 'value' field. +
            setVersion(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc.Builder +
            Sets the value of the 'version' field +
            setVersion(String) - +Method in class org.kiji.schema.avro.TableLayoutDesc +
            Sets the value of the 'version' field. +
            sizeOfLongAsVarInt64(long) - +Static method in class org.kiji.schema.util.ByteStreamArray +
            Reports the size of the zig-zag encoding of the specified long integer. +
            skip(int) - +Method in class org.kiji.schema.util.ByteStreamArray +
            Skips some bytes. +
            SpaceSeparatedMapParser - Class in org.kiji.schema.tools
            Parser for space-separated map arguments.
            SpecificCellDecoder<T> - Class in org.kiji.schema.impl
            Decodes cells encoded using Avro into specific types.
            SpecificCellDecoder(CellSpec) - +Constructor for class org.kiji.schema.impl.SpecificCellDecoder +
            Initializes a cell decoder that creates specific Avro types. +
            SpecificCellDecoderFactory - Class in org.kiji.schema
            Factory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas.
            SplitKeyFile - Class in org.kiji.schema.util
            Parses region boundaries split files.
            storage - +Variable in class org.kiji.schema.avro.CellSchema +
            Deprecated.  +
            StripValueRowFilter - Class in org.kiji.schema.filter
            A KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest.
            StripValueRowFilter() - +Constructor for class org.kiji.schema.filter.StripValueRowFilter +
              +
            SUCCESS - +Static variable in class org.kiji.schema.tools.BaseTool +
            Success tool exit code. +
            suppress_key_materialization - +Variable in class org.kiji.schema.avro.HashSpec +
            Deprecated.  +
            synthesize() - +Method in class org.kiji.schema.tools.synth.EmailSynthesizer +
              +
            synthesize() - +Method in class org.kiji.schema.tools.synth.NGramSynthesizer +
              +
            synthesize() - +Method in interface org.kiji.schema.tools.synth.Synthesizer +
            Synthesizes a piece of data. +
            synthesize() - +Method in class org.kiji.schema.tools.synth.WordSynthesizer +
              +
            synthesizeDomain() - +Method in class org.kiji.schema.tools.synth.EmailSynthesizer +
            Synthesize a random domain using the market share probabilities. +
            Synthesizer<T> - Interface in org.kiji.schema.tools.synth
            Synthesizers create objects from nothing.
            SynthesizeUserDataTool - Class in org.kiji.schema.tools
            Synthesize some user data into a kiji table.
            SynthesizeUserDataTool() - +Constructor for class org.kiji.schema.tools.SynthesizeUserDataTool +
              +
            +
            +

            +T

            +
            +
            TableBackup - Class in org.kiji.schema.avro
             
            TableBackup() - +Constructor for class org.kiji.schema.avro.TableBackup +
            Default constructor. +
            TableBackup(String, List<TableLayoutBackupEntry>, List<KeyValueBackupEntry>) - +Constructor for class org.kiji.schema.avro.TableBackup +
            All-args constructor. +
            TableBackup.Builder - Class in org.kiji.schema.avro
            RecordBuilder for TableBackup instances.
            TableKeyNotFoundException - Exception in org.kiji.schema
            Thrown when a key is not found in a map-like API implemented by one of the + Kiji tables, the system or meta table for example.
            TableKeyNotFoundException(String) - +Constructor for exception org.kiji.schema.TableKeyNotFoundException +
            Constructor. +
            TableLayoutBackupEntry - Class in org.kiji.schema.avro
             
            TableLayoutBackupEntry() - +Constructor for class org.kiji.schema.avro.TableLayoutBackupEntry +
            Default constructor. +
            TableLayoutBackupEntry(Long, TableLayoutDesc, TableLayoutDesc) - +Constructor for class org.kiji.schema.avro.TableLayoutBackupEntry +
            All-args constructor. +
            TableLayoutBackupEntry.Builder - Class in org.kiji.schema.avro
            RecordBuilder for TableLayoutBackupEntry instances.
            TableLayoutDesc - Class in org.kiji.schema.avro
             
            TableLayoutDesc() - +Constructor for class org.kiji.schema.avro.TableLayoutDesc +
            Default constructor. +
            TableLayoutDesc(String, String, Object, List<LocalityGroupDesc>, String, String, String) - +Constructor for class org.kiji.schema.avro.TableLayoutDesc +
            All-args constructor. +
            TableLayoutDesc.Builder - Class in org.kiji.schema.avro
            RecordBuilder for TableLayoutDesc instances.
            tableSet() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns a set view of the tables that have key-value pairs defined. +
            tableSet() - +Method in class org.kiji.schema.impl.HBaseTableKeyValueDatabase +
            Returns a set view of the tables that have key-value pairs defined. +
            tableSet() - +Method in interface org.kiji.schema.KijiTableKeyValueDatabase +
            Returns a set view of the tables that have key-value pairs defined. +
            timestamp - +Variable in class org.kiji.schema.avro.KeyValueBackupEntry +
            Deprecated.  +
            timestamp - +Variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Deprecated.  +
            TimestampComparator - Class in org.kiji.schema.util
            A comparator that sorts Longs in reverse chronological order.
            toAvroEntry(KijiSchemaTable.SchemaEntry) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Converts a SchemaEntry into an Avro SchemaTableEntry. +
            toAvroJsonString(Object, Schema) - +Static method in class org.kiji.schema.util.ToJson +
            Standard Avro/JSON encoder. +
            toAvroJsonString(IndexedRecord) - +Static method in class org.kiji.schema.util.ToJson +
            Standard Avro/JSON encoder. +
            toBackup() - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. +
            toBackup() - +Method in class org.kiji.schema.impl.HBaseSchemaTable +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. +
            toBackup() - +Method in class org.kiji.schema.KijiMetaTable +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. +
            toBackup() - +Method in class org.kiji.schema.KijiSchemaTable +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. +
            toByteArray() - +Method in class org.kiji.schema.layout.impl.ColumnId +
            Translates ColumnIds to HBase column names. +
            toBytes() - +Method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
            Gets the name of the HBase table that stores the data for this Kiji table. +
            toCanonicalString() - +Method in class org.kiji.schema.util.ProtocolVersion +
            Returns a string representation of this ProtocolVersion that includes any + optional trailing version components. +
            toGet(EntityId, KijiTableLayout) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row. +
            toHBaseColumnName(KijiColumnName) - +Method in class org.kiji.schema.layout.ColumnNameTranslator +
            Translates a Kiji column name into an HBase column name. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.ColumnValueEqualsRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.HasColumnDataRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiColumnName, KijiColumnFilter.Context) - +Method in class org.kiji.schema.filter.KijiColumnFilter +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +
            toHBaseFilter(KijiColumnName, KijiColumnFilter.Context) - +Method in class org.kiji.schema.filter.KijiPaginationFilter +
              +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.KijiRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHBaseFilter(KijiColumnName, KijiColumnFilter.Context) - +Method in class org.kiji.schema.filter.RegexQualifierColumnFilter +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +
            toHBaseFilter(KijiRowFilter.Context) - +Method in class org.kiji.schema.filter.StripValueRowFilter +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. +
            toHex(byte[]) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Formats a byte array as a sequence of hex-digits with no separator. +
            toHex(byte[], char) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Formats a byte array as a sequence of 2 hex-digits bytes with the specified separator. +
            toHTableDescriptor(String, KijiTableLayout) - +Method in class org.kiji.schema.layout.impl.HTableSchemaTranslator +
            Translates a Kiji table layout into an HColumnDescriptor. +
            ToJson - Class in org.kiji.schema.util
            Encode an Avro record into JSON.
            toJsonNode(Object, Schema) - +Static method in class org.kiji.schema.util.ToJson +
            Serializes a Java Avro value into JSON. +
            toJsonString(Object, Schema) - +Static method in class org.kiji.schema.util.ToJson +
            Encodes an Avro value into a JSON string. +
            toJsonString(IndexedRecord) - +Static method in class org.kiji.schema.util.ToJson +
            Encodes an Avro record into JSON. +
            toKijiColumnName(HBaseColumnName) - +Method in class org.kiji.schema.layout.ColumnNameTranslator +
            Translates an HBase column name to a Kiji column name. +
            toolMain(List<String>) - +Method in class org.kiji.schema.tools.BaseTool +
            Invoke the functionality of this tool, as supplied through its + implementation of the abstract methods of this class. +
            toolMain(List<String>) - +Method in class org.kiji.schema.tools.HelpTool +
            The main logic of your tool. +
            toolMain(List<String>) - +Method in interface org.kiji.schema.tools.KijiTool +
            The main logic of your tool. +
            ToolUtils - Class in org.kiji.schema.tools
            Utility class providing static methods used by command-line tools.
            toOrderedString() - +Method in class org.kiji.schema.KijiURI +
            Returns a string representation of this URI that preserves ordering of lists in fields, + such as the Zookeeper quorum and Kiji columns. +
            toScan(KijiTableLayout) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +
            toScan(KijiTableLayout, HBaseScanOptions) - +Method in class org.kiji.schema.impl.HBaseDataRequestAdapter +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +
            toString() - +Method in class org.kiji.schema.DecodedCell +
            +
            toString() - +Method in class org.kiji.schema.hbase.HBaseColumnName +
            +
            toString() - +Method in class org.kiji.schema.hbase.KijiManagedHBaseTableName +
              +
            toString() - +Method in class org.kiji.schema.impl.FormattedEntityId +
            +
            toString() - +Method in class org.kiji.schema.impl.HashedEntityId +
            +
            toString() - +Method in class org.kiji.schema.impl.HashPrefixedEntityId +
            +
            toString() - +Method in class org.kiji.schema.impl.HBaseEntityId +
            +
            toString() - +Method in class org.kiji.schema.impl.RawEntityId +
            +
            toString() - +Method in class org.kiji.schema.KijiCell +
            +
            toString() - +Method in class org.kiji.schema.KijiColumnName +
            +
            toString() - +Method in class org.kiji.schema.KijiDataRequest.Column +
            +
            toString() - +Method in class org.kiji.schema.KijiDataRequest +
            +
            toString() - +Method in class org.kiji.schema.KijiSchemaTable.SchemaEntry +
            +
            toString() - +Method in class org.kiji.schema.KijiURI +
            +
            toString() - +Method in class org.kiji.schema.layout.impl.ColumnId +
            Gets the id as a string of digits from our alphabet. +
            toString() - +Method in class org.kiji.schema.layout.KijiTableLayout +
            +
            toString() - +Method in class org.kiji.schema.util.BytesKey +
              +
            toString() - +Method in class org.kiji.schema.util.ProtocolVersion +
            Returns the string representation of this ProtocolVersion that was initially + parsed to create this ProtocolVersion. +
            toURL(byte[]) - +Static method in class org.kiji.schema.util.ByteArrayFormatter +
            Formats a byte array as a URL. +
            ttl_seconds - +Variable in class org.kiji.schema.avro.LocalityGroupDesc +
            Deprecated.  +
            type - +Variable in class org.kiji.schema.avro.CellSchema +
            Deprecated.  +
            type - +Variable in class org.kiji.schema.avro.RowKeyComponent +
            Deprecated.  +
            +
            +

            +U

            +
            +
            UNASSIGNED - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            The special value reserved to mean that a symbolic name has not been assigned a column id. +
            uninstall(HBaseAdmin, KijiURI) - +Static method in class org.kiji.schema.impl.HBaseMetaTable +
            Removes the meta table from HBase. +
            uninstall(HBaseAdmin, KijiURI) - +Static method in class org.kiji.schema.impl.HBaseSchemaTable +
            Disables and removes the schema table from HBase. +
            uninstall(HBaseAdmin, KijiURI) - +Static method in class org.kiji.schema.impl.HBaseSystemTable +
            Disables and delete the system table from HBase. +
            uninstall(KijiURI, Configuration) - +Method in class org.kiji.schema.KijiInstaller +
            Uninstalls the specified Kiji instance. +
            uninstall(KijiURI, HBaseFactory, Configuration) - +Method in class org.kiji.schema.KijiInstaller +
            Removes a kiji instance from the HBase cluster including any user tables. +
            UninstallTool - Class in org.kiji.schema.tools
            A command-line tool for uninstalling kiji instances from an hbase cluster.
            UninstallTool() - +Constructor for class org.kiji.schema.tools.UninstallTool +
              +
            unlock() - +Method in interface org.kiji.schema.util.Lock +
            Releases the lock. +
            unlock() - +Method in class org.kiji.schema.util.ZooKeeperLock +
            Releases the lock. +
            UNSET_URI_STRING - +Static variable in class org.kiji.schema.KijiURI +
            String to specify an unset KijiURI field. +
            update - +Variable in class org.kiji.schema.avro.TableLayoutBackupEntry +
            Deprecated.  +
            updateTableLayout(String, TableLayoutDesc) - +Method in class org.kiji.schema.impl.HBaseMetaTable +
            Sets a table's layout. +
            updateTableLayout(String, TableLayoutDesc) - +Method in class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +
            Sets a table's layout. +
            updateTableLayout(String, TableLayoutDesc) - +Method in interface org.kiji.schema.layout.KijiTableLayoutDatabase +
            Sets a table's layout. +
            +
            +

            +V

            +
            +
            VALID_ALIAS_PATTERN - +Static variable in class org.kiji.schema.util.KijiNameValidator +
            Regular expression that defines a valid alias for a layout name. +
            VALID_INSTANCE_PATTERN - +Static variable in class org.kiji.schema.util.KijiNameValidator +
            Regular expression that defines a valid instance name. +
            VALID_LAYOUT_NAME_PATTERN - +Static variable in class org.kiji.schema.util.KijiNameValidator +
            Regular expression that defines a valid layout name (family, qualifier, table, etc). +
            validate(KijiTableLayout) - +Method in class org.kiji.schema.KijiDataRequestValidator +
            Validates the data request against the given table layout. +
            validateAlias(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
            Validates characters that may be used in an alias for a qualifier, family, or + locality group. +
            validateFlags() - +Method in class org.kiji.schema.tools.BaseTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.CreateTableTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.DeleteTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.FlushTableTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.IncrementTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.LayoutTool +
            Validates the command-line flags. +
            validateFlags() - +Method in class org.kiji.schema.tools.LsTool +
              +
            validateFlags() - +Method in class org.kiji.schema.tools.SynthesizeUserDataTool +
            Validates the command-line flags. +
            validateKijiName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
            Determines whether a string is a valid Kiji instance name. +
            validateLayoutName(CharSequence) - +Static method in class org.kiji.schema.util.KijiNameValidator +
            Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names. +
            validateVersion(Kiji) - +Static method in class org.kiji.schema.util.VersionInfo +
            Validates that the client instance format version is compatible with the instance + format version installed on a Kiji instance. +
            value - +Variable in class org.kiji.schema.avro.CellSchema +
            Deprecated.  +
            value - +Variable in class org.kiji.schema.avro.KeyValueBackupEntry +
            Deprecated.  +
            VALUE_COLUMN_FAMILY - +Static variable in class org.kiji.schema.impl.HBaseSystemTable +
            The HBase column family that stores the value of the properties. +
            VALUE_MAP - +Static variable in class org.kiji.schema.layout.impl.ColumnId +
            A map from characters in the alphabet to the integer it represents. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.ComponentType +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.CompressionType +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.HashType +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.RowKeyEncoding +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.SchemaStorage +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.avro.SchemaType +
            Returns the enum constant of this type with the specified name. +
            valueOf(String) - +Static method in enum org.kiji.schema.KijiCell.CellType +
            Returns the enum constant of this type with the specified name. +
            values() - +Static method in enum org.kiji.schema.avro.ComponentType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.CompressionType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.HashType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.RowKeyEncoding +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.SchemaStorage +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.avro.SchemaType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            values() - +Static method in enum org.kiji.schema.KijiCell.CellType +
            Returns an array containing the constants of this enum type, in +the order they are declared. +
            version - +Variable in class org.kiji.schema.avro.TableLayoutDesc +
            Deprecated.  +
            VersionInfo - Class in org.kiji.schema.util
            Reports on the version numbers associated with this software bundle + as well as the installed format versions in used in a Kiji instance.
            VersionTool - Class in org.kiji.schema.tools
            Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            VersionTool() - +Constructor for class org.kiji.schema.tools.VersionTool +
              +
            +
            +

            +W

            +
            +
            withCellDecoderFactory(KijiCellDecoderFactory) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the cell decoder factory to use when reading cells from the scanner. +
            withClock(Clock) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets a clock. +
            withColumnNames(Collection<String>) - +Method in class org.kiji.schema.KijiURI.KijiURIBuilder +
            Configures the KijiURI with the Kiji column names. +
            withColumnNames(Iterable<KijiColumnName>) - +Method in class org.kiji.schema.KijiURI.KijiURIBuilder +
            Configures the KijiURI with the Kiji column names. +
            withDataRequest(KijiDataRequest) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the data request used to generate the KijiRowScanner. +
            withFilter(KijiColumnFilter) - +Method in class org.kiji.schema.KijiDataRequestBuilder.ColumnsDef +
            Sets a filter to attach to each column specified by this column request builder. +
            withHBaseResultScanner(ResultScanner) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the HBase result scanner the KijiRowScanner will wrap. +
            withIdlePollPeriod(long) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the amount of time between sweeps of the pool for removing idle connections. +
            withIdleTimeout(long) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the amount of time a connection may be idle before being removed from the pool. +
            withInstanceName(String) - +Method in class org.kiji.schema.KijiURI.KijiURIBuilder +
            Configures the KijiURI with the Kiji instance name. +
            withMaxSize(int) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the maximum number of connections to keep per table. +
            withMaxVersions(int) - +Method in class org.kiji.schema.KijiDataRequestBuilder.ColumnsDef +
            Sets the maximum number of the most recent versions to return. +
            withMinSize(int) - +Method in class org.kiji.schema.KijiTablePool.Options +
            Sets the minimum number of connections to keep per table. +
            withPageSize(int) - +Method in class org.kiji.schema.KijiDataRequestBuilder.ColumnsDef +
            Sets the page size (i.e. +
            withTable(HBaseKijiTable) - +Method in class org.kiji.schema.impl.HBaseKijiRowScanner.Options +
            Sets the table being scanned. +
            withTableName(String) - +Method in class org.kiji.schema.KijiURI.KijiURIBuilder +
            Configures the KijiURI with the Kiji table name. +
            withTimeRange(long, long) - +Method in class org.kiji.schema.KijiDataRequestBuilder +
            Sets the time range of cells to return: [minTimestamp, + maxTimestamp). +
            withZookeeperClientPort(int) - +Method in class org.kiji.schema.KijiURI.KijiURIBuilder +
            Configures the KijiURI with the Zookeeper client port. +
            withZookeeperQuorum(String[]) - +Method in class org.kiji.schema.KijiURI.KijiURIBuilder +
            Configures the KijiURI with Zookeeper Quorum. +
            WordSynthesizer - Class in org.kiji.schema.tools.synth
            Synthesizes random words from a dictionary.
            WordSynthesizer(Random, List<String>) - +Constructor for class org.kiji.schema.tools.synth.WordSynthesizer +
            Constructs a word synthesizer. +
            +
            +

            +Y

            +
            +
            yesNoPrompt(String) - +Method in class org.kiji.schema.tools.BaseTool +
            Prompts the user for a yes or no answer to the specified question until they provide a valid + response (y/n/yes/no case insensitive) and reports the result. +
            +
            +

            +Z

            +
            +
            zkConnStr(Configuration) - +Static method in class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a ZooKeeper connection string from an HBase configuration. +
            zkConnStr(KijiURI) - +Static method in class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a ZooKeeper connection string from a Kiji URI specifying an HBase instance. +
            ZooKeeperLock - Class in org.kiji.schema.util
            Distributed lock on top of ZooKeeper.
            ZooKeeperLock(ZooKeeper, File) - +Constructor for class org.kiji.schema.util.ZooKeeperLock +
            Constructs a ZooKeeper lock object. +
            ZooKeeperLockFactory - Class in org.kiji.schema.util
            Factory for ZooKeeperLock instances.
            ZooKeeperLockFactory(ZooKeeper) - +Constructor for class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a factory for ZooKeeperLock. +
            ZooKeeperLockFactory(String) - +Constructor for class org.kiji.schema.util.ZooKeeperLockFactory +
            Creates a factory for ZooKeeperLock. +
            +
            +A B C D E F G H I J K L M N O P Q R S T U V W Y Z + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated   Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/index.html b/apidocs/kiji-schema/1.0.0-rc4/index.html new file mode 100644 index 00000000..621279b1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/index.html @@ -0,0 +1,40 @@ + + + + + + + +kiji-schema 1.0.0-rc4 API + + + + + + + + + + + +<H2> +Frame Alert</H2> + +<P> +This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. +<BR> +Link to<A HREF="overview-summary.html">Non-frame version.</A> + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html new file mode 100644 index 00000000..56373b86 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/GenericTableMapReduceUtil.html @@ -0,0 +1,393 @@ + + + + + + + +GenericTableMapReduceUtil (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.apache.hadoop.hbase.mapreduce +
            +Class GenericTableMapReduceUtil

            +
            +java.lang.Object
+  extended by org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil
+      extended by org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil
+
            +
            +
            +
            public class GenericTableMapReduceUtil
            extends TableMapReduceUtil
            + + +

            +Just like TableMapReduceUtil but fixes some missing dependency jars. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            GenericTableMapReduceUtil() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidaddAllDependencyJars(Job job) + +
            +          Like TableMapReduceUtil.addDependencyJars() but this catches some + missing ones like google's guava library.
            +static ScanconvertStringToScan(String base64) + +
            +          This method is just like the package-private version in TableMapReduceUtil, + except that it disables block caching by default.
            +static voidinitGenericTableMapperJob(String table, + Scan scan, + Class<? extends TableMapper> mapper, + Class<?> outputKeyClass, + Class<?> outputValueClass, + Job job) + +
            +          This is just like the TableMapReduceUtil.initTableMapperJob but + it takes any classes for input and output keys instead of just + Writables.
            +static voidinitTableInput(String table, + Scan scan, + Job job) + +
            +          Configures the job with an HBase scan over a table as input.
            +static voidinitTableScan(Scan scan, + Job job) + +
            +          Configures the job with an HBase scan.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.hbase.mapreduce.TableMapReduceUtil
            addDependencyJars, addDependencyJars, initCredentials, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableMapperJob, initTableReducerJob, initTableReducerJob, initTableReducerJob, initTableReducerJob, limitNumReduceTasks, setNumReduceTasks, setScannerCaching
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +GenericTableMapReduceUtil

            +
            +public GenericTableMapReduceUtil()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initTableScan

            +
            +public static void initTableScan(Scan scan,
+                                 Job job)
+                          throws IOException
            +
            +
            Configures the job with an HBase scan. +

            +

            +
            Parameters:
            scan - The scan to set in the job configuration.
            job - The job to configure. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +initTableInput

            +
            +public static void initTableInput(String table,
+                                  Scan scan,
+                                  Job job)
+                           throws IOException
            +
            +
            Configures the job with an HBase scan over a table as input. +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +convertStringToScan

            +
            +public static Scan convertStringToScan(String base64)
+                                throws IOException
            +
            +
            This method is just like the package-private version in TableMapReduceUtil, + except that it disables block caching by default. +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +initGenericTableMapperJob

            +
            +public static void initGenericTableMapperJob(String table,
+                                             Scan scan,
+                                             Class<? extends TableMapper> mapper,
+                                             Class<?> outputKeyClass,
+                                             Class<?> outputValueClass,
+                                             Job job)
+                                      throws IOException
            +
            +
            This is just like the TableMapReduceUtil.initTableMapperJob but + it takes any classes for input and output keys instead of just + Writables. This way we can work with AvroSerialization instead + of just WritableSerialization. +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +addAllDependencyJars

            +
            +public static void addAllDependencyJars(Job job)
+                                 throws IOException
            +
            +
            Like TableMapReduceUtil.addDependencyJars() but this catches some + missing ones like google's guava library. +

            +

            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html new file mode 100644 index 00000000..cf5322cf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/class-use/GenericTableMapReduceUtil.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil

            +
            +No usage of org.apache.hadoop.hbase.mapreduce.GenericTableMapReduceUtil +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-frame.html new file mode 100644 index 00000000..5d91746e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-frame.html @@ -0,0 +1,33 @@ + + + + + + + +org.apache.hadoop.hbase.mapreduce (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.apache.hadoop.hbase.mapreduce + + + + +
            +Classes  + +
            +GenericTableMapReduceUtil
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-summary.html new file mode 100644 index 00000000..82b63bfd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-summary.html @@ -0,0 +1,158 @@ + + + + + + + +org.apache.hadoop.hbase.mapreduce (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.apache.hadoop.hbase.mapreduce +

            + + + + + + + + + +
            +Class Summary
            GenericTableMapReduceUtilJust like TableMapReduceUtil but fixes some missing dependency jars.
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-tree.html new file mode 100644 index 00000000..9df085be --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-tree.html @@ -0,0 +1,156 @@ + + + + + + + +org.apache.hadoop.hbase.mapreduce Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.apache.hadoop.hbase.mapreduce +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-use.html new file mode 100644 index 00000000..db6e8fa0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/apache/hadoop/hbase/mapreduce/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.apache.hadoop.hbase.mapreduce (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.apache.hadoop.hbase.mapreduce

            +
            +No usage of org.apache.hadoop.hbase.mapreduce +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/DecodedCell.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/DecodedCell.html new file mode 100644 index 00000000..4b857fb6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/DecodedCell.html @@ -0,0 +1,364 @@ + + + + + + + +DecodedCell (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class DecodedCell<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.DecodedCell<T>
+
            +
            +
            Type Parameters:
            T - Type of the data in the cell.
            +
            +
            +
            @ApiAudience.Private
+public final class DecodedCell<T>
            extends Object
            + + +

            +Content of a Kiji cell. + + DecodedCell is obtained through a KijiCellDecoder. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DecodedCell(org.apache.avro.Schema writerSchema, + T data) + +
            +          Initializes a DecodedCell instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object obj) + +
            +          Determines whether the data contained in this DecodedCell is equivalent to another.
            + TgetData() + +
            +           
            + org.apache.avro.SchemagetWriterSchema() + +
            +           
            + inthashCode() + +
            +          This operation is not supported.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +DecodedCell

            +
            +public DecodedCell(org.apache.avro.Schema writerSchema,
+                   T data)
            +
            +
            Initializes a DecodedCell instance. +

            +

            +
            Parameters:
            writerSchema - Avro schema used to the encode the cell, or null for counters.
            data - Cell content.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getWriterSchema

            +
            +public org.apache.avro.Schema getWriterSchema()
            +
            +
            + +
            Returns:
            the Avro schema used to encode the cell content, or null for counters.
            +
            +
            +
            + +

            +getData

            +
            +public T getData()
            +
            +
            + +
            Returns:
            the decoded cell content.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object obj)
            +
            +
            Determines whether the data contained in this DecodedCell is equivalent to another. The + data is equivalent if they have the same schema and the same data, regardless of location. +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            Parameters:
            obj - The object to compare. +
            Returns:
            Whether this contains the same data as the other DecodedCell.
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            This operation is not supported. +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            + +
            Returns:
            Nothing. Does not return since this operation is unsupported.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/EntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/EntityId.html new file mode 100644 index 00000000..206e6b99 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/EntityId.html @@ -0,0 +1,387 @@ + + + + + + + +EntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class EntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+
            +
            +
            Direct Known Subclasses:
            FormattedEntityId, HashedEntityId, HashPrefixedEntityId, HBaseEntityId, RawEntityId
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract class EntityId
            extends Object
            + + +

            +EntityId is used to identify a particular row in a Kiji table. + + There are two name-spaces for rows: +

              +
            • Kiji rows are primarily indexed by Kiji row keys (arbitrary byte arrays). +
            • Under the hood, rows are indexed by HBase row keys (arbitrary byte arrays). +
            + + The translation between Kiji row keys and HBase row keys depends on the layout of the table + the row belongs to. + + There are multiple translation schemes: +
              +
            • Raw: Kiji row keys and HBase row keys are identical (identity translation), specifically + used when the row key is an array of bytes. +
            • Hash: HBase row keys are MD5 hashes of the Kiji row key (non reversible transform). +
            • Hash-prefix: HBase row keys are Kiji row keys prefixed by a hash of the Kiji row key. +
            • Formatted: The user specifies the composition of the key. The key can be composed of one + or more components of type string, number or a hash of one of the other components. +
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EntityId() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object obj) + +
            +          
            +abstract + + + + +
            +<T> T
            +            		getComponentByIndex(int idx) + +
            +          Get the individual components of the kiji Row Key representation.
            +abstract  List<Object>getComponents() + +
            +          Get the components of the row key as a List of Objects.
            +abstract  byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + inthashCode() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EntityId

            +
            +public EntityId()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseRowKey

            +
            +public abstract byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            + +
            Returns:
            the HBase row key.
            +
            +
            +
            + +

            +getComponentByIndex

            +
            +public abstract <T> T getComponentByIndex(int idx)
            +
            +
            Get the individual components of the kiji Row Key representation. This excludes hash + prefixes and only includes user-addressible components. + E.g. If the key is composed of a String followed by an Int, getComponentByIndex(0) + returns the String component. Zero based indexing. +

            +

            +
            Type Parameters:
            T - The type of the row key component.
            Parameters:
            idx - The index of the component. An integer between 0 and numComponents - 1. +
            Returns:
            The specific component of the row key.
            +
            +
            +
            + +

            +getComponents

            +
            +public abstract List<Object> getComponents()
            +
            +
            Get the components of the row key as a List of Objects. This excludes hash + prefixes and only includes user-addressible components. +

            +

            + +
            Returns:
            List of Objects representing the individual components of a row key.
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object obj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/EntityIdException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/EntityIdException.html new file mode 100644 index 00000000..9cfd6dbe --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/EntityIdException.html @@ -0,0 +1,250 @@ + + + + + + + +EntityIdException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class EntityIdException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.EntityIdException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            public class EntityIdException
            extends RuntimeException
            + + +

            +Thrown when kiji encounters a row key component name that is not valid. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EntityIdException(String message) + +
            +          Creates a new EntityIdException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +EntityIdException

            +
            +public EntityIdException(String message)
            +
            +
            Creates a new EntityIdException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/EntityIdFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/EntityIdFactory.html new file mode 100644 index 00000000..04cd8238 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/EntityIdFactory.html @@ -0,0 +1,388 @@ + + + + + + + +EntityIdFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class EntityIdFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityIdFactory
+
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public abstract class EntityIdFactory
            extends Object
            + + +

            +Factory class for creating EntityIds. + + Light-weight object, so as many can be created as needed. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EntityIdFactory() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + EntityIdgetEntityId(List<Object> componentList) + +
            +          Creates an entity ID from a list of key components.
            +abstract  EntityIdgetEntityId(Object... components) + +
            +          Creates an entity ID from a list of key components.
            +abstract  EntityIdgetEntityIdFromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates an entity ID from an HBase row key.
            +static EntityIdFactorygetFactory(KijiTableLayout kijiTableLayout) + +
            +          Creates an entity ID factory for the row key format given by the specified + table layout.
            +static EntityIdFactorygetFactory(RowKeyFormat format) + +
            +          Creates an entity ID factory for the specified row key format.
            +static EntityIdFactorygetFactory(RowKeyFormat2 format) + +
            +          Creates an entity ID factory for the specified row key format.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EntityIdFactory

            +
            +public EntityIdFactory()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getFactory

            +
            +public static EntityIdFactory getFactory(RowKeyFormat format)
            +
            +
            Creates an entity ID factory for the specified row key format. +

            +

            +
            Parameters:
            format - Row key format of type RowKeyFormat that determines the + type of EntityIdFactory that's created. +
            Returns:
            a new entity ID factory for the specified row key format.
            +
            +
            +
            + +

            +getFactory

            +
            +public static EntityIdFactory getFactory(RowKeyFormat2 format)
            +
            +
            Creates an entity ID factory for the specified row key format. +

            +

            +
            Parameters:
            format - Row key format of type RowKeyFormat2 that determines + the type of EntityIdFactory that's created. +
            Returns:
            a new entity ID factory for the specified row key format.
            +
            +
            +
            + +

            +getFactory

            +
            +public static EntityIdFactory getFactory(KijiTableLayout kijiTableLayout)
            +
            +
            Creates an entity ID factory for the row key format given by the specified + table layout. +

            +

            +
            Parameters:
            kijiTableLayout - the layout of the kiji table. +
            Returns:
            a new entity ID factory.
            +
            +
            +
            + +

            +getEntityId

            +
            +public abstract EntityId getEntityId(Object... components)
            +
            +
            Creates an entity ID from a list of key components. +

            +

            +
            Parameters:
            components - This can be one of the following depending on row key encoding: +
              +
            • Raw, Hash, Hash-Prefix EntityId: A single String or byte array component.
              • +
            • Formatted EntityId: The primitive row key components (string, int, long) + in their expected order in the key.
              • +
            +
            Returns:
            a new EntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +getEntityId

            +
            +public EntityId getEntityId(List<Object> componentList)
            +
            +
            Creates an entity ID from a list of key components. +

            +

            +
            Parameters:
            componentList - This can be one of the following depending on row key encoding: +
              +
            • Raw, Hash, Hash-Prefix EntityId: A single String or byte array component.
              • +
            • Formatted EntityId: The primitive row key components (string, int, long) + in their expected order in the key.
              • +
            +
            Returns:
            a new EntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +getEntityIdFromHBaseRowKey

            +
            +public abstract EntityId getEntityIdFromHBaseRowKey(byte[] hbaseRowKey)
            +
            +
            Creates an entity ID from an HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key. +
            Returns:
            a new EntityId with the specified HBase row key.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/GenericCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/GenericCellDecoderFactory.html new file mode 100644 index 00000000..479b6c67 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/GenericCellDecoderFactory.html @@ -0,0 +1,260 @@ + + + + + + + +GenericCellDecoderFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class GenericCellDecoderFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.GenericCellDecoderFactory
+
            +
            +
            All Implemented Interfaces:
            KijiCellDecoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class GenericCellDecoderFactory
            extends Object
            implements KijiCellDecoderFactory
            + + +

            +Factory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellDecoder<?>create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +static KijiCellDecoderFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiCellDecoderFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            an instance of the GenericCellDecoderFactory.
            +
            +
            +
            + +

            +create

            +
            +public KijiCellDecoder<?> create(CellSpec cellSpec)
+                          throws IOException
            +
            +
            Creates a new Kiji cell decoder. +

            +

            +
            Specified by:
            create in interface KijiCellDecoderFactory
            +
            +
            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell decoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/IncompatibleKijiVersionException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/IncompatibleKijiVersionException.html new file mode 100644 index 00000000..351dee8e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/IncompatibleKijiVersionException.html @@ -0,0 +1,254 @@ + + + + + + + +IncompatibleKijiVersionException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class IncompatibleKijiVersionException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.IncompatibleKijiVersionException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class IncompatibleKijiVersionException
            extends IOException
            + + +

            +Thrown when there is an attempt to operate on a Kiji instance whose data format version + is incompatible with the Kiji client version. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            IncompatibleKijiVersionException(String message) + +
            +          Creates a new IncompatibleKijiVersionException with the specified + detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +IncompatibleKijiVersionException

            +
            +public IncompatibleKijiVersionException(String message)
            +
            +
            Creates a new IncompatibleKijiVersionException with the specified + detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/InternalKijiError.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/InternalKijiError.html new file mode 100644 index 00000000..fb6f7543 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/InternalKijiError.html @@ -0,0 +1,271 @@ + + + + + + + +InternalKijiError (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class InternalKijiError

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Error
+          extended by org.kiji.schema.InternalKijiError
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class InternalKijiError
            extends Error
            + + +

            +Thrown when there is something wrong with the internal Kiji + implementation. Clients should never catch one of these. Please + file a bug report if you ever see one at the + Kiji Issue tracker. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            InternalKijiError(String message) + +
            +          Creates a new InternalKijiError with the specified detail message.
            InternalKijiError(Throwable cause) + +
            +          Creates a new InternalKijiError with the specified cause.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +InternalKijiError

            +
            +public InternalKijiError(Throwable cause)
            +
            +
            Creates a new InternalKijiError with the specified cause. +

            +

            +
            Parameters:
            cause - A throwable cause.
            +
            +
            + +

            +InternalKijiError

            +
            +public InternalKijiError(String message)
            +
            +
            Creates a new InternalKijiError with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KConstants.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KConstants.html new file mode 100644 index 00000000..5aa410a3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KConstants.html @@ -0,0 +1,291 @@ + + + + + + + +KConstants (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KConstants

            +
            +java.lang.Object
+  extended by org.kiji.schema.KConstants
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KConstants
            extends Object
            + + +

            +Constants used by Kiji. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static longBEGINNING_OF_TIME + +
            +           
            +static StringDEFAULT_INSTANCE_NAME + +
            +          Default kiji instance name.
            +static StringDEFAULT_URI + +
            +          Default Kiji URI.
            +static longEND_OF_TIME + +
            +           
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +DEFAULT_INSTANCE_NAME

            +
            +public static final String DEFAULT_INSTANCE_NAME
            +
            +
            Default kiji instance name. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULT_URI

            +
            +public static final String DEFAULT_URI
            +
            +
            Default Kiji URI. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +END_OF_TIME

            +
            +public static final long END_OF_TIME
            +
            +
            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +BEGINNING_OF_TIME

            +
            +public static final long BEGINNING_OF_TIME
            +
            +
            +
            See Also:
            Constant Field Values
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/Kiji.Factory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/Kiji.Factory.html new file mode 100644 index 00000000..f5301fcc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/Kiji.Factory.html @@ -0,0 +1,288 @@ + + + + + + + +Kiji.Factory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class Kiji.Factory

            +
            +java.lang.Object
+  extended by org.kiji.schema.Kiji.Factory
+
            +
            +
            Enclosing interface:
            Kiji
            +
            +
            +
            +
            public static final class Kiji.Factory
            extends Object
            + + +

            +Provider for the default Kiji factory. + + Ensures that there is only one KijiFactory instance. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiFactoryget() + +
            +           
            +static Kijiopen(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            +static Kijiopen(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiFactory get()
            +
            +
            + +
            Returns:
            the default KijiFactory.
            +
            +
            +
            + +

            +open

            +
            +public static Kiji open(KijiURI uri)
+                 throws IOException
            +
            +
            Opens a Kiji instance by URI. + +

            Caller does not need to call Kiji.retain(), + but must call Kiji.release() when done with it. +

            +

            +
            Parameters:
            uri - URI specifying the Kiji instance to open. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +open

            +
            +public static Kiji open(KijiURI uri,
+                        Configuration conf)
+                 throws IOException
            +
            +
            Opens a Kiji instance by URI. + +

            Caller does not need to call Kiji.retain(), + but must call Kiji.release() when done with it. +

            +

            +
            Parameters:
            uri - URI specifying the Kiji instance to open.
            conf - Hadoop configuration. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/Kiji.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/Kiji.html new file mode 100644 index 00000000..321a7168 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/Kiji.html @@ -0,0 +1,638 @@ + + + + + + + +Kiji (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface Kiji

            +
            +
            All Superinterfaces:
            KijiTableFactory, ReferenceCountable<Kiji>
            +
            +
            +
            All Known Implementing Classes:
            HBaseKiji
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface Kiji
            extends KijiTableFactory, ReferenceCountable<Kiji>
            + + +

            +

            Provides a handle to a Kiji instance that contains table information and access to + Kiji administrative functionality. Kiji instances are identified by a KijiURI. + The default KijiURI is: kiji://.env/default/

            + +

            Kiji instance lifecycle:

            + An instance to Kiji can be retrieved using Kiji.Factory.open(KijiURI). Cleanup is + requested with the inherited ReferenceCountable.release() method. Thus the lifecycle of a Kiji + object looks like: + 
            
+   Kiji kiji = Kiji.Factory.open(kijiURI);
+   // Do some magic
+   kiji.release();
+
            + +

            Base Kiji tables within an instance:

            +

            + Upon installation, a Kiji instance contains a KijiSystemTable, KijiMetaTable, + and KijiSchemaTable that each contain information relevant to the operation of Kiji. +

            +
              +
            • System table: Kiji system and version information.
              • +
            • Meta table: Metadata about the existing Kiji tables.
              • +
            • Schema table: Avro Schemas of the cells in Kiji tables.
              • +
            +

            + These tables can be accessed via the getSystemTable(), getMetaTable(), + and getSchemaTable() methods respectively. +

            + +

            User tables:

            +

            + User tables can be accessed using KijiTableFactory.openTable(String). Note that they must be closed + after they are no longer necessary. +

            + 
            
+   KijiTable kijiTable = kiji.openTable("myTable");
+   // Do some table operations
+   kijiTable.close();
+
            + +

            Administration of user tables:

            +

            + The Kiji administration interface contains methods to create, modify, and delete tables from a + Kiji instance: +

            + +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKiji.Factory + +
            +          Provider for the default Kiji factory.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidcreateTable(String name, + KijiTableLayout layout) + +
            +          Creates a Kiji table in an HBase instance.
            + voidcreateTable(String name, + KijiTableLayout layout, + byte[][] splitKeys) + +
            +          Creates a Kiji table in an HBase instance.
            + voidcreateTable(String name, + KijiTableLayout layout, + int numRegions) + +
            +          Creates a Kiji table in an HBase instance.
            + voiddeleteTable(String name) + +
            +          Deletes a Kiji table.
            + ConfigurationgetConf() + +
            +          Deprecated. 
            + KijiMetaTablegetMetaTable() + +
            +          Gets the meta table for this Kiji instance.
            + KijiSchemaTablegetSchemaTable() + +
            +          Gets the schema table for this Kiji instance.
            + KijiSystemTablegetSystemTable() + +
            +          Gets the system table for this Kiji instance.
            + List<String>getTableNames() + +
            +          Gets the list of Kiji table names.
            + KijiURIgetURI() + +
            +           
            + KijiTableLayoutmodifyTableLayout(String name, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutmodifyTableLayout(String name, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiTableFactory
            openTable
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.util.ReferenceCountable
            release, retain
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getConf

            +
            +@Deprecated
+Configuration getConf()
            +
            +
            Deprecated.  +

            +

            +
            +
            +
            + +
            Returns:
            The hadoop configuration.
            +
            +
            +
            + +

            +getURI

            +
            +KijiURI getURI()
            +
            +
            +
            +
            +
            + +
            Returns:
            The address of this kiji instance, trimmed to the Kiji instance path component.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +KijiSchemaTable getSchemaTable()
+                               throws IOException
            +
            +
            Gets the schema table for this Kiji instance. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji schema table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getSystemTable

            +
            +KijiSystemTable getSystemTable()
+                               throws IOException
            +
            +
            Gets the system table for this Kiji instance. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji system table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMetaTable

            +
            +KijiMetaTable getMetaTable()
+                           throws IOException
            +
            +
            Gets the meta table for this Kiji instance. +

            +

            +
            +
            +
            + +
            Returns:
            The kiji meta table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +createTable

            +
            +void createTable(String name,
+                 KijiTableLayout layout)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            +
            +
            +
            Parameters:
            name - The name of the table to create.
            layout - The initial layout of the table (with unassigned column ids). +
            Throws: +
            IOException - on I/O error. +
            KijiAlreadyExistsException - if the table already exists.
            +
            +
            +
            + +

            +createTable

            +
            +void createTable(String name,
+                 KijiTableLayout layout,
+                 int numRegions)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            +
            +
            +
            Parameters:
            name - The name of the table to create.
            layout - The initial layout of the table (with unassigned column ids).
            numRegions - The initial number of regions to create. +
            Throws: +
            IllegalArgumentException - If numRegions is non-positive, or if numRegions is + more than 1 and row key hashing on the table layout is disabled. +
            IOException - on I/O error. +
            KijiAlreadyExistsException - if the table already exists.
            +
            +
            +
            + +

            +createTable

            +
            +void createTable(String name,
+                 KijiTableLayout layout,
+                 byte[][] splitKeys)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            +
            +
            +
            Parameters:
            name - The name of the table to create.
            layout - The initial layout of the table (with unassigned column ids).
            splitKeys - The initial key boundaries between regions. There will be splitKeys + + 1 regions created. Pass null to specify the default single region. +
            Throws: +
            IOException - on I/O error. +
            KijiAlreadyExistsException - if the table already exists.
            +
            +
            +
            + +

            +deleteTable

            +
            +void deleteTable(String name)
+                 throws IOException
            +
            +
            Deletes a Kiji table. Removes it from HBase. +

            +

            +
            +
            +
            +
            Parameters:
            name - The name of the Kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableNames

            +
            +List<String> getTableNames()
+                           throws IOException
            +
            +
            Gets the list of Kiji table names. +

            +

            +
            +
            +
            + +
            Returns:
            A list of the names of Kiji tables installed in the Kiji instance. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +modifyTableLayout

            +
            +KijiTableLayout modifyTableLayout(String name,
+                                  TableLayoutDesc update)
+                                  throws IOException
            +
            +
            Sets the layout of a table. +

            +

            +
            +
            +
            +
            Parameters:
            name - The name of the Kiji table to change the layout of.
            update - The new layout for the table. +
            Returns:
            the updated layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +modifyTableLayout

            +
            +KijiTableLayout modifyTableLayout(String name,
+                                  TableLayoutDesc update,
+                                  boolean dryRun,
+                                  PrintStream printStream)
+                                  throws IOException
            +
            +
            Sets the layout of a table, or print the results of setting the table layout if + dryRun is true. +

            +

            +
            +
            +
            +
            Parameters:
            name - The name of the Kiji table to affect.
            update - The new layout for the table.
            dryRun - true if this is a 'dry run', false if changes should be made.
            printStream - the print stream to use for information if dryRun is true. + If null, stdout will be used. +
            Returns:
            the updated layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiAlreadyExistsException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiAlreadyExistsException.html new file mode 100644 index 00000000..c5604380 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiAlreadyExistsException.html @@ -0,0 +1,282 @@ + + + + + + + +KijiAlreadyExistsException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiAlreadyExistsException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiAlreadyExistsException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiAlreadyExistsException
            extends RuntimeException
            + + +

            +Thrown when installing an instance or creating a table that already exists. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiAlreadyExistsException(String message, + KijiURI uri) + +
            +          Initializes a new exception object.
            +  + + + + + + + + + + + +
            +Method Summary
            + KijiURIgetURI() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiAlreadyExistsException

            +
            +public KijiAlreadyExistsException(String message,
+                                  KijiURI uri)
            +
            +
            Initializes a new exception object. +

            +

            +
            Parameters:
            message - Human readable message.
            uri - URI of the already existing entity.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getURI

            +
            +public KijiURI getURI()
            +
            +
            + +
            Returns:
            the URI of the already existing entity.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCell.CellType.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCell.CellType.html new file mode 100644 index 00000000..30ee0594 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCell.CellType.html @@ -0,0 +1,334 @@ + + + + + + + +KijiCell.CellType (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Enum KijiCell.CellType

            +
            +java.lang.Object
+  extended by java.lang.Enum<KijiCell.CellType>
+      extended by org.kiji.schema.KijiCell.CellType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<KijiCell.CellType>
            +
            +
            +
            Enclosing class:
            KijiCell<T>
            +
            +
            +
            +
            public static enum KijiCell.CellType
            extends Enum<KijiCell.CellType>
            + + +

            +Type of a Kiji cell. +

            + +

            +

            + +

            + + + + + + + + + + + + + +
            +Enum Constant Summary
            AVRO + +
            +          Cell encoded with Avro.
            COUNTER + +
            +          Cell encoded as a counter.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiCell.CellTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static KijiCell.CellType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +AVRO

            +
            +public static final KijiCell.CellType AVRO
            +
            +
            Cell encoded with Avro. +

            +

            +
            +
            +
            + +

            +COUNTER

            +
            +public static final KijiCell.CellType COUNTER
            +
            +
            Cell encoded as a counter. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static KijiCell.CellType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (KijiCell.CellType c : KijiCell.CellType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static KijiCell.CellType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCell.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCell.html new file mode 100644 index 00000000..236cfa49 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCell.html @@ -0,0 +1,419 @@ + + + + + + + +KijiCell (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiCell<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiCell<T>
+
            +
            +
            Type Parameters:
            T - Type of data stored in the cell.
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiCell<T>
            extends Object
            + + +

            +KijiCell represents a cell in a Kiji table. + + It contains the family, qualifier, timestamp + that uniquely locates the cell within a table as well as the data in the cell. + +

            This class has a Java type parameter T, which should be the Java type + determined by the Avro Schema. The mapping between Avro Schemas and Java types are + documented in the Avro Java API documentation: +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiCell.CellType + +
            +          Type of a Kiji cell.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiCell(String family, + String qualifier, + long timestamp, + DecodedCell<T> decodedCell) + +
            +          Initializes a KijiCell.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TgetData() + +
            +           
            + StringgetFamily() + +
            +           
            + StringgetQualifier() + +
            +           
            + longgetTimestamp() + +
            +           
            + KijiCell.CellTypegetType() + +
            +           
            + org.apache.avro.SchemagetWriterSchema() + +
            +           
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiCell

            +
            +public KijiCell(String family,
+                String qualifier,
+                long timestamp,
+                DecodedCell<T> decodedCell)
            +
            +
            Initializes a KijiCell. +

            +

            +
            Parameters:
            family - Kiji column family name of the cell.
            qualifier - Kiji column qualifier name of the cell.
            timestamp - Timestamp the cell was written at, in ms since the Epoch.
            decodedCell - Decoded cell content.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getFamily

            +
            +public String getFamily()
            +
            +
            + +
            Returns:
            the Kiji column family name of this cell.
            +
            +
            +
            + +

            +getQualifier

            +
            +public String getQualifier()
            +
            +
            + +
            Returns:
            the Kiji column qualifier name of this cell.
            +
            +
            +
            + +

            +getTimestamp

            +
            +public long getTimestamp()
            +
            +
            + +
            Returns:
            the timestamp this cell was written with, in ms since the Epoch.
            +
            +
            +
            + +

            +getData

            +
            +public T getData()
            +
            +
            + +
            Returns:
            the cell content.
            +
            +
            +
            + +

            +getWriterSchema

            +
            +public org.apache.avro.Schema getWriterSchema()
            +
            +
            + +
            Returns:
            the Avro schema used to encode this cell, or null.
            +
            +
            +
            + +

            +getType

            +
            +public KijiCell.CellType getType()
            +
            +
            + +
            Returns:
            this cell's encoding type.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellDecoder.html new file mode 100644 index 00000000..2ba52185 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellDecoder.html @@ -0,0 +1,252 @@ + + + + + + + +KijiCellDecoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellDecoder<T>

            +
            +
            Type Parameters:
            T - Type of the values being decoded.
            +
            +
            All Known Implementing Classes:
            AvroCellDecoder, CounterCellDecoder, GenericCellDecoder, SpecificCellDecoder
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiCellDecoder<T>
            + + +

            +Interface for Kiji cell decoders. + + A cell decoder is specific to one column and decodes only one type of value. + Cell decoders are instantiated via KijiCellDecoderFactory. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + DecodedCell<T>decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + TdecodeValue(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +decodeCell

            +
            +DecodedCell<T> decodeCell(byte[] bytes)
+                          throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Parameters:
            bytes - Binary encoded Kiji cell. +
            Returns:
            the decoded KijiCell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeValue

            +
            +T decodeValue(byte[] bytes)
+              throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Parameters:
            bytes - Binary encoded Kiji cell value. +
            Returns:
            the decoded cell value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellDecoderFactory.html new file mode 100644 index 00000000..0dde905e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellDecoderFactory.html @@ -0,0 +1,229 @@ + + + + + + + +KijiCellDecoderFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellDecoderFactory

            +
            +
            All Known Implementing Classes:
            GenericCellDecoderFactory, SpecificCellDecoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiCellDecoderFactory
            + + +

            +Interface for factories of KijiCellDecoder instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<T> KijiCellDecoder<T>
            +            		create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +<T> KijiCellDecoder<T> create(CellSpec cellSpec)
+                          throws IOException
            +
            +
            Creates a new Kiji cell decoder. +

            +

            +
            Type Parameters:
            T - Type of the value to decode.
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell decoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellEncoder.html new file mode 100644 index 00000000..cc461fff --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellEncoder.html @@ -0,0 +1,261 @@ + + + + + + + +KijiCellEncoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellEncoder

            +
            +
            All Known Implementing Classes:
            AvroCellEncoder, CounterCellEncoder
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiCellEncoder
            + + +

            +Interface for Kiji cell encoders. + + A cell encoder is configured to encode precisely one specific column and knows exactly the type + of data it is supposed to encode. + + Cell encoders are instantiated via KijiCellEncoderFactory. + + Intended for framework developers only. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]encode(DecodedCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + + + + + +
            +<T> byte[]
            +            		encode(T cellValue) + +
            +          Encodes the specified value.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +encode

            +
            +byte[] encode(DecodedCell<?> cell)
+              throws IOException
            +
            +
            Encodes the specified Kiji cell. +

            +

            +
            Parameters:
            cell - Kiji cell to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encode

            +
            +<T> byte[] encode(T cellValue)
+              throws IOException
            +
            +
            Encodes the specified value. +

            +

            +
            Type Parameters:
            T - type of the value to encode.
            Parameters:
            cellValue - value to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellEncoderFactory.html new file mode 100644 index 00000000..33c268c6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiCellEncoderFactory.html @@ -0,0 +1,222 @@ + + + + + + + +KijiCellEncoderFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiCellEncoderFactory

            +
            +
            All Known Implementing Classes:
            DefaultKijiCellEncoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiCellEncoderFactory
            + + +

            +Interface for factories of KijiCellEncoder instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + KijiCellEncodercreate(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +KijiCellEncoder create(CellSpec cellSpec)
+                       throws IOException
            +
            +
            Creates a new Kiji cell encoder. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell encoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiColumnName.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiColumnName.html new file mode 100644 index 00000000..debd9068 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiColumnName.html @@ -0,0 +1,519 @@ + + + + + + + +KijiColumnName (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiColumnName

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiColumnName
+
            +
            +
            All Implemented Interfaces:
            Comparable<KijiColumnName>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiColumnName
            extends Object
            implements Comparable<KijiColumnName>
            + + +

            +A Kiji column name is composed of one or two parts: a family and a qualifier. + The qualifier is sometimes also referred to as the key. + If the column is of type map, the qualifier is null. + If the column is of type group, then the qualifier is required but may be empty. +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiColumnName(String fullName) + +
            +          Constructs a column name from a string "family" or "family:qualifier".
            KijiColumnName(String family, + String qualifier) + +
            +          Constructs a column name from the two-part family:qualifier.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + intcompareTo(KijiColumnName o) + +
            +          
            + booleanequals(Object otherObj) + +
            +          
            + StringgetFamily() + +
            +          Gets the name of the column family.
            + byte[]getFamilyBytes() + +
            +          Gets the name of the column family as a byte array.
            + StringgetName() + +
            +          Gets the full name of the column.
            + StringgetQualifier() + +
            +          Gets the name of the column qualifier, which may be null or empty.
            + byte[]getQualifierBytes() + +
            +          Gets the name of the column qualifier as a byte array.
            + inthashCode() + +
            +          
            + booleanisFullyQualified() + +
            +          Determines whether the name refers to a qualified family (vs.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiColumnName

            +
            +public KijiColumnName(String fullName)
            +
            +
            Constructs a column name from a string "family" or "family:qualifier". +

            +

            +
            Parameters:
            fullName - The name of a kiji column "family:qualifier".
            +
            +
            + +

            +KijiColumnName

            +
            +public KijiColumnName(String family,
+                      String qualifier)
            +
            +
            Constructs a column name from the two-part family:qualifier. +

            +

            +
            Parameters:
            family - The kiji column family.
            qualifier - The kiji column qualifier: null means unqualified.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the full name of the column. +

            +

            +
            +
            +
            + +
            Returns:
            the full name of the column.
            +
            +
            +
            + +

            +getFamily

            +
            +public String getFamily()
            +
            +
            Gets the name of the column family. +

            +

            +
            +
            +
            + +
            Returns:
            the family component of the column name.
            +
            +
            +
            + +

            +getFamilyBytes

            +
            +public byte[] getFamilyBytes()
            +
            +
            Gets the name of the column family as a byte array. + Caches the result for subsequent calls. This method returns a shared + array instance for all calls; do not modify the returned byte array. +

            +

            +
            +
            +
            + +
            Returns:
            the family component of the column name.
            +
            +
            +
            + +

            +getQualifier

            +
            +public String getQualifier()
            +
            +
            Gets the name of the column qualifier, which may be null or empty. +

            +

            +
            +
            +
            + +
            Returns:
            the qualifier component of the column name.
            +
            +
            +
            + +

            +getQualifierBytes

            +
            +public byte[] getQualifierBytes()
            +
            +
            Gets the name of the column qualifier as a byte array. + Caches the result for subsequent calls. This method returns a shared + array instance for all calls; do not modify the returned byte array. +

            +

            +
            +
            +
            + +
            Returns:
            the qualifier component of the column name.
            +
            +
            +
            + +

            +isFullyQualified

            +
            +public boolean isFullyQualified()
            +
            +
            Determines whether the name refers to a qualified family (vs. an entire family). +

            +

            +
            +
            +
            + +
            Returns:
            whether the column refers to a fully qualified family.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object otherObj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +compareTo

            +
            +public int compareTo(KijiColumnName o)
            +
            +
            +

            +

            +
            Specified by:
            compareTo in interface Comparable<KijiColumnName>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequest.Column.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequest.Column.html new file mode 100644 index 00000000..901b310d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequest.Column.html @@ -0,0 +1,530 @@ + + + + + + + +KijiDataRequest.Column (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequest.Column

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequest.Column
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Enclosing class:
            KijiDataRequest
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiDataRequest.Column
            extends Object
            implements Serializable
            + + +

            +Describes a request for a Kiji Table column. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Field Summary
            +static longserialVersionUID + +
            +          Serialization version.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            + KijiColumnNamegetColumnName() + +
            +          Gets the column name.
            + StringgetFamily() + +
            +          Gets the name of the requested column family.
            + KijiColumnFiltergetFilter() + +
            +          Gets the column filter, or null if no filter was specified.
            + intgetMaxVersions() + +
            +          Gets the max number of most recent versions in this column.
            + StringgetName() + +
            +          Gets the full name of the requested column.
            + intgetPageSize() + +
            +          Gets the number of cells to return per page of results.
            + StringgetQualifier() + +
            +          Gets the name of the requested column qualifier, which may be null if any qualifier + should be included.
            + inthashCode() + +
            +          
            + booleanisPagingEnabled() + +
            +          Determines whether paging is enabled for this column.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +serialVersionUID

            +
            +public static final long serialVersionUID
            +
            +
            Serialization version. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getFamily

            +
            +public String getFamily()
            +
            +
            Gets the name of the requested column family. +

            +

            +
            +
            +
            + +
            Returns:
            A column family name.
            +
            +
            +
            + +

            +getQualifier

            +
            +public String getQualifier()
            +
            +
            Gets the name of the requested column qualifier, which may be null if any qualifier + should be included. +

            +

            +
            +
            +
            + +
            Returns:
            A column qualifier name (may be null or empty).
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +

            Gets the full name of the requested column.

            + +

            Note: A request for column "foo" means that all columns within the family "foo" + should be requested, whereas a request for column "foo:" means that the single + column with qualifier "" (empty) should be returned from the family "foo". +

            +

            +
            +
            +
            + +
            Returns:
            A column name.
            +
            +
            +
            + +

            +getColumnName

            +
            +public KijiColumnName getColumnName()
            +
            +
            Gets the column name. +

            +

            +
            +
            +
            + +
            Returns:
            The column name.
            +
            +
            +
            + +

            +getMaxVersions

            +
            +public int getMaxVersions()
            +
            +
            Gets the max number of most recent versions in this column. +

            +

            +
            +
            +
            + +
            Returns:
            The maximum number of most recent versions in this column.
            +
            +
            +
            + +

            +getFilter

            +
            +public KijiColumnFilter getFilter()
            +
            +
            Gets the column filter, or null if no filter was specified. +

            +

            +
            +
            +
            + +
            Returns:
            The column filter, or null.
            +
            +
            +
            + +

            +getPageSize

            +
            +public int getPageSize()
            +
            +
            Gets the number of cells to return per page of results. +

            +

            +
            +
            +
            + +
            Returns:
            The page size (or 0 if paging is disabled).
            +
            +
            +
            + +

            +isPagingEnabled

            +
            +public boolean isPagingEnabled()
            +
            +
            Determines whether paging is enabled for this column. +

            +

            +
            +
            +
            + +
            Returns:
            Whether paging is enabled.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequest.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequest.html new file mode 100644 index 00000000..3bc9d1bd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequest.html @@ -0,0 +1,697 @@ + + + + + + + +KijiDataRequest (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequest

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequest
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiDataRequest
            extends Object
            implements Serializable
            + + +

            +

            Describes a request for columns of data to read from a Kiji table.

            + +

            KijiDataRequest objects are immutable. To create a KijiDataRequest, use + the builder() method to get a new KijiDataRequestBuilder object. + Populate the object's fields, then call KijiDataRequestBuilder.build().

            + +

            For example, to request the 3 most recent versions of cell data from a column + bar from + the family foo within the time range [123, 456): + 

            + KijiDataRequestBuilder builder = KijiDataRequest.builder()
+     .withTimeRange(123L, 456L);
+ builder.newColumnsDef().withMaxVersions(3).add("foo", "bar");
+ KijiDataRequest request = builder.build();
+
            + Or: + 
            + KijiDataRequest dataRequest = KijiDataRequest.builder()
+     .withTimeRange(123L, 456L)
+     .addColumns(KijiDataRequestBuilder.ColumnsDef.create().withMaxVersions(3).add("foo", "bar"))
+     .build();
+
            +

            + +

            For convenience, you can also build KijiDataRequests for a single cell + using the KijiDataRequest.create() method: + + 

            + KijiDataRequest dataRequest = KijiDataRequest.create("info", "foo");
+
            +

            + +

            You cannot set any properties of the requested column using this + syntax; for further customization, see KijiDataRequestBuilder.

            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiDataRequest.Column + +
            +          Describes a request for a Kiji Table column.
            +  + + + + + + + + + + +
            +Field Summary
            +static longserialVersionUID + +
            +          Serialization version.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiDataRequestBuilderbuilder() + +
            +          Creates a new KijiDataRequestBuilder.
            +static KijiDataRequestcreate(String family) + +
            +          Factory method for a simple KijiDataRequest for the most recent version + of each qualifier in one column family.
            +static KijiDataRequestcreate(String family, + String qualifier) + +
            +          Factory method for a simple KijiDataRequest for the most recent + version of a specific family:qualifier.
            + booleanequals(Object other) + +
            +          
            + KijiDataRequest.ColumngetColumn(String family, + String qualifier) + +
            +          Gets a Column requested named "family:key", or + null if none exists.
            + Collection<KijiDataRequest.Column>getColumns() + +
            +          Gets the collection of requested columns.
            + longgetMaxTimestamp() + +
            +          Gets the maximum timestamp for versions in this request (exclusive).
            + longgetMinTimestamp() + +
            +          Gets the minimum timestamp for versions in this request (inclusive).
            + inthashCode() + +
            +          
            + booleanisEmpty() + +
            +          Determines whether this data request has any columns.
            + booleanisPagingEnabled() + +
            +          Determines whether paging is enabled on any of the columns in this request.
            + booleanisTimestampInRange(long ts) + +
            +          Determines whether a timestamp ts is within the time range for this + request.
            + KijiDataRequestmerge(KijiDataRequest other) + +
            +          Creates a new data request representing the union of this data request and the + data request specified as an argument.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +serialVersionUID

            +
            +public static final long serialVersionUID
            +
            +
            Serialization version. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiDataRequest create(String family)
            +
            +
            Factory method for a simple KijiDataRequest for the most recent version + of each qualifier in one column family. + +

            This method does not facilitate additional customization of the + data request, such as requesting multiple column families, or setting + the timestamp range. For that, get a KijiDataRequestBuilder by + calling builder().

            +

            +

            +
            +
            +
            +
            Parameters:
            family - the column family to request +
            Returns:
            a new KijiDataRequest that retrieves the selected column family.
            +
            +
            +
            + +

            +create

            +
            +public static KijiDataRequest create(String family,
+                                     String qualifier)
            +
            +
            Factory method for a simple KijiDataRequest for the most recent + version of a specific family:qualifier. + +

            This method does not facilitate additional customization of the + data request, such as requesting multiple columns, or setting + the timestamp range. For that, get a KijiDataRequestBuilder by + calling builder().

            +

            +

            +
            +
            +
            +
            Parameters:
            family - the column family to request
            qualifier - the column qualifier to request +
            Returns:
            a new KijiDataRequest that retrieves the selected column.
            +
            +
            +
            + +

            +merge

            +
            +public KijiDataRequest merge(KijiDataRequest other)
            +
            +
            Creates a new data request representing the union of this data request and the + data request specified as an argument. + +

            This method merges data requests using the widest-possible treatment of + parameters. This may result in cells being included in the result set that + were not specified by either data set. For example, if request A includes info:foo + from time range [400, 700), and request B includes info:bar from time range + [500, 900), then A.merge(B) will yield a data request for both columns, with time + range [400, 900).

            + +

            More precisely, merges are handled in the following way:

            +
              +
            • The output time interval encompasses both data requests' time intervals.
              • +
            • All columns associated with both data requests will be included.
              • +
            • When maxVersions differs for the same column in both requests, the greater + value is chosen.
              • +
            • When pageSize differs for the same column in both requests, the lesser value + is chosen.
              • +
            • If either request contains KijiColumnFilter definitions attached to a column, + this is considered an error, and a RuntimeException is thrown. Data requests with + filters cannot be merged.
              • +
            • If one data request includes an entire column family (foo:*) and + the other data request includes a column within that family (foo:bar), + the entire family will be requested, and properties such as max versions, etc. + for the family-wide request will be merged with the column to ensure the request + is as wide as possible.
              • +
            +

            +

            +
            +
            +
            +
            Parameters:
            other - another data request to include as a part of this one. +
            Returns:
            A new KijiDataRequest instance, including the union of this data request + and the argument request.
            +
            +
            +
            + +

            +getColumn

            +
            +public KijiDataRequest.Column getColumn(String family,
+                                        String qualifier)
            +
            +
            Gets a Column requested named "family:key", or + null if none exists. +

            +

            +
            +
            +
            +
            Parameters:
            family - The requested column family name.
            qualifier - The requested column qualifier name. +
            Returns:
            The requested column.
            +
            +
            +
            + +

            +isEmpty

            +
            +public boolean isEmpty()
            +
            +
            Determines whether this data request has any columns. +

            +

            +
            +
            +
            + +
            Returns:
            Whether any data has been requested.
            +
            +
            +
            + +

            +getColumns

            +
            +public Collection<KijiDataRequest.Column> getColumns()
            +
            +
            Gets the collection of requested columns. +

            +

            +
            +
            +
            + +
            Returns:
            All the requested column specs as an immutable collection.
            +
            +
            +
            + +

            +getMinTimestamp

            +
            +public long getMinTimestamp()
            +
            +
            Gets the minimum timestamp for versions in this request (inclusive). +

            +

            +
            +
            +
            + +
            Returns:
            A minimum timestamp (milliseconds since the epoch).
            +
            +
            +
            + +

            +getMaxTimestamp

            +
            +public long getMaxTimestamp()
            +
            +
            Gets the maximum timestamp for versions in this request (exclusive). +

            +

            +
            +
            +
            + +
            Returns:
            A maximum timestamp (milliseconds since the epoch).
            +
            +
            +
            + +

            +isTimestampInRange

            +
            +public boolean isTimestampInRange(long ts)
            +
            +
            Determines whether a timestamp ts is within the time range for this + request. +

            +

            +
            +
            +
            +
            Parameters:
            ts - The timestamp to check. +
            Returns:
            Whether the timestamp is within the range of this request.
            +
            +
            +
            + +

            +isPagingEnabled

            +
            +public boolean isPagingEnabled()
            +
            +
            Determines whether paging is enabled on any of the columns in this request. +

            +

            +
            +
            +
            + +
            Returns:
            Whether paging is enabled.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +builder

            +
            +public static KijiDataRequestBuilder builder()
            +
            +
            Creates a new KijiDataRequestBuilder. Use this to configure a KijiDataRequest, + then create one with the KijiDataRequestBuilder.build() method. +

            +

            +
            +
            +
            + +
            Returns:
            a new KijiDataRequestBuilder.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestBuilder.ColumnsDef.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestBuilder.ColumnsDef.html new file mode 100644 index 00000000..92aec592 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestBuilder.ColumnsDef.html @@ -0,0 +1,389 @@ + + + + + + + +KijiDataRequestBuilder.ColumnsDef (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequestBuilder.ColumnsDef

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequestBuilder.ColumnsDef
+
            +
            +
            Enclosing class:
            KijiDataRequestBuilder
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiDataRequestBuilder.ColumnsDef
            extends Object
            + + +

            +Defines properties associated with one or more columns in a request for Kiji table columns. + +

            See KijiDataRequestBuilder for a larger specification of how + KijiDataRequest objects are constructed.

            + +

            Use the KijiDataRequestBuilder.newColumnsDef() method to get an instance of + a column set definition. This object has no "build()" method; use the KijiDataRequestBuilder.build() method to build the entire KijiDataRequest at once.

            + +

            It is an error to call one of the with...() methods after calling + add() to add a specific column definition. You must define all + properties of the columns before specifying particular columns to attach to + the KijiDataRequest.

            + +

            It is an error to request a column more than once in the same + KijiDataRequest.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestBuilder.ColumnsDefadd(KijiColumnName column) + +
            +          Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object.
            + KijiDataRequestBuilder.ColumnsDefadd(String family, + String qualifier) + +
            +          Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object.
            + KijiDataRequestBuilder.ColumnsDefaddFamily(String family) + +
            +          Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object.
            +static KijiDataRequestBuilder.ColumnsDefcreate() + +
            +           
            + KijiDataRequestBuilder.ColumnsDefwithFilter(KijiColumnFilter filter) + +
            +          Sets a filter to attach to each column specified by this column request builder.
            + KijiDataRequestBuilder.ColumnsDefwithMaxVersions(int maxVersions) + +
            +          Sets the maximum number of the most recent versions to return.
            + KijiDataRequestBuilder.ColumnsDefwithPageSize(int pageSize) + +
            +          Sets the page size (i.e.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiDataRequestBuilder.ColumnsDef create()
            +
            +
            + +
            Returns:
            a new builder for column definitions.
            +
            +
            +
            + +

            +withMaxVersions

            +
            +public KijiDataRequestBuilder.ColumnsDef withMaxVersions(int maxVersions)
            +
            +
            Sets the maximum number of the most recent versions to return. +

            +

            +
            Parameters:
            maxVersions - The maximum number of versions of the cell to read. +
            Returns:
            This column request builder instance.
            +
            +
            +
            + +

            +withFilter

            +
            +public KijiDataRequestBuilder.ColumnsDef withFilter(KijiColumnFilter filter)
            +
            +
            Sets a filter to attach to each column specified by this column request builder. +

            +

            +
            Parameters:
            filter - The column filter; +
            Returns:
            This column request builder instance.
            +
            +
            +
            + +

            +withPageSize

            +
            +public KijiDataRequestBuilder.ColumnsDef withPageSize(int pageSize)
            +
            +
            Sets the page size (i.e. the maximum number of cells per page). + + Defaults to zero, which means paging is disabled. +

            +

            +
            Parameters:
            pageSize - The maximum number of cells to return in each page of results. + Use 0 to disable paging and return all results at once. +
            Returns:
            This column request instance.
            +
            +
            +
            + +

            +addFamily

            +
            +public KijiDataRequestBuilder.ColumnsDef addFamily(String family)
            +
            +
            Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object. Once you call this method, you may not + call property-setting methods like withPageSize() on this same object. +

            +

            +
            Parameters:
            family - the column family to retrieve as a map. +
            Returns:
            this column request builder instance.
            +
            +
            +
            + +

            +add

            +
            +public KijiDataRequestBuilder.ColumnsDef add(String family,
+                                             String qualifier)
            +
            +
            Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object. Once you call this method, you may not + call property-setting methods like withPageSize() on this same object. +

            +

            +
            Parameters:
            family - the column family of the column to retrieve.
            qualifier - the qualifier of the column to retrieve. +
            Returns:
            this column request builder instance.
            +
            +
            +
            + +

            +add

            +
            +public KijiDataRequestBuilder.ColumnsDef add(KijiColumnName column)
            +
            +
            Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object. Once you call this method, you may not + call property-setting methods like withPageSize() on this same object. +

            +

            +
            Parameters:
            column - the column name to retrieve. +
            Returns:
            this column request builder instance.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestBuilder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestBuilder.html new file mode 100644 index 00000000..10b8d11c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestBuilder.html @@ -0,0 +1,432 @@ + + + + + + + +KijiDataRequestBuilder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequestBuilder

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequestBuilder
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiDataRequestBuilder
            extends Object
            + + +

            +

            Builds a request for columns of data to read from a Kiji table.

            + +

            You can instantiate a KijiDataRequestBuilder using the KijiDataRequest.builder() method.

            + +

            KijiDataRequest objects are immutable; this object helps you construct + them. With a KijiDataRequest builder, you can set various properties that affect + the data request as a whole (for example, the timestamp interval to retrieve). + You can also use the newColumnsDef() method of this object to get instances of + KijiDataRequestBuilder.ColumnsDef, which allow you to define a set of columns that + are part of a data request, and their retrieval properties.

            + +

            A KijiDataRequestBuilder.ColumnsDef object has two types of methods: methods + starting with with... define properties associated with some columns. The + add() methods then attach specific columns to the data request being built, + using the properties previously specified. You may call add() or + addFamily() multiple times. + You may not overwrite the value of a property like maxVersions once it's already been set.

            + +

            It is an error to change properties within a column request (e.g., call KijiDataRequestBuilder.ColumnsDef.withMaxVersions(int)) after using the + add() or addFamily() methods to add columns to the request.

            + +

            The following behaviors are errors and are not allowed:

            +
              +
            • Adding the same column multiple times. This includes definitions like + info:name that conflict with requests for the entire + info:* family.
              • +
            • Calling a property-setting method (withTimeRange(), + withMaxVersions(), etc) more than once on a given + KijiDataRequestBuilder or KijiDataRequestBuilder.ColumnsDef. + These methods will throw IllegalStateException.
              • +
            • Changing any properties after calling build() to construct the KijiDataRequest.
              • +
            • Calling build() more than once.
              • +
            + +

            Usage example

            + +

            For the common case of reading info:foo, info:bar, + info:baz, and products:*:

            + 
            + KijiDataRequestBuilder builder = KijiDataRequest.builder().withTimeRange(t1, t2);
+ builder.newColumnsDef().withMaxVersions(42)
+     .add("info", "foo")
+     .add("info", "bar")
+     .add("info", "baz")
+     .addFamily("products");
+ KijiDataRequest request = builder.build();
+
            + + This can also be written as: + 
            + final KijiDataRequest request = KijiDataRequest.build()
+     .addColumns(ColumnsDef.create()
+         .withMaxVerions(42)
+         .add("info", "foo")
+         .add("info", "bar")
+         .add("info", "baz")
+         .addFamily("products"))
+     .build();
+
            + +

            To add fam1:col1, fam1:col2, and fam2:*, each with + different retrieval properties to the same request, do the following:

            + 
            + KijiDataRequestBuilder builder = KijiDataRequest.builder().withTimeRange(t1, t2);
+ builder.newColumnsDef().withMaxVersions(10).withPageSize(p).add("fam1", "col1");
+ builder.newColumnsDef().add("fam1", "col2");
+ builder.newColumnsDef().withMaxVersions(42).addFamily("fam2");
+ KijiDataRequest request = builder.build();
+
            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiDataRequestBuilder.ColumnsDef + +
            +          Defines properties associated with one or more columns in a request for Kiji table columns.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestBuilderaddColumns(KijiDataRequestBuilder.ColumnsDef def) + +
            +          Adds another set of column definitions to this KijiDataRequest builder.
            + KijiDataRequestbuild() + +
            +          Construct a new KijiDataRequest based on the configuration specified in this builder + and its associated column builders.
            + KijiDataRequestBuilder.ColumnsDefnewColumnsDef() + +
            +          Return a builder for columns associated with this KijiDataRequestBuilder.
            + KijiDataRequestBuilder.ColumnsDefnewColumnsDef(KijiDataRequest.Column existingColumn) + +
            +          Return a builder for columns, initialized from an existing + KijiDataRequest.Column.
            + KijiDataRequestBuilderwithTimeRange(long minTimestamp, + long maxTimestamp) + +
            +          Sets the time range of cells to return: [minTimestamp, + maxTimestamp).
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +withTimeRange

            +
            +public KijiDataRequestBuilder withTimeRange(long minTimestamp,
+                                            long maxTimestamp)
            +
            +
            Sets the time range of cells to return: [minTimestamp, + maxTimestamp). +

            +

            +
            Parameters:
            minTimestamp - Request cells with a timestamp at least minTimestamp.
            maxTimestamp - Request cells with a timestamp less than maxTimestamp. +
            Returns:
            This data request builder instance.
            +
            +
            +
            + +

            +newColumnsDef

            +
            +public KijiDataRequestBuilder.ColumnsDef newColumnsDef()
            +
            +
            Return a builder for columns associated with this KijiDataRequestBuilder. + +

            Creates an object that allows you to specify a set of related columns attached + to the same KijiDataRequest that all share the same retrieval properties, like + the number of max versions.

            +

            +

            + +
            Returns:
            a new KijiDataRequestBuilder.ColumnsDef builder object associated with this + data request builder.
            +
            +
            +
            + +

            +newColumnsDef

            +
            +public KijiDataRequestBuilder.ColumnsDef newColumnsDef(KijiDataRequest.Column existingColumn)
            +
            +
            Return a builder for columns, initialized from an existing + KijiDataRequest.Column. + +

            Creates an object that allows you to specify a set of related columns attached + to the same KijiDataRequest that all share the same retrieval properties, like + the number of max versions.

            + +

            This builder will have all properties fully initialized, and it will already + include a request for the column named as an argument. Only additional calls to + KijiDataRequestBuilder.ColumnsDef.add(...) are permitted.

            +

            +

            +
            Parameters:
            existingColumn - is a Column from an existing KijiDataRequest object that should + be included in this new KijiDataRequest. +
            Returns:
            a new KijiDataRequestBuilder.ColumnsDef builder object associated with this + data request builder.
            +
            +
            +
            + +

            +addColumns

            +
            +public KijiDataRequestBuilder addColumns(KijiDataRequestBuilder.ColumnsDef def)
            +
            +
            Adds another set of column definitions to this KijiDataRequest builder. + +

            Columns added in this manner must not redefine any column definitions already included in + the KijiDataRequestBuilder. It is an error to add a ColumnsDef instance to multiple + KijiDataRequestBuilders. +

            +

            +
            Parameters:
            def - A set of column definitions contained in a KijiDataRequestBuilder.ColumnsDef + instance. +
            Returns:
            this KijiDataRequest builder.
            +
            +
            +
            + +

            +build

            +
            +public KijiDataRequest build()
            +
            +
            Construct a new KijiDataRequest based on the configuration specified in this builder + and its associated column builders. + +

            After calling build(), you may not use the builder anymore.

            +

            +

            + +
            Returns:
            a new KijiDataRequest object containing the column requests associated + with this KijiDataRequestBuilder.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestException.html new file mode 100644 index 00000000..6741b506 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestException.html @@ -0,0 +1,251 @@ + + + + + + + +KijiDataRequestException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequestException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiDataRequestException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiDataRequestException
            extends RuntimeException
            + + +

            +Thrown when there is an error validating a KijiDataRequest against a Kiji table. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiDataRequestException(String message) + +
            +          Creates a new KijiDataRequestException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiDataRequestException

            +
            +public KijiDataRequestException(String message)
            +
            +
            Creates a new KijiDataRequestException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestValidator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestValidator.html new file mode 100644 index 00000000..d0731b83 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDataRequestValidator.html @@ -0,0 +1,267 @@ + + + + + + + +KijiDataRequestValidator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiDataRequestValidator

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiDataRequestValidator
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiDataRequestValidator
            extends Object
            + + +

            +This class validates a KijiDataRequest against the layout + of a Kiji table to make sure it contains all of the columns requested. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiDataRequestValidator(KijiDataRequest dataRequest) + +
            +          Construct a validator for a data request.
            +  + + + + + + + + + + + +
            +Method Summary
            + voidvalidate(KijiTableLayout tableLayout) + +
            +          Validates the data request against the given table layout.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiDataRequestValidator

            +
            +public KijiDataRequestValidator(KijiDataRequest dataRequest)
            +
            +
            Construct a validator for a data request. +

            +

            +
            Parameters:
            dataRequest - The data request to validate.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +validate

            +
            +public void validate(KijiTableLayout tableLayout)
            +
            +
            Validates the data request against the given table layout. +

            +

            +
            Parameters:
            tableLayout - The Kiji table layout to validate against. +
            Throws: +
            KijiDataRequestException - If the data request is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDeleter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDeleter.html new file mode 100644 index 00000000..ed686ca3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiDeleter.html @@ -0,0 +1,482 @@ + + + + + + + +KijiDeleter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiDeleter

            +
            +
            All Superinterfaces:
            Closeable, Flushable
            +
            +
            +
            All Known Subinterfaces:
            KijiTableWriter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiDeleter
            extends Closeable, Flushable
            + + +

            +Interface for performing deletes on a Kiji table. + +

            KijiDeleter provides methods for deleting data from a Kiji table.

            + +

            Delete all data on the given row in the given column (column family:column qualifier).

            + 
            +   final KijiDeleter deleter = myKijiTable.openTableWriter();
+   deleter.deleteColumn(entityId, columnFamily, columnQualifier);
+
            + +

            Delete the most recent data in a cell.

            + 
            +   final KijiDeleter deleter = myKijiTable.openTableWriter();
+   deleter.deleteCell(entityId, columnFamily, columnQualifier);
+
            + + This interface is bundled within the KijiTableWriter interface. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voiddeleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voiddeleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voiddeleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voiddeleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +deleteRow

            +
            +void deleteRow(EntityId entityId)
+               throws IOException
            +
            +
            Deletes an entire row. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteRow

            +
            +void deleteRow(EntityId entityId,
+               long upToTimestamp)
+               throws IOException
            +
            +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +void deleteFamily(EntityId entityId,
+                  String family)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a family. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +void deleteFamily(EntityId entityId,
+                  String family,
+                  long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +void deleteColumn(EntityId entityId,
+                  String family,
+                  String qualifier)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a column. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +void deleteColumn(EntityId entityId,
+                  String family,
+                  String qualifier,
+                  long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +void deleteCell(EntityId entityId,
+                String family,
+                String qualifier)
+                throws IOException
            +
            +
            Deletes the most recent version of the cell in a column. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +void deleteCell(EntityId entityId,
+                String family,
+                String qualifier,
+                long timestamp)
+                throws IOException
            +
            +
            Deletes a single cell with a specified timestamp. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            timestamp - The timestamp of the cell to delete (use HConstants.LATEST_TIMESTAMP + to delete the most recent cell in the column). +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiEncodingException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiEncodingException.html new file mode 100644 index 00000000..83681fda --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiEncodingException.html @@ -0,0 +1,289 @@ + + + + + + + +KijiEncodingException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiEncodingException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiEncodingException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiEncodingException
            extends RuntimeException
            + + +

            +Runtime exception thrown when encoding a cell's content fails. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiEncodingException(String message) + +
            +          Initializes an encoding exception.
            KijiEncodingException(String message, + Throwable throwable) + +
            +          Initializes an encoding exception.
            KijiEncodingException(Throwable throwable) + +
            +          Initializes an encoding exception.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiEncodingException

            +
            +public KijiEncodingException(String message)
            +
            +
            Initializes an encoding exception. +

            +

            +
            Parameters:
            message - Error message.
            +
            +
            + +

            +KijiEncodingException

            +
            +public KijiEncodingException(String message,
+                             Throwable throwable)
            +
            +
            Initializes an encoding exception. +

            +

            +
            Parameters:
            message - Error message.
            throwable - Underlying exception, if any.
            +
            +
            + +

            +KijiEncodingException

            +
            +public KijiEncodingException(Throwable throwable)
            +
            +
            Initializes an encoding exception. +

            +

            +
            Parameters:
            throwable - Underlying exception, if any.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiFactory.html new file mode 100644 index 00000000..066f42ef --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiFactory.html @@ -0,0 +1,267 @@ + + + + + + + +KijiFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiFactory

            +
            +
            All Superinterfaces:
            org.kiji.delegation.PriorityProvider
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiFactory
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiFactory
            extends org.kiji.delegation.PriorityProvider
            + + +

            +Factory for Kiji instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + Kijiopen(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + Kijiopen(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +  + + + + + + + +
            Methods inherited from interface org.kiji.delegation.PriorityProvider
            getPriority
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +open

            +
            +Kiji open(KijiURI uri)
+          throws IOException
            +
            +
            Opens a Kiji instance by URI. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI specifying the Kiji instance to open. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +open

            +
            +Kiji open(KijiURI uri,
+          Configuration conf)
+          throws IOException
            +
            +
            Opens a Kiji instance by URI. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI specifying the Kiji instance to open.
            conf - Hadoop configuration. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiIncrementer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiIncrementer.html new file mode 100644 index 00000000..57646d5a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiIncrementer.html @@ -0,0 +1,271 @@ + + + + + + + +KijiIncrementer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiIncrementer

            +
            +
            All Superinterfaces:
            Closeable, Flushable
            +
            +
            +
            All Known Subinterfaces:
            KijiTableWriter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiIncrementer
            extends Closeable, Flushable
            + + +

            +Interface for performing increments on a Kiji table. + +

            + KijiIncrementer provides a method for modifying the value of a counter given + an entity id, column family, column qualifier, and a signed long amount by which + to modify the counter. Increment does not support setting the timestamp of the + data to write, and returns the newly incremented cell. +

            + + 
            +   final KijiIncrementer incrementer = myKijiTable.openTableWriter();
+   incrementer.increment(entityId, columnFamily, columnQualifier, amount);
+
            + + This interface is not used alone but is bundled within KijiTableWriter. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + KijiCell<Long>increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +increment

            +
            +KijiCell<Long> increment(EntityId entityId,
+                         String family,
+                         String qualifier,
+                         long amount)
+                         throws IOException
            +
            +
            Atomically increments a counter in a kiji table. + +

            Throws an exception if the specified column is not a counter.

            +

            +

            +
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row containing the counter.
            family - Column family.
            qualifier - Column qualifier.
            amount - Amount to increment the counter (may be negative). +
            Returns:
            the new counter value, post increment. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiInstaller.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiInstaller.html new file mode 100644 index 00000000..1414cca8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiInstaller.html @@ -0,0 +1,345 @@ + + + + + + + +KijiInstaller (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiInstaller

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiInstaller
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiInstaller
            extends Object
            + + +

            +Installs or uninstalls Kiji instances from an HBase cluster. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiInstallerget() + +
            +          Gets an instance of a KijiInstaller.
            + voidinstall(KijiURI uri, + Configuration conf) + +
            +          Installs the specified Kiji instance.
            + voidinstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            + voiduninstall(KijiURI uri, + Configuration conf) + +
            +          Uninstalls the specified Kiji instance.
            + voiduninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +install

            +
            +public void install(KijiURI uri,
+                    Configuration conf)
+             throws IOException,
+                    KijiInvalidNameException
            +
            +
            Installs the specified Kiji instance. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to install.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error. +
            KijiInvalidNameException - if the Kiji instance name is invalid or already exists.
            +
            +
            +
            + +

            +uninstall

            +
            +public void uninstall(KijiURI uri,
+                      Configuration conf)
+               throws IOException,
+                      KijiInvalidNameException
            +
            +
            Uninstalls the specified Kiji instance. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to uninstall.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error. +
            KijiInvalidNameException - if the instance name is invalid or already exists.
            +
            +
            +
            + +

            +install

            +
            +public void install(KijiURI uri,
+                    HBaseFactory hbaseFactory,
+                    Configuration conf)
+             throws IOException,
+                    KijiInvalidNameException
            +
            +
            Installs a Kiji instance. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to install.
            hbaseFactory - Factory for HBase instances.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error. +
            KijiInvalidNameException - if the instance name is invalid or already exists.
            +
            +
            +
            + +

            +uninstall

            +
            +public void uninstall(KijiURI uri,
+                      HBaseFactory hbaseFactory,
+                      Configuration conf)
+               throws IOException,
+                      KijiInvalidNameException
            +
            +
            Removes a kiji instance from the HBase cluster including any user tables. +

            +

            +
            Parameters:
            uri - URI of the Kiji instance to install.
            hbaseFactory - Factory for HBase instances.
            conf - Hadoop configuration. +
            Throws: +
            IOException - on I/O error. +
            KijiInvalidNameException - if the instance name is invalid. +
            KijiNotInstalledException - if the specified instance does not exist.
            +
            +
            +
            + +

            +get

            +
            +public static KijiInstaller get()
            +
            +
            Gets an instance of a KijiInstaller. +

            +

            + +
            Returns:
            An instance of a KijiInstaller.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiInvalidNameException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiInvalidNameException.html new file mode 100644 index 00000000..e17e153b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiInvalidNameException.html @@ -0,0 +1,250 @@ + + + + + + + +KijiInvalidNameException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiInvalidNameException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.KijiInvalidNameException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiInvalidNameException
            extends Exception
            + + +

            +Thrown when a Kiji instance or table layout name is invalid. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiInvalidNameException(String message) + +
            +          Creates a new KijiInvalidNameException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiInvalidNameException

            +
            +public KijiInvalidNameException(String message)
            +
            +
            Creates a new KijiInvalidNameException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiMetaTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiMetaTable.html new file mode 100644 index 00000000..0b65c4f6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiMetaTable.html @@ -0,0 +1,412 @@ + + + + + + + +KijiMetaTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiMetaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiMetaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTableKeyValueDatabase, KijiTableLayoutDatabase
            +
            +
            +
            Direct Known Subclasses:
            HBaseMetaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public abstract class KijiMetaTable
            extends Object
            implements Closeable, KijiTableLayoutDatabase, KijiTableKeyValueDatabase
            + + +

            +The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis. +

            + +

            +

            +
            See Also:
            KijiSchemaTable, +KijiSystemTable
            +
            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected KijiMetaTable() + +
            +          Creates a new KijiMetaTable instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +abstract  voiddeleteTable(String table) + +
            +          Remove all metadata, including layouts, for a particular table.
            +protected  voidfinalize() + +
            +          
            +abstract  voidfromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            +abstract  Map<String,TableBackup>toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.layout.KijiTableLayoutDatabase
            getTableLayout, getTableLayoutVersions, getTimedTableLayoutVersions, layoutsFromBackup, layoutsToBackup, listTables, removeAllTableLayoutVersions, removeRecentTableLayoutVersions, updateTableLayout
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiTableKeyValueDatabase
            getTimedValues, getValue, getValues, keySet, keyValuesFromBackup, keyValuesToBackup, putValue, removeAllValues, removeValues, tableSet
            +  +

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

            +KijiMetaTable

            +
            +protected KijiMetaTable()
            +
            +
            Creates a new KijiMetaTable instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +deleteTable

            +
            +public abstract void deleteTable(String table)
+                          throws IOException
            +
            +
            Remove all metadata, including layouts, for a particular table. +

            +

            +
            +
            +
            +
            Parameters:
            table - The name of the kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +toBackup

            +
            +public abstract Map<String,TableBackup> toBackup()
+                                          throws IOException
            +
            +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            +
            +
            + +
            Returns:
            A map from table names to TableBackup records. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public abstract void fromBackup(Map<String,TableBackup> backup)
+                         throws IOException
            +
            +
            Restores metadata from a backup record. This consists of table layouts, schemas, and user + defined key-value pairs. +

            +

            +
            +
            +
            +
            Parameters:
            backup - A map from table name to table backup record. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiNotInstalledException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiNotInstalledException.html new file mode 100644 index 00000000..573c4e1f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiNotInstalledException.html @@ -0,0 +1,284 @@ + + + + + + + +KijiNotInstalledException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiNotInstalledException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiNotInstalledException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiNotInstalledException
            extends RuntimeException
            + + +

            +Thrown when attempting to open a non existing/not installed Kiji instance. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiNotInstalledException(String message, + String instanceName) + +
            +          Creates a new KijiNotInstalledException with the specified + detail message.
            +  + + + + + + + + + + + +
            +Method Summary
            + StringgetInstanceName() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiNotInstalledException

            +
            +public KijiNotInstalledException(String message,
+                                 String instanceName)
            +
            +
            Creates a new KijiNotInstalledException with the specified + detail message. +

            +

            +
            Parameters:
            message - The exception message.
            instanceName - the Kiji instance name that is not installed.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getInstanceName

            +
            +public String getInstanceName()
            +
            +
            + +
            Returns:
            the name of the missing Kiji instance.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiPager.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiPager.html new file mode 100644 index 00000000..0f165ef1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiPager.html @@ -0,0 +1,273 @@ + + + + + + + +KijiPager (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiPager

            +
            +
            All Superinterfaces:
            Closeable, Iterator<KijiRowData>
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiPager
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiPager
            extends Iterator<KijiRowData>, Closeable
            + + +

            +

            Manages retrieving pages of values from a column in a Kiji table. This is useful when you + are requesting a large number of values from a column.

            + +

            To get a KijiPager, first configure the default page size for the column on the corresponding + KijiDataRequest.Column. Then call KijiRowData.getPager(java.lang.String) on the + the KijiRowData constructed with your data request

            + +

            For example, you could request two versions per page, and a maximum of 5 versions for the + whole request: + + 

            +  KijiDataRequestBuilder builder = KijiDataRequest.builder();
+  builder.newColumnsDef().withMaxVersions(5).withPageSize(2).add("info", "name");
+  final KijiDataRequest dataRequest = builder.build();
+
            +

            + +

            + The row data constructed using this data request may then be used to retrieve a pager and + process results: + 

            +  KijiPager pager = myRowData.getPager("info", "name");
+  while(pager.hasNext()) {
+    final NavigableMap resultMap = pager.next().getValues("info", "name");
+    ...
+ }
+
            +

            +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + KijiRowDatanext(int pageSize) + +
            +          Gets the next page of results, with specified page size, for a column or family.
            +  + + + + + + + +
            Methods inherited from interface java.util.Iterator
            hasNext, next, remove
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +next

            +
            +KijiRowData next(int pageSize)
            +
            +
            Gets the next page of results, with specified page size, for a column or family. The + KijiRowData returned may potentially have no values. This method does not throw a + NoSuchElementException. +

            +

            +
            +
            +
            +
            Parameters:
            pageSize - The number of cells to retrieve for this page. +
            Returns:
            The HBase result containing the next page of data, or an empty KijiRowData + if there is no more data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiPutter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiPutter.html new file mode 100644 index 00000000..07f540db --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiPutter.html @@ -0,0 +1,316 @@ + + + + + + + +KijiPutter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiPutter

            +
            +
            All Superinterfaces:
            Closeable, Flushable
            +
            +
            +
            All Known Subinterfaces:
            KijiTableWriter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiPutter
            extends Closeable, Flushable
            + + +

            +Interface for performing puts on a Kiji table. + +

            + KijiPutter provides methods for putting values into cells given an entity id, + column family, column qualifier, and optional timestamp, along with the value to put. + If a timestamp is not specified, the current system time should be used for the put. +

            + 
            +   final KijiPutter putter = myKijiTable.openTableWriter();
+   putter.put(entityId, columnFamily, columnQualifier, timestamp, value);
+   putter.put(entityId, columnFamily, columnQualifier, value);
+
            + + This interface is not used alone but is bundled within KijiTableWriter. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +put

            +
            +<T> void put(EntityId entityId,
+             String family,
+             String qualifier,
+             T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +put

            +
            +<T> void put(EntityId entityId,
+             String family,
+             String qualifier,
+             long timestamp,
+             T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            timestamp - Timestamp, in millisecond since the Epoch.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRegion.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRegion.html new file mode 100644 index 00000000..b9b4a869 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRegion.html @@ -0,0 +1,261 @@ + + + + + + + +KijiRegion (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiRegion

            +
            +
            +
            @ApiAudience.Public
+public interface KijiRegion
            + + +

            +A KijiRegion specifies a logical region in a Kiji Table, bounded by + a start key (inclusive) and an end key (exclusive). +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]getEndKey() + +
            +          Gets the end key (exclusive) of this region.
            + Collection<String>getLocations() + +
            +          Gets the locations of this region in hostname:port form, if available.
            + byte[]getStartKey() + +
            +          Gets the start key (inclusive) of this region.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getStartKey

            +
            +byte[] getStartKey()
            +
            +
            Gets the start key (inclusive) of this region. +

            +

            + +
            Returns:
            The start key (inclusive) of this region.
            +
            +
            +
            + +

            +getEndKey

            +
            +byte[] getEndKey()
            +
            +
            Gets the end key (exclusive) of this region. +

            +

            + +
            Returns:
            The end key (exclusive) of this region.
            +
            +
            +
            + +

            +getLocations

            +
            +Collection<String> getLocations()
            +
            +
            Gets the locations of this region in hostname:port form, if available. + The collection is empty if no location information is available. +

            +

            + +
            Returns:
            The locations of this region; empty if no location information is available.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRowData.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRowData.html new file mode 100644 index 00000000..ed34067e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRowData.html @@ -0,0 +1,832 @@ + + + + + + + +KijiRowData (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiRowData

            +
            +
            All Known Implementing Classes:
            HBaseKijiRowData
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiRowData
            + + +

            +KijiRowData provides a way for applications to access data read from a Kiji table. + KijiRowData objects contain a subset of the cells contained within a row in + a Kiji table. This subset is often determined by a KijiDataRequest object + that must be provided before a read operation. + +

            + KijiRowData objects should not be constructed directly, but rather should be + obtained from a read operation. KijiRowData objects can be obtained by using a + KijiTableReader, KijiRowScanner, or KijiPager. +

            + +

            Reading cells

            +

            + Rows read from a Kiji table may contain multiple cells from multiple columns. To read the + value from a particular column: +

            + 
            +   
+     final KijiRowData row = myTableReader.get(myEntityId, myDataRequest);
+
+     // Read the value stored in the column named 'info:name' with a timestamp of 42.
+     final String name = row.getValue("info", "name", 42L);
+   
+
            +

            + We also provide additional methods for accessing data stored withing a row. See the + documentation below for methods with the name 'get*' for more information. +

            + +

            Checking for existence of cells

            +

            + Since rows within a Kiji table may not contain all the columns defined within a layout + we need a way to check this in code. KijiRowData contains several methods to help with + this: +

            + 
            +   
+     final KijiRowData row = myTableReader.get(myEntityId, myDataRequest);
+     if (row.containsColumn("info", "name")) {
+       // Now that we know the cell exists, read the value.
+       final String name = row.getMostRecentValue("info", "name");
+     }
+
+     if (row.containsCell("info", "name", 42L)) {
+       // Now that we know that this cell exists at the timestamp of 42.
+       final String name = row.getValue("info", "name", 42L);
+     }
+   
+
            + +

            Dealing with large rows

            +

            + Rows in Kiji tables may contain large amounts of data. In some cases, this is caused by + storing many versions of a cell with different timestamps in a row. This can become a + problem when the size of a row/cell exceeds the amount of RAM available. To deal with + this, KijiPagers can be used. See the documentation for KijiPager for + more information. +

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleancontainsCell(String family, + String qualifier, + long timestamp) + +
            +          Determines whether a particular column has data in this row with the specified timestamp.
            + booleancontainsColumn(String family) + +
            +          Determines whether a particular column family has data in this row.
            + booleancontainsColumn(String family, + String qualifier) + +
            +          Determines whether a particular column has data in this row.
            + + + + + +
            +<T> KijiCell<T>
            +            		getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		getCells(String family) + +
            +          Gets all cells stored within the specified column family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		getCells(String family, + String qualifier) + +
            +          Gets all cells stored within the specified column.
            + EntityIdgetEntityId() + +
            +          Gets the entity id for this row.
            + + + + + +
            +<T> KijiCell<T>
            +            		getMostRecentCell(String family, + String qualifier) + +
            +          Gets the cell in the specified column with the latest timestamp.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		getMostRecentCells(String family) + +
            +          Gets the cells in the specified column family flattened to contain only the cells with + the latest timestamp in each column.
            + + + + + +
            +<T> T
            +            		getMostRecentValue(String family, + String qualifier) + +
            +          Gets the data stored within the specified column with the latest timestamp.
            + + + + + +
            +<T> NavigableMap<String,T>
            +            		getMostRecentValues(String family) + +
            +          Gets all data stored within the specified column family flattened to contain only + the data with the latest timestamps in each column.
            + KijiPagergetPager(String family) + +
            +          Gets a KijiPager for the specified column family.
            + KijiPagergetPager(String family, + String qualifier) + +
            +          Gets a KijiPager for the specified column.
            + NavigableSet<String>getQualifiers(String family) + +
            +          Gets the set of column qualifiers that exist in a column family in this row.
            + org.apache.avro.SchemagetReaderSchema(String family, + String qualifier) + +
            +          Gets the reader schema for a column as declared in the layout of the table this row + comes from.
            + NavigableSet<Long>getTimestamps(String family, + String qualifier) + +
            +          Gets the set of timestamps on cells that exist in a column.
            + + + + + +
            +<T> T
            +            		getValue(String family, + String qualifier, + long timestamp) + +
            +          Gets the data stored within the specified column with the specified timestamp.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,T>>
            +            		getValues(String family) + +
            +          Gets all data stored within the specified column family.
            + + + + + +
            +<T> NavigableMap<Long,T>
            +            		getValues(String family, + String qualifier) + +
            +          Gets all data stored within the specified column.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEntityId

            +
            +EntityId getEntityId()
            +
            +
            Gets the entity id for this row. +

            +

            + +
            Returns:
            The row key.
            +
            +
            +
            + +

            +containsColumn

            +
            +boolean containsColumn(String family,
+                       String qualifier)
            +
            +
            Determines whether a particular column has data in this row. +

            +

            +
            Parameters:
            family - Column family of the column to check for.
            qualifier - Column qualifier of the column to check for. +
            Returns:
            Whether the specified column has data in this row.
            +
            +
            +
            + +

            +containsColumn

            +
            +boolean containsColumn(String family)
            +
            +
            Determines whether a particular column family has data in this row. +

            +

            +
            Parameters:
            family - Column family to check for. +
            Returns:
            Whether the specified column family has data in this row.
            +
            +
            +
            + +

            +containsCell

            +
            +boolean containsCell(String family,
+                     String qualifier,
+                     long timestamp)
            +
            +
            Determines whether a particular column has data in this row with the specified timestamp. +

            +

            +
            Parameters:
            family - Column family of the column to check for.
            qualifier - Column qualifier of the column to check for.
            timestamp - Timestamp of the value to check for. +
            Returns:
            Whether the specified column has data in this row with the specified timestamp.
            +
            +
            +
            + +

            +getQualifiers

            +
            +NavigableSet<String> getQualifiers(String family)
            +
            +
            Gets the set of column qualifiers that exist in a column family in this row. +

            +

            +
            Parameters:
            family - Column family to get column qualifiers from. +
            Returns:
            Set of column qualifiers that exist in the family column family.
            +
            +
            +
            + +

            +getTimestamps

            +
            +NavigableSet<Long> getTimestamps(String family,
+                                 String qualifier)
            +
            +
            Gets the set of timestamps on cells that exist in a column. + +

            + If iterating over the set, you will get timestamps in descending order. +

            +

            +

            +
            Parameters:
            family - Column family of the column to get timestamps from.
            qualifier - Column qualifier of the column to get timestamps from. +
            Returns:
            Set of all timestamps of cells in the family:qualifier column + in this row in descending order.
            +
            +
            +
            + +

            +getReaderSchema

            +
            +org.apache.avro.Schema getReaderSchema(String family,
+                                       String qualifier)
+                                       throws IOException
            +
            +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +

            +

            +
            Parameters:
            family - Column family of the desired column schema.
            qualifier - Column qualifier of the desired column schema. +
            Returns:
            Avro reader schema for the column. +
            Throws: +
            IOException - If there is an error or the column does not exist.
            See Also:
            KijiTableLayout
            +
            +
            +
            + +

            +getValue

            +
            +<T> T getValue(String family,
+               String qualifier,
+               long timestamp)
+           throws IOException
            +
            +
            Gets the data stored within the specified column with the specified timestamp. +

            +

            +
            Type Parameters:
            T - Type of the data stored at the specified coordinates.
            Parameters:
            family - Column family of the desired data.
            qualifier - Column qualifier of the desired data.
            timestamp - Timestamp of the desired data. +
            Returns:
            Data contained in the specified column with the specified timestamp, or null + if the column or timestamp does not exist in this row. Note: this method does not + distinguish between Avro encoded nulls and non-existant cells. Use + containsColumn(String, String) to distinguish between these scenarios. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValue

            +
            +<T> T getMostRecentValue(String family,
+                         String qualifier)
+                     throws IOException
            +
            +
            Gets the data stored within the specified column with the latest timestamp. +

            +

            +
            Type Parameters:
            T - Type of the data stored at the specified coordinates.
            Parameters:
            family - Column family of the desired data.
            qualifier - Column qualifier of the desired data. +
            Returns:
            Data contained in the specified column with the latest timestamp, or null + if the column does not exist in this row. Note: this method does not distinguish + between Avro encoded nulls and non-existant cells. Use + containsColumn(String, String) to distinguish between these scenarios. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValues

            +
            +<T> NavigableMap<String,T> getMostRecentValues(String family)
+                                           throws IOException
            +
            +
            Gets all data stored within the specified column family flattened to contain only + the data with the latest timestamps in each column. +

            +

            +
            Type Parameters:
            T - Type of the data stored at the specified coordinates.
            Parameters:
            family - Column family of the desired data. +
            Returns:
            Data contained in the specified column family flattened to contain only the + data with the latest timestamps in each column. Note: this method does not distinguish + between Avro encoded nulls and non-existant cells. Use + containsColumn(String, String) to distinguish between these scenarios. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +<T> NavigableMap<String,NavigableMap<Long,T>> getValues(String family)
+                                                    throws IOException
            +
            +
            Gets all data stored within the specified column family. +

            +

            +
            Type Parameters:
            T - Type of the data stored at the specified coordinates.
            Parameters:
            family - Column family of the desired data. +
            Returns:
            A sorted map containing the data stored in the specified column family. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +<T> NavigableMap<Long,T> getValues(String family,
+                                   String qualifier)
+                               throws IOException
            +
            +
            Gets all data stored within the specified column. +

            +

            +
            Type Parameters:
            T - Type of the data stored at the specified coordinates.
            Parameters:
            family - Column family of the desired data.
            qualifier - Column qualifier of the desired data. +
            Returns:
            A sorted map containing the data stored in the specified column. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCell

            +
            +<T> KijiCell<T> getCell(String family,
+                        String qualifier,
+                        long timestamp)
+                    throws IOException
            +
            +
            Gets the specified cell. +

            +

            +
            Type Parameters:
            T - Type of the cell stored at the specified coordinates.
            Parameters:
            family - Column family of the desired cell.
            qualifier - Column qualifier of the desired cell.
            timestamp - Timestamp of the desired cell. +
            Returns:
            Specified cell, or null if the cell does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCell

            +
            +<T> KijiCell<T> getMostRecentCell(String family,
+                                  String qualifier)
+                              throws IOException
            +
            +
            Gets the cell in the specified column with the latest timestamp. +

            +

            +
            Type Parameters:
            T - Type of the cell stored at the specified coordinates.
            Parameters:
            family - Column family of the desired cell.
            qualifier - Column qualifier of the desired cell. +
            Returns:
            Cell in the specified column with the latest timestamp, or null if the cell + does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCells

            +
            +<T> NavigableMap<String,KijiCell<T>> getMostRecentCells(String family)
+                                                    throws IOException
            +
            +
            Gets the cells in the specified column family flattened to contain only the cells with + the latest timestamp in each column. +

            +

            +
            Type Parameters:
            T - Type of the cells stored at the specified coordinates.
            Parameters:
            family - Column family of the desired cells. +
            Returns:
            Map from column qualifier to the most recent versions of the cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>> getCells(String family)
+                                                             throws IOException
            +
            +
            Gets all cells stored within the specified column family. +

            +

            +
            Type Parameters:
            T - Type of the cells stored at the specified coordinates.
            Parameters:
            family - Column family of the desired cells. +
            Returns:
            Sorted map versions of the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +<T> NavigableMap<Long,KijiCell<T>> getCells(String family,
+                                            String qualifier)
+                                        throws IOException
            +
            +
            Gets all cells stored within the specified column. +

            +

            +
            Type Parameters:
            T - Type of the cells stored at the specified coordinates.
            Parameters:
            family - Column family of the desired cells.
            qualifier - Column qualifier of the desired cells. +
            Returns:
            A sorted map containing the cells stored in the specified column. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getPager

            +
            +KijiPager getPager(String family,
+                   String qualifier)
+                   throws KijiColumnPagingNotEnabledException
            +
            +
            Gets a KijiPager for the specified column. +

            +

            +
            Parameters:
            family - Desired column family.
            qualifier - Desired column qualifier. +
            Returns:
            A pager for the specified column. +
            Throws: +
            KijiColumnPagingNotEnabledException - If paging is not enabled for the + specified column.
            See Also:
            For more information about paging.
            +
            +
            +
            + +

            +getPager

            +
            +KijiPager getPager(String family)
+                   throws KijiColumnPagingNotEnabledException
            +
            +
            Gets a KijiPager for the specified column family. +

            +

            +
            Parameters:
            family - Desired column family. +
            Returns:
            A pager for the specified column. +
            Throws: +
            KijiColumnPagingNotEnabledException - If paging is not enabled for the + specified column family.
            See Also:
            For more information about paging.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRowKeySplitter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRowKeySplitter.html new file mode 100644 index 00000000..53e305d4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRowKeySplitter.html @@ -0,0 +1,267 @@ + + + + + + + +KijiRowKeySplitter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiRowKeySplitter

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiRowKeySplitter
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiRowKeySplitter
            extends Object
            + + +

            +Utility class for splitting the Kiji row key space. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static intHBASE_ROW_KEY_RESOLUTION + +
            +          Resolution (in number of bytes) when generating evenly spaced HBase row keys.
            +  + + + + + + + + + + + +
            +Method Summary
            +static byte[][]getSplitKeys(int numRegions) + +
            +          Returns the split keys for the given number of regions.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +HBASE_ROW_KEY_RESOLUTION

            +
            +public static final int HBASE_ROW_KEY_RESOLUTION
            +
            +
            Resolution (in number of bytes) when generating evenly spaced HBase row keys. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getSplitKeys

            +
            +public static byte[][] getSplitKeys(int numRegions)
            +
            +
            Returns the split keys for the given number of regions. This assumes that the keys are + byte strings of size HBASE_ROW_KEY_RESOLUTION. +

            +

            +
            Parameters:
            numRegions - The number of desired regions. +
            Returns:
            The row keys that serve as the boundaries between the regions.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRowScanner.html new file mode 100644 index 00000000..b5fdeb87 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiRowScanner.html @@ -0,0 +1,254 @@ + + + + + + + +KijiRowScanner (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiRowScanner

            +
            +
            All Superinterfaces:
            Closeable, Iterable<KijiRowData>
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiRowScanner
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiRowScanner
            extends Closeable, Iterable<KijiRowData>
            + + +

            +Interface for scanning over rows read from a Kiji table. + +

            Because this class implements the Iterable interface, you can write code like this: + + 

            +   KijiRowScanner scanner = tableReader.getScanner(...);
+   try {
+     for (KijiRowData row : scanner) {
+       process(row);
+     }
+   } finally {
+     // Don't forget to close it!
+     scanner.close();
+   }
+
            +

            +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Closes this scanner and releases any system resources associated with it.
            +  + + + + + + + +
            Methods inherited from interface java.lang.Iterable
            iterator
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +close

            +
            +void close()
+           throws IOException
            +
            +
            Closes this scanner and releases any system resources associated with it. + +

            Calling this method when you are finished with the scanner is important. + See http://hbase.apache.org/book.html#perf.hbase.client.scannerclose for details.

            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException - If an I/O error occurs.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiSchemaTable.SchemaEntry.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiSchemaTable.SchemaEntry.html new file mode 100644 index 00000000..c1eb3358 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiSchemaTable.SchemaEntry.html @@ -0,0 +1,382 @@ + + + + + + + +KijiSchemaTable.SchemaEntry (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiSchemaTable.SchemaEntry

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSchemaTable.SchemaEntry
+
            +
            +
            Enclosing class:
            KijiSchemaTable
            +
            +
            +
            +
            public static class KijiSchemaTable.SchemaEntry
            extends Object
            + + +

            +Association between a schema and its ID. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiSchemaTable.SchemaEntry(long id, + BytesKey hash, + org.apache.avro.Schema schema) + +
            +          Creates a new schema entry.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            + BytesKeygetHash() + +
            +           
            + longgetId() + +
            +           
            + org.apache.avro.SchemagetSchema() + +
            +           
            + inthashCode() + +
            +          
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiSchemaTable.SchemaEntry

            +
            +@ApiAudience.Private
+public KijiSchemaTable.SchemaEntry(long id,
+                                                       BytesKey hash,
+                                                       org.apache.avro.Schema schema)
            +
            +
            Creates a new schema entry. +

            +

            +
            Parameters:
            id - the schema ID
            hash - the schema hash
            schema - the Avro schema object
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public long getId()
            +
            +
            + +
            Returns:
            the schema ID
            +
            +
            +
            + +

            +getHash

            +
            +public BytesKey getHash()
            +
            +
            + +
            Returns:
            the schema hash
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            + +
            Returns:
            the Avro schema object
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiSchemaTable.html new file mode 100644 index 00000000..07cc0d11 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiSchemaTable.html @@ -0,0 +1,550 @@ + + + + + + + +KijiSchemaTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiSchemaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSchemaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Direct Known Subclasses:
            HBaseSchemaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public abstract class KijiSchemaTable
            extends Object
            implements Closeable
            + + +

            +The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas. +

            + +

            +

            +
            See Also:
            KijiMetaTable, +KijiSystemTable
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiSchemaTable.SchemaEntry + +
            +          Association between a schema and its ID.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiSchemaTable() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  voidclose() + +
            +          Flushes and closes the KijiSchemaTable.
            + voidflush() + +
            +          Commits any pending additions to the schema table.
            +abstract  voidfromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            +abstract  BytesKeygetOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            +abstract  longgetOrCreateSchemaId(org.apache.avro.Schema schema) + +
            +          Looks up a schema ID given an Avro schema object.
            +abstract  org.apache.avro.SchemagetSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            +abstract  org.apache.avro.SchemagetSchema(long schemaId) + +
            +          Looks up a schema given an ID.
            + BytesKeygetSchemaHash(org.apache.avro.Schema schema) + +
            +          Computes a schema hash.
            +static byte[]hashSchema(org.apache.avro.Schema schema) + +
            +          Computes a hash of the specified Avro schema.
            +abstract  List<SchemaTableEntry>toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiSchemaTable

            +
            +public KijiSchemaTable()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getOrCreateSchemaId

            +
            +public abstract long getOrCreateSchemaId(org.apache.avro.Schema schema)
+                                  throws IOException
            +
            +
            Looks up a schema ID given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            +
            +
            +
            Parameters:
            schema - The full schema to store in the table. +
            Returns:
            The schema ID. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getOrCreateSchemaHash

            +
            +public abstract BytesKey getOrCreateSchemaHash(org.apache.avro.Schema schema)
+                                        throws IOException
            +
            +
            Looks up a schema hash given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            +
            +
            +
            Parameters:
            schema - Avro schema to look up. +
            Returns:
            The schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getSchemaHash

            +
            +public BytesKey getSchemaHash(org.apache.avro.Schema schema)
            +
            +
            Computes a schema hash. +

            +

            +
            +
            +
            +
            Parameters:
            schema - Avro schema to compute a hash for. +
            Returns:
            Schema hash.
            +
            +
            +
            + +

            +getSchema

            +
            +public abstract org.apache.avro.Schema getSchema(long schemaId)
+                                          throws IOException
            +
            +
            Looks up a schema given an ID. +

            +

            +
            +
            +
            +
            Parameters:
            schemaId - Schema ID to look up. +
            Returns:
            Avro schema, or null if the schema ID is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getSchema

            +
            +public abstract org.apache.avro.Schema getSchema(BytesKey schemaHash)
+                                          throws IOException
            +
            +
            Looks up a schema given a hash. +

            +

            +
            +
            +
            +
            Parameters:
            schemaHash - Schema hash to look up. +
            Returns:
            Avro schema, or null if the schema hash is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +hashSchema

            +
            +public static final byte[] hashSchema(org.apache.avro.Schema schema)
            +
            +
            Computes a hash of the specified Avro schema. + + Kiji currently uses MD5 sums (128 bits) of the schema JSON representation. +

            +

            +
            +
            +
            +
            Parameters:
            schema - Avro schema to compute a hash of. +
            Returns:
            Hash code as an array of bytes (16 bytes).
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            Commits any pending additions to the schema table. + + Default implementation is blank as flushing is not generally a vital operation +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +close

            +
            +public abstract void close()
+                    throws IOException
            +
            +
            Flushes and closes the KijiSchemaTable. No other methods may be called after this. +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +toBackup

            +
            +public abstract List<SchemaTableEntry> toBackup()
+                                         throws IOException
            +
            +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            +
            +
            + +
            Returns:
            A list of schema table entries. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public abstract void fromBackup(List<SchemaTableEntry> backup)
+                         throws IOException
            +
            +
            Restores the schema entries from the specified backup record. +

            +

            +
            +
            +
            +
            Parameters:
            backup - The schema entries from a MetadataBackup record. This consist of the schema + definition, schema id, and schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiSystemTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiSystemTable.html new file mode 100644 index 00000000..7ef18627 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiSystemTable.html @@ -0,0 +1,375 @@ + + + + + + + +KijiSystemTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiSystemTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSystemTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Direct Known Subclasses:
            HBaseSystemTable
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public abstract class KijiSystemTable
            extends Object
            implements Closeable
            + + +

            +The Kiji system table, which stores system information such as the version, ready state, and + locks. +

            + +

            +

            +
            See Also:
            KijiMetaTable, +KijiSystemTable
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiSystemTable() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  ProtocolVersiongetDataVersion() + +
            +          Gets the version of kiji installed.
            +abstract  byte[]getValue(String key) + +
            +          Gets the value associated with a property key.
            +abstract  voidputValue(String key, + byte[] value) + +
            +          Sets a value for a property key, which creates it if it doesn't exist.
            +abstract  voidsetDataVersion(ProtocolVersion version) + +
            +          Sets the version of kiji installed.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

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

            +KijiSystemTable

            +
            +public KijiSystemTable()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataVersion

            +
            +public abstract ProtocolVersion getDataVersion()
+                                        throws IOException
            +
            +
            Gets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            +
            +
            + +
            Returns:
            the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +setDataVersion

            +
            +public abstract void setDataVersion(ProtocolVersion version)
+                             throws IOException
            +
            +
            Sets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            +
            +
            +
            Parameters:
            version - the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValue

            +
            +public abstract byte[] getValue(String key)
+                         throws IOException
            +
            +
            Gets the value associated with a property key. +

            +

            +
            +
            +
            +
            Parameters:
            key - The property key to look up. +
            Returns:
            The value in the system table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public abstract void putValue(String key,
+                              byte[] value)
+                       throws IOException
            +
            +
            Sets a value for a property key, which creates it if it doesn't exist. +

            +

            +
            +
            +
            +
            Parameters:
            key - The property key to set.
            value - The value of the property. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTable.html new file mode 100644 index 00000000..5e3cb5f6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTable.html @@ -0,0 +1,476 @@ + + + + + + + +KijiTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTable

            +
            +
            All Superinterfaces:
            Closeable
            +
            +
            +
            All Known Implementing Classes:
            AbstractKijiTable, HBaseKijiTable
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiTable
            extends Closeable
            + + +

            +The KijiTable interface provides operations on KijiTables. To perform reads to and + writes from a Kiji table use a KijiTableReader or KijiTableWriter. + Instances of these classes can be obtained by using the openTableReader() + and openTableWriter() methods. EntityIds, which identify particular + rows within a Kiji table are also generated from its components. + +

            KijiTable instance lifecycle:

            +

            + To open a connection to a KijiTable, use KijiTableFactory.openTable(String). A KijiTable + contains an open connection to an HBase cluster. Because of this, KijiTable objects + must be closed using Closeable.close() when finished using it: +

            + 
            +   
+     final KijiTable table = myKiji.openTable("tableName");
+     // Do some magic
+     table.close();
+   
+
            + +

            Reading & Writing from a KijiTable:

            +

            + The KijiTable interface does not directly provide methods to perform I/O on a Kiji + table. Read and write operations can be performed using either a KijiTableReader + or a KijiTableWriter: +

            + 
            +   
+     final KijiTable table = myKiji.openTable("tableName");
+
+     final EntityId myId = table.getEntityId("myRowKey");
+
+     final KijiTableReader reader = table.openTableReader();
+     final KijiTableWriter writer = table.openTableWriter();
+
+     // Read some data from a Kiji table using an existing EntityId and KijiDataRequest.
+     final KijiRowData row = reader.get(myId, myDataRequest);
+
+     // Do things with the row...
+
+     // Write some data to a new column in the same row.
+     writer.put(myId, "info", "newcolumn", "newvalue");
+
+     // Close open connections.
+     reader.close();
+     writer.close();
+     table.close();
+   
+
            +

            + +

            +

            +
            See Also:
            for more information about reading data from a Kiji table., +for more information about writing data to a Kiji table., +for more information about identifying rows with entity ids., +for more information about opening a KijiTable instance.
            +
            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + EntityIdgetEntityId(Object... kijiRowKey) + +
            +          Creates an entity id from a list of components.
            + KijigetKiji() + +
            +           
            + KijiTableLayoutgetLayout() + +
            +           
            + StringgetName() + +
            +           
            + List<KijiRegion>getRegions() + +
            +          Return the regions in this table as an ordered list.
            + KijiURIgetURI() + +
            +           
            + KijiTableReaderopenTableReader() + +
            +          Opens a KijiTableReader for this table.
            + KijiTableWriteropenTableWriter() + +
            +          Opens a KijiTableWriter for this table.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getKiji

            +
            +Kiji getKiji()
            +
            +
            +
            +
            +
            + +
            Returns:
            the Kiji instance this table belongs to.
            +
            +
            +
            + +

            +getName

            +
            +String getName()
            +
            +
            +
            +
            +
            + +
            Returns:
            the name of this table.
            +
            +
            +
            + +

            +getURI

            +
            +KijiURI getURI()
            +
            +
            +
            +
            +
            + +
            Returns:
            the URI for this table, trimmed at the table path component.
            +
            +
            +
            + +

            +getLayout

            +
            +KijiTableLayout getLayout()
            +
            +
            +
            +
            +
            + +
            Returns:
            the layout of this table.
            +
            +
            +
            + +

            +getEntityId

            +
            +EntityId getEntityId(Object... kijiRowKey)
            +
            +
            Creates an entity id from a list of components. +

            +

            +
            +
            +
            +
            Parameters:
            kijiRowKey - This can be one of the following depending on row key encoding: +
              +
            • + Raw, Hash, Hash-Prefix EntityId: A single String or byte array + component. +
              • +
            • + Formatted EntityId: The primitive row key components (string, int, + long) either passed in their expected order in the key or as an ordered + list of components. +
              • +
            +
            Returns:
            a new EntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +openTableReader

            +
            +KijiTableReader openTableReader()
+                                throws IOException
            +
            +
            Opens a KijiTableReader for this table. The caller of this method is responsible + for closing the returned reader. +

            +

            +
            +
            +
            + +
            Returns:
            A KijiTableReader for this table. +
            Throws: +
            IOException - If there is an error opening the reader.
            +
            +
            +
            + +

            +openTableWriter

            +
            +KijiTableWriter openTableWriter()
+                                throws IOException
            +
            +
            Opens a KijiTableWriter for this table. The caller of this method is responsible + for closing the returned writer. +

            +

            +
            +
            +
            + +
            Returns:
            A KijiTableWriter for this table. +
            Throws: +
            IOException - If there is an error opening the writer.
            +
            +
            +
            + +

            +getRegions

            +
            +List<KijiRegion> getRegions()
+                            throws IOException
            +
            +
            Return the regions in this table as an ordered list. +

            +

            +
            +
            +
            + +
            Returns:
            An ordered list of the table regions. +
            Throws: +
            IOException - If there is an error retrieving the regions of this table.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableFactory.html new file mode 100644 index 00000000..6cbb908b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableFactory.html @@ -0,0 +1,227 @@ + + + + + + + +KijiTableFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableFactory

            +
            +
            All Known Subinterfaces:
            Kiji
            +
            +
            +
            All Known Implementing Classes:
            DefaultKijiTableFactory, HBaseKiji
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiTableFactory
            + + +

            +Factory for KijiTable instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + KijiTableopenTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +openTable

            +
            +KijiTable openTable(String tableName)
+                    throws IOException
            +
            +
            Opens a KijiTable by name. + +

            Clients must take care to close the KijiTable instance when finished.

            +

            +

            +
            Parameters:
            tableName - Name of the table to open. +
            Returns:
            the opened Kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableKeyValueDatabase.html new file mode 100644 index 00000000..3ccb6069 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableKeyValueDatabase.html @@ -0,0 +1,474 @@ + + + + + + + +KijiTableKeyValueDatabase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableKeyValueDatabase

            +
            +
            All Known Implementing Classes:
            HBaseMetaTable, HBaseTableKeyValueDatabase, KijiMetaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiTableKeyValueDatabase
            + + +

            +A database of per table key-value pairs. This is used to store meta data (in the form of + key-value pairs) on a per table basis. +

            + +

            +

            +
            See Also:
            KijiMetaTable
            +
            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + NavigableMap<Long,byte[]>getTimedValues(String table, + String key, + int numVersions) + +
            +          Returns a map of values associated with the specified table and key.
            + byte[]getValue(String table, + String key) + +
            +          Returns the most recent value associated with the specified table and key.
            + List<byte[]>getValues(String table, + String key, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key.
            + Set<String>keySet(String table) + +
            +          Returns a set view of keys contained in the map for the specified table.
            + voidkeyValuesFromBackup(String table, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            + List<KeyValueBackupEntry>keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + KijiTableKeyValueDatabaseputValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + voidremoveAllValues(String table) + +
            +          Deletes all key-value pairs associated with the specified table.
            + voidremoveValues(String table, + String key) + +
            +          Removes all values associated with the specified table and key.
            + Set<String>tableSet() + +
            +          Returns a set view of the tables that have key-value pairs defined.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +putValue

            +
            +KijiTableKeyValueDatabase putValue(String table,
+                                   String key,
+                                   byte[] value)
+                                   throws IOException
            +
            +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +

            +

            +
            Parameters:
            table - The kiji table that this key-value pair will be set with.
            key - The key to associate with the specified value.
            value - The value to associate with the specified key. +
            Returns:
            The same KijiTableKeyValueDatabase. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValue

            +
            +byte[] getValue(String table,
+                String key)
+                throws IOException
            +
            +
            Returns the most recent value associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for. +
            Returns:
            The value in the meta table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +List<byte[]> getValues(String table,
+                       String key,
+                       int numVersions)
+                       throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +

            +

            +
            Parameters:
            table - The Kiji table.
            key - The key to look up associated values for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the values for the specified table and key, + sorted by most-recent-first. If there are no values, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedValues

            +
            +NavigableMap<Long,byte[]> getTimedValues(String table,
+                                         String key,
+                                         int numVersions)
+                                         throws IOException
            +
            +
            Returns a map of values associated with the specified table and key. The Map + is keyed by timestamp. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values that are the user defined values for the specified key + and table, and keys that correspond to timestamps, ordered from newest to oldest. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeValues

            +
            +void removeValues(String table,
+                  String key)
+                  throws IOException
            +
            +
            Removes all values associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table associated with the metadata.
            key - The metadata key to look up. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllValues

            +
            +void removeAllValues(String table)
+                     throws IOException
            +
            +
            Deletes all key-value pairs associated with the specified table. +

            +

            +
            Parameters:
            table - The table to delete remove key-value pairs for. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keySet

            +
            +Set<String> keySet(String table)
+                   throws IOException
            +
            +
            Returns a set view of keys contained in the map for the specified table. +

            +

            +
            Parameters:
            table - The table to look up in use keys for. +
            Returns:
            A navigable set of keys used to store meta information for a given table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +tableSet

            +
            +Set<String> tableSet()
+                     throws IOException
            +
            +
            Returns a set view of the tables that have key-value pairs defined. +

            +

            + +
            Returns:
            A set of tables that have key-value pairs defined. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesToBackup

            +
            +List<KeyValueBackupEntry> keyValuesToBackup(String table)
+                                            throws IOException
            +
            +
            Gets a list of the TableKeyValueBackupEntries. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableKeyValueBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesFromBackup

            +
            +void keyValuesFromBackup(String table,
+                         List<KeyValueBackupEntry> keyValues)
+                         throws IOException
            +
            +
            Restores all table's key value history from a backup. +

            +

            +
            Parameters:
            table - The name of the kiji table.
            keyValues - The key values associated with the table to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableNotFoundException.html new file mode 100644 index 00000000..c907c156 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableNotFoundException.html @@ -0,0 +1,280 @@ + + + + + + + +KijiTableNotFoundException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTableNotFoundException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.KijiTableNotFoundException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableNotFoundException
            extends IOException
            + + +

            +Thrown when an attempt to access a table fails because it does not exist. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTableNotFoundException(String tableName) + +
            +          Creates a new KijiTableNotFoundException for the specified table.
            +  + + + + + + + + + + + +
            +Method Summary
            + StringgetTableName() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiTableNotFoundException

            +
            +public KijiTableNotFoundException(String tableName)
            +
            +
            Creates a new KijiTableNotFoundException for the specified table. +

            +

            +
            Parameters:
            tableName - The name of the table that wasn't found.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getTableName

            +
            +public String getTableName()
            +
            +
            + +
            Returns:
            the name of the missing table.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTablePool.NoCapacityException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTablePool.NoCapacityException.html new file mode 100644 index 00000000..02c6761d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTablePool.NoCapacityException.html @@ -0,0 +1,254 @@ + + + + + + + +KijiTablePool.NoCapacityException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTablePool.NoCapacityException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.KijiTablePool.NoCapacityException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Enclosing class:
            KijiTablePool
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiTablePool.NoCapacityException
            extends IOException
            + + +

            +Thrown when an attempt to get a table connection fails because there is no room in the pool. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTablePool.NoCapacityException(String message) + +
            +          Creates a new NoCapacityException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiTablePool.NoCapacityException

            +
            +public KijiTablePool.NoCapacityException(String message)
            +
            +
            Creates a new NoCapacityException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTablePool.Options.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTablePool.Options.html new file mode 100644 index 00000000..fd5e24a0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTablePool.Options.html @@ -0,0 +1,469 @@ + + + + + + + +KijiTablePool.Options (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTablePool.Options

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiTablePool.Options
+
            +
            +
            Enclosing class:
            KijiTablePool
            +
            +
            +
            +
            public static final class KijiTablePool.Options
            extends Object
            + + +

            +Describes the options that can be configured on the KijiTablePool. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTablePool.Options() + +
            +          Creates options with default values.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + ClockgetClock() + +
            +          Gets a clock.
            + longgetIdlePollPeriod() + +
            +          Gets the amount of time between sweeps of the pool for removing idle connections.
            + longgetIdleTimeout() + +
            +          Gets the amount of time a connection may be idle before being removed from the pool.
            + intgetMaxSize() + +
            +          Gets the maximum number of connections to keep per table.
            + intgetMinSize() + +
            +          Gets the minimum number of connections to keep per table.
            + KijiTablePool.OptionswithClock(Clock clock) + +
            +          Sets a clock.
            + KijiTablePool.OptionswithIdlePollPeriod(long periodMillis) + +
            +          Sets the amount of time between sweeps of the pool for removing idle connections.
            + KijiTablePool.OptionswithIdleTimeout(long timeoutMillis) + +
            +          Sets the amount of time a connection may be idle before being removed from the pool.
            + KijiTablePool.OptionswithMaxSize(int maxSize) + +
            +          Sets the maximum number of connections to keep per table.
            + KijiTablePool.OptionswithMinSize(int minSize) + +
            +          Sets the minimum number of connections to keep per table.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTablePool.Options

            +
            +public KijiTablePool.Options()
            +
            +
            Creates options with default values. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +withMinSize

            +
            +public KijiTablePool.Options withMinSize(int minSize)
            +
            +
            Sets the minimum number of connections to keep per table. + +

            Use zero(0) to indicate that the pool should be unbounded.

            +

            +

            +
            Parameters:
            minSize - The max number of connections to keep per table. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getMinSize

            +
            +public int getMinSize()
            +
            +
            Gets the minimum number of connections to keep per table. +

            +

            + +
            Returns:
            The min number of connections to keep per table.
            +
            +
            +
            + +

            +withMaxSize

            +
            +public KijiTablePool.Options withMaxSize(int maxSize)
            +
            +
            Sets the maximum number of connections to keep per table. + +

            Use zero(0) to indicate that the pool should be unbounded.

            +

            +

            +
            Parameters:
            maxSize - The max number of connections to keep per table. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getMaxSize

            +
            +public int getMaxSize()
            +
            +
            Gets the maximum number of connections to keep per table. +

            +

            + +
            Returns:
            The max number of connections to keep per table.
            +
            +
            +
            + +

            +withIdleTimeout

            +
            +public KijiTablePool.Options withIdleTimeout(long timeoutMillis)
            +
            +
            Sets the amount of time a connection may be idle before being removed from the pool. + +

            Use zero (0) to indicate that connections should never be removed.

            +

            +

            +
            Parameters:
            timeoutMillis - Timeout in milliseconds. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getIdleTimeout

            +
            +public long getIdleTimeout()
            +
            +
            Gets the amount of time a connection may be idle before being removed from the pool. +

            +

            + +
            Returns:
            The timeout in milliseconds.
            +
            +
            +
            + +

            +withIdlePollPeriod

            +
            +public KijiTablePool.Options withIdlePollPeriod(long periodMillis)
            +
            +
            Sets the amount of time between sweeps of the pool for removing idle connections. +

            +

            +
            Parameters:
            periodMillis - Number of milliseconds between sweeps. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getIdlePollPeriod

            +
            +public long getIdlePollPeriod()
            +
            +
            Gets the amount of time between sweeps of the pool for removing idle connections. +

            +

            + +
            Returns:
            Number of milliseconds between sweeps.
            +
            +
            +
            + +

            +withClock

            +
            +public KijiTablePool.Options withClock(Clock clock)
            +
            +
            Sets a clock. +

            +

            +
            Parameters:
            clock - A clock. +
            Returns:
            This options object for method chaining.
            +
            +
            +
            + +

            +getClock

            +
            +public Clock getClock()
            +
            +
            Gets a clock. +

            +

            + +
            Returns:
            A clock.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTablePool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTablePool.html new file mode 100644 index 00000000..c27be25a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTablePool.html @@ -0,0 +1,452 @@ + + + + + + + +KijiTablePool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTablePool

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiTablePool
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTablePool
            extends Object
            implements Closeable
            + + +

            +Maintains a pool of opened KijiTables. + +

            Instead of creating a new KijiTable instance when needed, clients may use a + KijiTablePool to keep a pool of opened tables for reuse. When a client asks for a + KijiTable, the pool first checks the cache for an already opened and available + table. If available, the cached table will be returned. Otherwise, a new one will be + opened and returned. When the client is finished, it should call release() to allow + other clients or threads the option to reuse the opened table.

            + +

            This class is thread-safe.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTablePool.NoCapacityException + +
            +          Thrown when an attempt to get a table connection fails because there is no room in the pool.
            +static classKijiTablePool.Options + +
            +          Describes the options that can be configured on the KijiTablePool.
            +  + + + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiTablePool(Kiji kiji) + +
            +          Constructs a new pool of Kiji tables.
            KijiTablePool(KijiTableFactory tableFactory) + +
            +          Constructs a new pool of Kiji tables.
            KijiTablePool(KijiTableFactory tableFactory, + KijiTablePool.Options options) + +
            +          Constructs a new pool of Kiji tables.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Closes the tables in the pool.
            +protected  voidfinalize() + +
            +           
            + KijiTableget(String name) + +
            +          Gets a previously opened table from the pool, or open a new connection.
            + intgetPoolSize(String tableName) + +
            +          Gets the total number of connections, active and cached, for the specified table.
            + voidrelease(KijiTable table) + +
            +          Releases a table back to the pool.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTablePool

            +
            +public KijiTablePool(Kiji kiji)
            +
            +
            Constructs a new pool of Kiji tables. +

            +

            +
            Parameters:
            kiji - The kiji instance.
            +
            +
            + +

            +KijiTablePool

            +
            +public KijiTablePool(KijiTableFactory tableFactory)
            +
            +
            Constructs a new pool of Kiji tables. +

            +

            +
            Parameters:
            tableFactory - A KijiTable factory.
            +
            +
            + +

            +KijiTablePool

            +
            +public KijiTablePool(KijiTableFactory tableFactory,
+                     KijiTablePool.Options options)
            +
            +
            Constructs a new pool of Kiji tables. +

            +

            +
            Parameters:
            tableFactory - A KijiTable factory.
            options - Configurable options for the pool.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public KijiTable get(String name)
+              throws IOException
            +
            +
            Gets a previously opened table from the pool, or open a new connection. + Clients should not call close() on the returned table. Instead, they should release the + table back to the pool when finished by passing it in call to release(). +

            +

            +
            +
            +
            +
            Parameters:
            name - The name of the Kiji table. +
            Returns:
            An opened Kiji table. +
            Throws: +
            IOException - If there is an error. +
            KijiTablePool.NoCapacityException - If the table pool is at capacity.
            +
            +
            +
            + +

            +release

            +
            +public void release(KijiTable table)
            +
            +
            Releases a table back to the pool. + +

            Only open tables that were retrieved from this pool should be released.

            +

            +

            +
            +
            +
            +
            Parameters:
            table - The table to release to the pool. If null, will be a no-op.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            Closes the tables in the pool. +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException - If there is an error closing the pool.
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +getPoolSize

            +
            +public int getPoolSize(String tableName)
            +
            +
            Gets the total number of connections, active and cached, for the specified table. +

            +

            +
            +
            +
            +
            Parameters:
            tableName - The name of the table you wish to know the pool size of. +
            Returns:
            The size of the table pool.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableReader.KijiScannerOptions.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableReader.KijiScannerOptions.html new file mode 100644 index 00000000..7229f57b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableReader.KijiScannerOptions.html @@ -0,0 +1,429 @@ + + + + + + + +KijiTableReader.KijiScannerOptions (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiTableReader.KijiScannerOptions

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiTableReader.KijiScannerOptions
+
            +
            +
            Enclosing interface:
            KijiTableReader
            +
            +
            +
            +
            @ApiAudience.Public
+public static final class KijiTableReader.KijiScannerOptions
            extends Object
            + + +

            +Options for KijiRowScanners. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiTableReader.KijiScannerOptions() + +
            +          Creates KijiScannerOptions with uninitialized options + and default HBaseScanOptions.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseScanOptionsgetHBaseScanOptions() + +
            +          Gets the HBaseScanOptions set in these options.
            + KijiRowFiltergetKijiRowFilter() + +
            +          Gets the row filter set in these options.
            + EntityIdgetStartRow() + +
            +          Gets the start row set in these options.
            + EntityIdgetStopRow() + +
            +          Gets the stop row set in these options.
            + KijiTableReader.KijiScannerOptionssetHBaseScanOptions(HBaseScanOptions hBaseScanOptions) + +
            +          Sets the HBaseScanOptions used by a HBase backed scanner.
            + KijiTableReader.KijiScannerOptionssetKijiRowFilter(KijiRowFilter rowFilter) + +
            +          Sets the row filter used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            + KijiTableReader.KijiScannerOptionssetStartRow(EntityId startRow) + +
            +          Sets the start row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            + KijiTableReader.KijiScannerOptionssetStopRow(EntityId stopRow) + +
            +          Sets the stop row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableReader.KijiScannerOptions

            +
            +public KijiTableReader.KijiScannerOptions()
            +
            +
            Creates KijiScannerOptions with uninitialized options + and default HBaseScanOptions. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +setStartRow

            +
            +public KijiTableReader.KijiScannerOptions setStartRow(EntityId startRow)
            +
            +
            Sets the start row used by the scanner, + and returns this KijiScannerOptions to allow chaining. +

            +

            +
            Parameters:
            startRow - The row to start scanning from. +
            Returns:
            This KijiScannerOptions with the start row set.
            +
            +
            +
            + +

            +getStartRow

            +
            +public EntityId getStartRow()
            +
            +
            Gets the start row set in these options. +

            +

            + +
            Returns:
            The start row to use, null if unset.
            +
            +
            +
            + +

            +setStopRow

            +
            +public KijiTableReader.KijiScannerOptions setStopRow(EntityId stopRow)
            +
            +
            Sets the stop row used by the scanner, + and returns this KijiScannerOptions to allow chaining. +

            +

            +
            Parameters:
            stopRow - The last row to scan. +
            Returns:
            This KijiScannerOptions with the stop row set.
            +
            +
            +
            + +

            +getStopRow

            +
            +public EntityId getStopRow()
            +
            +
            Gets the stop row set in these options. +

            +

            + +
            Returns:
            The stop row to use, null if unset.
            +
            +
            +
            + +

            +setKijiRowFilter

            +
            +public KijiTableReader.KijiScannerOptions setKijiRowFilter(KijiRowFilter rowFilter)
            +
            +
            Sets the row filter used by the scanner, + and returns this KijiScannerOptions to allow chaining. +

            +

            +
            Parameters:
            rowFilter - The row filter to use. +
            Returns:
            This KijiScannerOptions with the row filter set.
            +
            +
            +
            + +

            +getKijiRowFilter

            +
            +public KijiRowFilter getKijiRowFilter()
            +
            +
            Gets the row filter set in these options. +

            +

            + +
            Returns:
            The row filter to use, null if unset.
            +
            +
            +
            + +

            +setHBaseScanOptions

            +
            +public KijiTableReader.KijiScannerOptions setHBaseScanOptions(HBaseScanOptions hBaseScanOptions)
            +
            +
            Sets the HBaseScanOptions used by a HBase backed scanner. + The default is the default HBaseScanOptions. +

            +

            +
            Parameters:
            hBaseScanOptions - The HBaseScanOptions to use. +
            Returns:
            This KijiScannerOptions with the HBaseScanOptions set.
            +
            +
            +
            + +

            +getHBaseScanOptions

            +
            +public HBaseScanOptions getHBaseScanOptions()
            +
            +
            Gets the HBaseScanOptions set in these options. +

            +

            + +
            Returns:
            The HBaseScanOptions to use; if unset, the default HbaseScanOptions.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableReader.html new file mode 100644 index 00000000..574a7ec4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableReader.html @@ -0,0 +1,387 @@ + + + + + + + +KijiTableReader (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableReader

            +
            +
            All Superinterfaces:
            Closeable
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableReader
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiTableReader
            extends Closeable
            + + +

            +Interface for reading data from a Kiji table. + +

            + Utilizes EntityId and KijiDataRequest + to return KijiRowData or a KijiRowScanner + to iterate across rows in a Kiji table. +

            + +

            To get the three most recent versions of cell data from a column bar from + the family foo within the time range (123, 456): + 

            +   KijiDataRequestBuilder builder = KijiDataRequest.builder()
+     .withTimeRange(123L, 456L);
+     .newColumnsDef()
+     .withMaxVersions(3)
+     .add("foo", "bar");
+   final KijiDataRequest request = builder.build();
+
+   final KijiTableReader reader = myKijiTable.openTableReader();
+   final KijiRowData data = reader.get(myEntityId, request);
+
            +

            + +

            To get a row scanner across many records using the same column and version restrictions + from above: + 

            +   final KijiRowScanner scanner = reader.getScanner(request);
+
+   final KijiScannerOptions options = new KijiScannerOptions();
+   options.setStartRow(myStartRow);
+   options.setStopRow(myStopRow);
+   final KijiRowScanner limitedScanner = reader.getScanner(request, options);
+
            + If a KijiScannerOptions is not set, the scanner will iterate over all rows + in the table (as in the case of scanner +

            + + Instantiated in Kiji Schema via KijiTable.openTableReader(). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTableReader.KijiScannerOptions + +
            +          Options for KijiRowScanners.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + List<KijiRowData>bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + KijiRowDataget(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions scannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +KijiRowData get(EntityId entityId,
+                KijiDataRequest dataRequest)
+                throws IOException
            +
            +
            Retrieves data from a single row in the kiji table. +

            +

            +
            +
            +
            +
            Parameters:
            entityId - The entity id for the row to get data from.
            dataRequest - Specifies the columns of data to retrieve. +
            Returns:
            The requested data. If there is no row for the specified entityId, this + will return an empty KijiRowData. (containsColumn() will return false for all + columns.) +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +bulkGet

            +
            +List<KijiRowData> bulkGet(List<EntityId> entityIds,
+                          KijiDataRequest dataRequest)
+                          throws IOException
            +
            +
            Retrieves data from a list of rows in the kiji table. +

            +

            +
            +
            +
            +
            Parameters:
            entityIds - The list of entity ids to collect data for.
            dataRequest - Specifies constraints on the data to retrieve for each entity id. +
            Returns:
            The requested data. If an EntityId specified in entityIds + does not exist, then the corresponding KijiRowData will be empty. + If a get fails, then the corresponding KijiRowData will be null (instead of empty). +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +getScanner

            +
            +KijiRowScanner getScanner(KijiDataRequest dataRequest)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner with the specified data request. +

            +

            +
            +
            +
            +
            Parameters:
            dataRequest - The data request to scan for. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error. +
            KijiDataRequestException - If the data request is invalid.
            +
            +
            +
            + +

            +getScanner

            +
            +KijiRowScanner getScanner(KijiDataRequest dataRequest,
+                          KijiTableReader.KijiScannerOptions scannerOptions)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner using the specified data request and options. +

            +

            +
            +
            +
            +
            Parameters:
            dataRequest - The data request to scan for.
            scannerOptions - Other options for the scanner. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error. +
            KijiDataRequestException - If the data request is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableWriter.html new file mode 100644 index 00000000..4d55ef3a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiTableWriter.html @@ -0,0 +1,240 @@ + + + + + + + +KijiTableWriter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Interface KijiTableWriter

            +
            +
            All Superinterfaces:
            Closeable, Flushable, KijiDeleter, KijiIncrementer, KijiPutter
            +
            +
            +
            All Known Implementing Classes:
            HBaseKijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public interface KijiTableWriter
            extends KijiPutter, KijiIncrementer, KijiDeleter
            + + +

            +

            + Interface for modifying a Kiji table. Wraps methods from KijiPutter, KijiIncrementer, + and KijiDeleter. To get a KijiTableWriter call + KijiTable.openTableWriter(). +

            +

            + +

            +

            + +

            + + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiPutter
            put, put
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiIncrementer
            increment
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiDeleter
            deleteCell, deleteCell, deleteColumn, deleteColumn, deleteFamily, deleteFamily, deleteRow, deleteRow
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  + + + + + + + +
            Methods inherited from interface java.io.Flushable
            flush
            +  +

            + +

            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiURI.KijiURIBuilder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiURI.KijiURIBuilder.html new file mode 100644 index 00000000..f6a01375 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiURI.KijiURIBuilder.html @@ -0,0 +1,408 @@ + + + + + + + +KijiURI.KijiURIBuilder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiURI.KijiURIBuilder

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiURI.KijiURIBuilder
+
            +
            +
            Enclosing class:
            KijiURI
            +
            +
            +
            +
            public static final class KijiURI.KijiURIBuilder
            extends Object
            + + +

            +Builder class for constructing KijiURIs. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiURI.KijiURIBuilderaddColumnName(KijiColumnName columnName) + +
            +          Adds the column name to the Kiji URI column names.
            + KijiURI.KijiURIBuilderaddColumnNames(Collection<KijiColumnName> columnNames) + +
            +          Adds the column names to the Kiji URI column names.
            + KijiURIbuild() + +
            +          Builds the configured KijiURI.
            + KijiURI.KijiURIBuilderwithColumnNames(Collection<String> columnNames) + +
            +          Configures the KijiURI with the Kiji column names.
            + KijiURI.KijiURIBuilderwithColumnNames(Iterable<KijiColumnName> columnNames) + +
            +          Configures the KijiURI with the Kiji column names.
            + KijiURI.KijiURIBuilderwithInstanceName(String instanceName) + +
            +          Configures the KijiURI with the Kiji instance name.
            + KijiURI.KijiURIBuilderwithTableName(String tableName) + +
            +          Configures the KijiURI with the Kiji table name.
            + KijiURI.KijiURIBuilderwithZookeeperClientPort(int zookeeperClientPort) + +
            +          Configures the KijiURI with the Zookeeper client port.
            + KijiURI.KijiURIBuilderwithZookeeperQuorum(String[] zookeeperQuorum) + +
            +          Configures the KijiURI with Zookeeper Quorum.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +withZookeeperQuorum

            +
            +public KijiURI.KijiURIBuilder withZookeeperQuorum(String[] zookeeperQuorum)
            +
            +
            Configures the KijiURI with Zookeeper Quorum. +

            +

            +
            Parameters:
            zookeeperQuorum - The zookeeper quorum. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withZookeeperClientPort

            +
            +public KijiURI.KijiURIBuilder withZookeeperClientPort(int zookeeperClientPort)
            +
            +
            Configures the KijiURI with the Zookeeper client port. +

            +

            +
            Parameters:
            zookeeperClientPort - The port. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withInstanceName

            +
            +public KijiURI.KijiURIBuilder withInstanceName(String instanceName)
            +
            +
            Configures the KijiURI with the Kiji instance name. +

            +

            +
            Parameters:
            instanceName - The Kiji instance name. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withTableName

            +
            +public KijiURI.KijiURIBuilder withTableName(String tableName)
            +
            +
            Configures the KijiURI with the Kiji table name. +

            +

            +
            Parameters:
            tableName - The Kiji table name. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withColumnNames

            +
            +public KijiURI.KijiURIBuilder withColumnNames(Collection<String> columnNames)
            +
            +
            Configures the KijiURI with the Kiji column names. +

            +

            +
            Parameters:
            columnNames - The Kiji column names to configure. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +addColumnNames

            +
            +public KijiURI.KijiURIBuilder addColumnNames(Collection<KijiColumnName> columnNames)
            +
            +
            Adds the column names to the Kiji URI column names. +

            +

            +
            Parameters:
            columnNames - The Kiji column names to add. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +addColumnName

            +
            +public KijiURI.KijiURIBuilder addColumnName(KijiColumnName columnName)
            +
            +
            Adds the column name to the Kiji URI column names. +

            +

            +
            Parameters:
            columnName - The Kiji column name to add. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +withColumnNames

            +
            +public KijiURI.KijiURIBuilder withColumnNames(Iterable<KijiColumnName> columnNames)
            +
            +
            Configures the KijiURI with the Kiji column names. +

            +

            +
            Parameters:
            columnNames - The Kiji column names. +
            Returns:
            This builder instance so you may chain configuration method calls.
            +
            +
            +
            + +

            +build

            +
            +public KijiURI build()
            +
            +
            Builds the configured KijiURI. +

            +

            + +
            Returns:
            A KijiURI. +
            Throws: +
            KijiURIException - If the KijiURI was configured improperly.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiURI.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiURI.html new file mode 100644 index 00000000..0fff4080 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiURI.html @@ -0,0 +1,708 @@ + + + + + + + +KijiURI (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiURI

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiURI
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiURI
            extends Object
            + + +

            +URI that uniquely identifies a Kiji instance, table, column(s). + Use kiji://.env/default/ for the default Kiji instance URI. + +

            + KijiURI objects can be constructed directly from parsing a URI string: +

            + 
            
+   final KijiURI uri = KijiURI.newBuilder("kiji://.env/default/mytable/col").build();
+
            + +

            + Alternately, KijiURI objects can be constructed from components by using the builder: +

            + 
            
+   final KijiURI uri = KijiURI.newBuilder()
+     .withInstanceName("default")
+     .withTableName("mytable")
+     .addColumnName(new KijiColumnName(col))
+     .build();
+
            + + Valid URI forms look like: +
          • "kiji://zkHost" +
          • "kiji://zkHost/instance" +
          • "kiji://zkHost/instance/table" +
          • "kiji://zkHost:zkPort/instance/table" +
          • "kiji://zkHost1,zkHost2/instance/table" +
          • "kiji://(zkHost1,zkHost2):zkPort/instance/table" +
          • "kiji://zkHost/instance/table/col" +
          • "kiji://zkHost/instance/table/col1,col2" +
          • "kiji://.env/instance/table" +
          • "kiji://.unset/instance/table" +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiURI.KijiURIBuilder + +
            +          Builder class for constructing KijiURIs.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static intDEFAULT_ZOOKEEPER_CLIENT_PORT + +
            +          Default Zookeeper port.
            +static StringENV_URI_STRING + +
            +          String to specify a value through the local environment.
            +static StringKIJI_SCHEME + +
            +          URI/URL scheme used to fully qualify a Kiji table.
            +static PatternRE_AUTHORITY_GROUP + +
            +          Pattern matching "(host1,host2,host3):port".
            +static StringUNSET_URI_STRING + +
            +          String to specify an unset KijiURI field.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object object) + +
            +          
            + com.google.common.collect.ImmutableList<KijiColumnName>getColumns() + +
            +           
            + Collection<KijiColumnName>getColumnsOrdered() + +
            +           
            + StringgetInstance() + +
            +           
            + StringgetTable() + +
            +           
            + intgetZookeeperClientPort() + +
            +           
            + com.google.common.collect.ImmutableList<String>getZookeeperQuorum() + +
            +           
            + com.google.common.collect.ImmutableList<String>getZookeeperQuorumOrdered() + +
            +           
            + inthashCode() + +
            +          
            +static KijiURI.KijiURIBuildernewBuilder() + +
            +          Gets a builder configured with default Kiji URI fields.
            +static KijiURI.KijiURIBuildernewBuilder(KijiURI uri) + +
            +          Gets a builder configured with a Kiji URI.
            +static KijiURI.KijiURIBuildernewBuilder(String uri) + +
            +          Gets a builder configured with the Kiji URI.
            + KijiURIresolve(String path) + +
            +          Resolve the path relative to this KijiURI.
            + StringtoOrderedString() + +
            +          Returns a string representation of this URI that preserves ordering of lists in fields, + such as the Zookeeper quorum and Kiji columns.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +KIJI_SCHEME

            +
            +public static final String KIJI_SCHEME
            +
            +
            URI/URL scheme used to fully qualify a Kiji table. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +UNSET_URI_STRING

            +
            +public static final String UNSET_URI_STRING
            +
            +
            String to specify an unset KijiURI field. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +ENV_URI_STRING

            +
            +public static final String ENV_URI_STRING
            +
            +
            String to specify a value through the local environment. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULT_ZOOKEEPER_CLIENT_PORT

            +
            +public static final int DEFAULT_ZOOKEEPER_CLIENT_PORT
            +
            +
            Default Zookeeper port. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +RE_AUTHORITY_GROUP

            +
            +public static final Pattern RE_AUTHORITY_GROUP
            +
            +
            Pattern matching "(host1,host2,host3):port". +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newBuilder

            +
            +public static KijiURI.KijiURIBuilder newBuilder()
            +
            +
            Gets a builder configured with default Kiji URI fields. + + More precisely, the following defaults are initialized: +
              +
            • The Zookeeper quorum and client port is taken from the Hadoop Configuration
              • +
            • The Kiji instance name is set to KConstants.DEFAULT_INSTANCE_NAME + ("default").
              • +
            • The table name and column names are explicitly left unset.
              • +
            +

            +

            + +
            Returns:
            A builder configured with this Kiji URI.
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KijiURI.KijiURIBuilder newBuilder(KijiURI uri)
            +
            +
            Gets a builder configured with a Kiji URI. +

            +

            +
            Parameters:
            uri - The Kiji URI to configure the builder from. +
            Returns:
            A builder configured with uri.
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KijiURI.KijiURIBuilder newBuilder(String uri)
            +
            +
            Gets a builder configured with the Kiji URI. +

            +

            +
            Parameters:
            uri - String specification of a Kiji URI. +
            Returns:
            A builder configured with uri. +
            Throws: +
            KijiURIException - If the uri is invalid.
            +
            +
            +
            + +

            +resolve

            +
            +public KijiURI resolve(String path)
            +
            +
            Resolve the path relative to this KijiURI. Returns a new instance. +

            +

            +
            Parameters:
            path - The path to resolve. +
            Returns:
            The resolved KijiURI. +
            Throws: +
            KijiURIException - If this KijiURI is malformed.
            +
            +
            +
            + +

            +getZookeeperQuorum

            +
            +public com.google.common.collect.ImmutableList<String> getZookeeperQuorum()
            +
            +
            + +
            Returns:
            Zookeeper quorum (comma-separated list of host names or IPs), normalized.
            +
            +
            +
            + +

            +getZookeeperQuorumOrdered

            +
            +public com.google.common.collect.ImmutableList<String> getZookeeperQuorumOrdered()
            +
            +
            + +
            Returns:
            Zookeeper quorum (comma-separated list of host names or IPs), ordered.
            +
            +
            +
            + +

            +getZookeeperClientPort

            +
            +public int getZookeeperClientPort()
            +
            +
            + +
            Returns:
            Zookeeper client port.
            +
            +
            +
            + +

            +getInstance

            +
            +public String getInstance()
            +
            +
            + +
            Returns:
            Kiji instance name.
            +
            +
            +
            + +

            +getTable

            +
            +public String getTable()
            +
            +
            + +
            Returns:
            Kiji table name.
            +
            +
            +
            + +

            +getColumns

            +
            +public com.google.common.collect.ImmutableList<KijiColumnName> getColumns()
            +
            +
            + +
            Returns:
            Kiji columns (comma-separated list of Kiji column names), normalized. Never null.
            +
            +
            +
            + +

            +getColumnsOrdered

            +
            +public Collection<KijiColumnName> getColumnsOrdered()
            +
            +
            + +
            Returns:
            Kiji columns (comma-separated list of Kiji column names), ordered. Never null.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toOrderedString

            +
            +public String toOrderedString()
            +
            +
            Returns a string representation of this URI that preserves ordering of lists in fields, + such as the Zookeeper quorum and Kiji columns. +

            +

            + +
            Returns:
            An order-preserving string representation of this URI.
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object object)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiURIException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiURIException.html new file mode 100644 index 00000000..c14d31f5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/KijiURIException.html @@ -0,0 +1,271 @@ + + + + + + + +KijiURIException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class KijiURIException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.KijiURIException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiURIException
            extends RuntimeException
            + + +

            +Thrown when parsing a bogus Kiji URI. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiURIException(String message) + +
            +          Creates a new KijiURIException.
            KijiURIException(String uri, + String message) + +
            +          Creates a new KijiURIException for the specified uri and detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiURIException

            +
            +public KijiURIException(String message)
            +
            +
            Creates a new KijiURIException. +

            +

            +
            Parameters:
            message - Human readable message.
            +
            +
            + +

            +KijiURIException

            +
            +public KijiURIException(String uri,
+                        String message)
            +
            +
            Creates a new KijiURIException for the specified uri and detail message. +

            +

            +
            Parameters:
            uri - Bogus URI.
            message - Human readable explanation.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/NoCellDataException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/NoCellDataException.html new file mode 100644 index 00000000..ffb771a4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/NoCellDataException.html @@ -0,0 +1,250 @@ + + + + + + + +NoCellDataException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class NoCellDataException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.NoCellDataException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NoCellDataException
            extends Exception
            + + +

            +Thrown when attempting to read data from a cell that doesn't exist. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NoCellDataException(String message) + +
            +          Creates a new NoCellDataException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +NoCellDataException

            +
            +public NoCellDataException(String message)
            +
            +
            Creates a new NoCellDataException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/NoSuchColumnException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/NoSuchColumnException.html new file mode 100644 index 00000000..27f6f18a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/NoSuchColumnException.html @@ -0,0 +1,251 @@ + + + + + + + +NoSuchColumnException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class NoSuchColumnException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.NoSuchColumnException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NoSuchColumnException
            extends IOException
            + + +

            +Thrown when attempting to access a column that does not exist. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NoSuchColumnException(String message) + +
            +          Creates a new NoSuchColumnException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +NoSuchColumnException

            +
            +public NoSuchColumnException(String message)
            +
            +
            Creates a new NoSuchColumnException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/NotAKijiManagedTableException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/NotAKijiManagedTableException.html new file mode 100644 index 00000000..46b0c923 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/NotAKijiManagedTableException.html @@ -0,0 +1,285 @@ + + + + + + + +NotAKijiManagedTableException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class NotAKijiManagedTableException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.NotAKijiManagedTableException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class NotAKijiManagedTableException
            extends Exception
            + + +

            +Thrown when Kiji encounters an HBase table that is not managed by Kiji. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NotAKijiManagedTableException(String hbaseTableName, + String message) + +
            +          Creates a new NotAKijiManagedTableException for the specified + table with the specified detail message.
            +  + + + + + + + + + + + +
            +Method Summary
            + StringgetHBaseTableName() + +
            +          Gets the name of the HBase table that is not managed by Kiji.
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +NotAKijiManagedTableException

            +
            +public NotAKijiManagedTableException(String hbaseTableName,
+                                     String message)
            +
            +
            Creates a new NotAKijiManagedTableException for the specified + table with the specified detail message. +

            +

            +
            Parameters:
            hbaseTableName - The name of an HBase table that is not managed by Kiji.
            message - Detail about the exception.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseTableName

            +
            +public String getHBaseTableName()
            +
            +
            Gets the name of the HBase table that is not managed by Kiji. +

            +

            + +
            Returns:
            The HBase table name.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/SpecificCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/SpecificCellDecoderFactory.html new file mode 100644 index 00000000..18097576 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/SpecificCellDecoderFactory.html @@ -0,0 +1,260 @@ + + + + + + + +SpecificCellDecoderFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class SpecificCellDecoderFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.SpecificCellDecoderFactory
+
            +
            +
            All Implemented Interfaces:
            KijiCellDecoderFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class SpecificCellDecoderFactory
            extends Object
            implements KijiCellDecoderFactory
            + + +

            +Factory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellDecoder<?>create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +static KijiCellDecoderFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiCellDecoderFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            an instance of the SpecificCellDecoderFactory.
            +
            +
            +
            + +

            +create

            +
            +public KijiCellDecoder<?> create(CellSpec cellSpec)
+                          throws IOException
            +
            +
            Creates a new Kiji cell decoder. +

            +

            +
            Specified by:
            create in interface KijiCellDecoderFactory
            +
            +
            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell decoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/TableKeyNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/TableKeyNotFoundException.html new file mode 100644 index 00000000..e8c0f4f9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/TableKeyNotFoundException.html @@ -0,0 +1,252 @@ + + + + + + + +TableKeyNotFoundException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema +
            +Class TableKeyNotFoundException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.TableKeyNotFoundException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class TableKeyNotFoundException
            extends RuntimeException
            + + +

            +Thrown when a key is not found in a map-like API implemented by one of the + Kiji tables, the system or meta table for example. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            TableKeyNotFoundException(String message) + +
            +          Constructor.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +TableKeyNotFoundException

            +
            +public TableKeyNotFoundException(String message)
            +
            +
            Constructor. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/CellSchema.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/CellSchema.Builder.html new file mode 100644 index 00000000..4ee54dcc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/CellSchema.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +CellSchema.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class CellSchema.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<CellSchema>
+          extended by org.kiji.schema.avro.CellSchema.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<CellSchema>
            +
            +
            +
            Enclosing class:
            CellSchema
            +
            +
            +
            +
            public static class CellSchema.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<CellSchema>
            implements org.apache.avro.data.RecordBuilder<CellSchema>
            + + +

            +RecordBuilder for CellSchema instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + CellSchemabuild() + +
            +           
            + CellSchema.BuilderclearStorage() + +
            +          Clears the value of the 'storage' field
            + CellSchema.BuilderclearType() + +
            +          Clears the value of the 'type' field
            + CellSchema.BuilderclearValue() + +
            +          Clears the value of the 'value' field
            + SchemaStoragegetStorage() + +
            +          Gets the value of the 'storage' field
            + SchemaTypegetType() + +
            +          Gets the value of the 'type' field
            + StringgetValue() + +
            +          Gets the value of the 'value' field
            + booleanhasStorage() + +
            +          Checks whether the 'storage' field has been set
            + booleanhasType() + +
            +          Checks whether the 'type' field has been set
            + booleanhasValue() + +
            +          Checks whether the 'value' field has been set
            + CellSchema.BuildersetStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field
            + CellSchema.BuildersetType(SchemaType value) + +
            +          Sets the value of the 'type' field
            + CellSchema.BuildersetValue(String value) + +
            +          Sets the value of the 'value' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getStorage

            +
            +public SchemaStorage getStorage()
            +
            +
            Gets the value of the 'storage' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setStorage

            +
            +public CellSchema.Builder setStorage(SchemaStorage value)
            +
            +
            Sets the value of the 'storage' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasStorage

            +
            +public boolean hasStorage()
            +
            +
            Checks whether the 'storage' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearStorage

            +
            +public CellSchema.Builder clearStorage()
            +
            +
            Clears the value of the 'storage' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getType

            +
            +public SchemaType getType()
            +
            +
            Gets the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setType

            +
            +public CellSchema.Builder setType(SchemaType value)
            +
            +
            Sets the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasType

            +
            +public boolean hasType()
            +
            +
            Checks whether the 'type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearType

            +
            +public CellSchema.Builder clearType()
            +
            +
            Clears the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public String getValue()
            +
            +
            Gets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public CellSchema.Builder setValue(String value)
            +
            +
            Sets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasValue

            +
            +public boolean hasValue()
            +
            +
            Checks whether the 'value' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearValue

            +
            +public CellSchema.Builder clearValue()
            +
            +
            Clears the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public CellSchema build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<CellSchema>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/CellSchema.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/CellSchema.html new file mode 100644 index 00000000..0114e791 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/CellSchema.html @@ -0,0 +1,684 @@ + + + + + + + +CellSchema (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class CellSchema

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.CellSchema
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class CellSchema
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classCellSchema.Builder + +
            +          RecordBuilder for CellSchema instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + SchemaStoragestorage + +
            +          Deprecated. 
            + SchemaTypetype + +
            +          Deprecated. 
            + Stringvalue + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            CellSchema() + +
            +          Default constructor.
            CellSchema(SchemaStorage storage, + SchemaType type, + String value) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + org.apache.avro.SchemagetSchema() + +
            +           
            + SchemaStoragegetStorage() + +
            +          Gets the value of the 'storage' field.
            + SchemaTypegetType() + +
            +          Gets the value of the 'type' field.
            + StringgetValue() + +
            +          Gets the value of the 'value' field.
            +static CellSchema.BuildernewBuilder() + +
            +          Creates a new CellSchema RecordBuilder
            +static CellSchema.BuildernewBuilder(CellSchema.Builder other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing Builder
            +static CellSchema.BuildernewBuilder(CellSchema other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field.
            + voidsetType(SchemaType value) + +
            +          Sets the value of the 'type' field.
            + voidsetValue(String value) + +
            +          Sets the value of the 'value' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +storage

            +
            +@Deprecated
+public SchemaStorage storage
            +
            +
            Deprecated. 
            Schema encoding in cells. Unused if type is COUNTER. +

            +

            +
            +
            +
            + +

            +type

            +
            +@Deprecated
+public SchemaType type
            +
            +
            Deprecated. 
            Type of schema. +

            +

            +
            +
            +
            + +

            +value

            +
            +@Deprecated
+public String value
            +
            +
            Deprecated. 
            Schema value, whose interpretation depends on the schema type: + - inline : immediate Avro schema description, eg. "string"; + - class : Avro schema class name, eg. "org.kiji.avro.Node"; + - counter : unused, must be empty. +

            +

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

            +CellSchema

            +
            +public CellSchema()
            +
            +
            Default constructor. +

            +

            +
            + +

            +CellSchema

            +
            +public CellSchema(SchemaStorage storage,
+                  SchemaType type,
+                  String value)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getStorage

            +
            +public SchemaStorage getStorage()
            +
            +
            Gets the value of the 'storage' field. + Schema encoding in cells. Unused if type is COUNTER. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setStorage

            +
            +public void setStorage(SchemaStorage value)
            +
            +
            Sets the value of the 'storage' field. + Schema encoding in cells. Unused if type is COUNTER. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getType

            +
            +public SchemaType getType()
            +
            +
            Gets the value of the 'type' field. + Type of schema. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setType

            +
            +public void setType(SchemaType value)
            +
            +
            Sets the value of the 'type' field. + Type of schema. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public String getValue()
            +
            +
            Gets the value of the 'value' field. + * Schema value, whose interpretation depends on the schema type: + - inline : immediate Avro schema description, eg. "string"; + - class : Avro schema class name, eg. "org.kiji.avro.Node"; + - counter : unused, must be empty. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public void setValue(String value)
            +
            +
            Sets the value of the 'value' field. + * Schema value, whose interpretation depends on the schema type: + - inline : immediate Avro schema description, eg. "string"; + - class : Avro schema class name, eg. "org.kiji.avro.Node"; + - counter : unused, must be empty. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static CellSchema.Builder newBuilder()
            +
            +
            Creates a new CellSchema RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static CellSchema.Builder newBuilder(CellSchema.Builder other)
            +
            +
            Creates a new CellSchema RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static CellSchema.Builder newBuilder(CellSchema other)
            +
            +
            Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/ColumnDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/ColumnDesc.Builder.html new file mode 100644 index 00000000..43e45cf2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/ColumnDesc.Builder.html @@ -0,0 +1,1012 @@ + + + + + + + +ColumnDesc.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class ColumnDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<ColumnDesc>
+          extended by org.kiji.schema.avro.ColumnDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<ColumnDesc>
            +
            +
            +
            Enclosing class:
            ColumnDesc
            +
            +
            +
            +
            public static class ColumnDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<ColumnDesc>
            implements org.apache.avro.data.RecordBuilder<ColumnDesc>
            + + +

            +RecordBuilder for ColumnDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + ColumnDescbuild() + +
            +           
            + ColumnDesc.BuilderclearAliases() + +
            +          Clears the value of the 'aliases' field
            + ColumnDesc.BuilderclearColumnSchema() + +
            +          Clears the value of the 'column_schema' field
            + ColumnDesc.BuilderclearDelete() + +
            +          Clears the value of the 'delete' field
            + ColumnDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + ColumnDesc.BuilderclearEnabled() + +
            +          Clears the value of the 'enabled' field
            + ColumnDesc.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + ColumnDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + ColumnDesc.BuilderclearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field
            + CellSchemagetColumnSchema() + +
            +          Gets the value of the 'column_schema' field
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field
            + IntegergetId() + +
            +          Gets the value of the 'id' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field
            + booleanhasAliases() + +
            +          Checks whether the 'aliases' field has been set
            + booleanhasColumnSchema() + +
            +          Checks whether the 'column_schema' field has been set
            + booleanhasDelete() + +
            +          Checks whether the 'delete' field has been set
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasEnabled() + +
            +          Checks whether the 'enabled' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasRenamedFrom() + +
            +          Checks whether the 'renamed_from' field has been set
            + ColumnDesc.BuildersetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + ColumnDesc.BuildersetColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field
            + ColumnDesc.BuildersetDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + ColumnDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + ColumnDesc.BuildersetEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + ColumnDesc.BuildersetId(int value) + +
            +          Sets the value of the 'id' field
            + ColumnDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + ColumnDesc.BuildersetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public ColumnDesc.Builder setId(int value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public ColumnDesc.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public ColumnDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public ColumnDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public ColumnDesc.Builder setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAliases

            +
            +public boolean hasAliases()
            +
            +
            Checks whether the 'aliases' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAliases

            +
            +public ColumnDesc.Builder clearAliases()
            +
            +
            Clears the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public ColumnDesc.Builder setEnabled(boolean value)
            +
            +
            Sets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEnabled

            +
            +public boolean hasEnabled()
            +
            +
            Checks whether the 'enabled' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEnabled

            +
            +public ColumnDesc.Builder clearEnabled()
            +
            +
            Clears the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public ColumnDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public ColumnDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumnSchema

            +
            +public CellSchema getColumnSchema()
            +
            +
            Gets the value of the 'column_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumnSchema

            +
            +public ColumnDesc.Builder setColumnSchema(CellSchema value)
            +
            +
            Sets the value of the 'column_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasColumnSchema

            +
            +public boolean hasColumnSchema()
            +
            +
            Checks whether the 'column_schema' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearColumnSchema

            +
            +public ColumnDesc.Builder clearColumnSchema()
            +
            +
            Clears the value of the 'column_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public ColumnDesc.Builder setDelete(boolean value)
            +
            +
            Sets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDelete

            +
            +public boolean hasDelete()
            +
            +
            Checks whether the 'delete' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDelete

            +
            +public ColumnDesc.Builder clearDelete()
            +
            +
            Clears the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public ColumnDesc.Builder setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasRenamedFrom

            +
            +public boolean hasRenamedFrom()
            +
            +
            Checks whether the 'renamed_from' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearRenamedFrom

            +
            +public ColumnDesc.Builder clearRenamedFrom()
            +
            +
            Clears the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public ColumnDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<ColumnDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/ColumnDesc.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/ColumnDesc.html new file mode 100644 index 00000000..9758bd08 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/ColumnDesc.html @@ -0,0 +1,1040 @@ + + + + + + + +ColumnDesc (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class ColumnDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.ColumnDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class ColumnDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classColumnDesc.Builder + +
            +          RecordBuilder for ColumnDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<String>aliases + +
            +          Deprecated. 
            + CellSchemacolumn_schema + +
            +          Deprecated. 
            + booleandelete + +
            +          Deprecated. 
            + Stringdescription + +
            +          Deprecated. 
            + booleanenabled + +
            +          Deprecated. 
            + intid + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringrenamed_from + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            ColumnDesc() + +
            +          Default constructor.
            ColumnDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema column_schema, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field.
            + CellSchemagetColumnSchema() + +
            +          Gets the value of the 'column_schema' field.
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field.
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field.
            + IntegergetId() + +
            +          Gets the value of the 'id' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static ColumnDesc.BuildernewBuilder() + +
            +          Creates a new ColumnDesc RecordBuilder
            +static ColumnDesc.BuildernewBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +static ColumnDesc.BuildernewBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field.
            + voidsetColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field.
            + voidsetDelete(Boolean value) + +
            +          Sets the value of the 'delete' field.
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetEnabled(Boolean value) + +
            +          Sets the value of the 'enabled' field.
            + voidsetId(Integer value) + +
            +          Sets the value of the 'id' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public int id
            +
            +
            Deprecated. 
            Column ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +aliases

            +
            +@Deprecated
+public List<String> aliases
            +
            +
            Deprecated. 
            Column name aliases. +

            +

            +
            +
            +
            + +

            +enabled

            +
            +@Deprecated
+public boolean enabled
            +
            +
            Deprecated. 
            When false, the column is not visible or usable. +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the column. +

            +

            +
            +
            +
            + +

            +column_schema

            +
            +@Deprecated
+public CellSchema column_schema
            +
            +
            Deprecated. 
            Schema for the cell values. +

            +

            +
            +
            +
            + +

            +delete

            +
            +@Deprecated
+public boolean delete
            +
            +
            Deprecated. 
            When true, applying this layout deletes the column. +

            +

            +
            +
            +
            + +

            +renamed_from

            +
            +@Deprecated
+public String renamed_from
            +
            +
            Deprecated. 
            Reference primary name of the column, when renaming the column. +

            +

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

            +ColumnDesc

            +
            +public ColumnDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +ColumnDesc

            +
            +public ColumnDesc(Integer id,
+                  String name,
+                  List<String> aliases,
+                  Boolean enabled,
+                  String description,
+                  CellSchema column_schema,
+                  Boolean delete,
+                  String renamed_from)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field. + Column ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Integer value)
            +
            +
            Sets the value of the 'id' field. + Column ID. Not visible to the user. 0 means unset. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Column primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field. + Column name aliases. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public void setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field. + Column name aliases. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field. + When false, the column is not visible or usable. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public void setEnabled(Boolean value)
            +
            +
            Sets the value of the 'enabled' field. + When false, the column is not visible or usable. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the column. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the column. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumnSchema

            +
            +public CellSchema getColumnSchema()
            +
            +
            Gets the value of the 'column_schema' field. + Schema for the cell values. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumnSchema

            +
            +public void setColumnSchema(CellSchema value)
            +
            +
            Sets the value of the 'column_schema' field. + Schema for the cell values. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field. + When true, applying this layout deletes the column. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public void setDelete(Boolean value)
            +
            +
            Sets the value of the 'delete' field. + When true, applying this layout deletes the column. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field. + Reference primary name of the column, when renaming the column. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public void setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field. + Reference primary name of the column, when renaming the column. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder()
            +
            +
            Creates a new ColumnDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder(ColumnDesc.Builder other)
            +
            +
            Creates a new ColumnDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static ColumnDesc.Builder newBuilder(ColumnDesc other)
            +
            +
            Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/ComponentType.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/ComponentType.html new file mode 100644 index 00000000..16533bee --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/ComponentType.html @@ -0,0 +1,375 @@ + + + + + + + +ComponentType (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum ComponentType

            +
            +java.lang.Object
+  extended by java.lang.Enum<ComponentType>
+      extended by org.kiji.schema.avro.ComponentType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<ComponentType>
            +
            +
            +
            +
            public enum ComponentType
            extends Enum<ComponentType>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            INTEGER + +
            +           
            LONG + +
            +           
            STRING + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static ComponentTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static ComponentType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +STRING

            +
            +public static final ComponentType STRING
            +
            +
            +
            +
            +
            + +

            +INTEGER

            +
            +public static final ComponentType INTEGER
            +
            +
            +
            +
            +
            + +

            +LONG

            +
            +public static final ComponentType LONG
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static ComponentType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (ComponentType c : ComponentType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static ComponentType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/CompressionType.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/CompressionType.html new file mode 100644 index 00000000..840a17fc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/CompressionType.html @@ -0,0 +1,391 @@ + + + + + + + +CompressionType (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum CompressionType

            +
            +java.lang.Object
+  extended by java.lang.Enum<CompressionType>
+      extended by org.kiji.schema.avro.CompressionType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<CompressionType>
            +
            +
            +
            +
            public enum CompressionType
            extends Enum<CompressionType>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            GZ + +
            +           
            LZO + +
            +           
            NONE + +
            +           
            SNAPPY + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static CompressionTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static CompressionType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +NONE

            +
            +public static final CompressionType NONE
            +
            +
            +
            +
            +
            + +

            +GZ

            +
            +public static final CompressionType GZ
            +
            +
            +
            +
            +
            + +

            +LZO

            +
            +public static final CompressionType LZO
            +
            +
            +
            +
            +
            + +

            +SNAPPY

            +
            +public static final CompressionType SNAPPY
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static CompressionType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (CompressionType c : CompressionType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static CompressionType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/FamilyDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/FamilyDesc.Builder.html new file mode 100644 index 00000000..50f7120a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/FamilyDesc.Builder.html @@ -0,0 +1,1108 @@ + + + + + + + +FamilyDesc.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class FamilyDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<FamilyDesc>
+          extended by org.kiji.schema.avro.FamilyDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<FamilyDesc>
            +
            +
            +
            Enclosing class:
            FamilyDesc
            +
            +
            +
            +
            public static class FamilyDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<FamilyDesc>
            implements org.apache.avro.data.RecordBuilder<FamilyDesc>
            + + +

            +RecordBuilder for FamilyDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + FamilyDescbuild() + +
            +           
            + FamilyDesc.BuilderclearAliases() + +
            +          Clears the value of the 'aliases' field
            + FamilyDesc.BuilderclearColumns() + +
            +          Clears the value of the 'columns' field
            + FamilyDesc.BuilderclearDelete() + +
            +          Clears the value of the 'delete' field
            + FamilyDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + FamilyDesc.BuilderclearEnabled() + +
            +          Clears the value of the 'enabled' field
            + FamilyDesc.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + FamilyDesc.BuilderclearMapSchema() + +
            +          Clears the value of the 'map_schema' field
            + FamilyDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + FamilyDesc.BuilderclearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field
            + List<ColumnDesc>getColumns() + +
            +          Gets the value of the 'columns' field
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field
            + IntegergetId() + +
            +          Gets the value of the 'id' field
            + CellSchemagetMapSchema() + +
            +          Gets the value of the 'map_schema' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field
            + booleanhasAliases() + +
            +          Checks whether the 'aliases' field has been set
            + booleanhasColumns() + +
            +          Checks whether the 'columns' field has been set
            + booleanhasDelete() + +
            +          Checks whether the 'delete' field has been set
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasEnabled() + +
            +          Checks whether the 'enabled' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + booleanhasMapSchema() + +
            +          Checks whether the 'map_schema' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasRenamedFrom() + +
            +          Checks whether the 'renamed_from' field has been set
            + FamilyDesc.BuildersetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + FamilyDesc.BuildersetColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            + FamilyDesc.BuildersetDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + FamilyDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + FamilyDesc.BuildersetEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + FamilyDesc.BuildersetId(int value) + +
            +          Sets the value of the 'id' field
            + FamilyDesc.BuildersetMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field
            + FamilyDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + FamilyDesc.BuildersetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public FamilyDesc.Builder setId(int value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public FamilyDesc.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public FamilyDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public FamilyDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public FamilyDesc.Builder setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAliases

            +
            +public boolean hasAliases()
            +
            +
            Checks whether the 'aliases' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAliases

            +
            +public FamilyDesc.Builder clearAliases()
            +
            +
            Clears the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public FamilyDesc.Builder setEnabled(boolean value)
            +
            +
            Sets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEnabled

            +
            +public boolean hasEnabled()
            +
            +
            Checks whether the 'enabled' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEnabled

            +
            +public FamilyDesc.Builder clearEnabled()
            +
            +
            Clears the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public FamilyDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public FamilyDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMapSchema

            +
            +public CellSchema getMapSchema()
            +
            +
            Gets the value of the 'map_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMapSchema

            +
            +public FamilyDesc.Builder setMapSchema(CellSchema value)
            +
            +
            Sets the value of the 'map_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasMapSchema

            +
            +public boolean hasMapSchema()
            +
            +
            Checks whether the 'map_schema' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearMapSchema

            +
            +public FamilyDesc.Builder clearMapSchema()
            +
            +
            Clears the value of the 'map_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumns

            +
            +public List<ColumnDesc> getColumns()
            +
            +
            Gets the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumns

            +
            +public FamilyDesc.Builder setColumns(List<ColumnDesc> value)
            +
            +
            Sets the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasColumns

            +
            +public boolean hasColumns()
            +
            +
            Checks whether the 'columns' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearColumns

            +
            +public FamilyDesc.Builder clearColumns()
            +
            +
            Clears the value of the 'columns' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public FamilyDesc.Builder setDelete(boolean value)
            +
            +
            Sets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDelete

            +
            +public boolean hasDelete()
            +
            +
            Checks whether the 'delete' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDelete

            +
            +public FamilyDesc.Builder clearDelete()
            +
            +
            Clears the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public FamilyDesc.Builder setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasRenamedFrom

            +
            +public boolean hasRenamedFrom()
            +
            +
            Checks whether the 'renamed_from' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearRenamedFrom

            +
            +public FamilyDesc.Builder clearRenamedFrom()
            +
            +
            Clears the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public FamilyDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<FamilyDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/FamilyDesc.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/FamilyDesc.html new file mode 100644 index 00000000..bb3e32f9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/FamilyDesc.html @@ -0,0 +1,1113 @@ + + + + + + + +FamilyDesc (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class FamilyDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.FamilyDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class FamilyDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classFamilyDesc.Builder + +
            +          RecordBuilder for FamilyDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<String>aliases + +
            +          Deprecated. 
            + List<ColumnDesc>columns + +
            +          Deprecated. 
            + booleandelete + +
            +          Deprecated. 
            + Stringdescription + +
            +          Deprecated. 
            + booleanenabled + +
            +          Deprecated. 
            + intid + +
            +          Deprecated. 
            + CellSchemamap_schema + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringrenamed_from + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            FamilyDesc() + +
            +          Default constructor.
            FamilyDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema map_schema, + List<ColumnDesc> columns, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field.
            + List<ColumnDesc>getColumns() + +
            +          Gets the value of the 'columns' field.
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field.
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field.
            + IntegergetId() + +
            +          Gets the value of the 'id' field.
            + CellSchemagetMapSchema() + +
            +          Gets the value of the 'map_schema' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static FamilyDesc.BuildernewBuilder() + +
            +          Creates a new FamilyDesc RecordBuilder
            +static FamilyDesc.BuildernewBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +static FamilyDesc.BuildernewBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field.
            + voidsetColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field.
            + voidsetDelete(Boolean value) + +
            +          Sets the value of the 'delete' field.
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetEnabled(Boolean value) + +
            +          Sets the value of the 'enabled' field.
            + voidsetId(Integer value) + +
            +          Sets the value of the 'id' field.
            + voidsetMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public int id
            +
            +
            Deprecated. 
            Family ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +aliases

            +
            +@Deprecated
+public List<String> aliases
            +
            +
            Deprecated. 
            Column family name aliases. +

            +

            +
            +
            +
            + +

            +enabled

            +
            +@Deprecated
+public boolean enabled
            +
            +
            Deprecated. 
            When false, the family and its columns are not visible/usable. +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the column family. +

            +

            +
            +
            +
            + +

            +map_schema

            +
            +@Deprecated
+public CellSchema map_schema
            +
            +
            Deprecated. 
            Cell schema for map-type families. Null for group-type families. +

            +

            +
            +
            +
            + +

            +columns

            +
            +@Deprecated
+public List<ColumnDesc> columns
            +
            +
            Deprecated. 
            Columns, for group-type families only. Empty for map-type families. +

            +

            +
            +
            +
            + +

            +delete

            +
            +@Deprecated
+public boolean delete
            +
            +
            Deprecated. 
            When true, applying this layout deletes the family. +

            +

            +
            +
            +
            + +

            +renamed_from

            +
            +@Deprecated
+public String renamed_from
            +
            +
            Deprecated. 
            Reference primary name of the family, when renaming the family. +

            +

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

            +FamilyDesc

            +
            +public FamilyDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +FamilyDesc

            +
            +public FamilyDesc(Integer id,
+                  String name,
+                  List<String> aliases,
+                  Boolean enabled,
+                  String description,
+                  CellSchema map_schema,
+                  List<ColumnDesc> columns,
+                  Boolean delete,
+                  String renamed_from)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field. + Family ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Integer value)
            +
            +
            Sets the value of the 'id' field. + Family ID. Not visible to the user. 0 means unset. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Column family primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field. + Column family name aliases. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public void setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field. + Column family name aliases. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field. + When false, the family and its columns are not visible/usable. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public void setEnabled(Boolean value)
            +
            +
            Sets the value of the 'enabled' field. + When false, the family and its columns are not visible/usable. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the column family. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the column family. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMapSchema

            +
            +public CellSchema getMapSchema()
            +
            +
            Gets the value of the 'map_schema' field. + Cell schema for map-type families. Null for group-type families. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMapSchema

            +
            +public void setMapSchema(CellSchema value)
            +
            +
            Sets the value of the 'map_schema' field. + Cell schema for map-type families. Null for group-type families. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getColumns

            +
            +public List<ColumnDesc> getColumns()
            +
            +
            Gets the value of the 'columns' field. + Columns, for group-type families only. Empty for map-type families. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setColumns

            +
            +public void setColumns(List<ColumnDesc> value)
            +
            +
            Sets the value of the 'columns' field. + Columns, for group-type families only. Empty for map-type families. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field. + When true, applying this layout deletes the family. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public void setDelete(Boolean value)
            +
            +
            Sets the value of the 'delete' field. + When true, applying this layout deletes the family. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field. + Reference primary name of the family, when renaming the family. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public void setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field. + Reference primary name of the family, when renaming the family. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder()
            +
            +
            Creates a new FamilyDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder(FamilyDesc.Builder other)
            +
            +
            Creates a new FamilyDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static FamilyDesc.Builder newBuilder(FamilyDesc other)
            +
            +
            Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/HashSpec.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/HashSpec.Builder.html new file mode 100644 index 00000000..301c456d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/HashSpec.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +HashSpec.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class HashSpec.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<HashSpec>
+          extended by org.kiji.schema.avro.HashSpec.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<HashSpec>
            +
            +
            +
            Enclosing class:
            HashSpec
            +
            +
            +
            +
            public static class HashSpec.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<HashSpec>
            implements org.apache.avro.data.RecordBuilder<HashSpec>
            + + +

            +RecordBuilder for HashSpec instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + HashSpecbuild() + +
            +           
            + HashSpec.BuilderclearHashSize() + +
            +          Clears the value of the 'hash_size' field
            + HashSpec.BuilderclearHashType() + +
            +          Clears the value of the 'hash_type' field
            + HashSpec.BuilderclearSuppressKeyMaterialization() + +
            +          Clears the value of the 'suppress_key_materialization' field
            + IntegergetHashSize() + +
            +          Gets the value of the 'hash_size' field
            + HashTypegetHashType() + +
            +          Gets the value of the 'hash_type' field
            + BooleangetSuppressKeyMaterialization() + +
            +          Gets the value of the 'suppress_key_materialization' field
            + booleanhasHashSize() + +
            +          Checks whether the 'hash_size' field has been set
            + booleanhasHashType() + +
            +          Checks whether the 'hash_type' field has been set
            + booleanhasSuppressKeyMaterialization() + +
            +          Checks whether the 'suppress_key_materialization' field has been set
            + HashSpec.BuildersetHashSize(int value) + +
            +          Sets the value of the 'hash_size' field
            + HashSpec.BuildersetHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            + HashSpec.BuildersetSuppressKeyMaterialization(boolean value) + +
            +          Sets the value of the 'suppress_key_materialization' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getHashType

            +
            +public HashType getHashType()
            +
            +
            Gets the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashType

            +
            +public HashSpec.Builder setHashType(HashType value)
            +
            +
            Sets the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHashType

            +
            +public boolean hasHashType()
            +
            +
            Checks whether the 'hash_type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHashType

            +
            +public HashSpec.Builder clearHashType()
            +
            +
            Clears the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashSize

            +
            +public Integer getHashSize()
            +
            +
            Gets the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashSize

            +
            +public HashSpec.Builder setHashSize(int value)
            +
            +
            Sets the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHashSize

            +
            +public boolean hasHashSize()
            +
            +
            Checks whether the 'hash_size' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHashSize

            +
            +public HashSpec.Builder clearHashSize()
            +
            +
            Clears the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSuppressKeyMaterialization

            +
            +public Boolean getSuppressKeyMaterialization()
            +
            +
            Gets the value of the 'suppress_key_materialization' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSuppressKeyMaterialization

            +
            +public HashSpec.Builder setSuppressKeyMaterialization(boolean value)
            +
            +
            Sets the value of the 'suppress_key_materialization' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasSuppressKeyMaterialization

            +
            +public boolean hasSuppressKeyMaterialization()
            +
            +
            Checks whether the 'suppress_key_materialization' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearSuppressKeyMaterialization

            +
            +public HashSpec.Builder clearSuppressKeyMaterialization()
            +
            +
            Clears the value of the 'suppress_key_materialization' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public HashSpec build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<HashSpec>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/HashSpec.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/HashSpec.html new file mode 100644 index 00000000..9b991cbc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/HashSpec.html @@ -0,0 +1,687 @@ + + + + + + + +HashSpec (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class HashSpec

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.HashSpec
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class HashSpec
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classHashSpec.Builder + +
            +          RecordBuilder for HashSpec instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + inthash_size + +
            +          Deprecated. 
            + HashTypehash_type + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + booleansuppress_key_materialization + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            HashSpec() + +
            +          Default constructor.
            HashSpec(HashType hash_type, + Integer hash_size, + Boolean suppress_key_materialization) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + IntegergetHashSize() + +
            +          Gets the value of the 'hash_size' field.
            + HashTypegetHashType() + +
            +          Gets the value of the 'hash_type' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + BooleangetSuppressKeyMaterialization() + +
            +          Gets the value of the 'suppress_key_materialization' field.
            +static HashSpec.BuildernewBuilder() + +
            +          Creates a new HashSpec RecordBuilder
            +static HashSpec.BuildernewBuilder(HashSpec.Builder other) + +
            +          Creates a new HashSpec RecordBuilder by copying an existing Builder
            +static HashSpec.BuildernewBuilder(HashSpec other) + +
            +          Creates a new HashSpec RecordBuilder by copying an existing HashSpec instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetHashSize(Integer value) + +
            +          Sets the value of the 'hash_size' field.
            + voidsetHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field.
            + voidsetSuppressKeyMaterialization(Boolean value) + +
            +          Sets the value of the 'suppress_key_materialization' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +hash_type

            +
            +@Deprecated
+public HashType hash_type
            +
            +
            Deprecated. 
            Hashing algorithm used. +

            +

            +
            +
            +
            + +

            +hash_size

            +
            +@Deprecated
+public int hash_size
            +
            +
            Deprecated. 
            Size of the hash. If used for salting purposes, i.e. the hash is not the sole + component of the key, use a smaller hash size. +

            +

            +
            +
            +
            + +

            +suppress_key_materialization

            +
            +@Deprecated
+public boolean suppress_key_materialization
            +
            +
            Deprecated. 
            Use with caution! Under normal circumstances, an hbase row key is created as + a hash is followed by the actual component that is hashed. Setting this to + true enables the user to store only the hash. (making the distinction between HASHED + and HASH_PREFIXED). This means that there is a non-zero possibility for collisions. +

            +

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

            +HashSpec

            +
            +public HashSpec()
            +
            +
            Default constructor. +

            +

            +
            + +

            +HashSpec

            +
            +public HashSpec(HashType hash_type,
+                Integer hash_size,
+                Boolean suppress_key_materialization)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getHashType

            +
            +public HashType getHashType()
            +
            +
            Gets the value of the 'hash_type' field. + Hashing algorithm used. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashType

            +
            +public void setHashType(HashType value)
            +
            +
            Sets the value of the 'hash_type' field. + Hashing algorithm used. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashSize

            +
            +public Integer getHashSize()
            +
            +
            Gets the value of the 'hash_size' field. + * Size of the hash. If used for salting purposes, i.e. the hash is not the sole + component of the key, use a smaller hash size. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashSize

            +
            +public void setHashSize(Integer value)
            +
            +
            Sets the value of the 'hash_size' field. + * Size of the hash. If used for salting purposes, i.e. the hash is not the sole + component of the key, use a smaller hash size. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSuppressKeyMaterialization

            +
            +public Boolean getSuppressKeyMaterialization()
            +
            +
            Gets the value of the 'suppress_key_materialization' field. + Use with caution! Under normal circumstances, an hbase row key is created as + a hash is followed by the actual component that is hashed. Setting this to + true enables the user to store only the hash. (making the distinction between HASHED + and HASH_PREFIXED). This means that there is a non-zero possibility for collisions. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSuppressKeyMaterialization

            +
            +public void setSuppressKeyMaterialization(Boolean value)
            +
            +
            Sets the value of the 'suppress_key_materialization' field. + Use with caution! Under normal circumstances, an hbase row key is created as + a hash is followed by the actual component that is hashed. Setting this to + true enables the user to store only the hash. (making the distinction between HASHED + and HASH_PREFIXED). This means that there is a non-zero possibility for collisions. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static HashSpec.Builder newBuilder()
            +
            +
            Creates a new HashSpec RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static HashSpec.Builder newBuilder(HashSpec.Builder other)
            +
            +
            Creates a new HashSpec RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static HashSpec.Builder newBuilder(HashSpec other)
            +
            +
            Creates a new HashSpec RecordBuilder by copying an existing HashSpec instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/HashType.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/HashType.html new file mode 100644 index 00000000..d19511af --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/HashType.html @@ -0,0 +1,343 @@ + + + + + + + +HashType (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum HashType

            +
            +java.lang.Object
+  extended by java.lang.Enum<HashType>
+      extended by org.kiji.schema.avro.HashType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<HashType>
            +
            +
            +
            +
            public enum HashType
            extends Enum<HashType>
            + + +

            +

            + +

            + + + + + + + + + + +
            +Enum Constant Summary
            MD5 + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static HashTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static HashType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +MD5

            +
            +public static final HashType MD5
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static HashType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (HashType c : HashType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static HashType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KeyValueBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KeyValueBackupEntry.Builder.html new file mode 100644 index 00000000..3db5df17 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KeyValueBackupEntry.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +KeyValueBackupEntry.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class KeyValueBackupEntry.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<KeyValueBackupEntry>
+          extended by org.kiji.schema.avro.KeyValueBackupEntry.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<KeyValueBackupEntry>
            +
            +
            +
            Enclosing class:
            KeyValueBackupEntry
            +
            +
            +
            +
            public static class KeyValueBackupEntry.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<KeyValueBackupEntry>
            implements org.apache.avro.data.RecordBuilder<KeyValueBackupEntry>
            + + +

            +RecordBuilder for KeyValueBackupEntry instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KeyValueBackupEntrybuild() + +
            +           
            + KeyValueBackupEntry.BuilderclearKey() + +
            +          Clears the value of the 'key' field
            + KeyValueBackupEntry.BuilderclearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + KeyValueBackupEntry.BuilderclearValue() + +
            +          Clears the value of the 'value' field
            + StringgetKey() + +
            +          Gets the value of the 'key' field
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field
            + ByteBuffergetValue() + +
            +          Gets the value of the 'value' field
            + booleanhasKey() + +
            +          Checks whether the 'key' field has been set
            + booleanhasTimestamp() + +
            +          Checks whether the 'timestamp' field has been set
            + booleanhasValue() + +
            +          Checks whether the 'value' field has been set
            + KeyValueBackupEntry.BuildersetKey(String value) + +
            +          Sets the value of the 'key' field
            + KeyValueBackupEntry.BuildersetTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + KeyValueBackupEntry.BuildersetValue(ByteBuffer value) + +
            +          Sets the value of the 'value' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public KeyValueBackupEntry.Builder setTimestamp(long value)
            +
            +
            Sets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasTimestamp

            +
            +public boolean hasTimestamp()
            +
            +
            Checks whether the 'timestamp' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearTimestamp

            +
            +public KeyValueBackupEntry.Builder clearTimestamp()
            +
            +
            Clears the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKey

            +
            +public String getKey()
            +
            +
            Gets the value of the 'key' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKey

            +
            +public KeyValueBackupEntry.Builder setKey(String value)
            +
            +
            Sets the value of the 'key' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasKey

            +
            +public boolean hasKey()
            +
            +
            Checks whether the 'key' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearKey

            +
            +public KeyValueBackupEntry.Builder clearKey()
            +
            +
            Clears the value of the 'key' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public ByteBuffer getValue()
            +
            +
            Gets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public KeyValueBackupEntry.Builder setValue(ByteBuffer value)
            +
            +
            Sets the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasValue

            +
            +public boolean hasValue()
            +
            +
            Checks whether the 'value' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearValue

            +
            +public KeyValueBackupEntry.Builder clearValue()
            +
            +
            Clears the value of the 'value' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public KeyValueBackupEntry build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<KeyValueBackupEntry>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KeyValueBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KeyValueBackupEntry.html new file mode 100644 index 00000000..916da9f7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KeyValueBackupEntry.html @@ -0,0 +1,675 @@ + + + + + + + +KeyValueBackupEntry (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class KeyValueBackupEntry

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.KeyValueBackupEntry
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class KeyValueBackupEntry
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKeyValueBackupEntry.Builder + +
            +          RecordBuilder for KeyValueBackupEntry instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringkey + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + longtimestamp + +
            +          Deprecated. 
            + ByteBuffervalue + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            KeyValueBackupEntry() + +
            +          Default constructor.
            KeyValueBackupEntry(Long timestamp, + String key, + ByteBuffer value) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetKey() + +
            +          Gets the value of the 'key' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field.
            + ByteBuffergetValue() + +
            +          Gets the value of the 'value' field.
            +static KeyValueBackupEntry.BuildernewBuilder() + +
            +          Creates a new KeyValueBackupEntry RecordBuilder
            +static KeyValueBackupEntry.BuildernewBuilder(KeyValueBackupEntry.Builder other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder
            +static KeyValueBackupEntry.BuildernewBuilder(KeyValueBackupEntry other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetKey(String value) + +
            +          Sets the value of the 'key' field.
            + voidsetTimestamp(Long value) + +
            +          Sets the value of the 'timestamp' field.
            + voidsetValue(ByteBuffer value) + +
            +          Sets the value of the 'value' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +timestamp

            +
            +@Deprecated
+public long timestamp
            +
            +
            Deprecated. 
            Time Stamp. +

            +

            +
            +
            +
            + +

            +key

            +
            +@Deprecated
+public String key
            +
            +
            Deprecated. 
            Key. +

            +

            +
            +
            +
            + +

            +value

            +
            +@Deprecated
+public ByteBuffer value
            +
            +
            Deprecated. 
            Value. +

            +

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

            +KeyValueBackupEntry

            +
            +public KeyValueBackupEntry()
            +
            +
            Default constructor. +

            +

            +
            + +

            +KeyValueBackupEntry

            +
            +public KeyValueBackupEntry(Long timestamp,
+                           String key,
+                           ByteBuffer value)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field. + Time Stamp. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public void setTimestamp(Long value)
            +
            +
            Sets the value of the 'timestamp' field. + Time Stamp. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKey

            +
            +public String getKey()
            +
            +
            Gets the value of the 'key' field. + Key. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKey

            +
            +public void setKey(String value)
            +
            +
            Sets the value of the 'key' field. + Key. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getValue

            +
            +public ByteBuffer getValue()
            +
            +
            Gets the value of the 'value' field. + Value. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setValue

            +
            +public void setValue(ByteBuffer value)
            +
            +
            Sets the value of the 'value' field. + Value. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KeyValueBackupEntry.Builder newBuilder()
            +
            +
            Creates a new KeyValueBackupEntry RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KeyValueBackupEntry.Builder newBuilder(KeyValueBackupEntry.Builder other)
            +
            +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static KeyValueBackupEntry.Builder newBuilder(KeyValueBackupEntry other)
            +
            +
            Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html new file mode 100644 index 00000000..a9d7a78e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KijiTableLayoutRecords.Callback.html @@ -0,0 +1,230 @@ + + + + + + + +KijiTableLayoutRecords.Callback (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Interface KijiTableLayoutRecords.Callback

            +
            +
            All Superinterfaces:
            KijiTableLayoutRecords
            +
            +
            +
            Enclosing interface:
            KijiTableLayoutRecords
            +
            +
            +
            +
            public static interface KijiTableLayoutRecords.Callback
            extends KijiTableLayoutRecords
            + + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.schema.avro.KijiTableLayoutRecords
            KijiTableLayoutRecords.Callback
            +  + + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.ProtocolPROTOCOL + +
            +           
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +PROTOCOL

            +
            +static final org.apache.avro.Protocol PROTOCOL
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KijiTableLayoutRecords.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KijiTableLayoutRecords.html new file mode 100644 index 00000000..3d52abb0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/KijiTableLayoutRecords.html @@ -0,0 +1,225 @@ + + + + + + + +KijiTableLayoutRecords (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Interface KijiTableLayoutRecords

            +
            +
            All Known Subinterfaces:
            KijiTableLayoutRecords.Callback
            +
            +
            +
            +
            public interface KijiTableLayoutRecords
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static interfaceKijiTableLayoutRecords.Callback + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.ProtocolPROTOCOL + +
            +           
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +PROTOCOL

            +
            +static final org.apache.avro.Protocol PROTOCOL
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/LocalityGroupDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/LocalityGroupDesc.Builder.html new file mode 100644 index 00000000..c28434b3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/LocalityGroupDesc.Builder.html @@ -0,0 +1,1396 @@ + + + + + + + +LocalityGroupDesc.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class LocalityGroupDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<LocalityGroupDesc>
+          extended by org.kiji.schema.avro.LocalityGroupDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<LocalityGroupDesc>
            +
            +
            +
            Enclosing class:
            LocalityGroupDesc
            +
            +
            +
            +
            public static class LocalityGroupDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<LocalityGroupDesc>
            implements org.apache.avro.data.RecordBuilder<LocalityGroupDesc>
            + + +

            +RecordBuilder for LocalityGroupDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + LocalityGroupDescbuild() + +
            +           
            + LocalityGroupDesc.BuilderclearAliases() + +
            +          Clears the value of the 'aliases' field
            + LocalityGroupDesc.BuilderclearCompressionType() + +
            +          Clears the value of the 'compression_type' field
            + LocalityGroupDesc.BuilderclearDelete() + +
            +          Clears the value of the 'delete' field
            + LocalityGroupDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + LocalityGroupDesc.BuilderclearEnabled() + +
            +          Clears the value of the 'enabled' field
            + LocalityGroupDesc.BuilderclearFamilies() + +
            +          Clears the value of the 'families' field
            + LocalityGroupDesc.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + LocalityGroupDesc.BuilderclearInMemory() + +
            +          Clears the value of the 'in_memory' field
            + LocalityGroupDesc.BuilderclearMaxVersions() + +
            +          Clears the value of the 'max_versions' field
            + LocalityGroupDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + LocalityGroupDesc.BuilderclearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + LocalityGroupDesc.BuilderclearTtlSeconds() + +
            +          Clears the value of the 'ttl_seconds' field
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field
            + CompressionTypegetCompressionType() + +
            +          Gets the value of the 'compression_type' field
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field
            + List<FamilyDesc>getFamilies() + +
            +          Gets the value of the 'families' field
            + IntegergetId() + +
            +          Gets the value of the 'id' field
            + BooleangetInMemory() + +
            +          Gets the value of the 'in_memory' field
            + IntegergetMaxVersions() + +
            +          Gets the value of the 'max_versions' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field
            + IntegergetTtlSeconds() + +
            +          Gets the value of the 'ttl_seconds' field
            + booleanhasAliases() + +
            +          Checks whether the 'aliases' field has been set
            + booleanhasCompressionType() + +
            +          Checks whether the 'compression_type' field has been set
            + booleanhasDelete() + +
            +          Checks whether the 'delete' field has been set
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasEnabled() + +
            +          Checks whether the 'enabled' field has been set
            + booleanhasFamilies() + +
            +          Checks whether the 'families' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + booleanhasInMemory() + +
            +          Checks whether the 'in_memory' field has been set
            + booleanhasMaxVersions() + +
            +          Checks whether the 'max_versions' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasRenamedFrom() + +
            +          Checks whether the 'renamed_from' field has been set
            + booleanhasTtlSeconds() + +
            +          Checks whether the 'ttl_seconds' field has been set
            + LocalityGroupDesc.BuildersetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + LocalityGroupDesc.BuildersetCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field
            + LocalityGroupDesc.BuildersetDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + LocalityGroupDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + LocalityGroupDesc.BuildersetEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + LocalityGroupDesc.BuildersetFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            + LocalityGroupDesc.BuildersetId(int value) + +
            +          Sets the value of the 'id' field
            + LocalityGroupDesc.BuildersetInMemory(boolean value) + +
            +          Sets the value of the 'in_memory' field
            + LocalityGroupDesc.BuildersetMaxVersions(int value) + +
            +          Sets the value of the 'max_versions' field
            + LocalityGroupDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + LocalityGroupDesc.BuildersetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            + LocalityGroupDesc.BuildersetTtlSeconds(int value) + +
            +          Sets the value of the 'ttl_seconds' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public LocalityGroupDesc.Builder setId(int value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public LocalityGroupDesc.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public LocalityGroupDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public LocalityGroupDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public LocalityGroupDesc.Builder setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAliases

            +
            +public boolean hasAliases()
            +
            +
            Checks whether the 'aliases' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAliases

            +
            +public LocalityGroupDesc.Builder clearAliases()
            +
            +
            Clears the value of the 'aliases' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public LocalityGroupDesc.Builder setEnabled(boolean value)
            +
            +
            Sets the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEnabled

            +
            +public boolean hasEnabled()
            +
            +
            Checks whether the 'enabled' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEnabled

            +
            +public LocalityGroupDesc.Builder clearEnabled()
            +
            +
            Clears the value of the 'enabled' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public LocalityGroupDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public LocalityGroupDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getInMemory

            +
            +public Boolean getInMemory()
            +
            +
            Gets the value of the 'in_memory' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setInMemory

            +
            +public LocalityGroupDesc.Builder setInMemory(boolean value)
            +
            +
            Sets the value of the 'in_memory' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasInMemory

            +
            +public boolean hasInMemory()
            +
            +
            Checks whether the 'in_memory' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearInMemory

            +
            +public LocalityGroupDesc.Builder clearInMemory()
            +
            +
            Clears the value of the 'in_memory' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMaxVersions

            +
            +public Integer getMaxVersions()
            +
            +
            Gets the value of the 'max_versions' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMaxVersions

            +
            +public LocalityGroupDesc.Builder setMaxVersions(int value)
            +
            +
            Sets the value of the 'max_versions' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasMaxVersions

            +
            +public boolean hasMaxVersions()
            +
            +
            Checks whether the 'max_versions' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearMaxVersions

            +
            +public LocalityGroupDesc.Builder clearMaxVersions()
            +
            +
            Clears the value of the 'max_versions' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getTtlSeconds

            +
            +public Integer getTtlSeconds()
            +
            +
            Gets the value of the 'ttl_seconds' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTtlSeconds

            +
            +public LocalityGroupDesc.Builder setTtlSeconds(int value)
            +
            +
            Sets the value of the 'ttl_seconds' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasTtlSeconds

            +
            +public boolean hasTtlSeconds()
            +
            +
            Checks whether the 'ttl_seconds' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearTtlSeconds

            +
            +public LocalityGroupDesc.Builder clearTtlSeconds()
            +
            +
            Clears the value of the 'ttl_seconds' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getCompressionType

            +
            +public CompressionType getCompressionType()
            +
            +
            Gets the value of the 'compression_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setCompressionType

            +
            +public LocalityGroupDesc.Builder setCompressionType(CompressionType value)
            +
            +
            Sets the value of the 'compression_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasCompressionType

            +
            +public boolean hasCompressionType()
            +
            +
            Checks whether the 'compression_type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearCompressionType

            +
            +public LocalityGroupDesc.Builder clearCompressionType()
            +
            +
            Clears the value of the 'compression_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getFamilies

            +
            +public List<FamilyDesc> getFamilies()
            +
            +
            Gets the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setFamilies

            +
            +public LocalityGroupDesc.Builder setFamilies(List<FamilyDesc> value)
            +
            +
            Sets the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasFamilies

            +
            +public boolean hasFamilies()
            +
            +
            Checks whether the 'families' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearFamilies

            +
            +public LocalityGroupDesc.Builder clearFamilies()
            +
            +
            Clears the value of the 'families' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public LocalityGroupDesc.Builder setDelete(boolean value)
            +
            +
            Sets the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDelete

            +
            +public boolean hasDelete()
            +
            +
            Checks whether the 'delete' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDelete

            +
            +public LocalityGroupDesc.Builder clearDelete()
            +
            +
            Clears the value of the 'delete' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public LocalityGroupDesc.Builder setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasRenamedFrom

            +
            +public boolean hasRenamedFrom()
            +
            +
            Checks whether the 'renamed_from' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearRenamedFrom

            +
            +public LocalityGroupDesc.Builder clearRenamedFrom()
            +
            +
            Clears the value of the 'renamed_from' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public LocalityGroupDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<LocalityGroupDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/LocalityGroupDesc.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/LocalityGroupDesc.html new file mode 100644 index 00000000..0bfaae85 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/LocalityGroupDesc.html @@ -0,0 +1,1332 @@ + + + + + + + +LocalityGroupDesc (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class LocalityGroupDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.LocalityGroupDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class LocalityGroupDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classLocalityGroupDesc.Builder + +
            +          RecordBuilder for LocalityGroupDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<String>aliases + +
            +          Deprecated. 
            + CompressionTypecompression_type + +
            +          Deprecated. 
            + booleandelete + +
            +          Deprecated. 
            + Stringdescription + +
            +          Deprecated. 
            + booleanenabled + +
            +          Deprecated. 
            + List<FamilyDesc>families + +
            +          Deprecated. 
            + intid + +
            +          Deprecated. 
            + booleanin_memory + +
            +          Deprecated. 
            + intmax_versions + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringrenamed_from + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + intttl_seconds + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            LocalityGroupDesc() + +
            +          Default constructor.
            LocalityGroupDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + Boolean in_memory, + Integer max_versions, + Integer ttl_seconds, + CompressionType compression_type, + List<FamilyDesc> families, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<String>getAliases() + +
            +          Gets the value of the 'aliases' field.
            + CompressionTypegetCompressionType() + +
            +          Gets the value of the 'compression_type' field.
            + BooleangetDelete() + +
            +          Gets the value of the 'delete' field.
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + BooleangetEnabled() + +
            +          Gets the value of the 'enabled' field.
            + List<FamilyDesc>getFamilies() + +
            +          Gets the value of the 'families' field.
            + IntegergetId() + +
            +          Gets the value of the 'id' field.
            + BooleangetInMemory() + +
            +          Gets the value of the 'in_memory' field.
            + IntegergetMaxVersions() + +
            +          Gets the value of the 'max_versions' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetRenamedFrom() + +
            +          Gets the value of the 'renamed_from' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + IntegergetTtlSeconds() + +
            +          Gets the value of the 'ttl_seconds' field.
            +static LocalityGroupDesc.BuildernewBuilder() + +
            +          Creates a new LocalityGroupDesc RecordBuilder
            +static LocalityGroupDesc.BuildernewBuilder(LocalityGroupDesc.Builder other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder
            +static LocalityGroupDesc.BuildernewBuilder(LocalityGroupDesc other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field.
            + voidsetCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field.
            + voidsetDelete(Boolean value) + +
            +          Sets the value of the 'delete' field.
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetEnabled(Boolean value) + +
            +          Sets the value of the 'enabled' field.
            + voidsetFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field.
            + voidsetId(Integer value) + +
            +          Sets the value of the 'id' field.
            + voidsetInMemory(Boolean value) + +
            +          Sets the value of the 'in_memory' field.
            + voidsetMaxVersions(Integer value) + +
            +          Sets the value of the 'max_versions' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field.
            + voidsetTtlSeconds(Integer value) + +
            +          Sets the value of the 'ttl_seconds' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public int id
            +
            +
            Deprecated. 
            Locality group ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Locality group primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            + +

            +aliases

            +
            +@Deprecated
+public List<String> aliases
            +
            +
            Deprecated. 
            Locality group name aliases. +

            +

            +
            +
            +
            + +

            +enabled

            +
            +@Deprecated
+public boolean enabled
            +
            +
            Deprecated. 
            When false, the locality group and its famillies are not visible. +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the locality group. +

            +

            +
            +
            +
            + +

            +in_memory

            +
            +@Deprecated
+public boolean in_memory
            +
            +
            Deprecated. 
            Reduce latency by forcing all data to be kept in memory. +

            +

            +
            +
            +
            + +

            +max_versions

            +
            +@Deprecated
+public int max_versions
            +
            +
            Deprecated. 
            Maximum number of the most recent cell versions to retain. +

            +

            +
            +
            +
            + +

            +ttl_seconds

            +
            +@Deprecated
+public int ttl_seconds
            +
            +
            Deprecated. 
            Length of time in seconds to retain cells. +

            +

            +
            +
            +
            + +

            +compression_type

            +
            +@Deprecated
+public CompressionType compression_type
            +
            +
            Deprecated. 
            Data compression type. +

            +

            +
            +
            +
            + +

            +families

            +
            +@Deprecated
+public List<FamilyDesc> families
            +
            +
            Deprecated. 
            Column family descriptors. +

            +

            +
            +
            +
            + +

            +delete

            +
            +@Deprecated
+public boolean delete
            +
            +
            Deprecated. 
            When true, applying this layout deletes the locality group. +

            +

            +
            +
            +
            + +

            +renamed_from

            +
            +@Deprecated
+public String renamed_from
            +
            +
            Deprecated. 
            Reference primary name of the locality group, when renaming. +

            +

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

            +LocalityGroupDesc

            +
            +public LocalityGroupDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +LocalityGroupDesc

            +
            +public LocalityGroupDesc(Integer id,
+                         String name,
+                         List<String> aliases,
+                         Boolean enabled,
+                         String description,
+                         Boolean in_memory,
+                         Integer max_versions,
+                         Integer ttl_seconds,
+                         CompressionType compression_type,
+                         List<FamilyDesc> families,
+                         Boolean delete,
+                         String renamed_from)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Integer getId()
            +
            +
            Gets the value of the 'id' field. + Locality group ID. Not visible to the user. 0 means unset. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Integer value)
            +
            +
            Sets the value of the 'id' field. + Locality group ID. Not visible to the user. 0 means unset. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Locality group primary name ([a-zA-Z_][a-zA-Z0-9_]*). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Locality group primary name ([a-zA-Z_][a-zA-Z0-9_]*). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAliases

            +
            +public List<String> getAliases()
            +
            +
            Gets the value of the 'aliases' field. + Locality group name aliases. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAliases

            +
            +public void setAliases(List<String> value)
            +
            +
            Sets the value of the 'aliases' field. + Locality group name aliases. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getEnabled

            +
            +public Boolean getEnabled()
            +
            +
            Gets the value of the 'enabled' field. + When false, the locality group and its famillies are not visible. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEnabled

            +
            +public void setEnabled(Boolean value)
            +
            +
            Sets the value of the 'enabled' field. + When false, the locality group and its famillies are not visible. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the locality group. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the locality group. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getInMemory

            +
            +public Boolean getInMemory()
            +
            +
            Gets the value of the 'in_memory' field. + Reduce latency by forcing all data to be kept in memory. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setInMemory

            +
            +public void setInMemory(Boolean value)
            +
            +
            Sets the value of the 'in_memory' field. + Reduce latency by forcing all data to be kept in memory. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMaxVersions

            +
            +public Integer getMaxVersions()
            +
            +
            Gets the value of the 'max_versions' field. + Maximum number of the most recent cell versions to retain. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMaxVersions

            +
            +public void setMaxVersions(Integer value)
            +
            +
            Sets the value of the 'max_versions' field. + Maximum number of the most recent cell versions to retain. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getTtlSeconds

            +
            +public Integer getTtlSeconds()
            +
            +
            Gets the value of the 'ttl_seconds' field. + Length of time in seconds to retain cells. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTtlSeconds

            +
            +public void setTtlSeconds(Integer value)
            +
            +
            Sets the value of the 'ttl_seconds' field. + Length of time in seconds to retain cells. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getCompressionType

            +
            +public CompressionType getCompressionType()
            +
            +
            Gets the value of the 'compression_type' field. + Data compression type. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setCompressionType

            +
            +public void setCompressionType(CompressionType value)
            +
            +
            Sets the value of the 'compression_type' field. + Data compression type. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getFamilies

            +
            +public List<FamilyDesc> getFamilies()
            +
            +
            Gets the value of the 'families' field. + Column family descriptors. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setFamilies

            +
            +public void setFamilies(List<FamilyDesc> value)
            +
            +
            Sets the value of the 'families' field. + Column family descriptors. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDelete

            +
            +public Boolean getDelete()
            +
            +
            Gets the value of the 'delete' field. + When true, applying this layout deletes the locality group. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDelete

            +
            +public void setDelete(Boolean value)
            +
            +
            Sets the value of the 'delete' field. + When true, applying this layout deletes the locality group. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRenamedFrom

            +
            +public String getRenamedFrom()
            +
            +
            Gets the value of the 'renamed_from' field. + Reference primary name of the locality group, when renaming. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRenamedFrom

            +
            +public void setRenamedFrom(String value)
            +
            +
            Sets the value of the 'renamed_from' field. + Reference primary name of the locality group, when renaming. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static LocalityGroupDesc.Builder newBuilder()
            +
            +
            Creates a new LocalityGroupDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static LocalityGroupDesc.Builder newBuilder(LocalityGroupDesc.Builder other)
            +
            +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static LocalityGroupDesc.Builder newBuilder(LocalityGroupDesc other)
            +
            +
            Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/MD5Hash.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/MD5Hash.html new file mode 100644 index 00000000..0db8520f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/MD5Hash.html @@ -0,0 +1,294 @@ + + + + + + + +MD5Hash (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class MD5Hash

            +
            +java.lang.Object
+  extended by org.apache.avro.generic.GenericData.Fixed
+      extended by org.apache.avro.specific.SpecificFixed
+          extended by org.kiji.schema.avro.MD5Hash
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.generic.GenericData.Fixed>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.GenericFixed
            +
            +
            +
            +
            @FixedSize(value=16)
+public class MD5Hash
            extends org.apache.avro.specific.SpecificFixed
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            MD5Hash() + +
            +          Creates a new MD5Hash
            MD5Hash(byte[] bytes) + +
            +          Creates a new MD5Hash with the given bytes
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.generic.GenericData.Fixed
            bytes, bytes, compareTo, equals, getSchema, hashCode, setSchema, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +MD5Hash

            +
            +public MD5Hash()
            +
            +
            Creates a new MD5Hash +

            +

            +
            + +

            +MD5Hash

            +
            +public MD5Hash(byte[] bytes)
            +
            +
            Creates a new MD5Hash with the given bytes +

            +

            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/MetadataBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/MetadataBackup.Builder.html new file mode 100644 index 00000000..c2ea89d7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/MetadataBackup.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +MetadataBackup.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class MetadataBackup.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<MetadataBackup>
+          extended by org.kiji.schema.avro.MetadataBackup.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<MetadataBackup>
            +
            +
            +
            Enclosing class:
            MetadataBackup
            +
            +
            +
            +
            public static class MetadataBackup.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<MetadataBackup>
            implements org.apache.avro.data.RecordBuilder<MetadataBackup>
            + + +

            +RecordBuilder for MetadataBackup instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + MetadataBackupbuild() + +
            +           
            + MetadataBackup.BuilderclearLayoutVersion() + +
            +          Clears the value of the 'layout_version' field
            + MetadataBackup.BuilderclearMetaTable() + +
            +          Clears the value of the 'meta_table' field
            + MetadataBackup.BuilderclearSchemaTable() + +
            +          Clears the value of the 'schema_table' field
            + StringgetLayoutVersion() + +
            +          Gets the value of the 'layout_version' field
            + Map<String,TableBackup>getMetaTable() + +
            +          Gets the value of the 'meta_table' field
            + List<SchemaTableEntry>getSchemaTable() + +
            +          Gets the value of the 'schema_table' field
            + booleanhasLayoutVersion() + +
            +          Checks whether the 'layout_version' field has been set
            + booleanhasMetaTable() + +
            +          Checks whether the 'meta_table' field has been set
            + booleanhasSchemaTable() + +
            +          Checks whether the 'schema_table' field has been set
            + MetadataBackup.BuildersetLayoutVersion(String value) + +
            +          Sets the value of the 'layout_version' field
            + MetadataBackup.BuildersetMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field
            + MetadataBackup.BuildersetSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getLayoutVersion

            +
            +public String getLayoutVersion()
            +
            +
            Gets the value of the 'layout_version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutVersion

            +
            +public MetadataBackup.Builder setLayoutVersion(String value)
            +
            +
            Sets the value of the 'layout_version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayoutVersion

            +
            +public boolean hasLayoutVersion()
            +
            +
            Checks whether the 'layout_version' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayoutVersion

            +
            +public MetadataBackup.Builder clearLayoutVersion()
            +
            +
            Clears the value of the 'layout_version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public List<SchemaTableEntry> getSchemaTable()
            +
            +
            Gets the value of the 'schema_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSchemaTable

            +
            +public MetadataBackup.Builder setSchemaTable(List<SchemaTableEntry> value)
            +
            +
            Sets the value of the 'schema_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasSchemaTable

            +
            +public boolean hasSchemaTable()
            +
            +
            Checks whether the 'schema_table' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearSchemaTable

            +
            +public MetadataBackup.Builder clearSchemaTable()
            +
            +
            Clears the value of the 'schema_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMetaTable

            +
            +public Map<String,TableBackup> getMetaTable()
            +
            +
            Gets the value of the 'meta_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMetaTable

            +
            +public MetadataBackup.Builder setMetaTable(Map<String,TableBackup> value)
            +
            +
            Sets the value of the 'meta_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasMetaTable

            +
            +public boolean hasMetaTable()
            +
            +
            Checks whether the 'meta_table' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearMetaTable

            +
            +public MetadataBackup.Builder clearMetaTable()
            +
            +
            Clears the value of the 'meta_table' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public MetadataBackup build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<MetadataBackup>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/MetadataBackup.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/MetadataBackup.html new file mode 100644 index 00000000..1fdb8061 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/MetadataBackup.html @@ -0,0 +1,675 @@ + + + + + + + +MetadataBackup (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class MetadataBackup

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.MetadataBackup
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class MetadataBackup
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classMetadataBackup.Builder + +
            +          RecordBuilder for MetadataBackup instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringlayout_version + +
            +          Deprecated. 
            + Map<String,TableBackup>meta_table + +
            +          Deprecated. 
            + List<SchemaTableEntry>schema_table + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            MetadataBackup() + +
            +          Default constructor.
            MetadataBackup(String layout_version, + List<SchemaTableEntry> schema_table, + Map<String,TableBackup> meta_table) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetLayoutVersion() + +
            +          Gets the value of the 'layout_version' field.
            + Map<String,TableBackup>getMetaTable() + +
            +          Gets the value of the 'meta_table' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + List<SchemaTableEntry>getSchemaTable() + +
            +          Gets the value of the 'schema_table' field.
            +static MetadataBackup.BuildernewBuilder() + +
            +          Creates a new MetadataBackup RecordBuilder
            +static MetadataBackup.BuildernewBuilder(MetadataBackup.Builder other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing Builder
            +static MetadataBackup.BuildernewBuilder(MetadataBackup other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetLayoutVersion(String value) + +
            +          Sets the value of the 'layout_version' field.
            + voidsetMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field.
            + voidsetSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +layout_version

            +
            +@Deprecated
+public String layout_version
            +
            +
            Deprecated. 
            Layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            + +

            +schema_table

            +
            +@Deprecated
+public List<SchemaTableEntry> schema_table
            +
            +
            Deprecated. 
            Schema entries. +

            +

            +
            +
            +
            + +

            +meta_table

            +
            +@Deprecated
+public Map<String,TableBackup> meta_table
            +
            +
            Deprecated. 
            Map from table names to table backup records. +

            +

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

            +MetadataBackup

            +
            +public MetadataBackup()
            +
            +
            Default constructor. +

            +

            +
            + +

            +MetadataBackup

            +
            +public MetadataBackup(String layout_version,
+                      List<SchemaTableEntry> schema_table,
+                      Map<String,TableBackup> meta_table)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getLayoutVersion

            +
            +public String getLayoutVersion()
            +
            +
            Gets the value of the 'layout_version' field. + Layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutVersion

            +
            +public void setLayoutVersion(String value)
            +
            +
            Sets the value of the 'layout_version' field. + Layout version (eg. "kiji-1.0"). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public List<SchemaTableEntry> getSchemaTable()
            +
            +
            Gets the value of the 'schema_table' field. + Schema entries. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSchemaTable

            +
            +public void setSchemaTable(List<SchemaTableEntry> value)
            +
            +
            Sets the value of the 'schema_table' field. + Schema entries. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getMetaTable

            +
            +public Map<String,TableBackup> getMetaTable()
            +
            +
            Gets the value of the 'meta_table' field. + Map from table names to table backup records. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setMetaTable

            +
            +public void setMetaTable(Map<String,TableBackup> value)
            +
            +
            Sets the value of the 'meta_table' field. + Map from table names to table backup records. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static MetadataBackup.Builder newBuilder()
            +
            +
            Creates a new MetadataBackup RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static MetadataBackup.Builder newBuilder(MetadataBackup.Builder other)
            +
            +
            Creates a new MetadataBackup RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static MetadataBackup.Builder newBuilder(MetadataBackup other)
            +
            +
            Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyComponent.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyComponent.Builder.html new file mode 100644 index 00000000..508a4798 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyComponent.Builder.html @@ -0,0 +1,436 @@ + + + + + + + +RowKeyComponent.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class RowKeyComponent.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<RowKeyComponent>
+          extended by org.kiji.schema.avro.RowKeyComponent.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<RowKeyComponent>
            +
            +
            +
            Enclosing class:
            RowKeyComponent
            +
            +
            +
            +
            public static class RowKeyComponent.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<RowKeyComponent>
            implements org.apache.avro.data.RecordBuilder<RowKeyComponent>
            + + +

            +RecordBuilder for RowKeyComponent instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + RowKeyComponentbuild() + +
            +           
            + RowKeyComponent.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + RowKeyComponent.BuilderclearType() + +
            +          Clears the value of the 'type' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + ComponentTypegetType() + +
            +          Gets the value of the 'type' field
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasType() + +
            +          Checks whether the 'type' field has been set
            + RowKeyComponent.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + RowKeyComponent.BuildersetType(ComponentType value) + +
            +          Sets the value of the 'type' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public RowKeyComponent.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public RowKeyComponent.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getType

            +
            +public ComponentType getType()
            +
            +
            Gets the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setType

            +
            +public RowKeyComponent.Builder setType(ComponentType value)
            +
            +
            Sets the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasType

            +
            +public boolean hasType()
            +
            +
            Checks whether the 'type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearType

            +
            +public RowKeyComponent.Builder clearType()
            +
            +
            Clears the value of the 'type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public RowKeyComponent build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<RowKeyComponent>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyComponent.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyComponent.html new file mode 100644 index 00000000..e9b00bd2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyComponent.html @@ -0,0 +1,605 @@ + + + + + + + +RowKeyComponent (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class RowKeyComponent

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.RowKeyComponent
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class RowKeyComponent
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classRowKeyComponent.Builder + +
            +          RecordBuilder for RowKeyComponent instances.
            +  + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringname + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + ComponentTypetype + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            RowKeyComponent() + +
            +          Default constructor.
            RowKeyComponent(String name, + ComponentType type) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + ComponentTypegetType() + +
            +          Gets the value of the 'type' field.
            +static RowKeyComponent.BuildernewBuilder() + +
            +          Creates a new RowKeyComponent RecordBuilder
            +static RowKeyComponent.BuildernewBuilder(RowKeyComponent.Builder other) + +
            +          Creates a new RowKeyComponent RecordBuilder by copying an existing Builder
            +static RowKeyComponent.BuildernewBuilder(RowKeyComponent other) + +
            +          Creates a new RowKeyComponent RecordBuilder by copying an existing RowKeyComponent instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetType(ComponentType value) + +
            +          Sets the value of the 'type' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Name of element. This name must match the regular expression for + identifiers: [A-Za-z_][A-Za-z0-9_]. +

            +

            +
            +
            +
            + +

            +type

            +
            +@Deprecated
+public ComponentType type
            +
            +
            Deprecated. 
            Primitive type of the component. +

            +

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

            +RowKeyComponent

            +
            +public RowKeyComponent()
            +
            +
            Default constructor. +

            +

            +
            + +

            +RowKeyComponent

            +
            +public RowKeyComponent(String name,
+                       ComponentType type)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + * Name of element. This name must match the regular expression for + identifiers: [A-Za-z_][A-Za-z0-9_]. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + * Name of element. This name must match the regular expression for + identifiers: [A-Za-z_][A-Za-z0-9_]. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getType

            +
            +public ComponentType getType()
            +
            +
            Gets the value of the 'type' field. + Primitive type of the component. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setType

            +
            +public void setType(ComponentType value)
            +
            +
            Sets the value of the 'type' field. + Primitive type of the component. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyComponent.Builder newBuilder()
            +
            +
            Creates a new RowKeyComponent RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyComponent.Builder newBuilder(RowKeyComponent.Builder other)
            +
            +
            Creates a new RowKeyComponent RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyComponent.Builder newBuilder(RowKeyComponent other)
            +
            +
            Creates a new RowKeyComponent RecordBuilder by copying an existing RowKeyComponent instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyEncoding.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyEncoding.html new file mode 100644 index 00000000..3a37fad4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyEncoding.html @@ -0,0 +1,391 @@ + + + + + + + +RowKeyEncoding (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum RowKeyEncoding

            +
            +java.lang.Object
+  extended by java.lang.Enum<RowKeyEncoding>
+      extended by org.kiji.schema.avro.RowKeyEncoding
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<RowKeyEncoding>
            +
            +
            +
            +
            public enum RowKeyEncoding
            extends Enum<RowKeyEncoding>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            FORMATTED + +
            +           
            HASH + +
            +           
            HASH_PREFIX + +
            +           
            RAW + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static RowKeyEncodingvalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static RowKeyEncoding[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +RAW

            +
            +public static final RowKeyEncoding RAW
            +
            +
            +
            +
            +
            + +

            +HASH

            +
            +public static final RowKeyEncoding HASH
            +
            +
            +
            +
            +
            + +

            +HASH_PREFIX

            +
            +public static final RowKeyEncoding HASH_PREFIX
            +
            +
            +
            +
            +
            + +

            +FORMATTED

            +
            +public static final RowKeyEncoding FORMATTED
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static RowKeyEncoding[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (RowKeyEncoding c : RowKeyEncoding.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static RowKeyEncoding valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat.Builder.html new file mode 100644 index 00000000..d866d011 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +RowKeyFormat.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class RowKeyFormat.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<RowKeyFormat>
+          extended by org.kiji.schema.avro.RowKeyFormat.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<RowKeyFormat>
            +
            +
            +
            Enclosing class:
            RowKeyFormat
            +
            +
            +
            +
            public static class RowKeyFormat.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<RowKeyFormat>
            implements org.apache.avro.data.RecordBuilder<RowKeyFormat>
            + + +

            +RecordBuilder for RowKeyFormat instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + RowKeyFormatbuild() + +
            +           
            + RowKeyFormat.BuilderclearEncoding() + +
            +          Clears the value of the 'encoding' field
            + RowKeyFormat.BuilderclearHashSize() + +
            +          Clears the value of the 'hash_size' field
            + RowKeyFormat.BuilderclearHashType() + +
            +          Clears the value of the 'hash_type' field
            + RowKeyEncodinggetEncoding() + +
            +          Gets the value of the 'encoding' field
            + IntegergetHashSize() + +
            +          Gets the value of the 'hash_size' field
            + HashTypegetHashType() + +
            +          Gets the value of the 'hash_type' field
            + booleanhasEncoding() + +
            +          Checks whether the 'encoding' field has been set
            + booleanhasHashSize() + +
            +          Checks whether the 'hash_size' field has been set
            + booleanhasHashType() + +
            +          Checks whether the 'hash_type' field has been set
            + RowKeyFormat.BuildersetEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            + RowKeyFormat.BuildersetHashSize(int value) + +
            +          Sets the value of the 'hash_size' field
            + RowKeyFormat.BuildersetHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEncoding

            +
            +public RowKeyEncoding getEncoding()
            +
            +
            Gets the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEncoding

            +
            +public RowKeyFormat.Builder setEncoding(RowKeyEncoding value)
            +
            +
            Sets the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEncoding

            +
            +public boolean hasEncoding()
            +
            +
            Checks whether the 'encoding' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEncoding

            +
            +public RowKeyFormat.Builder clearEncoding()
            +
            +
            Clears the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashType

            +
            +public HashType getHashType()
            +
            +
            Gets the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashType

            +
            +public RowKeyFormat.Builder setHashType(HashType value)
            +
            +
            Sets the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHashType

            +
            +public boolean hasHashType()
            +
            +
            Checks whether the 'hash_type' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHashType

            +
            +public RowKeyFormat.Builder clearHashType()
            +
            +
            Clears the value of the 'hash_type' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashSize

            +
            +public Integer getHashSize()
            +
            +
            Gets the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashSize

            +
            +public RowKeyFormat.Builder setHashSize(int value)
            +
            +
            Sets the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHashSize

            +
            +public boolean hasHashSize()
            +
            +
            Checks whether the 'hash_size' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHashSize

            +
            +public RowKeyFormat.Builder clearHashSize()
            +
            +
            Clears the value of the 'hash_size' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public RowKeyFormat build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<RowKeyFormat>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat.html new file mode 100644 index 00000000..e88e2628 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat.html @@ -0,0 +1,681 @@ + + + + + + + +RowKeyFormat (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class RowKeyFormat

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.RowKeyFormat
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class RowKeyFormat
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classRowKeyFormat.Builder + +
            +          RecordBuilder for RowKeyFormat instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + RowKeyEncodingencoding + +
            +          Deprecated. 
            + inthash_size + +
            +          Deprecated. 
            + HashTypehash_type + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            RowKeyFormat() + +
            +          Default constructor.
            RowKeyFormat(RowKeyEncoding encoding, + HashType hash_type, + Integer hash_size) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + RowKeyEncodinggetEncoding() + +
            +          Gets the value of the 'encoding' field.
            + IntegergetHashSize() + +
            +          Gets the value of the 'hash_size' field.
            + HashTypegetHashType() + +
            +          Gets the value of the 'hash_type' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static RowKeyFormat.BuildernewBuilder() + +
            +          Creates a new RowKeyFormat RecordBuilder
            +static RowKeyFormat.BuildernewBuilder(RowKeyFormat.Builder other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing Builder
            +static RowKeyFormat.BuildernewBuilder(RowKeyFormat other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field.
            + voidsetHashSize(Integer value) + +
            +          Sets the value of the 'hash_size' field.
            + voidsetHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +encoding

            +
            +@Deprecated
+public RowKeyEncoding encoding
            +
            +
            Deprecated. 
            Encoding of the row key. +

            +

            +
            +
            +
            + +

            +hash_type

            +
            +@Deprecated
+public HashType hash_type
            +
            +
            Deprecated. 
            Type of hashing used, if any. +

            +

            +
            +
            +
            + +

            +hash_size

            +
            +@Deprecated
+public int hash_size
            +
            +
            Deprecated. 
            Size of the hash, in bytes. + - unused when encoding is RAW. + - smaller than the hash size used for HASH or HASH_PREFIX. +

            +

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

            +RowKeyFormat

            +
            +public RowKeyFormat()
            +
            +
            Default constructor. +

            +

            +
            + +

            +RowKeyFormat

            +
            +public RowKeyFormat(RowKeyEncoding encoding,
+                    HashType hash_type,
+                    Integer hash_size)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getEncoding

            +
            +public RowKeyEncoding getEncoding()
            +
            +
            Gets the value of the 'encoding' field. + Encoding of the row key. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEncoding

            +
            +public void setEncoding(RowKeyEncoding value)
            +
            +
            Sets the value of the 'encoding' field. + Encoding of the row key. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashType

            +
            +public HashType getHashType()
            +
            +
            Gets the value of the 'hash_type' field. + Type of hashing used, if any. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashType

            +
            +public void setHashType(HashType value)
            +
            +
            Sets the value of the 'hash_type' field. + Type of hashing used, if any. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHashSize

            +
            +public Integer getHashSize()
            +
            +
            Gets the value of the 'hash_size' field. + * Size of the hash, in bytes. + - unused when encoding is RAW. + - smaller than the hash size used for HASH or HASH_PREFIX. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHashSize

            +
            +public void setHashSize(Integer value)
            +
            +
            Sets the value of the 'hash_size' field. + * Size of the hash, in bytes. + - unused when encoding is RAW. + - smaller than the hash size used for HASH or HASH_PREFIX. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat.Builder newBuilder()
            +
            +
            Creates a new RowKeyFormat RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat.Builder newBuilder(RowKeyFormat.Builder other)
            +
            +
            Creates a new RowKeyFormat RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat.Builder newBuilder(RowKeyFormat other)
            +
            +
            Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat2.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat2.Builder.html new file mode 100644 index 00000000..07bc8a96 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat2.Builder.html @@ -0,0 +1,724 @@ + + + + + + + +RowKeyFormat2.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class RowKeyFormat2.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<RowKeyFormat2>
+          extended by org.kiji.schema.avro.RowKeyFormat2.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<RowKeyFormat2>
            +
            +
            +
            Enclosing class:
            RowKeyFormat2
            +
            +
            +
            +
            public static class RowKeyFormat2.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<RowKeyFormat2>
            implements org.apache.avro.data.RecordBuilder<RowKeyFormat2>
            + + +

            +RecordBuilder for RowKeyFormat2 instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + RowKeyFormat2build() + +
            +           
            + RowKeyFormat2.BuilderclearComponents() + +
            +          Clears the value of the 'components' field
            + RowKeyFormat2.BuilderclearEncoding() + +
            +          Clears the value of the 'encoding' field
            + RowKeyFormat2.BuilderclearNullableStartIndex() + +
            +          Clears the value of the 'nullable_start_index' field
            + RowKeyFormat2.BuilderclearRangeScanStartIndex() + +
            +          Clears the value of the 'range_scan_start_index' field
            + RowKeyFormat2.BuilderclearSalt() + +
            +          Clears the value of the 'salt' field
            + List<RowKeyComponent>getComponents() + +
            +          Gets the value of the 'components' field
            + RowKeyEncodinggetEncoding() + +
            +          Gets the value of the 'encoding' field
            + IntegergetNullableStartIndex() + +
            +          Gets the value of the 'nullable_start_index' field
            + IntegergetRangeScanStartIndex() + +
            +          Gets the value of the 'range_scan_start_index' field
            + HashSpecgetSalt() + +
            +          Gets the value of the 'salt' field
            + booleanhasComponents() + +
            +          Checks whether the 'components' field has been set
            + booleanhasEncoding() + +
            +          Checks whether the 'encoding' field has been set
            + booleanhasNullableStartIndex() + +
            +          Checks whether the 'nullable_start_index' field has been set
            + booleanhasRangeScanStartIndex() + +
            +          Checks whether the 'range_scan_start_index' field has been set
            + booleanhasSalt() + +
            +          Checks whether the 'salt' field has been set
            + RowKeyFormat2.BuildersetComponents(List<RowKeyComponent> value) + +
            +          Sets the value of the 'components' field
            + RowKeyFormat2.BuildersetEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            + RowKeyFormat2.BuildersetNullableStartIndex(int value) + +
            +          Sets the value of the 'nullable_start_index' field
            + RowKeyFormat2.BuildersetRangeScanStartIndex(int value) + +
            +          Sets the value of the 'range_scan_start_index' field
            + RowKeyFormat2.BuildersetSalt(HashSpec value) + +
            +          Sets the value of the 'salt' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEncoding

            +
            +public RowKeyEncoding getEncoding()
            +
            +
            Gets the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEncoding

            +
            +public RowKeyFormat2.Builder setEncoding(RowKeyEncoding value)
            +
            +
            Sets the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasEncoding

            +
            +public boolean hasEncoding()
            +
            +
            Checks whether the 'encoding' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearEncoding

            +
            +public RowKeyFormat2.Builder clearEncoding()
            +
            +
            Clears the value of the 'encoding' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSalt

            +
            +public HashSpec getSalt()
            +
            +
            Gets the value of the 'salt' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSalt

            +
            +public RowKeyFormat2.Builder setSalt(HashSpec value)
            +
            +
            Sets the value of the 'salt' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasSalt

            +
            +public boolean hasSalt()
            +
            +
            Checks whether the 'salt' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearSalt

            +
            +public RowKeyFormat2.Builder clearSalt()
            +
            +
            Clears the value of the 'salt' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRangeScanStartIndex

            +
            +public Integer getRangeScanStartIndex()
            +
            +
            Gets the value of the 'range_scan_start_index' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRangeScanStartIndex

            +
            +public RowKeyFormat2.Builder setRangeScanStartIndex(int value)
            +
            +
            Sets the value of the 'range_scan_start_index' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasRangeScanStartIndex

            +
            +public boolean hasRangeScanStartIndex()
            +
            +
            Checks whether the 'range_scan_start_index' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearRangeScanStartIndex

            +
            +public RowKeyFormat2.Builder clearRangeScanStartIndex()
            +
            +
            Clears the value of the 'range_scan_start_index' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getNullableStartIndex

            +
            +public Integer getNullableStartIndex()
            +
            +
            Gets the value of the 'nullable_start_index' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setNullableStartIndex

            +
            +public RowKeyFormat2.Builder setNullableStartIndex(int value)
            +
            +
            Sets the value of the 'nullable_start_index' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasNullableStartIndex

            +
            +public boolean hasNullableStartIndex()
            +
            +
            Checks whether the 'nullable_start_index' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearNullableStartIndex

            +
            +public RowKeyFormat2.Builder clearNullableStartIndex()
            +
            +
            Clears the value of the 'nullable_start_index' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getComponents

            +
            +public List<RowKeyComponent> getComponents()
            +
            +
            Gets the value of the 'components' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setComponents

            +
            +public RowKeyFormat2.Builder setComponents(List<RowKeyComponent> value)
            +
            +
            Sets the value of the 'components' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasComponents

            +
            +public boolean hasComponents()
            +
            +
            Checks whether the 'components' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearComponents

            +
            +public RowKeyFormat2.Builder clearComponents()
            +
            +
            Clears the value of the 'components' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public RowKeyFormat2 build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<RowKeyFormat2>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat2.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat2.html new file mode 100644 index 00000000..e2a047f8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/RowKeyFormat2.html @@ -0,0 +1,848 @@ + + + + + + + +RowKeyFormat2 (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class RowKeyFormat2

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.RowKeyFormat2
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class RowKeyFormat2
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classRowKeyFormat2.Builder + +
            +          RecordBuilder for RowKeyFormat2 instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<RowKeyComponent>components + +
            +          Deprecated. 
            + RowKeyEncodingencoding + +
            +          Deprecated. 
            + intnullable_start_index + +
            +          Deprecated. 
            + intrange_scan_start_index + +
            +          Deprecated. 
            + HashSpecsalt + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            RowKeyFormat2() + +
            +          Default constructor.
            RowKeyFormat2(RowKeyEncoding encoding, + HashSpec salt, + Integer range_scan_start_index, + Integer nullable_start_index, + List<RowKeyComponent> components) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<RowKeyComponent>getComponents() + +
            +          Gets the value of the 'components' field.
            + RowKeyEncodinggetEncoding() + +
            +          Gets the value of the 'encoding' field.
            + IntegergetNullableStartIndex() + +
            +          Gets the value of the 'nullable_start_index' field.
            + IntegergetRangeScanStartIndex() + +
            +          Gets the value of the 'range_scan_start_index' field.
            + HashSpecgetSalt() + +
            +          Gets the value of the 'salt' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static RowKeyFormat2.BuildernewBuilder() + +
            +          Creates a new RowKeyFormat2 RecordBuilder
            +static RowKeyFormat2.BuildernewBuilder(RowKeyFormat2.Builder other) + +
            +          Creates a new RowKeyFormat2 RecordBuilder by copying an existing Builder
            +static RowKeyFormat2.BuildernewBuilder(RowKeyFormat2 other) + +
            +          Creates a new RowKeyFormat2 RecordBuilder by copying an existing RowKeyFormat2 instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetComponents(List<RowKeyComponent> value) + +
            +          Sets the value of the 'components' field.
            + voidsetEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field.
            + voidsetNullableStartIndex(Integer value) + +
            +          Sets the value of the 'nullable_start_index' field.
            + voidsetRangeScanStartIndex(Integer value) + +
            +          Sets the value of the 'range_scan_start_index' field.
            + voidsetSalt(HashSpec value) + +
            +          Sets the value of the 'salt' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +encoding

            +
            +@Deprecated
+public RowKeyEncoding encoding
            +
            +
            Deprecated. 
            Whether the row key is raw bytes or composed of one or more primitive types. +

            +

            +
            +
            +
            + +

            +salt

            +
            +@Deprecated
+public HashSpec salt
            +
            +
            Deprecated. 
            Specification for hashing. Hashing is left prefixed. +

            +

            +
            +
            +
            + +

            +range_scan_start_index

            +
            +@Deprecated
+public int range_scan_start_index
            +
            +
            Deprecated. 
            The first component index from which point we support range scans. This means + only components to the left of this will be included in the hash. IOW, you + are able to perform range scans over this component and components that follow. + It is invalid to make the first component of key support range scans. + 0 indexed. Set to key_spec.length to hash over the entire key. +

            +

            +
            +
            +
            + +

            +nullable_start_index

            +
            +@Deprecated
+public int nullable_start_index
            +
            +
            Deprecated. 
            The component at this index, and all following components can take null values. + A row key with a null component must ensure that all the components following it + are also null, in order to comply with ordering constraints. It is invalid to make + the first component of a key nullable. + 0 indexed. Set to key_spec.length to disallow nulls. +

            +

            +
            +
            +
            + +

            +components

            +
            +@Deprecated
+public List<RowKeyComponent> components
            +
            +
            Deprecated. 
            An ordered list of the individual components that make up this key. Must contain + at least one component. +

            +

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

            +RowKeyFormat2

            +
            +public RowKeyFormat2()
            +
            +
            Default constructor. +

            +

            +
            + +

            +RowKeyFormat2

            +
            +public RowKeyFormat2(RowKeyEncoding encoding,
+                     HashSpec salt,
+                     Integer range_scan_start_index,
+                     Integer nullable_start_index,
+                     List<RowKeyComponent> components)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getEncoding

            +
            +public RowKeyEncoding getEncoding()
            +
            +
            Gets the value of the 'encoding' field. + Whether the row key is raw bytes or composed of one or more primitive types. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setEncoding

            +
            +public void setEncoding(RowKeyEncoding value)
            +
            +
            Sets the value of the 'encoding' field. + Whether the row key is raw bytes or composed of one or more primitive types. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getSalt

            +
            +public HashSpec getSalt()
            +
            +
            Gets the value of the 'salt' field. + * Specification for hashing. Hashing is left prefixed. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setSalt

            +
            +public void setSalt(HashSpec value)
            +
            +
            Sets the value of the 'salt' field. + * Specification for hashing. Hashing is left prefixed. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getRangeScanStartIndex

            +
            +public Integer getRangeScanStartIndex()
            +
            +
            Gets the value of the 'range_scan_start_index' field. + * The first component index from which point we support range scans. This means + only components to the left of this will be included in the hash. IOW, you + are able to perform range scans over this component and components that follow. + It is invalid to make the first component of key support range scans. + 0 indexed. Set to key_spec.length to hash over the entire key. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setRangeScanStartIndex

            +
            +public void setRangeScanStartIndex(Integer value)
            +
            +
            Sets the value of the 'range_scan_start_index' field. + * The first component index from which point we support range scans. This means + only components to the left of this will be included in the hash. IOW, you + are able to perform range scans over this component and components that follow. + It is invalid to make the first component of key support range scans. + 0 indexed. Set to key_spec.length to hash over the entire key. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getNullableStartIndex

            +
            +public Integer getNullableStartIndex()
            +
            +
            Gets the value of the 'nullable_start_index' field. + * The component at this index, and all following components can take null values. + A row key with a null component must ensure that all the components following it + are also null, in order to comply with ordering constraints. It is invalid to make + the first component of a key nullable. + 0 indexed. Set to key_spec.length to disallow nulls. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setNullableStartIndex

            +
            +public void setNullableStartIndex(Integer value)
            +
            +
            Sets the value of the 'nullable_start_index' field. + * The component at this index, and all following components can take null values. + A row key with a null component must ensure that all the components following it + are also null, in order to comply with ordering constraints. It is invalid to make + the first component of a key nullable. + 0 indexed. Set to key_spec.length to disallow nulls. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getComponents

            +
            +public List<RowKeyComponent> getComponents()
            +
            +
            Gets the value of the 'components' field. + * An ordered list of the individual components that make up this key. Must contain + at least one component. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setComponents

            +
            +public void setComponents(List<RowKeyComponent> value)
            +
            +
            Sets the value of the 'components' field. + * An ordered list of the individual components that make up this key. Must contain + at least one component. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat2.Builder newBuilder()
            +
            +
            Creates a new RowKeyFormat2 RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat2.Builder newBuilder(RowKeyFormat2.Builder other)
            +
            +
            Creates a new RowKeyFormat2 RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static RowKeyFormat2.Builder newBuilder(RowKeyFormat2 other)
            +
            +
            Creates a new RowKeyFormat2 RecordBuilder by copying an existing RowKeyFormat2 instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaStorage.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaStorage.html new file mode 100644 index 00000000..e5b13c60 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaStorage.html @@ -0,0 +1,375 @@ + + + + + + + +SchemaStorage (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum SchemaStorage

            +
            +java.lang.Object
+  extended by java.lang.Enum<SchemaStorage>
+      extended by org.kiji.schema.avro.SchemaStorage
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<SchemaStorage>
            +
            +
            +
            +
            public enum SchemaStorage
            extends Enum<SchemaStorage>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            FINAL + +
            +           
            HASH + +
            +           
            UID + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static SchemaStoragevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaStorage[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +HASH

            +
            +public static final SchemaStorage HASH
            +
            +
            +
            +
            +
            + +

            +UID

            +
            +public static final SchemaStorage UID
            +
            +
            +
            +
            +
            + +

            +FINAL

            +
            +public static final SchemaStorage FINAL
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static SchemaStorage[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (SchemaStorage c : SchemaStorage.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static SchemaStorage valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaTableEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaTableEntry.Builder.html new file mode 100644 index 00000000..624b9b4b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaTableEntry.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +SchemaTableEntry.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class SchemaTableEntry.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<SchemaTableEntry>
+          extended by org.kiji.schema.avro.SchemaTableEntry.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<SchemaTableEntry>
            +
            +
            +
            Enclosing class:
            SchemaTableEntry
            +
            +
            +
            +
            public static class SchemaTableEntry.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<SchemaTableEntry>
            implements org.apache.avro.data.RecordBuilder<SchemaTableEntry>
            + + +

            +RecordBuilder for SchemaTableEntry instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + SchemaTableEntrybuild() + +
            +           
            + SchemaTableEntry.BuilderclearAvroSchema() + +
            +          Clears the value of the 'avro_schema' field
            + SchemaTableEntry.BuilderclearHash() + +
            +          Clears the value of the 'hash' field
            + SchemaTableEntry.BuilderclearId() + +
            +          Clears the value of the 'id' field
            + StringgetAvroSchema() + +
            +          Gets the value of the 'avro_schema' field
            + MD5HashgetHash() + +
            +          Gets the value of the 'hash' field
            + LonggetId() + +
            +          Gets the value of the 'id' field
            + booleanhasAvroSchema() + +
            +          Checks whether the 'avro_schema' field has been set
            + booleanhasHash() + +
            +          Checks whether the 'hash' field has been set
            + booleanhasId() + +
            +          Checks whether the 'id' field has been set
            + SchemaTableEntry.BuildersetAvroSchema(String value) + +
            +          Sets the value of the 'avro_schema' field
            + SchemaTableEntry.BuildersetHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field
            + SchemaTableEntry.BuildersetId(long value) + +
            +          Sets the value of the 'id' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getId

            +
            +public Long getId()
            +
            +
            Gets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public SchemaTableEntry.Builder setId(long value)
            +
            +
            Sets the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasId

            +
            +public boolean hasId()
            +
            +
            Checks whether the 'id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearId

            +
            +public SchemaTableEntry.Builder clearId()
            +
            +
            Clears the value of the 'id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHash

            +
            +public MD5Hash getHash()
            +
            +
            Gets the value of the 'hash' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHash

            +
            +public SchemaTableEntry.Builder setHash(MD5Hash value)
            +
            +
            Sets the value of the 'hash' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasHash

            +
            +public boolean hasHash()
            +
            +
            Checks whether the 'hash' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearHash

            +
            +public SchemaTableEntry.Builder clearHash()
            +
            +
            Clears the value of the 'hash' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAvroSchema

            +
            +public String getAvroSchema()
            +
            +
            Gets the value of the 'avro_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAvroSchema

            +
            +public SchemaTableEntry.Builder setAvroSchema(String value)
            +
            +
            Sets the value of the 'avro_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasAvroSchema

            +
            +public boolean hasAvroSchema()
            +
            +
            Checks whether the 'avro_schema' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearAvroSchema

            +
            +public SchemaTableEntry.Builder clearAvroSchema()
            +
            +
            Clears the value of the 'avro_schema' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public SchemaTableEntry build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<SchemaTableEntry>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaTableEntry.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaTableEntry.html new file mode 100644 index 00000000..0f17b542 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaTableEntry.html @@ -0,0 +1,675 @@ + + + + + + + +SchemaTableEntry (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class SchemaTableEntry

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.SchemaTableEntry
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class SchemaTableEntry
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classSchemaTableEntry.Builder + +
            +          RecordBuilder for SchemaTableEntry instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringavro_schema + +
            +          Deprecated. 
            + MD5Hashhash + +
            +          Deprecated. 
            + longid + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            SchemaTableEntry() + +
            +          Default constructor.
            SchemaTableEntry(Long id, + MD5Hash hash, + String avro_schema) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetAvroSchema() + +
            +          Gets the value of the 'avro_schema' field.
            + MD5HashgetHash() + +
            +          Gets the value of the 'hash' field.
            + LonggetId() + +
            +          Gets the value of the 'id' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static SchemaTableEntry.BuildernewBuilder() + +
            +          Creates a new SchemaTableEntry RecordBuilder
            +static SchemaTableEntry.BuildernewBuilder(SchemaTableEntry.Builder other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder
            +static SchemaTableEntry.BuildernewBuilder(SchemaTableEntry other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetAvroSchema(String value) + +
            +          Sets the value of the 'avro_schema' field.
            + voidsetHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field.
            + voidsetId(Long value) + +
            +          Sets the value of the 'id' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +id

            +
            +@Deprecated
+public long id
            +
            +
            Deprecated. 
            Schema ID: positive integers only. +

            +

            +
            +
            +
            + +

            +hash

            +
            +@Deprecated
+public MD5Hash hash
            +
            +
            Deprecated. 
            128 bits (16 bytes) hash of the schema JSON representation. +

            +

            +
            +
            +
            + +

            +avro_schema

            +
            +@Deprecated
+public String avro_schema
            +
            +
            Deprecated. 
            JSON representation of the schema. +

            +

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

            +SchemaTableEntry

            +
            +public SchemaTableEntry()
            +
            +
            Default constructor. +

            +

            +
            + +

            +SchemaTableEntry

            +
            +public SchemaTableEntry(Long id,
+                        MD5Hash hash,
+                        String avro_schema)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getId

            +
            +public Long getId()
            +
            +
            Gets the value of the 'id' field. + Schema ID: positive integers only. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setId

            +
            +public void setId(Long value)
            +
            +
            Sets the value of the 'id' field. + Schema ID: positive integers only. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getHash

            +
            +public MD5Hash getHash()
            +
            +
            Gets the value of the 'hash' field. + 128 bits (16 bytes) hash of the schema JSON representation. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setHash

            +
            +public void setHash(MD5Hash value)
            +
            +
            Sets the value of the 'hash' field. + 128 bits (16 bytes) hash of the schema JSON representation. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getAvroSchema

            +
            +public String getAvroSchema()
            +
            +
            Gets the value of the 'avro_schema' field. + JSON representation of the schema. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setAvroSchema

            +
            +public void setAvroSchema(String value)
            +
            +
            Sets the value of the 'avro_schema' field. + JSON representation of the schema. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static SchemaTableEntry.Builder newBuilder()
            +
            +
            Creates a new SchemaTableEntry RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static SchemaTableEntry.Builder newBuilder(SchemaTableEntry.Builder other)
            +
            +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static SchemaTableEntry.Builder newBuilder(SchemaTableEntry other)
            +
            +
            Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaType.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaType.html new file mode 100644 index 00000000..0e3d0635 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/SchemaType.html @@ -0,0 +1,375 @@ + + + + + + + +SchemaType (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Enum SchemaType

            +
            +java.lang.Object
+  extended by java.lang.Enum<SchemaType>
+      extended by org.kiji.schema.avro.SchemaType
+
            +
            +
            All Implemented Interfaces:
            Serializable, Comparable<SchemaType>
            +
            +
            +
            +
            public enum SchemaType
            extends Enum<SchemaType>
            + + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Enum Constant Summary
            CLASS + +
            +           
            COUNTER + +
            +           
            INLINE + +
            +           
            +  + + + + + + + + + + +
            +Field Summary
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static SchemaTypevalueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaType[]values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  + + + + + + + +
            Methods inherited from class java.lang.Enum
            clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Enum Constant Detail
            + +

            +INLINE

            +
            +public static final SchemaType INLINE
            +
            +
            +
            +
            +
            + +

            +CLASS

            +
            +public static final SchemaType CLASS
            +
            +
            +
            +
            +
            + +

            +COUNTER

            +
            +public static final SchemaType COUNTER
            +
            +
            +
            +
            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +values

            +
            +public static SchemaType[] values()
            +
            +
            Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +
            +for (SchemaType c : SchemaType.values())
+    System.out.println(c);
+
            +

            +

            + +
            Returns:
            an array containing the constants of this enum type, in +the order they are declared
            +
            +
            +
            + +

            +valueOf

            +
            +public static SchemaType valueOf(String name)
            +
            +
            Returns the enum constant of this type with the specified name. +The string must match exactly an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.) +

            +

            +
            Parameters:
            name - the name of the enum constant to be returned. +
            Returns:
            the enum constant with the specified name +
            Throws: +
            IllegalArgumentException - if this enum type has no constant +with the specified name +
            NullPointerException - if the argument is null
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD +DETAIL: ENUM CONSTANTS | FIELD | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableBackup.Builder.html new file mode 100644 index 00000000..00f4da92 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableBackup.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +TableBackup.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableBackup.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<TableBackup>
+          extended by org.kiji.schema.avro.TableBackup.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<TableBackup>
            +
            +
            +
            Enclosing class:
            TableBackup
            +
            +
            +
            +
            public static class TableBackup.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<TableBackup>
            implements org.apache.avro.data.RecordBuilder<TableBackup>
            + + +

            +RecordBuilder for TableBackup instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TableBackupbuild() + +
            +           
            + TableBackup.BuilderclearKeyValues() + +
            +          Clears the value of the 'key_values' field
            + TableBackup.BuilderclearLayouts() + +
            +          Clears the value of the 'layouts' field
            + TableBackup.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + List<KeyValueBackupEntry>getKeyValues() + +
            +          Gets the value of the 'key_values' field
            + List<TableLayoutBackupEntry>getLayouts() + +
            +          Gets the value of the 'layouts' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + booleanhasKeyValues() + +
            +          Checks whether the 'key_values' field has been set
            + booleanhasLayouts() + +
            +          Checks whether the 'layouts' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + TableBackup.BuildersetKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field
            + TableBackup.BuildersetLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field
            + TableBackup.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public TableBackup.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public TableBackup.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayouts

            +
            +public List<TableLayoutBackupEntry> getLayouts()
            +
            +
            Gets the value of the 'layouts' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayouts

            +
            +public TableBackup.Builder setLayouts(List<TableLayoutBackupEntry> value)
            +
            +
            Sets the value of the 'layouts' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayouts

            +
            +public boolean hasLayouts()
            +
            +
            Checks whether the 'layouts' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayouts

            +
            +public TableBackup.Builder clearLayouts()
            +
            +
            Clears the value of the 'layouts' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeyValues

            +
            +public List<KeyValueBackupEntry> getKeyValues()
            +
            +
            Gets the value of the 'key_values' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeyValues

            +
            +public TableBackup.Builder setKeyValues(List<KeyValueBackupEntry> value)
            +
            +
            Sets the value of the 'key_values' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasKeyValues

            +
            +public boolean hasKeyValues()
            +
            +
            Checks whether the 'key_values' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearKeyValues

            +
            +public TableBackup.Builder clearKeyValues()
            +
            +
            Clears the value of the 'key_values' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public TableBackup build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<TableBackup>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableBackup.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableBackup.html new file mode 100644 index 00000000..599811e8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableBackup.html @@ -0,0 +1,675 @@ + + + + + + + +TableBackup (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableBackup

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.TableBackup
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class TableBackup
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTableBackup.Builder + +
            +          RecordBuilder for TableBackup instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + List<KeyValueBackupEntry>key_values + +
            +          Deprecated. 
            + List<TableLayoutBackupEntry>layouts + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            TableBackup() + +
            +          Default constructor.
            TableBackup(String name, + List<TableLayoutBackupEntry> layouts, + List<KeyValueBackupEntry> key_values) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + List<KeyValueBackupEntry>getKeyValues() + +
            +          Gets the value of the 'key_values' field.
            + List<TableLayoutBackupEntry>getLayouts() + +
            +          Gets the value of the 'layouts' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            +static TableBackup.BuildernewBuilder() + +
            +          Creates a new TableBackup RecordBuilder
            +static TableBackup.BuildernewBuilder(TableBackup.Builder other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing Builder
            +static TableBackup.BuildernewBuilder(TableBackup other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field.
            + voidsetLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Table name. +

            +

            +
            +
            +
            + +

            +layouts

            +
            +@Deprecated
+public List<TableLayoutBackupEntry> layouts
            +
            +
            Deprecated. 
            Sequence of layouts for the specified table, in order +

            +

            +
            +
            +
            + +

            +key_values

            +
            +@Deprecated
+public List<KeyValueBackupEntry> key_values
            +
            +
            Deprecated. 
            Sequence of user defined key-value pairs for the specified table, in order. +

            +

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

            +TableBackup

            +
            +public TableBackup()
            +
            +
            Default constructor. +

            +

            +
            + +

            +TableBackup

            +
            +public TableBackup(String name,
+                   List<TableLayoutBackupEntry> layouts,
+                   List<KeyValueBackupEntry> key_values)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Table name. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Table name. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayouts

            +
            +public List<TableLayoutBackupEntry> getLayouts()
            +
            +
            Gets the value of the 'layouts' field. + Sequence of layouts for the specified table, in order +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayouts

            +
            +public void setLayouts(List<TableLayoutBackupEntry> value)
            +
            +
            Sets the value of the 'layouts' field. + Sequence of layouts for the specified table, in order * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeyValues

            +
            +public List<KeyValueBackupEntry> getKeyValues()
            +
            +
            Gets the value of the 'key_values' field. + Sequence of user defined key-value pairs for the specified table, in order. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeyValues

            +
            +public void setKeyValues(List<KeyValueBackupEntry> value)
            +
            +
            Sets the value of the 'key_values' field. + Sequence of user defined key-value pairs for the specified table, in order. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableBackup.Builder newBuilder()
            +
            +
            Creates a new TableBackup RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableBackup.Builder newBuilder(TableBackup.Builder other)
            +
            +
            Creates a new TableBackup RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableBackup.Builder newBuilder(TableBackup other)
            +
            +
            Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html new file mode 100644 index 00000000..7e908ce8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutBackupEntry.Builder.html @@ -0,0 +1,532 @@ + + + + + + + +TableLayoutBackupEntry.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutBackupEntry.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutBackupEntry>
+          extended by org.kiji.schema.avro.TableLayoutBackupEntry.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<TableLayoutBackupEntry>
            +
            +
            +
            Enclosing class:
            TableLayoutBackupEntry
            +
            +
            +
            +
            public static class TableLayoutBackupEntry.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutBackupEntry>
            implements org.apache.avro.data.RecordBuilder<TableLayoutBackupEntry>
            + + +

            +RecordBuilder for TableLayoutBackupEntry instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TableLayoutBackupEntrybuild() + +
            +           
            + TableLayoutBackupEntry.BuilderclearLayout() + +
            +          Clears the value of the 'layout' field
            + TableLayoutBackupEntry.BuilderclearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuilderclearUpdate() + +
            +          Clears the value of the 'update' field
            + TableLayoutDescgetLayout() + +
            +          Gets the value of the 'layout' field
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field
            + TableLayoutDescgetUpdate() + +
            +          Gets the value of the 'update' field
            + booleanhasLayout() + +
            +          Checks whether the 'layout' field has been set
            + booleanhasTimestamp() + +
            +          Checks whether the 'timestamp' field has been set
            + booleanhasUpdate() + +
            +          Checks whether the 'update' field has been set
            + TableLayoutBackupEntry.BuildersetLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field
            + TableLayoutBackupEntry.BuildersetTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuildersetUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public TableLayoutBackupEntry.Builder setTimestamp(long value)
            +
            +
            Sets the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasTimestamp

            +
            +public boolean hasTimestamp()
            +
            +
            Checks whether the 'timestamp' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearTimestamp

            +
            +public TableLayoutBackupEntry.Builder clearTimestamp()
            +
            +
            Clears the value of the 'timestamp' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getUpdate

            +
            +public TableLayoutDesc getUpdate()
            +
            +
            Gets the value of the 'update' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setUpdate

            +
            +public TableLayoutBackupEntry.Builder setUpdate(TableLayoutDesc value)
            +
            +
            Sets the value of the 'update' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasUpdate

            +
            +public boolean hasUpdate()
            +
            +
            Checks whether the 'update' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearUpdate

            +
            +public TableLayoutBackupEntry.Builder clearUpdate()
            +
            +
            Clears the value of the 'update' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayout

            +
            +public TableLayoutDesc getLayout()
            +
            +
            Gets the value of the 'layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayout

            +
            +public TableLayoutBackupEntry.Builder setLayout(TableLayoutDesc value)
            +
            +
            Sets the value of the 'layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayout

            +
            +public boolean hasLayout()
            +
            +
            Checks whether the 'layout' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayout

            +
            +public TableLayoutBackupEntry.Builder clearLayout()
            +
            +
            Clears the value of the 'layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public TableLayoutBackupEntry build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<TableLayoutBackupEntry>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutBackupEntry.html new file mode 100644 index 00000000..744410fa --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutBackupEntry.html @@ -0,0 +1,678 @@ + + + + + + + +TableLayoutBackupEntry (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutBackupEntry

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.TableLayoutBackupEntry
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class TableLayoutBackupEntry
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTableLayoutBackupEntry.Builder + +
            +          RecordBuilder for TableLayoutBackupEntry instances.
            +  + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + TableLayoutDesclayout + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + longtimestamp + +
            +          Deprecated. 
            + TableLayoutDescupdate + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            TableLayoutBackupEntry() + +
            +          Default constructor.
            TableLayoutBackupEntry(Long timestamp, + TableLayoutDesc update, + TableLayoutDesc layout) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + TableLayoutDescgetLayout() + +
            +          Gets the value of the 'layout' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + LonggetTimestamp() + +
            +          Gets the value of the 'timestamp' field.
            + TableLayoutDescgetUpdate() + +
            +          Gets the value of the 'update' field.
            +static TableLayoutBackupEntry.BuildernewBuilder() + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder
            +static TableLayoutBackupEntry.BuildernewBuilder(TableLayoutBackupEntry.Builder other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder
            +static TableLayoutBackupEntry.BuildernewBuilder(TableLayoutBackupEntry other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field.
            + voidsetTimestamp(Long value) + +
            +          Sets the value of the 'timestamp' field.
            + voidsetUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +timestamp

            +
            +@Deprecated
+public long timestamp
            +
            +
            Deprecated. 
            Time Stamp. +

            +

            +
            +
            +
            + +

            +update

            +
            +@Deprecated
+public TableLayoutDesc update
            +
            +
            Deprecated. 
            Table layout update, as specified by the submitter/user. + Except for the first one, the update builds on the previous layout. +

            +

            +
            +
            +
            + +

            +layout

            +
            +@Deprecated
+public TableLayoutDesc layout
            +
            +
            Deprecated. 
            Effective table layout, after applying the update. +

            +

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

            +TableLayoutBackupEntry

            +
            +public TableLayoutBackupEntry()
            +
            +
            Default constructor. +

            +

            +
            + +

            +TableLayoutBackupEntry

            +
            +public TableLayoutBackupEntry(Long timestamp,
+                              TableLayoutDesc update,
+                              TableLayoutDesc layout)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getTimestamp

            +
            +public Long getTimestamp()
            +
            +
            Gets the value of the 'timestamp' field. + Time Stamp. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setTimestamp

            +
            +public void setTimestamp(Long value)
            +
            +
            Sets the value of the 'timestamp' field. + Time Stamp. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getUpdate

            +
            +public TableLayoutDesc getUpdate()
            +
            +
            Gets the value of the 'update' field. + * Table layout update, as specified by the submitter/user. + Except for the first one, the update builds on the previous layout. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setUpdate

            +
            +public void setUpdate(TableLayoutDesc value)
            +
            +
            Sets the value of the 'update' field. + * Table layout update, as specified by the submitter/user. + Except for the first one, the update builds on the previous layout. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayout

            +
            +public TableLayoutDesc getLayout()
            +
            +
            Gets the value of the 'layout' field. + Effective table layout, after applying the update. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayout

            +
            +public void setLayout(TableLayoutDesc value)
            +
            +
            Sets the value of the 'layout' field. + Effective table layout, after applying the update. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutBackupEntry.Builder newBuilder()
            +
            +
            Creates a new TableLayoutBackupEntry RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutBackupEntry.Builder newBuilder(TableLayoutBackupEntry.Builder other)
            +
            +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutBackupEntry.Builder newBuilder(TableLayoutBackupEntry other)
            +
            +
            Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutDesc.Builder.html new file mode 100644 index 00000000..a5104f3d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutDesc.Builder.html @@ -0,0 +1,916 @@ + + + + + + + +TableLayoutDesc.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutDesc.Builder

            +
            +java.lang.Object
+  extended by org.apache.avro.data.RecordBuilderBase<T>
+      extended by org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutDesc>
+          extended by org.kiji.schema.avro.TableLayoutDesc.Builder
+
            +
            +
            All Implemented Interfaces:
            org.apache.avro.data.RecordBuilder<TableLayoutDesc>
            +
            +
            +
            Enclosing class:
            TableLayoutDesc
            +
            +
            +
            +
            public static class TableLayoutDesc.Builder
            extends org.apache.avro.specific.SpecificRecordBuilderBase<TableLayoutDesc>
            implements org.apache.avro.data.RecordBuilder<TableLayoutDesc>
            + + +

            +RecordBuilder for TableLayoutDesc instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + TableLayoutDescbuild() + +
            +           
            + TableLayoutDesc.BuilderclearDescription() + +
            +          Clears the value of the 'description' field
            + TableLayoutDesc.BuilderclearKeysFormat() + +
            +          Clears the value of the 'keys_format' field
            + TableLayoutDesc.BuilderclearLayoutId() + +
            +          Clears the value of the 'layout_id' field
            + TableLayoutDesc.BuilderclearLocalityGroups() + +
            +          Clears the value of the 'locality_groups' field
            + TableLayoutDesc.BuilderclearName() + +
            +          Clears the value of the 'name' field
            + TableLayoutDesc.BuilderclearReferenceLayout() + +
            +          Clears the value of the 'reference_layout' field
            + TableLayoutDesc.BuilderclearVersion() + +
            +          Clears the value of the 'version' field
            + StringgetDescription() + +
            +          Gets the value of the 'description' field
            + ObjectgetKeysFormat() + +
            +          Gets the value of the 'keys_format' field
            + StringgetLayoutId() + +
            +          Gets the value of the 'layout_id' field
            + List<LocalityGroupDesc>getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field
            + StringgetName() + +
            +          Gets the value of the 'name' field
            + StringgetReferenceLayout() + +
            +          Gets the value of the 'reference_layout' field
            + StringgetVersion() + +
            +          Gets the value of the 'version' field
            + booleanhasDescription() + +
            +          Checks whether the 'description' field has been set
            + booleanhasKeysFormat() + +
            +          Checks whether the 'keys_format' field has been set
            + booleanhasLayoutId() + +
            +          Checks whether the 'layout_id' field has been set
            + booleanhasLocalityGroups() + +
            +          Checks whether the 'locality_groups' field has been set
            + booleanhasName() + +
            +          Checks whether the 'name' field has been set
            + booleanhasReferenceLayout() + +
            +          Checks whether the 'reference_layout' field has been set
            + booleanhasVersion() + +
            +          Checks whether the 'version' field has been set
            + TableLayoutDesc.BuildersetDescription(String value) + +
            +          Sets the value of the 'description' field
            + TableLayoutDesc.BuildersetKeysFormat(Object value) + +
            +          Sets the value of the 'keys_format' field
            + TableLayoutDesc.BuildersetLayoutId(String value) + +
            +          Sets the value of the 'layout_id' field
            + TableLayoutDesc.BuildersetLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field
            + TableLayoutDesc.BuildersetName(String value) + +
            +          Sets the value of the 'name' field
            + TableLayoutDesc.BuildersetReferenceLayout(String value) + +
            +          Sets the value of the 'reference_layout' field
            + TableLayoutDesc.BuildersetVersion(String value) + +
            +          Sets the value of the 'version' field
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.data.RecordBuilderBase
            data, defaultValue, equals, fields, fieldSetFlags, hashCode, isValidValue, schema, validate
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public TableLayoutDesc.Builder setName(String value)
            +
            +
            Sets the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasName

            +
            +public boolean hasName()
            +
            +
            Checks whether the 'name' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearName

            +
            +public TableLayoutDesc.Builder clearName()
            +
            +
            Clears the value of the 'name' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public TableLayoutDesc.Builder setDescription(String value)
            +
            +
            Sets the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasDescription

            +
            +public boolean hasDescription()
            +
            +
            Checks whether the 'description' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearDescription

            +
            +public TableLayoutDesc.Builder clearDescription()
            +
            +
            Clears the value of the 'description' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeysFormat

            +
            +public Object getKeysFormat()
            +
            +
            Gets the value of the 'keys_format' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeysFormat

            +
            +public TableLayoutDesc.Builder setKeysFormat(Object value)
            +
            +
            Sets the value of the 'keys_format' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasKeysFormat

            +
            +public boolean hasKeysFormat()
            +
            +
            Checks whether the 'keys_format' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearKeysFormat

            +
            +public TableLayoutDesc.Builder clearKeysFormat()
            +
            +
            Clears the value of the 'keys_format' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLocalityGroups

            +
            +public List<LocalityGroupDesc> getLocalityGroups()
            +
            +
            Gets the value of the 'locality_groups' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLocalityGroups

            +
            +public TableLayoutDesc.Builder setLocalityGroups(List<LocalityGroupDesc> value)
            +
            +
            Sets the value of the 'locality_groups' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLocalityGroups

            +
            +public boolean hasLocalityGroups()
            +
            +
            Checks whether the 'locality_groups' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLocalityGroups

            +
            +public TableLayoutDesc.Builder clearLocalityGroups()
            +
            +
            Clears the value of the 'locality_groups' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getVersion

            +
            +public String getVersion()
            +
            +
            Gets the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setVersion

            +
            +public TableLayoutDesc.Builder setVersion(String value)
            +
            +
            Sets the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasVersion

            +
            +public boolean hasVersion()
            +
            +
            Checks whether the 'version' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearVersion

            +
            +public TableLayoutDesc.Builder clearVersion()
            +
            +
            Clears the value of the 'version' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayoutId

            +
            +public String getLayoutId()
            +
            +
            Gets the value of the 'layout_id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutId

            +
            +public TableLayoutDesc.Builder setLayoutId(String value)
            +
            +
            Sets the value of the 'layout_id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasLayoutId

            +
            +public boolean hasLayoutId()
            +
            +
            Checks whether the 'layout_id' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearLayoutId

            +
            +public TableLayoutDesc.Builder clearLayoutId()
            +
            +
            Clears the value of the 'layout_id' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getReferenceLayout

            +
            +public String getReferenceLayout()
            +
            +
            Gets the value of the 'reference_layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setReferenceLayout

            +
            +public TableLayoutDesc.Builder setReferenceLayout(String value)
            +
            +
            Sets the value of the 'reference_layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +hasReferenceLayout

            +
            +public boolean hasReferenceLayout()
            +
            +
            Checks whether the 'reference_layout' field has been set +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +clearReferenceLayout

            +
            +public TableLayoutDesc.Builder clearReferenceLayout()
            +
            +
            Clears the value of the 'reference_layout' field +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +build

            +
            +public TableLayoutDesc build()
            +
            +
            +
            Specified by:
            build in interface org.apache.avro.data.RecordBuilder<TableLayoutDesc>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutDesc.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutDesc.html new file mode 100644 index 00000000..7b828a8c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/TableLayoutDesc.html @@ -0,0 +1,970 @@ + + + + + + + +TableLayoutDesc (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.avro +
            +Class TableLayoutDesc

            +
            +java.lang.Object
+  extended by org.apache.avro.specific.SpecificRecordBase
+      extended by org.kiji.schema.avro.TableLayoutDesc
+
            +
            +
            All Implemented Interfaces:
            Comparable<org.apache.avro.specific.SpecificRecord>, org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord, org.apache.avro.specific.SpecificRecord
            +
            +
            +
            +
            public class TableLayoutDesc
            extends org.apache.avro.specific.SpecificRecordBase
            implements org.apache.avro.specific.SpecificRecord
            + + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classTableLayoutDesc.Builder + +
            +          RecordBuilder for TableLayoutDesc instances.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            + Stringdescription + +
            +          Deprecated. 
            + Objectkeys_format + +
            +          Deprecated. 
            + Stringlayout_id + +
            +          Deprecated. 
            + List<LocalityGroupDesc>locality_groups + +
            +          Deprecated. 
            + Stringname + +
            +          Deprecated. 
            + Stringreference_layout + +
            +          Deprecated. 
            +static org.apache.avro.SchemaSCHEMA$ + +
            +           
            + Stringversion + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            TableLayoutDesc() + +
            +          Default constructor.
            TableLayoutDesc(String name, + String description, + Object keys_format, + List<LocalityGroupDesc> locality_groups, + String version, + String layout_id, + String reference_layout) + +
            +          All-args constructor.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Objectget(int field$) + +
            +           
            + StringgetDescription() + +
            +          Gets the value of the 'description' field.
            + ObjectgetKeysFormat() + +
            +          Gets the value of the 'keys_format' field.
            + StringgetLayoutId() + +
            +          Gets the value of the 'layout_id' field.
            + List<LocalityGroupDesc>getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field.
            + StringgetName() + +
            +          Gets the value of the 'name' field.
            + StringgetReferenceLayout() + +
            +          Gets the value of the 'reference_layout' field.
            + org.apache.avro.SchemagetSchema() + +
            +           
            + StringgetVersion() + +
            +          Gets the value of the 'version' field.
            +static TableLayoutDesc.BuildernewBuilder() + +
            +          Creates a new TableLayoutDesc RecordBuilder
            +static TableLayoutDesc.BuildernewBuilder(TableLayoutDesc.Builder other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder
            +static TableLayoutDesc.BuildernewBuilder(TableLayoutDesc other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance
            + voidput(int field$, + Object value$) + +
            +           
            + voidsetDescription(String value) + +
            +          Sets the value of the 'description' field.
            + voidsetKeysFormat(Object value) + +
            +          Sets the value of the 'keys_format' field.
            + voidsetLayoutId(String value) + +
            +          Sets the value of the 'layout_id' field.
            + voidsetLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field.
            + voidsetName(String value) + +
            +          Sets the value of the 'name' field.
            + voidsetReferenceLayout(String value) + +
            +          Sets the value of the 'reference_layout' field.
            + voidsetVersion(String value) + +
            +          Sets the value of the 'version' field.
            +  + + + + + + + +
            Methods inherited from class org.apache.avro.specific.SpecificRecordBase
            compareTo, equals, hashCode, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA$

            +
            +public static final org.apache.avro.Schema SCHEMA$
            +
            +
            +
            +
            +
            + +

            +name

            +
            +@Deprecated
+public String name
            +
            +
            Deprecated. 
            Name of the table ([a-zA-Z0-9_]+). +

            +

            +
            +
            +
            + +

            +description

            +
            +@Deprecated
+public String description
            +
            +
            Deprecated. 
            User description of the table. +

            +

            +
            +
            +
            + +

            +keys_format

            +
            +@Deprecated
+public Object keys_format
            +
            +
            Deprecated. 
            The format of row keys for the table. Please use RowKeyFormat2 as + RowKeyFormat is deprecated. +

            +

            +
            +
            +
            + +

            +locality_groups

            +
            +@Deprecated
+public List<LocalityGroupDesc> locality_groups
            +
            +
            Deprecated. 
            Locality groups in the table. +

            +

            +
            +
            +
            + +

            +version

            +
            +@Deprecated
+public String version
            +
            +
            Deprecated. 
            Data layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            + +

            +layout_id

            +
            +@Deprecated
+public String layout_id
            +
            +
            Deprecated. 
            ID of the layout. +

            +

            +
            +
            +
            + +

            +reference_layout

            +
            +@Deprecated
+public String reference_layout
            +
            +
            Deprecated. 
            Reference to the base layout this descriptor builds on. +

            +

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

            +TableLayoutDesc

            +
            +public TableLayoutDesc()
            +
            +
            Default constructor. +

            +

            +
            + +

            +TableLayoutDesc

            +
            +public TableLayoutDesc(String name,
+                       String description,
+                       Object keys_format,
+                       List<LocalityGroupDesc> locality_groups,
+                       String version,
+                       String layout_id,
+                       String reference_layout)
            +
            +
            All-args constructor. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema()
            +
            +
            +
            Specified by:
            getSchema in interface org.apache.avro.generic.GenericContainer
            Specified by:
            getSchema in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +get

            +
            +public Object get(int field$)
            +
            +
            +
            Specified by:
            get in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            get in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +put

            +
            +public void put(int field$,
+                Object value$)
            +
            +
            +
            Specified by:
            put in interface org.apache.avro.generic.IndexedRecord
            Specified by:
            put in class org.apache.avro.specific.SpecificRecordBase
            +
            +
            +
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            Gets the value of the 'name' field. + Name of the table ([a-zA-Z0-9_]+). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setName

            +
            +public void setName(String value)
            +
            +
            Sets the value of the 'name' field. + Name of the table ([a-zA-Z0-9_]+). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            Gets the value of the 'description' field. + User description of the table. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setDescription

            +
            +public void setDescription(String value)
            +
            +
            Sets the value of the 'description' field. + User description of the table. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getKeysFormat

            +
            +public Object getKeysFormat()
            +
            +
            Gets the value of the 'keys_format' field. + * The format of row keys for the table. Please use RowKeyFormat2 as + RowKeyFormat is deprecated. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setKeysFormat

            +
            +public void setKeysFormat(Object value)
            +
            +
            Sets the value of the 'keys_format' field. + * The format of row keys for the table. Please use RowKeyFormat2 as + RowKeyFormat is deprecated. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLocalityGroups

            +
            +public List<LocalityGroupDesc> getLocalityGroups()
            +
            +
            Gets the value of the 'locality_groups' field. + Locality groups in the table. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLocalityGroups

            +
            +public void setLocalityGroups(List<LocalityGroupDesc> value)
            +
            +
            Sets the value of the 'locality_groups' field. + Locality groups in the table. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getVersion

            +
            +public String getVersion()
            +
            +
            Gets the value of the 'version' field. + Data layout version (eg. "kiji-1.0"). +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setVersion

            +
            +public void setVersion(String value)
            +
            +
            Sets the value of the 'version' field. + Data layout version (eg. "kiji-1.0"). * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getLayoutId

            +
            +public String getLayoutId()
            +
            +
            Gets the value of the 'layout_id' field. + ID of the layout. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setLayoutId

            +
            +public void setLayoutId(String value)
            +
            +
            Sets the value of the 'layout_id' field. + ID of the layout. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +getReferenceLayout

            +
            +public String getReferenceLayout()
            +
            +
            Gets the value of the 'reference_layout' field. + Reference to the base layout this descriptor builds on. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +setReferenceLayout

            +
            +public void setReferenceLayout(String value)
            +
            +
            Sets the value of the 'reference_layout' field. + Reference to the base layout this descriptor builds on. * @param value the value to set. +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutDesc.Builder newBuilder()
            +
            +
            Creates a new TableLayoutDesc RecordBuilder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutDesc.Builder newBuilder(TableLayoutDesc.Builder other)
            +
            +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder +

            +

            +
            +
            +
            +
            +
            +
            +
            + +

            +newBuilder

            +
            +public static TableLayoutDesc.Builder newBuilder(TableLayoutDesc other)
            +
            +
            Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance +

            +

            +
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/CellSchema.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/CellSchema.Builder.html new file mode 100644 index 00000000..6cc2fa06 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/CellSchema.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.CellSchema.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.CellSchema.Builder

            +
            + + + + + + + + + +
            +Packages that use CellSchema.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of CellSchema.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return CellSchema.Builder
            + CellSchema.BuilderCellSchema.Builder.clearStorage() + +
            +          Clears the value of the 'storage' field
            + CellSchema.BuilderCellSchema.Builder.clearType() + +
            +          Clears the value of the 'type' field
            + CellSchema.BuilderCellSchema.Builder.clearValue() + +
            +          Clears the value of the 'value' field
            +static CellSchema.BuilderCellSchema.newBuilder() + +
            +          Creates a new CellSchema RecordBuilder
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema.Builder other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing Builder
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance
            + CellSchema.BuilderCellSchema.Builder.setStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field
            + CellSchema.BuilderCellSchema.Builder.setType(SchemaType value) + +
            +          Sets the value of the 'type' field
            + CellSchema.BuilderCellSchema.Builder.setValue(String value) + +
            +          Sets the value of the 'value' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type CellSchema.Builder
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema.Builder other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/CellSchema.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/CellSchema.html new file mode 100644 index 00000000..ea3aa1d4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/CellSchema.html @@ -0,0 +1,435 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.CellSchema (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.CellSchema

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use CellSchema
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of CellSchema in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as CellSchema
            + CellSchemaColumnDesc.column_schema + +
            +          Deprecated. 
            + CellSchemaFamilyDesc.map_schema + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return CellSchema
            + CellSchemaCellSchema.Builder.build() + +
            +           
            + CellSchemaColumnDesc.getColumnSchema() + +
            +          Gets the value of the 'column_schema' field.
            + CellSchemaColumnDesc.Builder.getColumnSchema() + +
            +          Gets the value of the 'column_schema' field
            + CellSchemaFamilyDesc.getMapSchema() + +
            +          Gets the value of the 'map_schema' field.
            + CellSchemaFamilyDesc.Builder.getMapSchema() + +
            +          Gets the value of the 'map_schema' field
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type CellSchema
            +static CellSchema.BuilderCellSchema.newBuilder(CellSchema other) + +
            +          Creates a new CellSchema RecordBuilder by copying an existing CellSchema instance
            + voidColumnDesc.setColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field.
            + ColumnDesc.BuilderColumnDesc.Builder.setColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field
            + voidFamilyDesc.setMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field.
            + FamilyDesc.BuilderFamilyDesc.Builder.setMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type CellSchema
            ColumnDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema column_schema, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            FamilyDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema map_schema, + List<ColumnDesc> columns, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of CellSchema in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return CellSchema
            + CellSchemaKijiTableLayout.getCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type CellSchema
            +static org.apache.avro.SchemaKijiTableLayout.readAvroSchema(CellSchema avro) + +
            +          Reads the Avro schema from the table layout.
            +  +

            + + + + + +
            +Uses of CellSchema in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return CellSchema
            + CellSchemaCellSpec.getCellSchema() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type CellSchema
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            +static org.apache.avro.SchemaCellSpec.readAvroSchema(CellSchema cellSchema) + +
            +          Reads the Avro schema from the table layout.
            + CellSpecCellSpec.setCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html new file mode 100644 index 00000000..e1d965cd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/ColumnDesc.Builder.html @@ -0,0 +1,341 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.ColumnDesc.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.ColumnDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use ColumnDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of ColumnDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return ColumnDesc.Builder
            + ColumnDesc.BuilderColumnDesc.Builder.clearAliases() + +
            +          Clears the value of the 'aliases' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearColumnSchema() + +
            +          Clears the value of the 'column_schema' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearDelete() + +
            +          Clears the value of the 'delete' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearEnabled() + +
            +          Clears the value of the 'enabled' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearId() + +
            +          Clears the value of the 'id' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + ColumnDesc.BuilderColumnDesc.Builder.clearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            +static ColumnDesc.BuilderColumnDesc.newBuilder() + +
            +          Creates a new ColumnDesc RecordBuilder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            + ColumnDesc.BuilderColumnDesc.Builder.setAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + ColumnDesc.BuilderColumnDesc.Builder.setColumnSchema(CellSchema value) + +
            +          Sets the value of the 'column_schema' field
            + ColumnDesc.BuilderColumnDesc.Builder.setDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + ColumnDesc.BuilderColumnDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + ColumnDesc.BuilderColumnDesc.Builder.setEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + ColumnDesc.BuilderColumnDesc.Builder.setId(int value) + +
            +          Sets the value of the 'id' field
            + ColumnDesc.BuilderColumnDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + ColumnDesc.BuilderColumnDesc.Builder.setRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type ColumnDesc.Builder
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc.Builder other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/ColumnDesc.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/ColumnDesc.html new file mode 100644 index 00000000..a1a00342 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/ColumnDesc.html @@ -0,0 +1,312 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.ColumnDesc (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.ColumnDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use ColumnDesc
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of ColumnDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type ColumnDesc
            + List<ColumnDesc>FamilyDesc.columns + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return ColumnDesc
            + ColumnDescColumnDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type ColumnDesc
            + List<ColumnDesc>FamilyDesc.getColumns() + +
            +          Gets the value of the 'columns' field.
            + List<ColumnDesc>FamilyDesc.Builder.getColumns() + +
            +          Gets the value of the 'columns' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type ColumnDesc
            +static ColumnDesc.BuilderColumnDesc.newBuilder(ColumnDesc other) + +
            +          Creates a new ColumnDesc RecordBuilder by copying an existing ColumnDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type ColumnDesc
            + voidFamilyDesc.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field.
            + FamilyDesc.BuilderFamilyDesc.Builder.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type ColumnDesc
            FamilyDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + CellSchema map_schema, + List<ColumnDesc> columns, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of ColumnDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return ColumnDesc
            + ColumnDescKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.getDesc() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/ComponentType.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/ComponentType.html new file mode 100644 index 00000000..95b8d9a1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/ComponentType.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.ComponentType (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.ComponentType

            +
            + + + + + + + + + +
            +Packages that use ComponentType
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of ComponentType in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as ComponentType
            + ComponentTypeRowKeyComponent.type + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return ComponentType
            + ComponentTypeRowKeyComponent.getType() + +
            +          Gets the value of the 'type' field.
            + ComponentTypeRowKeyComponent.Builder.getType() + +
            +          Gets the value of the 'type' field
            +static ComponentTypeComponentType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static ComponentType[]ComponentType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type ComponentType
            + voidRowKeyComponent.setType(ComponentType value) + +
            +          Sets the value of the 'type' field.
            + RowKeyComponent.BuilderRowKeyComponent.Builder.setType(ComponentType value) + +
            +          Sets the value of the 'type' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type ComponentType
            RowKeyComponent(String name, + ComponentType type) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/CompressionType.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/CompressionType.html new file mode 100644 index 00000000..312b77ce --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/CompressionType.html @@ -0,0 +1,271 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.CompressionType (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.CompressionType

            +
            + + + + + + + + + +
            +Packages that use CompressionType
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of CompressionType in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as CompressionType
            + CompressionTypeLocalityGroupDesc.compression_type + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return CompressionType
            + CompressionTypeLocalityGroupDesc.getCompressionType() + +
            +          Gets the value of the 'compression_type' field.
            + CompressionTypeLocalityGroupDesc.Builder.getCompressionType() + +
            +          Gets the value of the 'compression_type' field
            +static CompressionTypeCompressionType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static CompressionType[]CompressionType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type CompressionType
            + voidLocalityGroupDesc.setCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field.
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type CompressionType
            LocalityGroupDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + Boolean in_memory, + Integer max_versions, + Integer ttl_seconds, + CompressionType compression_type, + List<FamilyDesc> families, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html new file mode 100644 index 00000000..204f90ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/FamilyDesc.Builder.html @@ -0,0 +1,357 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.FamilyDesc.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.FamilyDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use FamilyDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of FamilyDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return FamilyDesc.Builder
            + FamilyDesc.BuilderFamilyDesc.Builder.clearAliases() + +
            +          Clears the value of the 'aliases' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearColumns() + +
            +          Clears the value of the 'columns' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearDelete() + +
            +          Clears the value of the 'delete' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearEnabled() + +
            +          Clears the value of the 'enabled' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearId() + +
            +          Clears the value of the 'id' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearMapSchema() + +
            +          Clears the value of the 'map_schema' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + FamilyDesc.BuilderFamilyDesc.Builder.clearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            +static FamilyDesc.BuilderFamilyDesc.newBuilder() + +
            +          Creates a new FamilyDesc RecordBuilder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            + FamilyDesc.BuilderFamilyDesc.Builder.setAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setColumns(List<ColumnDesc> value) + +
            +          Sets the value of the 'columns' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setId(int value) + +
            +          Sets the value of the 'id' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setMapSchema(CellSchema value) + +
            +          Sets the value of the 'map_schema' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + FamilyDesc.BuilderFamilyDesc.Builder.setRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type FamilyDesc.Builder
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc.Builder other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/FamilyDesc.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/FamilyDesc.html new file mode 100644 index 00000000..83898358 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/FamilyDesc.html @@ -0,0 +1,315 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.FamilyDesc (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.FamilyDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use FamilyDesc
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of FamilyDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type FamilyDesc
            + List<FamilyDesc>LocalityGroupDesc.families + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return FamilyDesc
            + FamilyDescFamilyDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type FamilyDesc
            + List<FamilyDesc>LocalityGroupDesc.getFamilies() + +
            +          Gets the value of the 'families' field.
            + List<FamilyDesc>LocalityGroupDesc.Builder.getFamilies() + +
            +          Gets the value of the 'families' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type FamilyDesc
            +static FamilyDesc.BuilderFamilyDesc.newBuilder(FamilyDesc other) + +
            +          Creates a new FamilyDesc RecordBuilder by copying an existing FamilyDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type FamilyDesc
            + voidLocalityGroupDesc.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field.
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type FamilyDesc
            LocalityGroupDesc(Integer id, + String name, + List<String> aliases, + Boolean enabled, + String description, + Boolean in_memory, + Integer max_versions, + Integer ttl_seconds, + CompressionType compression_type, + List<FamilyDesc> families, + Boolean delete, + String renamed_from) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of FamilyDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return FamilyDesc
            + FamilyDescKijiTableLayout.LocalityGroupLayout.FamilyLayout.getDesc() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/HashSpec.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/HashSpec.Builder.html new file mode 100644 index 00000000..57aed72f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/HashSpec.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.HashSpec.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.HashSpec.Builder

            +
            + + + + + + + + + +
            +Packages that use HashSpec.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of HashSpec.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return HashSpec.Builder
            + HashSpec.BuilderHashSpec.Builder.clearHashSize() + +
            +          Clears the value of the 'hash_size' field
            + HashSpec.BuilderHashSpec.Builder.clearHashType() + +
            +          Clears the value of the 'hash_type' field
            + HashSpec.BuilderHashSpec.Builder.clearSuppressKeyMaterialization() + +
            +          Clears the value of the 'suppress_key_materialization' field
            +static HashSpec.BuilderHashSpec.newBuilder() + +
            +          Creates a new HashSpec RecordBuilder
            +static HashSpec.BuilderHashSpec.newBuilder(HashSpec.Builder other) + +
            +          Creates a new HashSpec RecordBuilder by copying an existing Builder
            +static HashSpec.BuilderHashSpec.newBuilder(HashSpec other) + +
            +          Creates a new HashSpec RecordBuilder by copying an existing HashSpec instance
            + HashSpec.BuilderHashSpec.Builder.setHashSize(int value) + +
            +          Sets the value of the 'hash_size' field
            + HashSpec.BuilderHashSpec.Builder.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            + HashSpec.BuilderHashSpec.Builder.setSuppressKeyMaterialization(boolean value) + +
            +          Sets the value of the 'suppress_key_materialization' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type HashSpec.Builder
            +static HashSpec.BuilderHashSpec.newBuilder(HashSpec.Builder other) + +
            +          Creates a new HashSpec RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/HashSpec.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/HashSpec.html new file mode 100644 index 00000000..180dd603 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/HashSpec.html @@ -0,0 +1,263 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.HashSpec (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.HashSpec

            +
            + + + + + + + + + +
            +Packages that use HashSpec
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of HashSpec in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as HashSpec
            + HashSpecRowKeyFormat2.salt + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return HashSpec
            + HashSpecHashSpec.Builder.build() + +
            +           
            + HashSpecRowKeyFormat2.getSalt() + +
            +          Gets the value of the 'salt' field.
            + HashSpecRowKeyFormat2.Builder.getSalt() + +
            +          Gets the value of the 'salt' field
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type HashSpec
            +static HashSpec.BuilderHashSpec.newBuilder(HashSpec other) + +
            +          Creates a new HashSpec RecordBuilder by copying an existing HashSpec instance
            + voidRowKeyFormat2.setSalt(HashSpec value) + +
            +          Sets the value of the 'salt' field.
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.setSalt(HashSpec value) + +
            +          Sets the value of the 'salt' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type HashSpec
            RowKeyFormat2(RowKeyEncoding encoding, + HashSpec salt, + Integer range_scan_start_index, + Integer nullable_start_index, + List<RowKeyComponent> components) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/HashType.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/HashType.html new file mode 100644 index 00000000..8c135b1c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/HashType.html @@ -0,0 +1,310 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.HashType (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.HashType

            +
            + + + + + + + + + +
            +Packages that use HashType
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of HashType in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as HashType
            + HashTypeHashSpec.hash_type + +
            +          Deprecated. 
            + HashTypeRowKeyFormat.hash_type + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return HashType
            + HashTypeHashSpec.getHashType() + +
            +          Gets the value of the 'hash_type' field.
            + HashTypeHashSpec.Builder.getHashType() + +
            +          Gets the value of the 'hash_type' field
            + HashTypeRowKeyFormat.getHashType() + +
            +          Gets the value of the 'hash_type' field.
            + HashTypeRowKeyFormat.Builder.getHashType() + +
            +          Gets the value of the 'hash_type' field
            +static HashTypeHashType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static HashType[]HashType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type HashType
            + voidHashSpec.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field.
            + HashSpec.BuilderHashSpec.Builder.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            + voidRowKeyFormat.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field.
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type HashType
            HashSpec(HashType hash_type, + Integer hash_size, + Boolean suppress_key_materialization) + +
            +          All-args constructor.
            RowKeyFormat(RowKeyEncoding encoding, + HashType hash_type, + Integer hash_size) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KeyValueBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KeyValueBackupEntry.Builder.html new file mode 100644 index 00000000..9f4869f6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KeyValueBackupEntry.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.KeyValueBackupEntry.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.KeyValueBackupEntry.Builder

            +
            + + + + + + + + + +
            +Packages that use KeyValueBackupEntry.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return KeyValueBackupEntry.Builder
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.clearKey() + +
            +          Clears the value of the 'key' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.clearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.clearValue() + +
            +          Clears the value of the 'value' field
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder() + +
            +          Creates a new KeyValueBackupEntry RecordBuilder
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry.Builder other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.setKey(String value) + +
            +          Sets the value of the 'key' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.setTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + KeyValueBackupEntry.BuilderKeyValueBackupEntry.Builder.setValue(ByteBuffer value) + +
            +          Sets the value of the 'value' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type KeyValueBackupEntry.Builder
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry.Builder other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KeyValueBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KeyValueBackupEntry.html new file mode 100644 index 00000000..bceb4a57 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KeyValueBackupEntry.html @@ -0,0 +1,386 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.KeyValueBackupEntry (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.KeyValueBackupEntry

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KeyValueBackupEntry
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>KijiTableKeyValueDatabase.keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type KeyValueBackupEntry
            + voidKijiTableKeyValueDatabase.keyValuesFromBackup(String table, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>TableBackup.key_values + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return KeyValueBackupEntry
            + KeyValueBackupEntryKeyValueBackupEntry.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>TableBackup.getKeyValues() + +
            +          Gets the value of the 'key_values' field.
            + List<KeyValueBackupEntry>TableBackup.Builder.getKeyValues() + +
            +          Gets the value of the 'key_values' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type KeyValueBackupEntry
            +static KeyValueBackupEntry.BuilderKeyValueBackupEntry.newBuilder(KeyValueBackupEntry other) + +
            +          Creates a new KeyValueBackupEntry RecordBuilder by copying an existing KeyValueBackupEntry instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type KeyValueBackupEntry
            + voidTableBackup.setKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field.
            + TableBackup.BuilderTableBackup.Builder.setKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type KeyValueBackupEntry
            TableBackup(String name, + List<TableLayoutBackupEntry> layouts, + List<KeyValueBackupEntry> key_values) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of KeyValueBackupEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KeyValueBackupEntry
            + List<KeyValueBackupEntry>HBaseMetaTable.keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + List<KeyValueBackupEntry>HBaseTableKeyValueDatabase.keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type KeyValueBackupEntry
            + voidHBaseMetaTable.keyValuesFromBackup(String table, + List<KeyValueBackupEntry> tableBackup) + +
            +          Restores all table's key value history from a backup.
            + voidHBaseTableKeyValueDatabase.keyValuesFromBackup(String tableName, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html new file mode 100644 index 00000000..a3a91e05 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.Callback.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Interface org.kiji.schema.avro.KijiTableLayoutRecords.Callback (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.avro.KijiTableLayoutRecords.Callback

            +
            +No usage of org.kiji.schema.avro.KijiTableLayoutRecords.Callback +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html new file mode 100644 index 00000000..29b2358e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/KijiTableLayoutRecords.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface org.kiji.schema.avro.KijiTableLayoutRecords (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.avro.KijiTableLayoutRecords

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayoutRecords
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of KijiTableLayoutRecords in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiTableLayoutRecords in org.kiji.schema.avro
            +static interfaceKijiTableLayoutRecords.Callback + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html new file mode 100644 index 00000000..517b0f40 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/LocalityGroupDesc.Builder.html @@ -0,0 +1,405 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.LocalityGroupDesc.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.LocalityGroupDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use LocalityGroupDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of LocalityGroupDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return LocalityGroupDesc.Builder
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearAliases() + +
            +          Clears the value of the 'aliases' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearCompressionType() + +
            +          Clears the value of the 'compression_type' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearDelete() + +
            +          Clears the value of the 'delete' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearEnabled() + +
            +          Clears the value of the 'enabled' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearFamilies() + +
            +          Clears the value of the 'families' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearId() + +
            +          Clears the value of the 'id' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearInMemory() + +
            +          Clears the value of the 'in_memory' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearMaxVersions() + +
            +          Clears the value of the 'max_versions' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearRenamedFrom() + +
            +          Clears the value of the 'renamed_from' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.clearTtlSeconds() + +
            +          Clears the value of the 'ttl_seconds' field
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder() + +
            +          Creates a new LocalityGroupDesc RecordBuilder
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc.Builder other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setAliases(List<String> value) + +
            +          Sets the value of the 'aliases' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setCompressionType(CompressionType value) + +
            +          Sets the value of the 'compression_type' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setDelete(boolean value) + +
            +          Sets the value of the 'delete' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setEnabled(boolean value) + +
            +          Sets the value of the 'enabled' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setFamilies(List<FamilyDesc> value) + +
            +          Sets the value of the 'families' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setId(int value) + +
            +          Sets the value of the 'id' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setInMemory(boolean value) + +
            +          Sets the value of the 'in_memory' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setMaxVersions(int value) + +
            +          Sets the value of the 'max_versions' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setRenamedFrom(String value) + +
            +          Sets the value of the 'renamed_from' field
            + LocalityGroupDesc.BuilderLocalityGroupDesc.Builder.setTtlSeconds(int value) + +
            +          Sets the value of the 'ttl_seconds' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type LocalityGroupDesc.Builder
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc.Builder other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/LocalityGroupDesc.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/LocalityGroupDesc.html new file mode 100644 index 00000000..6e081134 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/LocalityGroupDesc.html @@ -0,0 +1,310 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.LocalityGroupDesc (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.LocalityGroupDesc

            +
            + + + + + + + + + + + + + +
            +Packages that use LocalityGroupDesc
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of LocalityGroupDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type LocalityGroupDesc
            + List<LocalityGroupDesc>TableLayoutDesc.locality_groups + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return LocalityGroupDesc
            + LocalityGroupDescLocalityGroupDesc.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type LocalityGroupDesc
            + List<LocalityGroupDesc>TableLayoutDesc.getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field.
            + List<LocalityGroupDesc>TableLayoutDesc.Builder.getLocalityGroups() + +
            +          Gets the value of the 'locality_groups' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type LocalityGroupDesc
            +static LocalityGroupDesc.BuilderLocalityGroupDesc.newBuilder(LocalityGroupDesc other) + +
            +          Creates a new LocalityGroupDesc RecordBuilder by copying an existing LocalityGroupDesc instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type LocalityGroupDesc
            + voidTableLayoutDesc.setLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field.
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type LocalityGroupDesc
            TableLayoutDesc(String name, + String description, + Object keys_format, + List<LocalityGroupDesc> locality_groups, + String version, + String layout_id, + String reference_layout) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of LocalityGroupDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return LocalityGroupDesc
            + LocalityGroupDescKijiTableLayout.LocalityGroupLayout.getDesc() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/MD5Hash.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/MD5Hash.html new file mode 100644 index 00000000..efc70b5b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/MD5Hash.html @@ -0,0 +1,245 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.MD5Hash (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.MD5Hash

            +
            + + + + + + + + + +
            +Packages that use MD5Hash
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of MD5Hash in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as MD5Hash
            + MD5HashSchemaTableEntry.hash + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return MD5Hash
            + MD5HashSchemaTableEntry.getHash() + +
            +          Gets the value of the 'hash' field.
            + MD5HashSchemaTableEntry.Builder.getHash() + +
            +          Gets the value of the 'hash' field
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type MD5Hash
            + voidSchemaTableEntry.setHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field.
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type MD5Hash
            SchemaTableEntry(Long id, + MD5Hash hash, + String avro_schema) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html new file mode 100644 index 00000000..1930f045 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/MetadataBackup.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.MetadataBackup.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.MetadataBackup.Builder

            +
            + + + + + + + + + +
            +Packages that use MetadataBackup.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of MetadataBackup.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return MetadataBackup.Builder
            + MetadataBackup.BuilderMetadataBackup.Builder.clearLayoutVersion() + +
            +          Clears the value of the 'layout_version' field
            + MetadataBackup.BuilderMetadataBackup.Builder.clearMetaTable() + +
            +          Clears the value of the 'meta_table' field
            + MetadataBackup.BuilderMetadataBackup.Builder.clearSchemaTable() + +
            +          Clears the value of the 'schema_table' field
            +static MetadataBackup.BuilderMetadataBackup.newBuilder() + +
            +          Creates a new MetadataBackup RecordBuilder
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup.Builder other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing Builder
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance
            + MetadataBackup.BuilderMetadataBackup.Builder.setLayoutVersion(String value) + +
            +          Sets the value of the 'layout_version' field
            + MetadataBackup.BuilderMetadataBackup.Builder.setMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field
            + MetadataBackup.BuilderMetadataBackup.Builder.setSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type MetadataBackup.Builder
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup.Builder other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/MetadataBackup.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/MetadataBackup.html new file mode 100644 index 00000000..d3548401 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/MetadataBackup.html @@ -0,0 +1,236 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.MetadataBackup (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.MetadataBackup

            +
            + + + + + + + + + + + + + +
            +Packages that use MetadataBackup
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of MetadataBackup in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return MetadataBackup
            + MetadataBackupMetadataBackup.Builder.build() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type MetadataBackup
            +static MetadataBackup.BuilderMetadataBackup.newBuilder(MetadataBackup other) + +
            +          Creates a new MetadataBackup RecordBuilder by copying an existing MetadataBackup instance
            +  +

            + + + + + +
            +Uses of MetadataBackup in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type MetadataBackup
            + voidMetadataRestorer.restoreSchemas(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all SchemaTable entries from the metadata backup.
            + voidMetadataRestorer.restoreTables(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all tables from the metadata backup into the running Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyComponent.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyComponent.Builder.html new file mode 100644 index 00000000..0f47b9a7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyComponent.Builder.html @@ -0,0 +1,245 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyComponent.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyComponent.Builder

            +
            + + + + + + + + + +
            +Packages that use RowKeyComponent.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of RowKeyComponent.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyComponent.Builder
            + RowKeyComponent.BuilderRowKeyComponent.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + RowKeyComponent.BuilderRowKeyComponent.Builder.clearType() + +
            +          Clears the value of the 'type' field
            +static RowKeyComponent.BuilderRowKeyComponent.newBuilder() + +
            +          Creates a new RowKeyComponent RecordBuilder
            +static RowKeyComponent.BuilderRowKeyComponent.newBuilder(RowKeyComponent.Builder other) + +
            +          Creates a new RowKeyComponent RecordBuilder by copying an existing Builder
            +static RowKeyComponent.BuilderRowKeyComponent.newBuilder(RowKeyComponent other) + +
            +          Creates a new RowKeyComponent RecordBuilder by copying an existing RowKeyComponent instance
            + RowKeyComponent.BuilderRowKeyComponent.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + RowKeyComponent.BuilderRowKeyComponent.Builder.setType(ComponentType value) + +
            +          Sets the value of the 'type' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyComponent.Builder
            +static RowKeyComponent.BuilderRowKeyComponent.newBuilder(RowKeyComponent.Builder other) + +
            +          Creates a new RowKeyComponent RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyComponent.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyComponent.html new file mode 100644 index 00000000..11d078ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyComponent.html @@ -0,0 +1,279 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyComponent (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyComponent

            +
            + + + + + + + + + +
            +Packages that use RowKeyComponent
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of RowKeyComponent in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type RowKeyComponent
            + List<RowKeyComponent>RowKeyFormat2.components + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyComponent
            + RowKeyComponentRowKeyComponent.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type RowKeyComponent
            + List<RowKeyComponent>RowKeyFormat2.getComponents() + +
            +          Gets the value of the 'components' field.
            + List<RowKeyComponent>RowKeyFormat2.Builder.getComponents() + +
            +          Gets the value of the 'components' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyComponent
            +static RowKeyComponent.BuilderRowKeyComponent.newBuilder(RowKeyComponent other) + +
            +          Creates a new RowKeyComponent RecordBuilder by copying an existing RowKeyComponent instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type RowKeyComponent
            + voidRowKeyFormat2.setComponents(List<RowKeyComponent> value) + +
            +          Sets the value of the 'components' field.
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.setComponents(List<RowKeyComponent> value) + +
            +          Sets the value of the 'components' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type RowKeyComponent
            RowKeyFormat2(RowKeyEncoding encoding, + HashSpec salt, + Integer range_scan_start_index, + Integer nullable_start_index, + List<RowKeyComponent> components) + +
            +          All-args constructor.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyEncoding.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyEncoding.html new file mode 100644 index 00000000..897217e4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyEncoding.html @@ -0,0 +1,341 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyEncoding (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyEncoding

            +
            + + + + + + + + + + + + + +
            +Packages that use RowKeyEncoding
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of RowKeyEncoding in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as RowKeyEncoding
            + RowKeyEncodingRowKeyFormat2.encoding + +
            +          Deprecated. 
            + RowKeyEncodingRowKeyFormat.encoding + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyEncoding
            + RowKeyEncodingRowKeyFormat2.getEncoding() + +
            +          Gets the value of the 'encoding' field.
            + RowKeyEncodingRowKeyFormat2.Builder.getEncoding() + +
            +          Gets the value of the 'encoding' field
            + RowKeyEncodingRowKeyFormat.getEncoding() + +
            +          Gets the value of the 'encoding' field.
            + RowKeyEncodingRowKeyFormat.Builder.getEncoding() + +
            +          Gets the value of the 'encoding' field
            +static RowKeyEncodingRowKeyEncoding.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static RowKeyEncoding[]RowKeyEncoding.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyEncoding
            + voidRowKeyFormat2.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field.
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            + voidRowKeyFormat.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field.
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type RowKeyEncoding
            RowKeyFormat(RowKeyEncoding encoding, + HashType hash_type, + Integer hash_size) + +
            +          All-args constructor.
            RowKeyFormat2(RowKeyEncoding encoding, + HashSpec salt, + Integer range_scan_start_index, + Integer nullable_start_index, + List<RowKeyComponent> components) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of RowKeyEncoding in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return RowKeyEncoding
            +static RowKeyEncodingKijiTableLayout.getEncoding(Object rowKeyFormat) + +
            +          Find the encoding of the row key given the format.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html new file mode 100644 index 00000000..40e83908 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyFormat.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyFormat.Builder

            +
            + + + + + + + + + +
            +Packages that use RowKeyFormat.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of RowKeyFormat.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyFormat.Builder
            + RowKeyFormat.BuilderRowKeyFormat.Builder.clearEncoding() + +
            +          Clears the value of the 'encoding' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.clearHashSize() + +
            +          Clears the value of the 'hash_size' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.clearHashType() + +
            +          Clears the value of the 'hash_type' field
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder() + +
            +          Creates a new RowKeyFormat RecordBuilder
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat.Builder other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing Builder
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setHashSize(int value) + +
            +          Sets the value of the 'hash_size' field
            + RowKeyFormat.BuilderRowKeyFormat.Builder.setHashType(HashType value) + +
            +          Sets the value of the 'hash_type' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyFormat.Builder
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat.Builder other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat.html new file mode 100644 index 00000000..9f974eed --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat.html @@ -0,0 +1,301 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyFormat (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyFormat

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use RowKeyFormat
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type RowKeyFormat
            +static EntityIdFactoryEntityIdFactory.getFactory(RowKeyFormat format) + +
            +          Creates an entity ID factory for the specified row key format.
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyFormat
            + RowKeyFormatRowKeyFormat.Builder.build() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyFormat
            +static RowKeyFormat.BuilderRowKeyFormat.newBuilder(RowKeyFormat other) + +
            +          Creates a new RowKeyFormat RecordBuilder by copying an existing RowKeyFormat instance
            +  +

            + + + + + +
            +Uses of RowKeyFormat in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type RowKeyFormat
            +static HashPrefixedEntityIdHashPrefixedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified HBase row key.
            +static HashedEntityIdHashedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified HBase row key.
            +static HashPrefixedEntityIdHashPrefixedEntityId.getEntityId(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified Kiji row key.
            +static HashedEntityIdHashedEntityId.getEntityId(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified Kiji row key.
            +static byte[]HashPrefixedEntityId.hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            +static byte[]HashedEntityId.hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat2.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat2.Builder.html new file mode 100644 index 00000000..808a552f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat2.Builder.html @@ -0,0 +1,293 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyFormat2.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyFormat2.Builder

            +
            + + + + + + + + + +
            +Packages that use RowKeyFormat2.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of RowKeyFormat2.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyFormat2.Builder
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.clearComponents() + +
            +          Clears the value of the 'components' field
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.clearEncoding() + +
            +          Clears the value of the 'encoding' field
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.clearNullableStartIndex() + +
            +          Clears the value of the 'nullable_start_index' field
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.clearRangeScanStartIndex() + +
            +          Clears the value of the 'range_scan_start_index' field
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.clearSalt() + +
            +          Clears the value of the 'salt' field
            +static RowKeyFormat2.BuilderRowKeyFormat2.newBuilder() + +
            +          Creates a new RowKeyFormat2 RecordBuilder
            +static RowKeyFormat2.BuilderRowKeyFormat2.newBuilder(RowKeyFormat2.Builder other) + +
            +          Creates a new RowKeyFormat2 RecordBuilder by copying an existing Builder
            +static RowKeyFormat2.BuilderRowKeyFormat2.newBuilder(RowKeyFormat2 other) + +
            +          Creates a new RowKeyFormat2 RecordBuilder by copying an existing RowKeyFormat2 instance
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.setComponents(List<RowKeyComponent> value) + +
            +          Sets the value of the 'components' field
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.setEncoding(RowKeyEncoding value) + +
            +          Sets the value of the 'encoding' field
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.setNullableStartIndex(int value) + +
            +          Sets the value of the 'nullable_start_index' field
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.setRangeScanStartIndex(int value) + +
            +          Sets the value of the 'range_scan_start_index' field
            + RowKeyFormat2.BuilderRowKeyFormat2.Builder.setSalt(HashSpec value) + +
            +          Sets the value of the 'salt' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyFormat2.Builder
            +static RowKeyFormat2.BuilderRowKeyFormat2.newBuilder(RowKeyFormat2.Builder other) + +
            +          Creates a new RowKeyFormat2 RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat2.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat2.html new file mode 100644 index 00000000..df6ccde7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/RowKeyFormat2.html @@ -0,0 +1,297 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.RowKeyFormat2 (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.RowKeyFormat2

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use RowKeyFormat2
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of RowKeyFormat2 in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type RowKeyFormat2
            +static EntityIdFactoryEntityIdFactory.getFactory(RowKeyFormat2 format) + +
            +          Creates an entity ID factory for the specified row key format.
            +  +

            + + + + + +
            +Uses of RowKeyFormat2 in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return RowKeyFormat2
            + RowKeyFormat2RowKeyFormat2.Builder.build() + +
            +           
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type RowKeyFormat2
            +static RowKeyFormat2.BuilderRowKeyFormat2.newBuilder(RowKeyFormat2 other) + +
            +          Creates a new RowKeyFormat2 RecordBuilder by copying an existing RowKeyFormat2 instance
            +  +

            + + + + + +
            +Uses of RowKeyFormat2 in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type RowKeyFormat2
            +static FormattedEntityIdFormattedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat2 format) + +
            +          Creates a FormattedEntityId from the specified HBase row key.
            +static FormattedEntityIdFormattedEntityId.getEntityId(List<Object> kijiRowKey, + RowKeyFormat2 format) + +
            +          Creates a FormattedEntityId from the specified Kiji row key.
            +  +

            + + + + + +
            +Uses of RowKeyFormat2 in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type RowKeyFormat2
            +static EntityIdToolUtils.parseJsonFormattedKeySpec(String json, + RowKeyFormat2 format, + EntityIdFactory factory) + +
            +          Parses a JSON formatted row key specification.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaStorage.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaStorage.html new file mode 100644 index 00000000..68b61e7f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaStorage.html @@ -0,0 +1,320 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaStorage (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaStorage

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use SchemaStorage
            org.kiji.schema.avro  
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of SchemaStorage in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as SchemaStorage
            + SchemaStorageCellSchema.storage + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaStorage
            + SchemaStorageCellSchema.getStorage() + +
            +          Gets the value of the 'storage' field.
            + SchemaStorageCellSchema.Builder.getStorage() + +
            +          Gets the value of the 'storage' field
            +static SchemaStorageSchemaStorage.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaStorage[]SchemaStorage.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaStorage
            + voidCellSchema.setStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field.
            + CellSchema.BuilderCellSchema.Builder.setStorage(SchemaStorage value) + +
            +          Sets the value of the 'storage' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type SchemaStorage
            CellSchema(SchemaStorage storage, + SchemaType type, + String value) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of SchemaStorage in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return SchemaStorage
            + SchemaStorageKijiTableLayout.getCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            +  +

            + + + + + +
            +Uses of SchemaStorage in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type SchemaStorage
            + CellSpecCellSpec.setSchemaStorage(SchemaStorage schemaStorage) + +
            +          Sets the schema storage.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html new file mode 100644 index 00000000..954300eb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaTableEntry.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaTableEntry.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaTableEntry.Builder

            +
            + + + + + + + + + +
            +Packages that use SchemaTableEntry.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of SchemaTableEntry.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaTableEntry.Builder
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.clearAvroSchema() + +
            +          Clears the value of the 'avro_schema' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.clearHash() + +
            +          Clears the value of the 'hash' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.clearId() + +
            +          Clears the value of the 'id' field
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder() + +
            +          Creates a new SchemaTableEntry RecordBuilder
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry.Builder other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setAvroSchema(String value) + +
            +          Sets the value of the 'avro_schema' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setHash(MD5Hash value) + +
            +          Sets the value of the 'hash' field
            + SchemaTableEntry.BuilderSchemaTableEntry.Builder.setId(long value) + +
            +          Sets the value of the 'id' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaTableEntry.Builder
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry.Builder other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaTableEntry.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaTableEntry.html new file mode 100644 index 00000000..c1361aa3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaTableEntry.html @@ -0,0 +1,417 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaTableEntry (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaTableEntry

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use SchemaTableEntry
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of SchemaTableEntry in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type SchemaTableEntry
            +abstract  List<SchemaTableEntry>KijiSchemaTable.toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type SchemaTableEntry
            +abstract  voidKijiSchemaTable.fromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            +  +

            + + + + + +
            +Uses of SchemaTableEntry in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type SchemaTableEntry
            + List<SchemaTableEntry>MetadataBackup.schema_table + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaTableEntry
            + SchemaTableEntrySchemaTableEntry.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type SchemaTableEntry
            + List<SchemaTableEntry>MetadataBackup.getSchemaTable() + +
            +          Gets the value of the 'schema_table' field.
            + List<SchemaTableEntry>MetadataBackup.Builder.getSchemaTable() + +
            +          Gets the value of the 'schema_table' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaTableEntry
            +static SchemaTableEntry.BuilderSchemaTableEntry.newBuilder(SchemaTableEntry other) + +
            +          Creates a new SchemaTableEntry RecordBuilder by copying an existing SchemaTableEntry instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type SchemaTableEntry
            + voidMetadataBackup.setSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field.
            + MetadataBackup.BuilderMetadataBackup.Builder.setSchemaTable(List<SchemaTableEntry> value) + +
            +          Sets the value of the 'schema_table' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type SchemaTableEntry
            MetadataBackup(String layout_version, + List<SchemaTableEntry> schema_table, + Map<String,TableBackup> meta_table) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of SchemaTableEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return SchemaTableEntry
            +static SchemaTableEntryHBaseSchemaTable.decodeSchemaEntry(byte[] bytes) + +
            +          Decodes a binary-encoded Avro schema entry.
            +static SchemaTableEntryHBaseSchemaTable.toAvroEntry(KijiSchemaTable.SchemaEntry entry) + +
            +          Converts a SchemaEntry into an Avro SchemaTableEntry.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type SchemaTableEntry
            + List<SchemaTableEntry>HBaseSchemaTable.toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type SchemaTableEntry
            +static byte[]HBaseSchemaTable.encodeSchemaEntry(SchemaTableEntry avroEntry) + +
            +          Encodes an Avro schema entry into binary.
            +static KijiSchemaTable.SchemaEntryHBaseSchemaTable.fromAvroEntry(SchemaTableEntry avroEntry) + +
            +          Converts an Avro SchemaTableEntry into a SchemaEntry.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type SchemaTableEntry
            + voidHBaseSchemaTable.fromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaType.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaType.html new file mode 100644 index 00000000..7bcff160 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/SchemaType.html @@ -0,0 +1,291 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.SchemaType (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.SchemaType

            +
            + + + + + + + + + + + + + +
            +Packages that use SchemaType
            org.kiji.schema.avro  
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of SchemaType in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as SchemaType
            + SchemaTypeCellSchema.type + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return SchemaType
            + SchemaTypeCellSchema.getType() + +
            +          Gets the value of the 'type' field.
            + SchemaTypeCellSchema.Builder.getType() + +
            +          Gets the value of the 'type' field
            +static SchemaTypeSchemaType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static SchemaType[]SchemaType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type SchemaType
            + voidCellSchema.setType(SchemaType value) + +
            +          Sets the value of the 'type' field.
            + CellSchema.BuilderCellSchema.Builder.setType(SchemaType value) + +
            +          Sets the value of the 'type' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type SchemaType
            CellSchema(SchemaStorage storage, + SchemaType type, + String value) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of SchemaType in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type SchemaType
            + CellSpecCellSpec.setType(SchemaType schemaType) + +
            +          Sets the cell type.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableBackup.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableBackup.Builder.html new file mode 100644 index 00000000..afbc3ab5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableBackup.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableBackup.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableBackup.Builder

            +
            + + + + + + + + + +
            +Packages that use TableBackup.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of TableBackup.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableBackup.Builder
            + TableBackup.BuilderTableBackup.Builder.clearKeyValues() + +
            +          Clears the value of the 'key_values' field
            + TableBackup.BuilderTableBackup.Builder.clearLayouts() + +
            +          Clears the value of the 'layouts' field
            + TableBackup.BuilderTableBackup.Builder.clearName() + +
            +          Clears the value of the 'name' field
            +static TableBackup.BuilderTableBackup.newBuilder() + +
            +          Creates a new TableBackup RecordBuilder
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup.Builder other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing Builder
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance
            + TableBackup.BuilderTableBackup.Builder.setKeyValues(List<KeyValueBackupEntry> value) + +
            +          Sets the value of the 'key_values' field
            + TableBackup.BuilderTableBackup.Builder.setLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field
            + TableBackup.BuilderTableBackup.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableBackup.Builder
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup.Builder other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableBackup.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableBackup.html new file mode 100644 index 00000000..dadfcd1c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableBackup.html @@ -0,0 +1,369 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableBackup (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableBackup

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use TableBackup
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of TableBackup in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type TableBackup
            +abstract  Map<String,TableBackup>KijiMetaTable.toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type TableBackup
            +abstract  voidKijiMetaTable.fromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            +  +

            + + + + + +
            +Uses of TableBackup in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type TableBackup
            + Map<String,TableBackup>MetadataBackup.meta_table + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableBackup
            + TableBackupTableBackup.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type TableBackup
            + Map<String,TableBackup>MetadataBackup.getMetaTable() + +
            +          Gets the value of the 'meta_table' field.
            + Map<String,TableBackup>MetadataBackup.Builder.getMetaTable() + +
            +          Gets the value of the 'meta_table' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableBackup
            +static TableBackup.BuilderTableBackup.newBuilder(TableBackup other) + +
            +          Creates a new TableBackup RecordBuilder by copying an existing TableBackup instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type TableBackup
            + voidMetadataBackup.setMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field.
            + MetadataBackup.BuilderMetadataBackup.Builder.setMetaTable(Map<String,TableBackup> value) + +
            +          Sets the value of the 'meta_table' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type TableBackup
            MetadataBackup(String layout_version, + List<SchemaTableEntry> schema_table, + Map<String,TableBackup> meta_table) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of TableBackup in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type TableBackup
            + Map<String,TableBackup>HBaseMetaTable.toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type TableBackup
            + voidHBaseMetaTable.fromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html new file mode 100644 index 00000000..74772ebc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.Builder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutBackupEntry.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutBackupEntry.Builder

            +
            + + + + + + + + + +
            +Packages that use TableLayoutBackupEntry.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutBackupEntry.Builder
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.clearLayout() + +
            +          Clears the value of the 'layout' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.clearTimestamp() + +
            +          Clears the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.clearUpdate() + +
            +          Clears the value of the 'update' field
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder() + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry.Builder other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setTimestamp(long value) + +
            +          Sets the value of the 'timestamp' field
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutBackupEntry.Builder
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry.Builder other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html new file mode 100644 index 00000000..6a824ec0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutBackupEntry.html @@ -0,0 +1,415 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutBackupEntry (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutBackupEntry

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use TableLayoutBackupEntry
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.avro
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.avro with type parameters of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>TableBackup.layouts + +
            +          Deprecated. 
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutBackupEntry
            + TableLayoutBackupEntryTableLayoutBackupEntry.Builder.build() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>TableBackup.getLayouts() + +
            +          Gets the value of the 'layouts' field.
            + List<TableLayoutBackupEntry>TableBackup.Builder.getLayouts() + +
            +          Gets the value of the 'layouts' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutBackupEntry
            +static TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.newBuilder(TableLayoutBackupEntry other) + +
            +          Creates a new TableLayoutBackupEntry RecordBuilder by copying an existing TableLayoutBackupEntry instance
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema.avro with type arguments of type TableLayoutBackupEntry
            + voidTableBackup.setLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field.
            + TableBackup.BuilderTableBackup.Builder.setLayouts(List<TableLayoutBackupEntry> value) + +
            +          Sets the value of the 'layouts' field
            +  +

            + + + + + + + + +
            Constructor parameters in org.kiji.schema.avro with type arguments of type TableLayoutBackupEntry
            TableBackup(String name, + List<TableLayoutBackupEntry> layouts, + List<KeyValueBackupEntry> key_values) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>HBaseMetaTable.layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type TableLayoutBackupEntry
            + voidHBaseMetaTable.layoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +           
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>KijiTableLayoutDatabase.layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.layout with type arguments of type TableLayoutBackupEntry
            + voidKijiTableLayoutDatabase.layoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +          Restores a table layout history from a backup.
            +  +

            + + + + + +
            +Uses of TableLayoutBackupEntry in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return types with arguments of type TableLayoutBackupEntry
            + List<TableLayoutBackupEntry>HBaseTableLayoutDatabase.layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.layout.impl with type arguments of type TableLayoutBackupEntry
            + voidHBaseTableLayoutDatabase.layoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> layoutBackup) + +
            +          Restores a table layout history from a backup.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html new file mode 100644 index 00000000..c768b75e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutDesc.Builder.html @@ -0,0 +1,325 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutDesc.Builder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutDesc.Builder

            +
            + + + + + + + + + +
            +Packages that use TableLayoutDesc.Builder
            org.kiji.schema.avro  
            +  +

            + + + + + +
            +Uses of TableLayoutDesc.Builder in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutDesc.Builder
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearDescription() + +
            +          Clears the value of the 'description' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearKeysFormat() + +
            +          Clears the value of the 'keys_format' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearLayoutId() + +
            +          Clears the value of the 'layout_id' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearLocalityGroups() + +
            +          Clears the value of the 'locality_groups' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearName() + +
            +          Clears the value of the 'name' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearReferenceLayout() + +
            +          Clears the value of the 'reference_layout' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.clearVersion() + +
            +          Clears the value of the 'version' field
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder() + +
            +          Creates a new TableLayoutDesc RecordBuilder
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc.Builder other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setDescription(String value) + +
            +          Sets the value of the 'description' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setKeysFormat(Object value) + +
            +          Sets the value of the 'keys_format' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setLayoutId(String value) + +
            +          Sets the value of the 'layout_id' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setLocalityGroups(List<LocalityGroupDesc> value) + +
            +          Sets the value of the 'locality_groups' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setName(String value) + +
            +          Sets the value of the 'name' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setReferenceLayout(String value) + +
            +          Sets the value of the 'reference_layout' field
            + TableLayoutDesc.BuilderTableLayoutDesc.Builder.setVersion(String value) + +
            +          Sets the value of the 'version' field
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutDesc.Builder
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc.Builder other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing Builder
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutDesc.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutDesc.html new file mode 100644 index 00000000..87ddfa4d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/class-use/TableLayoutDesc.html @@ -0,0 +1,498 @@ + + + + + + + +Uses of Class org.kiji.schema.avro.TableLayoutDesc (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.avro.TableLayoutDesc

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use TableLayoutDesc
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type TableLayoutDesc
            + KijiTableLayoutKiji.modifyTableLayout(String name, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutKiji.modifyTableLayout(String name, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.avro
            +  +

            + + + + + + + + + + + + + +
            Fields in org.kiji.schema.avro declared as TableLayoutDesc
            + TableLayoutDescTableLayoutBackupEntry.layout + +
            +          Deprecated. 
            + TableLayoutDescTableLayoutBackupEntry.update + +
            +          Deprecated. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro that return TableLayoutDesc
            + TableLayoutDescTableLayoutDesc.Builder.build() + +
            +           
            + TableLayoutDescTableLayoutBackupEntry.getLayout() + +
            +          Gets the value of the 'layout' field.
            + TableLayoutDescTableLayoutBackupEntry.Builder.getLayout() + +
            +          Gets the value of the 'layout' field
            + TableLayoutDescTableLayoutBackupEntry.getUpdate() + +
            +          Gets the value of the 'update' field.
            + TableLayoutDescTableLayoutBackupEntry.Builder.getUpdate() + +
            +          Gets the value of the 'update' field
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.avro with parameters of type TableLayoutDesc
            +static TableLayoutDesc.BuilderTableLayoutDesc.newBuilder(TableLayoutDesc other) + +
            +          Creates a new TableLayoutDesc RecordBuilder by copying an existing TableLayoutDesc instance
            + voidTableLayoutBackupEntry.setLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field.
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setLayout(TableLayoutDesc value) + +
            +          Sets the value of the 'layout' field
            + voidTableLayoutBackupEntry.setUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field.
            + TableLayoutBackupEntry.BuilderTableLayoutBackupEntry.Builder.setUpdate(TableLayoutDesc value) + +
            +          Sets the value of the 'update' field
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.avro with parameters of type TableLayoutDesc
            TableLayoutBackupEntry(Long timestamp, + TableLayoutDesc update, + TableLayoutDesc layout) + +
            +          All-args constructor.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type TableLayoutDesc
            + KijiTableLayoutHBaseKiji.modifyTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutHBaseKiji.modifyTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            + KijiTableLayoutHBaseMetaTable.updateTableLayout(String table, + TableLayoutDesc layoutUpdate) + +
            +          Sets a table's layout.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return TableLayoutDesc
            + TableLayoutDescKijiTableLayout.getDesc() + +
            +           
            +static TableLayoutDescKijiTableLayout.readTableLayoutDescFromJSON(InputStream istream) + +
            +          Reads a table layout descriptor from its JSON serialized form.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type TableLayoutDesc
            +static KijiTableLayoutKijiTableLayout.createUpdatedLayout(TableLayoutDesc updateLayoutDesc, + KijiTableLayout oldLayout) + +
            +          Creates and returns a new KijiTableLayout instance as specified by composing updates described + by a TableLayoutDesc with the original + KijiTableLayout.
            +static KijiTableLayoutKijiTableLayout.newLayout(TableLayoutDesc layout) + +
            +          Creates and returns a new KijiTableLayout instance as specified by an Avro TableLayoutDesc + description record.
            + KijiTableLayoutKijiTableLayoutDatabase.updateTableLayout(String table, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + +
            +Uses of TableLayoutDesc in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type TableLayoutDesc
            + KijiTableLayoutHBaseTableLayoutDatabase.updateTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-frame.html new file mode 100644 index 00000000..a17b1d75 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-frame.html @@ -0,0 +1,123 @@ + + + + + + + +org.kiji.schema.avro (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema.avro + + + + +
            +Interfaces  + +
            +KijiTableLayoutRecords +
            +KijiTableLayoutRecords.Callback
            + + + + + + +
            +Classes  + +
            +CellSchema +
            +CellSchema.Builder +
            +ColumnDesc +
            +ColumnDesc.Builder +
            +FamilyDesc +
            +FamilyDesc.Builder +
            +HashSpec +
            +HashSpec.Builder +
            +KeyValueBackupEntry +
            +KeyValueBackupEntry.Builder +
            +LocalityGroupDesc +
            +LocalityGroupDesc.Builder +
            +MD5Hash +
            +MetadataBackup +
            +MetadataBackup.Builder +
            +RowKeyComponent +
            +RowKeyComponent.Builder +
            +RowKeyFormat +
            +RowKeyFormat.Builder +
            +RowKeyFormat2 +
            +RowKeyFormat2.Builder +
            +SchemaTableEntry +
            +SchemaTableEntry.Builder +
            +TableBackup +
            +TableBackup.Builder +
            +TableLayoutBackupEntry +
            +TableLayoutBackupEntry.Builder +
            +TableLayoutDesc +
            +TableLayoutDesc.Builder
            + + + + + + +
            +Enums  + +
            +ComponentType +
            +CompressionType +
            +HashType +
            +RowKeyEncoding +
            +SchemaStorage +
            +SchemaType
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-summary.html new file mode 100644 index 00000000..f453259b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-summary.html @@ -0,0 +1,322 @@ + + + + + + + +org.kiji.schema.avro (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.avro +

            + + + + + + + + + + + + + +
            +Interface Summary
            KijiTableLayoutRecords 
            KijiTableLayoutRecords.Callback 
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            CellSchema 
            CellSchema.BuilderRecordBuilder for CellSchema instances.
            ColumnDesc 
            ColumnDesc.BuilderRecordBuilder for ColumnDesc instances.
            FamilyDesc 
            FamilyDesc.BuilderRecordBuilder for FamilyDesc instances.
            HashSpec 
            HashSpec.BuilderRecordBuilder for HashSpec instances.
            KeyValueBackupEntry 
            KeyValueBackupEntry.BuilderRecordBuilder for KeyValueBackupEntry instances.
            LocalityGroupDesc 
            LocalityGroupDesc.BuilderRecordBuilder for LocalityGroupDesc instances.
            MD5Hash 
            MetadataBackup 
            MetadataBackup.BuilderRecordBuilder for MetadataBackup instances.
            RowKeyComponent 
            RowKeyComponent.BuilderRecordBuilder for RowKeyComponent instances.
            RowKeyFormat 
            RowKeyFormat.BuilderRecordBuilder for RowKeyFormat instances.
            RowKeyFormat2 
            RowKeyFormat2.BuilderRecordBuilder for RowKeyFormat2 instances.
            SchemaTableEntry 
            SchemaTableEntry.BuilderRecordBuilder for SchemaTableEntry instances.
            TableBackup 
            TableBackup.BuilderRecordBuilder for TableBackup instances.
            TableLayoutBackupEntry 
            TableLayoutBackupEntry.BuilderRecordBuilder for TableLayoutBackupEntry instances.
            TableLayoutDesc 
            TableLayoutDesc.BuilderRecordBuilder for TableLayoutDesc instances.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Enum Summary
            ComponentType 
            CompressionType 
            HashType 
            RowKeyEncoding 
            SchemaStorage 
            SchemaType 
            +  + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-tree.html new file mode 100644 index 00000000..e04be6bb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-tree.html @@ -0,0 +1,212 @@ + + + + + + + +org.kiji.schema.avro Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.avro +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            +
              +
            • java.lang.Object
                +
              • org.apache.avro.generic.GenericData.Fixed (implements java.lang.Comparable<T>, org.apache.avro.generic.GenericFixed) +
                  +
                • org.apache.avro.specific.SpecificFixed +
                +
              • org.apache.avro.data.RecordBuilderBase<T> (implements org.apache.avro.data.RecordBuilder<T>) + +
              • org.apache.avro.specific.SpecificRecordBase (implements java.lang.Comparable<T>, org.apache.avro.specific.SpecificRecord) +
                  +
                • org.kiji.schema.avro.CellSchema (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.ColumnDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.FamilyDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.HashSpec (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.KeyValueBackupEntry (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.LocalityGroupDesc (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.MetadataBackup (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.RowKeyComponent (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.RowKeyFormat (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.RowKeyFormat2 (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.SchemaTableEntry (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.TableBackup (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.TableLayoutBackupEntry (implements org.apache.avro.specific.SpecificRecord) +
                • org.kiji.schema.avro.TableLayoutDesc (implements org.apache.avro.specific.SpecificRecord) +
                +
              +
            +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-use.html new file mode 100644 index 00000000..76387f3b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/avro/package-use.html @@ -0,0 +1,615 @@ + + + + + + + +Uses of Package org.kiji.schema.avro (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.avro

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.avro
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.avro  
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema
            KeyValueBackupEntry + +
            +           
            RowKeyFormat + +
            +           
            RowKeyFormat2 + +
            +           
            SchemaTableEntry + +
            +           
            TableBackup + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.avro
            CellSchema + +
            +           
            CellSchema.Builder + +
            +          RecordBuilder for CellSchema instances.
            ColumnDesc + +
            +           
            ColumnDesc.Builder + +
            +          RecordBuilder for ColumnDesc instances.
            ComponentType + +
            +           
            CompressionType + +
            +           
            FamilyDesc + +
            +           
            FamilyDesc.Builder + +
            +          RecordBuilder for FamilyDesc instances.
            HashSpec + +
            +           
            HashSpec.Builder + +
            +          RecordBuilder for HashSpec instances.
            HashType + +
            +           
            KeyValueBackupEntry + +
            +           
            KeyValueBackupEntry.Builder + +
            +          RecordBuilder for KeyValueBackupEntry instances.
            KijiTableLayoutRecords + +
            +           
            LocalityGroupDesc + +
            +           
            LocalityGroupDesc.Builder + +
            +          RecordBuilder for LocalityGroupDesc instances.
            MD5Hash + +
            +           
            MetadataBackup + +
            +           
            MetadataBackup.Builder + +
            +          RecordBuilder for MetadataBackup instances.
            RowKeyComponent + +
            +           
            RowKeyComponent.Builder + +
            +          RecordBuilder for RowKeyComponent instances.
            RowKeyEncoding + +
            +           
            RowKeyFormat + +
            +           
            RowKeyFormat.Builder + +
            +          RecordBuilder for RowKeyFormat instances.
            RowKeyFormat2 + +
            +           
            RowKeyFormat2.Builder + +
            +          RecordBuilder for RowKeyFormat2 instances.
            SchemaStorage + +
            +           
            SchemaTableEntry + +
            +           
            SchemaTableEntry.Builder + +
            +          RecordBuilder for SchemaTableEntry instances.
            SchemaType + +
            +           
            TableBackup + +
            +           
            TableBackup.Builder + +
            +          RecordBuilder for TableBackup instances.
            TableLayoutBackupEntry + +
            +           
            TableLayoutBackupEntry.Builder + +
            +          RecordBuilder for TableLayoutBackupEntry instances.
            TableLayoutDesc + +
            +           
            TableLayoutDesc.Builder + +
            +          RecordBuilder for TableLayoutDesc instances.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.impl
            KeyValueBackupEntry + +
            +           
            MetadataBackup + +
            +           
            RowKeyFormat + +
            +           
            RowKeyFormat2 + +
            +           
            SchemaTableEntry + +
            +           
            TableBackup + +
            +           
            TableLayoutBackupEntry + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.layout
            CellSchema + +
            +           
            ColumnDesc + +
            +           
            FamilyDesc + +
            +           
            LocalityGroupDesc + +
            +           
            RowKeyEncoding + +
            +           
            SchemaStorage + +
            +           
            TableLayoutBackupEntry + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.layout.impl
            CellSchema + +
            +           
            SchemaStorage + +
            +           
            SchemaType + +
            +           
            TableLayoutBackupEntry + +
            +           
            TableLayoutDesc + +
            +           
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.avro used by org.kiji.schema.tools
            RowKeyFormat2 + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/DecodedCell.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/DecodedCell.html new file mode 100644 index 00000000..977dc2ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/DecodedCell.html @@ -0,0 +1,321 @@ + + + + + + + +Uses of Class org.kiji.schema.DecodedCell (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.DecodedCell

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use DecodedCell
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of DecodedCell in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return DecodedCell
            + DecodedCell<T>KijiCellDecoder.decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type DecodedCell
            + byte[]KijiCellEncoder.encode(DecodedCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type DecodedCell
            KijiCell(String family, + String qualifier, + long timestamp, + DecodedCell<T> decodedCell) + +
            +          Initializes a KijiCell.
            +  +

            + + + + + +
            +Uses of DecodedCell in org.kiji.schema.filter
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type DecodedCell
            +abstract  byte[]KijiRowFilter.Context.getHBaseCellValue(KijiColumnName column, + DecodedCell<?> kijiCell) + +
            +          Converts a Kiji cell value into an HBase cell value.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.filter with parameters of type DecodedCell
            ColumnValueEqualsRowFilter(String family, + String qualifier, + DecodedCell<?> value) + +
            +          Creates a new ColumnValueEqualsRowFilter instance.
            +  +

            + + + + + +
            +Uses of DecodedCell in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return DecodedCell
            + DecodedCell<T>AvroCellDecoder.decodeCell(byte[] encodedBytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + DecodedCell<Long>CounterCellDecoder.decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type DecodedCell
            + byte[]CounterCellEncoder.encode(DecodedCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + byte[]AvroCellEncoder.encode(DecodedCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/EntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/EntityId.html new file mode 100644 index 00000000..d716a91c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/EntityId.html @@ -0,0 +1,805 @@ + + + + + + + +Uses of Class org.kiji.schema.EntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.EntityId

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use EntityId
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji MapReduce utilities. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return EntityId
            + EntityIdKijiRowData.getEntityId() + +
            +          Gets the entity id for this row.
            + EntityIdEntityIdFactory.getEntityId(List<Object> componentList) + +
            +          Creates an entity ID from a list of key components.
            +abstract  EntityIdEntityIdFactory.getEntityId(Object... components) + +
            +          Creates an entity ID from a list of key components.
            + EntityIdKijiTable.getEntityId(Object... kijiRowKey) + +
            +          Creates an entity id from a list of components.
            +abstract  EntityIdEntityIdFactory.getEntityIdFromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates an entity ID from an HBase row key.
            + EntityIdKijiTableReader.KijiScannerOptions.getStartRow() + +
            +          Gets the start row set in these options.
            + EntityIdKijiTableReader.KijiScannerOptions.getStopRow() + +
            +          Gets the stop row set in these options.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type EntityId
            + voidKijiDeleter.deleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voidKijiDeleter.deleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voidKijiDeleter.deleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voidKijiDeleter.deleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voidKijiDeleter.deleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voidKijiDeleter.deleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voidKijiDeleter.deleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voidKijiDeleter.deleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            + KijiRowDataKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiCell<Long>KijiIncrementer.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            + + + + + +
            +<T> void
            +            		KijiPutter.put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		KijiPutter.put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setStartRow(EntityId startRow) + +
            +          Sets the start row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setStopRow(EntityId stopRow) + +
            +          Sets the stop row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type EntityId
            + List<KijiRowData>KijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of EntityId in org.kiji.schema.impl
            + classFormattedEntityId + +
            +          Implements the Formatted Entity Id row key.
            + classHashedEntityId + +
            +          Implements the hashed row key format.
            + classHashPrefixedEntityId + +
            +          Implements the hash-prefixed row key format.
            + classHBaseEntityId + +
            +          Entity ID encapsulating an HBase row key.
            + classRawEntityId + +
            +          Implements the raw row key format.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return EntityId
            + EntityIdHBaseKijiRowData.getEntityId() + +
            +          Gets the entity id for this row.
            +abstract  EntityIdAbstractKijiTable.getEntityId(Object... kijiRowKey) + +
            +          Creates an entity id from a list of components.
            + EntityIdHBaseKijiTable.getEntityId(Object... kijiRowKey) + +
            +          Creates an entity id from a list of components.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type EntityId
            + voidHBaseKijiTableWriter.deleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voidHBaseKijiTableWriter.deleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voidHBaseKijiTableWriter.deleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voidHBaseKijiTableWriter.deleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voidHBaseKijiTableWriter.deleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voidHBaseKijiTableWriter.deleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voidHBaseKijiTableWriter.deleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voidHBaseKijiTableWriter.deleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            + KijiRowDataHBaseKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiCell<Long>HBaseKijiTableWriter.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            + + + + + +
            +<T> void
            +            		HBaseKijiTableWriter.put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		HBaseKijiTableWriter.put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            + GetHBaseDataRequestAdapter.toGet(EntityId entityId, + KijiTableLayout tableLayout) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            +  +

            + + + + + + + + + +
            Method parameters in org.kiji.schema.impl with type arguments of type EntityId
            + List<KijiRowData>HBaseKijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type EntityId
            HBaseKijiPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HBaseKijiTable table, + KijiColumnName colName) + +
            +          Initializes a HBaseKijiPager.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return EntityId
            + EntityIdKijiTableInputFormat.KijiTableRecordReader.getCurrentKey() + +
            +          
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return types with arguments of type EntityId
            + RecordReader<EntityId,KijiRowData>KijiTableInputFormat.createRecordReader(InputSplit split, + TaskAttemptContext context) + +
            +          Deprecated. 
            +  +

            + + + + + +
            +Uses of EntityId in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.tools that return EntityId
            +static EntityIdToolUtils.createEntityIdFromUserInputs(String entityFlag, + KijiTableLayout layout) + +
            +          Parses a command-line flag specifying an entity ID.
            +static EntityIdToolUtils.parseJsonFormattedKeySpec(String json, + RowKeyFormat2 format, + EntityIdFactory factory) + +
            +          Parses a JSON formatted row key specification.
            +static EntityIdToolUtils.parseKijiRowKey(String rowKeySpec, + EntityIdFactory factory, + KijiTableLayout layout) + +
            +          Parses a Kiji row key specification from a command-line flag.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/EntityIdException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/EntityIdException.html new file mode 100644 index 00000000..86ec5595 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/EntityIdException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.EntityIdException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.EntityIdException

            +
            +No usage of org.kiji.schema.EntityIdException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/EntityIdFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/EntityIdFactory.html new file mode 100644 index 00000000..74d60f35 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/EntityIdFactory.html @@ -0,0 +1,240 @@ + + + + + + + +Uses of Class org.kiji.schema.EntityIdFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.EntityIdFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use EntityIdFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of EntityIdFactory in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return EntityIdFactory
            +static EntityIdFactoryEntityIdFactory.getFactory(KijiTableLayout kijiTableLayout) + +
            +          Creates an entity ID factory for the row key format given by the specified + table layout.
            +static EntityIdFactoryEntityIdFactory.getFactory(RowKeyFormat format) + +
            +          Creates an entity ID factory for the specified row key format.
            +static EntityIdFactoryEntityIdFactory.getFactory(RowKeyFormat2 format) + +
            +          Creates an entity ID factory for the specified row key format.
            +  +

            + + + + + +
            +Uses of EntityIdFactory in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type EntityIdFactory
            +static EntityIdToolUtils.parseJsonFormattedKeySpec(String json, + RowKeyFormat2 format, + EntityIdFactory factory) + +
            +          Parses a JSON formatted row key specification.
            +static EntityIdToolUtils.parseKijiRowKey(String rowKeySpec, + EntityIdFactory factory, + KijiTableLayout layout) + +
            +          Parses a Kiji row key specification from a command-line flag.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/GenericCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/GenericCellDecoderFactory.html new file mode 100644 index 00000000..3b4814dd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/GenericCellDecoderFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.GenericCellDecoderFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.GenericCellDecoderFactory

            +
            +No usage of org.kiji.schema.GenericCellDecoderFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/IncompatibleKijiVersionException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/IncompatibleKijiVersionException.html new file mode 100644 index 00000000..ab3d3257 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/IncompatibleKijiVersionException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.IncompatibleKijiVersionException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.IncompatibleKijiVersionException

            +
            +No usage of org.kiji.schema.IncompatibleKijiVersionException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/InternalKijiError.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/InternalKijiError.html new file mode 100644 index 00000000..09ee2ad2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/InternalKijiError.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.InternalKijiError (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.InternalKijiError

            +
            +No usage of org.kiji.schema.InternalKijiError +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KConstants.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KConstants.html new file mode 100644 index 00000000..eca90206 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KConstants.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KConstants (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KConstants

            +
            +No usage of org.kiji.schema.KConstants +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/Kiji.Factory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/Kiji.Factory.html new file mode 100644 index 00000000..0b563da3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/Kiji.Factory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.Kiji.Factory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.Kiji.Factory

            +
            +No usage of org.kiji.schema.Kiji.Factory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/Kiji.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/Kiji.html new file mode 100644 index 00000000..64a2cb0e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/Kiji.html @@ -0,0 +1,403 @@ + + + + + + + +Uses of Interface org.kiji.schema.Kiji (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.Kiji

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use Kiji
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return Kiji
            + KijiKijiTable.getKiji() + +
            +           
            + KijiKijiFactory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            +static KijiKiji.Factory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + KijiKijiFactory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +static KijiKiji.Factory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type Kiji
            KijiTablePool(Kiji kiji) + +
            +          Constructs a new pool of Kiji tables.
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement Kiji
            + classHBaseKiji + +
            +          Kiji instance class that contains configuration and table + information.
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return Kiji
            + KijiAbstractKijiTable.getKiji() + +
            +          
            + KijiHBaseKijiFactory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + KijiHBaseKijiFactory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            + KijiHBaseKiji.retain() + +
            +          Expresses interest in retaining this resource.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type Kiji
            + voidMetadataRestorer.exportMetadata(String outputFile, + Kiji kiji) + +
            +          Exports all Kiji metadata to an Avro file with the specified filename.
            + voidMetadataRestorer.restoreSchemas(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all SchemaTable entries from the metadata backup.
            + voidMetadataRestorer.restoreTables(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all tables from the metadata backup into the running Kiji instance.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type Kiji
            AbstractKijiTable(Kiji kiji, + String name) + +
            +          Creates a new KijiTable instance.
            DefaultKijiTableFactory(Kiji kiji) + +
            +          Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance.
            +  +

            + + + + + +
            +Uses of Kiji in org.kiji.schema.util
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util with parameters of type Kiji
            +static ProtocolVersionVersionInfo.getClusterDataVersion(Kiji kiji) + +
            +          Gets the version of the Kiji instance format installed on the HBase cluster.
            +static booleanVersionInfo.isKijiVersionCompatible(Kiji kiji) + +
            +          Validates that the client instance format version is compatible with the instance + format version installed on a Kiji instance.
            +static voidVersionInfo.validateVersion(Kiji kiji) + +
            +          Validates that the client instance format version is compatible with the instance + format version installed on a Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiAlreadyExistsException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiAlreadyExistsException.html new file mode 100644 index 00000000..b48b0103 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiAlreadyExistsException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiAlreadyExistsException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiAlreadyExistsException

            +
            +No usage of org.kiji.schema.KijiAlreadyExistsException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCell.CellType.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCell.CellType.html new file mode 100644 index 00000000..21b23437 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCell.CellType.html @@ -0,0 +1,198 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiCell.CellType (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiCell.CellType

            +
            + + + + + + + + + +
            +Packages that use KijiCell.CellType
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiCell.CellType in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCell.CellType
            + KijiCell.CellTypeKijiCell.getType() + +
            +           
            +static KijiCell.CellTypeKijiCell.CellType.valueOf(String name) + +
            +          Returns the enum constant of this type with the specified name.
            +static KijiCell.CellType[]KijiCell.CellType.values() + +
            +          Returns an array containing the constants of this enum type, in +the order they are declared.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCell.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCell.html new file mode 100644 index 00000000..8504d1f8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCell.html @@ -0,0 +1,392 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiCell (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiCell

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCell
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCell in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCell
            + + + + + +
            +<T> KijiCell<T>
            +            		KijiRowData.getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> KijiCell<T>
            +            		KijiRowData.getMostRecentCell(String family, + String qualifier) + +
            +          Gets the cell in the specified column with the latest timestamp.
            + KijiCell<Long>KijiIncrementer.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiCell
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		KijiRowData.getCells(String family) + +
            +          Gets all cells stored within the specified column family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		KijiRowData.getCells(String family, + String qualifier) + +
            +          Gets all cells stored within the specified column.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		KijiRowData.getMostRecentCells(String family) + +
            +          Gets the cells in the specified column family flattened to contain only the cells with + the latest timestamp in each column.
            +  +

            + + + + + +
            +Uses of KijiCell in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCell
            + + + + + +
            +<T> KijiCell<T>
            +            		HBaseKijiRowData.getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> KijiCell<T>
            +            		HBaseKijiRowData.getMostRecentCell(String family, + String qualifier) + +
            +          Gets the cell in the specified column with the latest timestamp.
            + KijiCell<Long>HBaseKijiTableWriter.increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KijiCell
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		HBaseKijiRowData.getCells(String family) + +
            +          Gets all cells stored within the specified column family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		HBaseKijiRowData.getCells(String family, + String qualifier) + +
            +          Gets all cells stored within the specified column.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		HBaseKijiRowData.getMostRecentCells(String family) + +
            +          Gets the cells in the specified column family flattened to contain only the cells with + the latest timestamp in each column.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellDecoder.html new file mode 100644 index 00000000..7054813a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellDecoder.html @@ -0,0 +1,257 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellDecoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellDecoder

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCellDecoder
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellDecoder in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCellDecoder
            + KijiCellDecoder<?>GenericCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + KijiCellDecoder<?>SpecificCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + + + + + +
            +<T> KijiCellDecoder<T>
            +            		KijiCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +  +

            + + + + + +
            +Uses of KijiCellDecoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCellDecoder
            + classAvroCellDecoder<T> + +
            +          Base class for decoders that read Kiji cells encoded using Avro.
            + classCounterCellDecoder + +
            +          Cell decoder for counters.
            + classGenericCellDecoder<T> + +
            +          Decodes cells encoded using Avro into generic types.
            + classSpecificCellDecoder<T> + +
            +          Decodes cells encoded using Avro into specific types.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellDecoderFactory.html new file mode 100644 index 00000000..e4932770 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellDecoderFactory.html @@ -0,0 +1,287 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellDecoderFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellDecoderFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCellDecoderFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellDecoderFactory in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema that implement KijiCellDecoderFactory
            + classGenericCellDecoderFactory + +
            +          Factory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas.
            + classSpecificCellDecoderFactory + +
            +          Factory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCellDecoderFactory
            +static KijiCellDecoderFactoryGenericCellDecoderFactory.get() + +
            +           
            +static KijiCellDecoderFactorySpecificCellDecoderFactory.get() + +
            +           
            +  +

            + + + + + +
            +Uses of KijiCellDecoderFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCellDecoderFactory
            + KijiCellDecoderFactoryHBaseKijiRowScanner.Options.getCellDecoderFactory() + +
            +          Gets the cell decoder factory.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiCellDecoderFactory
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory) + +
            +          Sets the cell decoder factory to use when reading cells from the scanner.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiCellDecoderFactory
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellEncoder.html new file mode 100644 index 00000000..552f1cb0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellEncoder.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellEncoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellEncoder

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiCellEncoder
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellEncoder in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiCellEncoder
            + KijiCellEncoderKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            + + + + + +
            +Uses of KijiCellEncoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCellEncoder
            + classAvroCellEncoder + +
            +          Serializes a KijiCell.
            + classCounterCellEncoder + +
            +          Encoder for Kiji counters.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiCellEncoder
            + KijiCellEncoderDefaultKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellEncoderFactory.html new file mode 100644 index 00000000..e4688dca --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiCellEncoderFactory.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiCellEncoderFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiCellEncoderFactory

            +
            + + + + + + + + + +
            +Packages that use KijiCellEncoderFactory
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiCellEncoderFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiCellEncoderFactory
            + classDefaultKijiCellEncoderFactory + +
            +          Factory for cell encoders.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiColumnName.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiColumnName.html new file mode 100644 index 00000000..bf6199db --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiColumnName.html @@ -0,0 +1,467 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiColumnName (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiColumnName

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiColumnName
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiColumnName in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiColumnName
            + KijiColumnNameKijiDataRequest.Column.getColumnName() + +
            +          Gets the column name.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiColumnName
            + com.google.common.collect.ImmutableList<KijiColumnName>KijiURI.getColumns() + +
            +           
            + Collection<KijiColumnName>KijiURI.getColumnsOrdered() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiColumnName
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.ColumnsDef.add(KijiColumnName column) + +
            +          Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object.
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.addColumnName(KijiColumnName columnName) + +
            +          Adds the column name to the Kiji URI column names.
            + intKijiColumnName.compareTo(KijiColumnName o) + +
            +          
            +  +

            + + + + + + + + + + + + + +
            Method parameters in org.kiji.schema with type arguments of type KijiColumnName
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.addColumnNames(Collection<KijiColumnName> columnNames) + +
            +          Adds the column names to the Kiji URI column names.
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.withColumnNames(Iterable<KijiColumnName> columnNames) + +
            +          Configures the KijiURI with the Kiji column names.
            +  +

            + + + + + +
            +Uses of KijiColumnName in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiColumnName
            +abstract  byte[]KijiRowFilter.Context.getHBaseCellValue(KijiColumnName column, + DecodedCell<?> kijiCell) + +
            +          Converts a Kiji cell value into an HBase cell value.
            + HBaseColumnNameKijiColumnFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +abstract  HBaseColumnNameKijiRowFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            +abstract  FilterKijiColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            + FilterRegexQualifierColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            + FilterKijiPaginationFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +           
            +  +

            + + + + + +
            +Uses of KijiColumnName in org.kiji.schema.impl
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiColumnName
            HBaseKijiPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HBaseKijiTable table, + KijiColumnName colName) + +
            +          Initializes a HBaseKijiPager.
            +  +

            + + + + + +
            +Uses of KijiColumnName in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiColumnName
            + KijiColumnNameColumnNameTranslator.toKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiColumnName
            + Set<KijiColumnName>KijiTableLayout.getColumnNames() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type KijiColumnName
            + booleanKijiTableLayout.exists(KijiColumnName column) + +
            +          Reports whether a column exists.
            + SchemaStorageKijiTableLayout.getCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            + CellSchemaKijiTableLayout.getCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            + CellSpecKijiTableLayout.getCellSpec(KijiColumnName column) + +
            +           
            + org.apache.avro.SchemaKijiTableLayout.getSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            + HBaseColumnNameColumnNameTranslator.toHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequest.Column.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequest.Column.html new file mode 100644 index 00000000..f19516cf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequest.Column.html @@ -0,0 +1,216 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequest.Column (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequest.Column

            +
            + + + + + + + + + +
            +Packages that use KijiDataRequest.Column
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiDataRequest.Column in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiDataRequest.Column
            + KijiDataRequest.ColumnKijiDataRequest.getColumn(String family, + String qualifier) + +
            +          Gets a Column requested named "family:key", or + null if none exists.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiDataRequest.Column
            + Collection<KijiDataRequest.Column>KijiDataRequest.getColumns() + +
            +          Gets the collection of requested columns.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiDataRequest.Column
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.newColumnsDef(KijiDataRequest.Column existingColumn) + +
            +          Return a builder for columns, initialized from an existing + KijiDataRequest.Column.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequest.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequest.html new file mode 100644 index 00000000..70e78d8c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequest.html @@ -0,0 +1,520 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequest (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequest

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiDataRequest
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji MapReduce utilities. 
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiDataRequest
            + KijiDataRequestKijiDataRequestBuilder.build() + +
            +          Construct a new KijiDataRequest based on the configuration specified in this builder + and its associated column builders.
            +static KijiDataRequestKijiDataRequest.create(String family) + +
            +          Factory method for a simple KijiDataRequest for the most recent version + of each qualifier in one column family.
            +static KijiDataRequestKijiDataRequest.create(String family, + String qualifier) + +
            +          Factory method for a simple KijiDataRequest for the most recent + version of a specific family:qualifier.
            + KijiDataRequestKijiDataRequest.merge(KijiDataRequest other) + +
            +          Creates a new data request representing the union of this data request and the + data request specified as an argument.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiDataRequest
            + List<KijiRowData>KijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + KijiRowDataKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions scannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            + KijiDataRequestKijiDataRequest.merge(KijiDataRequest other) + +
            +          Creates a new data request representing the union of this data request and the + data request specified as an argument.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiDataRequest
            KijiDataRequestValidator(KijiDataRequest dataRequest) + +
            +          Construct a validator for a data request.
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that return KijiDataRequest
            + KijiDataRequestStripValueRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            +abstract  KijiDataRequestKijiRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + KijiDataRequestColumnValueEqualsRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + KijiDataRequestHasColumnDataRowFilter.getDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiDataRequest
            + KijiDataRequestHBaseKijiRowScanner.Options.getDataRequest() + +
            +          Gets the data request.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiDataRequest
            + List<KijiRowData>HBaseKijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + KijiRowDataHBaseKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions kijiScannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withDataRequest(KijiDataRequest dataRequest) + +
            +          Sets the data request used to generate the KijiRowScanner.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiDataRequest
            HBaseDataRequestAdapter(KijiDataRequest kijiDataRequest) + +
            +          Wraps a KijiDataRequest.
            HBaseKijiPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HBaseKijiTable table, + KijiColumnName colName) + +
            +          Initializes a HBaseKijiPager.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  +

            + + + + + +
            +Uses of KijiDataRequest in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.mapreduce declared as KijiDataRequest
            +protected  KijiDataRequestKijiTableInputFormat.KijiTableRecordReader.mDataRequest + +
            +          Data request.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce with parameters of type KijiDataRequest
            +static voidKijiTableInputFormat.configureJob(Job job, + KijiURI tableURI, + KijiDataRequest dataRequest, + String startRow, + String endRow) + +
            +          Deprecated. Configures a Hadoop M/R job to read from a given table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestBuilder.ColumnsDef.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestBuilder.ColumnsDef.html new file mode 100644 index 00000000..88a740b6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestBuilder.ColumnsDef.html @@ -0,0 +1,266 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequestBuilder.ColumnsDef (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequestBuilder.ColumnsDef

            +
            + + + + + + + + + +
            +Packages that use KijiDataRequestBuilder.ColumnsDef
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiDataRequestBuilder.ColumnsDef in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiDataRequestBuilder.ColumnsDef
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.ColumnsDef.add(KijiColumnName column) + +
            +          Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object.
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.ColumnsDef.add(String family, + String qualifier) + +
            +          Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object.
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.ColumnsDef.addFamily(String family) + +
            +          Adds a column to the data request, using the properties associated with this + KijiDataRequestBuilder.ColumnsDef object.
            +static KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.ColumnsDef.create() + +
            +           
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.newColumnsDef() + +
            +          Return a builder for columns associated with this KijiDataRequestBuilder.
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.newColumnsDef(KijiDataRequest.Column existingColumn) + +
            +          Return a builder for columns, initialized from an existing + KijiDataRequest.Column.
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.ColumnsDef.withFilter(KijiColumnFilter filter) + +
            +          Sets a filter to attach to each column specified by this column request builder.
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.ColumnsDef.withMaxVersions(int maxVersions) + +
            +          Sets the maximum number of the most recent versions to return.
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.ColumnsDef.withPageSize(int pageSize) + +
            +          Sets the page size (i.e.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiDataRequestBuilder.ColumnsDef
            + KijiDataRequestBuilderKijiDataRequestBuilder.addColumns(KijiDataRequestBuilder.ColumnsDef def) + +
            +          Adds another set of column definitions to this KijiDataRequest builder.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestBuilder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestBuilder.html new file mode 100644 index 00000000..4384015f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestBuilder.html @@ -0,0 +1,199 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequestBuilder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequestBuilder

            +
            + + + + + + + + + +
            +Packages that use KijiDataRequestBuilder
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiDataRequestBuilder in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiDataRequestBuilder
            + KijiDataRequestBuilderKijiDataRequestBuilder.addColumns(KijiDataRequestBuilder.ColumnsDef def) + +
            +          Adds another set of column definitions to this KijiDataRequest builder.
            +static KijiDataRequestBuilderKijiDataRequest.builder() + +
            +          Creates a new KijiDataRequestBuilder.
            + KijiDataRequestBuilderKijiDataRequestBuilder.withTimeRange(long minTimestamp, + long maxTimestamp) + +
            +          Sets the time range of cells to return: [minTimestamp, + maxTimestamp).
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestException.html new file mode 100644 index 00000000..ca1e8bd4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequestException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequestException

            +
            +No usage of org.kiji.schema.KijiDataRequestException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestValidator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestValidator.html new file mode 100644 index 00000000..0528811e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDataRequestValidator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiDataRequestValidator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiDataRequestValidator

            +
            +No usage of org.kiji.schema.KijiDataRequestValidator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDeleter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDeleter.html new file mode 100644 index 00000000..4fb3a001 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiDeleter.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiDeleter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiDeleter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiDeleter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiDeleter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiDeleter in org.kiji.schema
            + interfaceKijiTableWriter + +
            +           + Interface for modifying a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiDeleter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiDeleter
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiEncodingException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiEncodingException.html new file mode 100644 index 00000000..afdae57e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiEncodingException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiEncodingException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiEncodingException

            +
            +No usage of org.kiji.schema.KijiEncodingException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiFactory.html new file mode 100644 index 00000000..2f88ffc7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiFactory.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiFactory
            +static KijiFactoryKiji.Factory.get() + +
            +           
            +  +

            + + + + + +
            +Uses of KijiFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiFactory
            + classHBaseKijiFactory + +
            +          Factory for constructing instances of HBaseKiji.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiIncrementer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiIncrementer.html new file mode 100644 index 00000000..d5bbef7a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiIncrementer.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiIncrementer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiIncrementer

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiIncrementer
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiIncrementer in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiIncrementer in org.kiji.schema
            + interfaceKijiTableWriter + +
            +           + Interface for modifying a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiIncrementer in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiIncrementer
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiInstaller.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiInstaller.html new file mode 100644 index 00000000..dbe2550a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiInstaller.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiInstaller (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiInstaller

            +
            + + + + + + + + + +
            +Packages that use KijiInstaller
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiInstaller in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiInstaller
            +static KijiInstallerKijiInstaller.get() + +
            +          Gets an instance of a KijiInstaller.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiInvalidNameException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiInvalidNameException.html new file mode 100644 index 00000000..eea2a53d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiInvalidNameException.html @@ -0,0 +1,258 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiInvalidNameException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiInvalidNameException

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiInvalidNameException
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of KijiInvalidNameException in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that throw KijiInvalidNameException
            + voidKijiInstaller.install(KijiURI uri, + Configuration conf) + +
            +          Installs the specified Kiji instance.
            + voidKijiInstaller.install(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            + voidKijiInstaller.uninstall(KijiURI uri, + Configuration conf) + +
            +          Uninstalls the specified Kiji instance.
            + voidKijiInstaller.uninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  +

            + + + + + +
            +Uses of KijiInvalidNameException in org.kiji.schema.util
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util that throw KijiInvalidNameException
            +static voidKijiNameValidator.validateAlias(CharSequence name) + +
            +          Validates characters that may be used in an alias for a qualifier, family, or + locality group.
            +static voidKijiNameValidator.validateKijiName(CharSequence name) + +
            +          Determines whether a string is a valid Kiji instance name.
            +static voidKijiNameValidator.validateLayoutName(CharSequence name) + +
            +          Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiMetaTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiMetaTable.html new file mode 100644 index 00000000..dce5cd25 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiMetaTable.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiMetaTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiMetaTable

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiMetaTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiMetaTable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiMetaTable
            + KijiMetaTableKiji.getMetaTable() + +
            +          Gets the meta table for this Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiMetaTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiMetaTable in org.kiji.schema.impl
            + classHBaseMetaTable + +
            +          An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiMetaTable
            + KijiMetaTableHBaseKiji.getMetaTable() + +
            +          Gets the meta table for this Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiNotInstalledException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiNotInstalledException.html new file mode 100644 index 00000000..ca6dfb5b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiNotInstalledException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiNotInstalledException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiNotInstalledException

            +
            +No usage of org.kiji.schema.KijiNotInstalledException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiPager.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiPager.html new file mode 100644 index 00000000..a764913f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiPager.html @@ -0,0 +1,244 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiPager (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiPager

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiPager
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiPager in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiPager
            + KijiPagerKijiRowData.getPager(String family) + +
            +          Gets a KijiPager for the specified column family.
            + KijiPagerKijiRowData.getPager(String family, + String qualifier) + +
            +          Gets a KijiPager for the specified column.
            +  +

            + + + + + +
            +Uses of KijiPager in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiPager
            + classHBaseKijiPager + +
            +          Implementation of a KijiPager for HBase.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiPager
            + KijiPagerHBaseKijiRowData.getPager(String family) + +
            +          Gets a KijiPager for the specified column family.
            + KijiPagerHBaseKijiRowData.getPager(String family, + String qualifier) + +
            +          Gets a KijiPager for the specified column.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiPutter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiPutter.html new file mode 100644 index 00000000..f05e7638 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiPutter.html @@ -0,0 +1,211 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiPutter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiPutter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiPutter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiPutter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiPutter in org.kiji.schema
            + interfaceKijiTableWriter + +
            +           + Interface for modifying a Kiji table.
            +  +

            + + + + + +
            +Uses of KijiPutter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiPutter
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRegion.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRegion.html new file mode 100644 index 00000000..547470dd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRegion.html @@ -0,0 +1,210 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiRegion (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiRegion

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiRegion
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiRegion in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiRegion
            + List<KijiRegion>KijiTable.getRegions() + +
            +          Return the regions in this table as an ordered list.
            +  +

            + + + + + +
            +Uses of KijiRegion in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KijiRegion
            + List<KijiRegion>HBaseKijiTable.getRegions() + +
            +          Return the regions in this table as a list.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRowData.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRowData.html new file mode 100644 index 00000000..04b21819 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRowData.html @@ -0,0 +1,332 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiRowData (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiRowData

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiRowData
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji MapReduce utilities. 
            +  +

            + + + + + +
            +Uses of KijiRowData in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiRowData
            + KijiRowDataKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowDataKijiPager.next(int pageSize) + +
            +          Gets the next page of results, with specified page size, for a column or family.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return types with arguments of type KijiRowData
            + List<KijiRowData>KijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + +
            +Uses of KijiRowData in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiRowData
            + classHBaseKijiRowData + +
            +          An implementation of KijiRowData that wraps an HBase Result object.
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiRowData
            + KijiRowDataHBaseKijiTableReader.get(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowDataHBaseKijiPager.next() + +
            +          
            + KijiRowDataHBaseKijiPager.next(int pageSize) + +
            +          Gets the next page of results, with specified page size, for a column or family.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KijiRowData
            + List<KijiRowData>HBaseKijiTableReader.bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            +  +

            + + + + + +
            +Uses of KijiRowData in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return KijiRowData
            + KijiRowDataKijiTableInputFormat.KijiTableRecordReader.getCurrentValue() + +
            +          
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce that return types with arguments of type KijiRowData
            + RecordReader<EntityId,KijiRowData>KijiTableInputFormat.createRecordReader(InputSplit split, + TaskAttemptContext context) + +
            +          Deprecated. 
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRowKeySplitter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRowKeySplitter.html new file mode 100644 index 00000000..6000fe34 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRowKeySplitter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiRowKeySplitter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiRowKeySplitter

            +
            +No usage of org.kiji.schema.KijiRowKeySplitter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRowScanner.html new file mode 100644 index 00000000..490f5509 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiRowScanner.html @@ -0,0 +1,244 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiRowScanner (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiRowScanner

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiRowScanner
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiRowScanner in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiRowScanner
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions scannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  +

            + + + + + +
            +Uses of KijiRowScanner in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiRowScanner
            + classHBaseKijiRowScanner + +
            +          The internal implementation of KijiRowScanner that reads from HTables.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiRowScanner
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions kijiScannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html new file mode 100644 index 00000000..4decf577 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiSchemaTable.SchemaEntry.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiSchemaTable.SchemaEntry (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiSchemaTable.SchemaEntry

            +
            + + + + + + + + + +
            +Packages that use KijiSchemaTable.SchemaEntry
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiSchemaTable.SchemaEntry in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiSchemaTable.SchemaEntry
            +static KijiSchemaTable.SchemaEntryHBaseSchemaTable.fromAvroEntry(SchemaTableEntry avroEntry) + +
            +          Converts an Avro SchemaTableEntry into a SchemaEntry.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiSchemaTable.SchemaEntry
            +static SchemaTableEntryHBaseSchemaTable.toAvroEntry(KijiSchemaTable.SchemaEntry entry) + +
            +          Converts a SchemaEntry into an Avro SchemaTableEntry.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiSchemaTable.html new file mode 100644 index 00000000..575640e4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiSchemaTable.html @@ -0,0 +1,381 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiSchemaTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiSchemaTable

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiSchemaTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiSchemaTable
            + KijiSchemaTableKiji.getSchemaTable() + +
            +          Gets the schema table for this Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema.filter
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiSchemaTable
            +static KijiRowFilterApplicatorKijiRowFilterApplicator.create(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiSchemaTable in org.kiji.schema.impl
            + classHBaseSchemaTable + +
            +           + Mapping between schema IDs, hashes and Avro schema objects.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiSchemaTable
            + KijiSchemaTableHBaseKiji.getSchemaTable() + +
            +          Gets the schema table for this Kiji instance.
            + KijiSchemaTableHBaseKijiRowData.getSchemaTable() + +
            +          Gets the schema table this kiji row data uses for decoding.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiSchemaTable
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseMetaTable(HTableInterface htable, + KijiSchemaTable schemaTable) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseMetaTable(KijiURI kijiURI, + Configuration conf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  +

            + + + + + +
            +Uses of KijiSchemaTable in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return KijiSchemaTable
            + KijiSchemaTableCellSpec.getSchemaTable() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type KijiSchemaTable
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            + CellSpecCellSpec.setSchemaTable(KijiSchemaTable schemaTable) + +
            +          Sets the schema table.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.layout.impl with parameters of type KijiSchemaTable
            HBaseTableLayoutDatabase(HTableInterface htable, + String family, + KijiSchemaTable schemaTable) + +
            +          Creates a new HBaseTableLayoutDatabase instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiSystemTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiSystemTable.html new file mode 100644 index 00000000..c1b23dc8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiSystemTable.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiSystemTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiSystemTable

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiSystemTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiSystemTable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiSystemTable
            + KijiSystemTableKiji.getSystemTable() + +
            +          Gets the system table for this Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiSystemTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of KijiSystemTable in org.kiji.schema.impl
            + classHBaseSystemTable + +
            +          The Kiji system table that is stored in HBase.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiSystemTable
            + KijiSystemTableHBaseKiji.getSystemTable() + +
            +          Gets the system table for this Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTable.html new file mode 100644 index 00000000..793ac486 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTable.html @@ -0,0 +1,297 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTable

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTable in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTable
            + KijiTableKijiTablePool.get(String name) + +
            +          Gets a previously opened table from the pool, or open a new connection.
            + KijiTableKijiTableFactory.openTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiTable
            + voidKijiTablePool.release(KijiTable table) + +
            +          Releases a table back to the pool.
            +  +

            + + + + + +
            +Uses of KijiTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTable
            + classAbstractKijiTable + +
            +          Main handle for a Kiji table with basic functionality.
            + classHBaseKijiTable + +
            +          A KijiTable that exposes the underlying HBase implementation.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTable
            + KijiTableHBaseKiji.openTable(String tableName) + +
            +          Opens a KijiTable by name.
            + KijiTableDefaultKijiTableFactory.openTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiTable
            +static HBaseKijiTableHBaseKijiTable.downcast(KijiTable kijiTable) + +
            +          We know that all KijiTables are really HBaseKijiTables + instances.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTable
            HBaseKijiTableWriter(KijiTable table) + +
            +          Creates a non-buffered kiji table writer that sends modifications directly to Kiji.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableFactory.html new file mode 100644 index 00000000..9dbd9f0e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableFactory.html @@ -0,0 +1,241 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableFactory in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of KijiTableFactory in org.kiji.schema
            + interfaceKiji + +
            +          Provides a handle to a Kiji instance that contains table information and access to + Kiji administrative functionality.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiTableFactory
            KijiTablePool(KijiTableFactory tableFactory) + +
            +          Constructs a new pool of Kiji tables.
            KijiTablePool(KijiTableFactory tableFactory, + KijiTablePool.Options options) + +
            +          Constructs a new pool of Kiji tables.
            +  +

            + + + + + +
            +Uses of KijiTableFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableFactory
            + classDefaultKijiTableFactory + +
            +          The default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open().
            + classHBaseKiji + +
            +          Kiji instance class that contains configuration and table + information.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html new file mode 100644 index 00000000..c9a326f5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableKeyValueDatabase.html @@ -0,0 +1,288 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableKeyValueDatabase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableKeyValueDatabase

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableKeyValueDatabase
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableKeyValueDatabase in org.kiji.schema
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema that implement KijiTableKeyValueDatabase
            + classKijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableKeyValueDatabase
            + KijiTableKeyValueDatabaseKijiTableKeyValueDatabase.putValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            +  +

            + + + + + +
            +Uses of KijiTableKeyValueDatabase in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableKeyValueDatabase
            + classHBaseMetaTable + +
            +          An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            + classHBaseTableKeyValueDatabase + +
            +          Manages key-value pairs on a per table basis.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableKeyValueDatabase
            + KijiTableKeyValueDatabaseHBaseMetaTable.putValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + KijiTableKeyValueDatabaseHBaseTableKeyValueDatabase.putValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTableKeyValueDatabase
            HBaseMetaTable(HTableInterface htable, + KijiTableLayoutDatabase tableLayoutDatabase, + KijiTableKeyValueDatabase tableKeyValueDatabase) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableNotFoundException.html new file mode 100644 index 00000000..7e9aea0f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableNotFoundException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTableNotFoundException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTableNotFoundException

            +
            +No usage of org.kiji.schema.KijiTableNotFoundException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html new file mode 100644 index 00000000..2fccd353 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTablePool.NoCapacityException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTablePool.NoCapacityException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTablePool.NoCapacityException

            +
            +No usage of org.kiji.schema.KijiTablePool.NoCapacityException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTablePool.Options.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTablePool.Options.html new file mode 100644 index 00000000..6cffd3bb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTablePool.Options.html @@ -0,0 +1,228 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTablePool.Options (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTablePool.Options

            +
            + + + + + + + + + +
            +Packages that use KijiTablePool.Options
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiTablePool.Options in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTablePool.Options
            + KijiTablePool.OptionsKijiTablePool.Options.withClock(Clock clock) + +
            +          Sets a clock.
            + KijiTablePool.OptionsKijiTablePool.Options.withIdlePollPeriod(long periodMillis) + +
            +          Sets the amount of time between sweeps of the pool for removing idle connections.
            + KijiTablePool.OptionsKijiTablePool.Options.withIdleTimeout(long timeoutMillis) + +
            +          Sets the amount of time a connection may be idle before being removed from the pool.
            + KijiTablePool.OptionsKijiTablePool.Options.withMaxSize(int maxSize) + +
            +          Sets the maximum number of connections to keep per table.
            + KijiTablePool.OptionsKijiTablePool.Options.withMinSize(int minSize) + +
            +          Sets the minimum number of connections to keep per table.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiTablePool.Options
            KijiTablePool(KijiTableFactory tableFactory, + KijiTablePool.Options options) + +
            +          Constructs a new pool of Kiji tables.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTablePool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTablePool.html new file mode 100644 index 00000000..875e4952 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTablePool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTablePool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTablePool

            +
            +No usage of org.kiji.schema.KijiTablePool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableReader.KijiScannerOptions.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableReader.KijiScannerOptions.html new file mode 100644 index 00000000..d733e372 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableReader.KijiScannerOptions.html @@ -0,0 +1,255 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiTableReader.KijiScannerOptions (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiTableReader.KijiScannerOptions

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableReader.KijiScannerOptions
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableReader.KijiScannerOptions in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableReader.KijiScannerOptions
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setHBaseScanOptions(HBaseScanOptions hBaseScanOptions) + +
            +          Sets the HBaseScanOptions used by a HBase backed scanner.
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setKijiRowFilter(KijiRowFilter rowFilter) + +
            +          Sets the row filter used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setStartRow(EntityId startRow) + +
            +          Sets the start row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setStopRow(EntityId stopRow) + +
            +          Sets the stop row used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiTableReader.KijiScannerOptions
            + KijiRowScannerKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions scannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  +

            + + + + + +
            +Uses of KijiTableReader.KijiScannerOptions in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiTableReader.KijiScannerOptions
            + KijiRowScannerHBaseKijiTableReader.getScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions kijiScannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableReader.html new file mode 100644 index 00000000..a310047e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableReader.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableReader (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableReader

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableReader
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableReader in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableReader
            + KijiTableReaderKijiTable.openTableReader() + +
            +          Opens a KijiTableReader for this table.
            +  +

            + + + + + +
            +Uses of KijiTableReader in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableReader
            + classHBaseKijiTableReader + +
            +          Reads from a kiji table by sending the requests directly to the HBase tables.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableReader
            + KijiTableReaderHBaseKijiTable.openTableReader() + +
            +          Opens a KijiTableReader for this table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableWriter.html new file mode 100644 index 00000000..325001fd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiTableWriter.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Interface org.kiji.schema.KijiTableWriter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.KijiTableWriter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiTableWriter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiTableWriter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableWriter
            + KijiTableWriterKijiTable.openTableWriter() + +
            +          Opens a KijiTableWriter for this table.
            +  +

            + + + + + +
            +Uses of KijiTableWriter in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableWriter
            + classHBaseKijiTableWriter + +
            +          Makes modifications to a Kiji table by sending requests directly to HBase from the local client.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableWriter
            + KijiTableWriterHBaseKijiTable.openTableWriter() + +
            +          Opens a KijiTableWriter for this table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiURI.KijiURIBuilder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiURI.KijiURIBuilder.html new file mode 100644 index 00000000..1a6a351c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiURI.KijiURIBuilder.html @@ -0,0 +1,261 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiURI.KijiURIBuilder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiURI.KijiURIBuilder

            +
            + + + + + + + + + +
            +Packages that use KijiURI.KijiURIBuilder
            org.kiji.schemaThe main package for users of KijiSchema. 
            +  +

            + + + + + +
            +Uses of KijiURI.KijiURIBuilder in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiURI.KijiURIBuilder
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.addColumnName(KijiColumnName columnName) + +
            +          Adds the column name to the Kiji URI column names.
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.addColumnNames(Collection<KijiColumnName> columnNames) + +
            +          Adds the column names to the Kiji URI column names.
            +static KijiURI.KijiURIBuilderKijiURI.newBuilder() + +
            +          Gets a builder configured with default Kiji URI fields.
            +static KijiURI.KijiURIBuilderKijiURI.newBuilder(KijiURI uri) + +
            +          Gets a builder configured with a Kiji URI.
            +static KijiURI.KijiURIBuilderKijiURI.newBuilder(String uri) + +
            +          Gets a builder configured with the Kiji URI.
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.withColumnNames(Collection<String> columnNames) + +
            +          Configures the KijiURI with the Kiji column names.
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.withColumnNames(Iterable<KijiColumnName> columnNames) + +
            +          Configures the KijiURI with the Kiji column names.
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.withInstanceName(String instanceName) + +
            +          Configures the KijiURI with the Kiji instance name.
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.withTableName(String tableName) + +
            +          Configures the KijiURI with the Kiji table name.
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.withZookeeperClientPort(int zookeeperClientPort) + +
            +          Configures the KijiURI with the Zookeeper client port.
            + KijiURI.KijiURIBuilderKijiURI.KijiURIBuilder.withZookeeperQuorum(String[] zookeeperQuorum) + +
            +          Configures the KijiURI with Zookeeper Quorum.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiURI.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiURI.html new file mode 100644 index 00000000..42f9fb60 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiURI.html @@ -0,0 +1,693 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiURI (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiURI

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiURI
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.mapreduceKiji MapReduce utilities. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiURI
            + KijiURIKijiURI.KijiURIBuilder.build() + +
            +          Builds the configured KijiURI.
            + KijiURIKijiAlreadyExistsException.getURI() + +
            +           
            + KijiURIKiji.getURI() + +
            +           
            + KijiURIKijiTable.getURI() + +
            +           
            + KijiURIKijiURI.resolve(String path) + +
            +          Resolve the path relative to this KijiURI.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiURI
            + voidKijiInstaller.install(KijiURI uri, + Configuration conf) + +
            +          Installs the specified Kiji instance.
            + voidKijiInstaller.install(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            +static KijiURI.KijiURIBuilderKijiURI.newBuilder(KijiURI uri) + +
            +          Gets a builder configured with a Kiji URI.
            + KijiKijiFactory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            +static KijiKiji.Factory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + KijiKijiFactory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +static KijiKiji.Factory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            + voidKijiInstaller.uninstall(KijiURI uri, + Configuration conf) + +
            +          Uninstalls the specified Kiji instance.
            + voidKijiInstaller.uninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type KijiURI
            KijiAlreadyExistsException(String message, + KijiURI uri) + +
            +          Initializes a new exception object.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.hbase
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.hbase with parameters of type KijiURI
            + HBaseAdminFactoryHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactoryHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactoryHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiURI
            + KijiURIHBaseKiji.getURI() + +
            +          
            + KijiURIAbstractKijiTable.getURI() + +
            +          
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiURI
            + HBaseAdminFactoryDefaultHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactoryDefaultHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactoryDefaultHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +static voidHBaseMetaTable.install(HBaseAdmin admin, + KijiURI uri) + +
            +          Install the meta table into a Kiji instance.
            +static voidHBaseSystemTable.install(HBaseAdmin admin, + KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Installs a Kiji system table into a running HBase instance.
            +static voidHBaseSchemaTable.install(HBaseAdmin admin, + KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static LockHBaseSchemaTable.newLock(KijiURI kijiURI, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +static HTableInterfaceHBaseMetaTable.newMetaTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTableInterface for the specified table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaHashTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema hash table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaIdTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema ID table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaV5Table(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema V5 table.
            +static HTableInterfaceHBaseSystemTable.newSystemTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates a new HTableInterface for the Kiji system table.
            + KijiHBaseKijiFactory.open(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + KijiHBaseKijiFactory.open(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +static voidHBaseSystemTable.uninstall(HBaseAdmin admin, + KijiURI kijiURI) + +
            +          Disables and delete the system table from HBase.
            +static voidHBaseMetaTable.uninstall(HBaseAdmin admin, + KijiURI uri) + +
            +          Removes the meta table from HBase.
            +static voidHBaseSchemaTable.uninstall(HBaseAdmin admin, + KijiURI kijiURI) + +
            +          Disables and removes the schema table from HBase.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiURI
            HBaseMetaTable(KijiURI kijiURI, + Configuration conf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseSchemaTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            HBaseSystemTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Connect to the HBase system table inside a Kiji instance.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.mapreduce
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.mapreduce with parameters of type KijiURI
            +static voidKijiTableInputFormat.configureJob(Job job, + KijiURI tableURI, + KijiDataRequest dataRequest, + String startRow, + String endRow) + +
            +          Deprecated. Configures a Hadoop M/R job to read from a given table.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type KijiURI
            +protected static Set<String>LsTool.getInstanceNames(KijiURI hbaseURI) + +
            +          Returns a set of instance names.
            +  +

            + + + + + +
            +Uses of KijiURI in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.util with parameters of type KijiURI
            +static StringZooKeeperLockFactory.zkConnStr(KijiURI uri) + +
            +          Creates a ZooKeeper connection string from a Kiji URI specifying an HBase instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiURIException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiURIException.html new file mode 100644 index 00000000..d1712cf5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/KijiURIException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.KijiURIException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.KijiURIException

            +
            +No usage of org.kiji.schema.KijiURIException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/NoCellDataException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/NoCellDataException.html new file mode 100644 index 00000000..40c12284 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/NoCellDataException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.NoCellDataException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.NoCellDataException

            +
            +No usage of org.kiji.schema.NoCellDataException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/NoSuchColumnException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/NoSuchColumnException.html new file mode 100644 index 00000000..7bce2ab8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/NoSuchColumnException.html @@ -0,0 +1,250 @@ + + + + + + + +Uses of Class org.kiji.schema.NoSuchColumnException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.NoSuchColumnException

            +
            + + + + + + + + + + + + + +
            +Packages that use NoSuchColumnException
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of NoSuchColumnException in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that throw NoSuchColumnException
            + HBaseColumnNameKijiColumnFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +abstract  HBaseColumnNameKijiRowFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            +  +

            + + + + + +
            +Uses of NoSuchColumnException in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that throw NoSuchColumnException
            + SchemaStorageKijiTableLayout.getCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            + CellSchemaKijiTableLayout.getCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            + org.apache.avro.SchemaKijiTableLayout.getSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            + HBaseColumnNameColumnNameTranslator.toHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            + KijiColumnNameColumnNameTranslator.toKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/NotAKijiManagedTableException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/NotAKijiManagedTableException.html new file mode 100644 index 00000000..b60fbef6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/NotAKijiManagedTableException.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.NotAKijiManagedTableException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.NotAKijiManagedTableException

            +
            + + + + + + + + + +
            +Packages that use NotAKijiManagedTableException
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            +  +

            + + + + + +
            +Uses of NotAKijiManagedTableException in org.kiji.schema.hbase
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.hbase that throw NotAKijiManagedTableException
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.get(String hbaseTableName) + +
            +          Constructs using an HBase HTable name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/SpecificCellDecoderFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/SpecificCellDecoderFactory.html new file mode 100644 index 00000000..346b4580 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/SpecificCellDecoderFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.SpecificCellDecoderFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.SpecificCellDecoderFactory

            +
            +No usage of org.kiji.schema.SpecificCellDecoderFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/TableKeyNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/TableKeyNotFoundException.html new file mode 100644 index 00000000..a2a78325 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/class-use/TableKeyNotFoundException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.TableKeyNotFoundException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.TableKeyNotFoundException

            +
            +No usage of org.kiji.schema.TableKeyNotFoundException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/AndRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/AndRowFilter.html new file mode 100644 index 00000000..bf9a3e26 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/AndRowFilter.html @@ -0,0 +1,355 @@ + + + + + + + +AndRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class AndRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.AndRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class AndRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter for a conjunction (AND operator) of other filters. + +

            If a row R is accepted by both filter A and B, R + will be accepted by AndRowFilter(A, B).

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classOperatorRowFilter.Operator + +
            +          Available logical operators.
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            AndRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new AndRowFilter instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AndRowFilter

            +
            +public AndRowFilter(List<? extends KijiRowFilter> filters)
            +
            +
            Creates a new AndRowFilter instance. +

            +

            +
            Parameters:
            filters - The filters that should be used in the filter conjunction.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html new file mode 100644 index 00000000..3fd86869 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/ColumnValueEqualsRowFilter.html @@ -0,0 +1,352 @@ + + + + + + + +ColumnValueEqualsRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class ColumnValueEqualsRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.ColumnValueEqualsRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class ColumnValueEqualsRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value. + +

            This filter will only pass if the data in the Kiji cell matches the specified value + exactly. Both the data and the Avro schema must be the same.

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            ColumnValueEqualsRowFilter(String family, + String qualifier, + DecodedCell<?> value) + +
            +          Creates a new ColumnValueEqualsRowFilter instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ColumnValueEqualsRowFilter

            +
            +public ColumnValueEqualsRowFilter(String family,
+                                  String qualifier,
+                                  DecodedCell<?> value)
            +
            +
            Creates a new ColumnValueEqualsRowFilter instance. +

            +

            +
            Parameters:
            family - The column family of interest.
            qualifier - The column qualifier of interest.
            value - The value the most recent cell in the column must equal to pass the filter.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/HasColumnDataRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/HasColumnDataRowFilter.html new file mode 100644 index 00000000..d21076ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/HasColumnDataRowFilter.html @@ -0,0 +1,364 @@ + + + + + + + +HasColumnDataRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class HasColumnDataRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.HasColumnDataRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class HasColumnDataRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter that excludes rows that have no data for some column columnName. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + + + + +
            +Constructor Summary
            HasColumnDataRowFilter(String columnName) + +
            +          Constructs a row filter that excludes rows that have no data in columnName.
            HasColumnDataRowFilter(String family, + String qualifier) + +
            +          Constructs a row filter that excludes rows that have no data in columnName.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HasColumnDataRowFilter

            +
            +public HasColumnDataRowFilter(String family,
+                              String qualifier)
            +
            +
            Constructs a row filter that excludes rows that have no data in columnName. +

            +

            +
            Parameters:
            family - The column family of interest.
            qualifier - The column qualifier of interest.
            +
            +
            + +

            +HasColumnDataRowFilter

            +
            +public HasColumnDataRowFilter(String columnName)
            +
            +
            Constructs a row filter that excludes rows that have no data in columnName. +

            +

            +
            Parameters:
            columnName - The column family:qualifier of interest.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiColumnFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiColumnFilter.Context.html new file mode 100644 index 00000000..02da2a9f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiColumnFilter.Context.html @@ -0,0 +1,223 @@ + + + + + + + +KijiColumnFilter.Context (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Interface KijiColumnFilter.Context

            +
            +
            Enclosing class:
            KijiColumnFilter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public static interface KijiColumnFilter.Context
            + + +

            +An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + HBaseColumnNamegetHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseColumnName

            +
            +HBaseColumnName getHBaseColumnName(KijiColumnName kijiColumnName)
+                                   throws NoSuchColumnException
            +
            +
            Converts a Kiji column name to an HBase column name. +

            +

            +
            Parameters:
            kijiColumnName - The name of a kiji column. +
            Returns:
            The name of the HBase column that stores the kiji column data. +
            Throws: +
            NoSuchColumnException - If there is no such column in the kiji table.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiColumnFilter.html new file mode 100644 index 00000000..2786681b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiColumnFilter.html @@ -0,0 +1,305 @@ + + + + + + + +KijiColumnFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiColumnFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiColumnFilter
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Direct Known Subclasses:
            KijiPaginationFilter, RegexQualifierColumnFilter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KijiColumnFilter
            extends Object
            implements Serializable
            + + +

            +A column filter provides a means of filtering cells from a column on the server side. + +

            To make your jobs more efficient, you may use a KijiColumnFilter to specify that + certain cells from a column be filtered. The cells will be filtered on the server, + which reduces the amount of data that needs to be sent to the client.

            + +

            KijiColumnFilters filter cells from a column, in contrast with KijiRowFilters, which + filters rows from a table.

            +

            + +

            +

            +
            See Also:
            KijiRowFilter, +KijiDataRequestBuilder.ColumnsDef.withFilter(KijiColumnFilter), +Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static interfaceKijiColumnFilter.Context + +
            +          An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiColumnFilter() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            +abstract  FiltertoHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiColumnFilter

            +
            +public KijiColumnFilter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toHBaseFilter

            +
            +public abstract Filter toHBaseFilter(KijiColumnName kijiColumnName,
+                                     KijiColumnFilter.Context context)
+                              throws IOException
            +
            +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +

            +

            +
            +
            +
            +
            Parameters:
            kijiColumnName - The column this filter applies to.
            context - The context. +
            Returns:
            An equivalent HBase Filter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiPaginationFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiPaginationFilter.html new file mode 100644 index 00000000..b1f37999 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiPaginationFilter.html @@ -0,0 +1,325 @@ + + + + + + + +KijiPaginationFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiPaginationFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiColumnFilter
+      extended by org.kiji.schema.filter.KijiPaginationFilter
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Private
+public class KijiPaginationFilter
            extends KijiColumnFilter
            + + +

            +A KijiColumnFilter that allows for pagination of results given an offset, limit, and + other filters that are and-ed together. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiColumnFilter
            KijiColumnFilter.Context
            +  + + + + + + + + + + + + + + +
            +Constructor Summary
            KijiPaginationFilter(int limit, + int offset) + +
            +          Initialize pagination filter with limit, offset, and other filters to fold in.
            KijiPaginationFilter(int limit, + int offset, + KijiColumnFilter filter) + +
            +          Initialize pagination filter with limit, offset, and other filters to fold in.
            +  + + + + + + + + + + + +
            +Method Summary
            + FiltertoHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiPaginationFilter

            +
            +public KijiPaginationFilter(int limit,
+                            int offset)
            +
            +
            Initialize pagination filter with limit, offset, and other filters to fold in. +

            +

            +
            Parameters:
            limit - The max number of versions to return.
            offset - How many versions back in history to begin looking. + Write unit tests that verify these. HBase's docs are not specific
            +
            +
            + +

            +KijiPaginationFilter

            +
            +public KijiPaginationFilter(int limit,
+                            int offset,
+                            KijiColumnFilter filter)
            +
            +
            Initialize pagination filter with limit, offset, and other filters to fold in. +

            +

            +
            Parameters:
            limit - The max number of versions to return.
            offset - How many versions back in history to begin looking.
            filter - Other filter that will precede
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiColumnName kijiColumnName,
+                            KijiColumnFilter.Context context)
+                     throws IOException
            +
            +
            Description copied from class: KijiColumnFilter
            +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +

            +

            +
            Specified by:
            toHBaseFilter in class KijiColumnFilter
            +
            +
            +
            Parameters:
            kijiColumnName - The column this filter applies to.
            context - The context. +
            Returns:
            An equivalent HBase Filter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiRowFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiRowFilter.Context.html new file mode 100644 index 00000000..cfa5bafe --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiRowFilter.Context.html @@ -0,0 +1,320 @@ + + + + + + + +KijiRowFilter.Context (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiRowFilter.Context

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter.Context
+
            +
            +
            Enclosing class:
            KijiRowFilter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract static class KijiRowFilter.Context
            extends Object
            + + +

            +A helper class for converting between Kiji objects and their HBase counterparts. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiRowFilter.Context() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  byte[]getHBaseCellValue(KijiColumnName column, + DecodedCell<?> kijiCell) + +
            +          Converts a Kiji cell value into an HBase cell value.
            +abstract  HBaseColumnNamegetHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            +abstract  byte[]getHBaseRowKey(String kijiRowKey) + +
            +          Converts a Kiji row key into an HBase row key.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiRowFilter.Context

            +
            +public KijiRowFilter.Context()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseRowKey

            +
            +public abstract byte[] getHBaseRowKey(String kijiRowKey)
            +
            +
            Converts a Kiji row key into an HBase row key. + +

            This method is useful only on tables with row key hashing disabled, since hashed + row keys have no ordering or semantics beyond being an identifier.

            +

            +

            +
            Parameters:
            kijiRowKey - A kiji row key. +
            Returns:
            The corresponding HBase row key.
            +
            +
            +
            + +

            +getHBaseColumnName

            +
            +public abstract HBaseColumnName getHBaseColumnName(KijiColumnName kijiColumnName)
+                                            throws NoSuchColumnException
            +
            +
            Converts a Kiji column name to an HBase column family name. +

            +

            +
            Parameters:
            kijiColumnName - The name of a kiji column. +
            Returns:
            The name of the HBase column that stores the kiji column data. +
            Throws: +
            NoSuchColumnException - If there is no such column in the kiji table.
            +
            +
            +
            + +

            +getHBaseCellValue

            +
            +public abstract byte[] getHBaseCellValue(KijiColumnName column,
+                                         DecodedCell<?> kijiCell)
+                                  throws IOException
            +
            +
            Converts a Kiji cell value into an HBase cell value. +

            +

            +
            Parameters:
            column - Name of the column this cell belongs to.
            kijiCell - A kiji cell value. +
            Returns:
            The Kiji cell encoded as an HBase value. +
            Throws: +
            IOException - If there is an error encoding the cell value.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiRowFilter.html new file mode 100644 index 00000000..11cc0182 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiRowFilter.html @@ -0,0 +1,335 @@ + + + + + + + +KijiRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+
            +
            +
            Direct Known Subclasses:
            AndRowFilter, ColumnValueEqualsRowFilter, HasColumnDataRowFilter, OrRowFilter, StripValueRowFilter
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public abstract class KijiRowFilter
            extends Object
            + + +

            +The abstract base class for filters that exclude data from KijiRows. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiRowFilter.Context + +
            +          A helper class for converting between Kiji objects and their HBase counterparts.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiRowFilter() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +abstract  KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            +abstract  FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiRowFilter

            +
            +public KijiRowFilter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public abstract KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public abstract Filter toHBaseFilter(KijiRowFilter.Context context)
+                              throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiRowFilterApplicator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiRowFilterApplicator.html new file mode 100644 index 00000000..948c385d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/KijiRowFilterApplicator.html @@ -0,0 +1,262 @@ + + + + + + + +KijiRowFilterApplicator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class KijiRowFilterApplicator

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilterApplicator
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiRowFilterApplicator
            extends Object
            + + +

            +Applies a KijiRowFilter to various row-savvy objects. + + There are several limitations when filtering cells this way, as the filter relies on byte + comparisons, which does not play well with Avro records. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidapplyTo(Scan scan) + +
            +          Applies the row filter to an HBase scan object.
            +static KijiRowFilterApplicatorcreate(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static KijiRowFilterApplicator create(KijiRowFilter rowFilter,
+                                             KijiTableLayout tableLayout,
+                                             KijiSchemaTable schemaTable)
            +
            +
            Creates a new KijiRowFilterApplicator instance. +

            +

            +
            Parameters:
            rowFilter - The row filter to be applied.
            schemaTable - The kiji schema table.
            tableLayout - The layout of the table this filter applies to. +
            Returns:
            a new KijiRowFilterApplicator instance.
            +
            +
            +
            + +

            +applyTo

            +
            +public void applyTo(Scan scan)
+             throws IOException
            +
            +
            Applies the row filter to an HBase scan object. + +

            This will tell HBase region servers to filter rows on the server-side, so filtered + rows will not even need to get sent across the network back to the client.

            +

            +

            +
            Parameters:
            scan - An HBase scan descriptor. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/OrRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/OrRowFilter.html new file mode 100644 index 00000000..240ab0f8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/OrRowFilter.html @@ -0,0 +1,355 @@ + + + + + + + +OrRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class OrRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.OrRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class OrRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter for a disjunction (OR operator) of other filters. + +

            If a row R is accepted by filter A or B, R + will be accepted by OrRowFilter(A, B).

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classOperatorRowFilter.Operator + +
            +          Available logical operators.
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            OrRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new OrRowFilter instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +OrRowFilter

            +
            +public OrRowFilter(List<? extends KijiRowFilter> filters)
            +
            +
            Creates a new OrRowFilter instance. +

            +

            +
            Parameters:
            filters - The filters that should be used in the filter conjunction.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/RegexQualifierColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/RegexQualifierColumnFilter.html new file mode 100644 index 00000000..f2778181 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/RegexQualifierColumnFilter.html @@ -0,0 +1,300 @@ + + + + + + + +RegexQualifierColumnFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class RegexQualifierColumnFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiColumnFilter
+      extended by org.kiji.schema.filter.RegexQualifierColumnFilter
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class RegexQualifierColumnFilter
            extends KijiColumnFilter
            + + +

            +A KijiColumnFilter that only allows qualifiers that match a given regular expression. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiColumnFilter
            KijiColumnFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            RegexQualifierColumnFilter(String regularExpression) + +
            +          Constructor.
            +  + + + + + + + + + + + +
            +Method Summary
            + FiltertoHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +RegexQualifierColumnFilter

            +
            +public RegexQualifierColumnFilter(String regularExpression)
            +
            +
            Constructor. +

            +

            +
            Parameters:
            regularExpression - The regular expression for qualifiers that should be + accepted by this filter. The expression is matched against the full qualifier (as + if it implicitly starts with '^' and ends with '$'.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiColumnName kijiColumnName,
+                            KijiColumnFilter.Context context)
+                     throws IOException
            +
            +
            Expresses the KijiColumnFilter in terms an equivalent HBase Filter. +

            +

            +
            Specified by:
            toHBaseFilter in class KijiColumnFilter
            +
            +
            +
            Parameters:
            kijiColumnName - The column this filter applies to.
            context - The context. +
            Returns:
            An equivalent HBase Filter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/StripValueRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/StripValueRowFilter.html new file mode 100644 index 00000000..c8ed2a17 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/StripValueRowFilter.html @@ -0,0 +1,343 @@ + + + + + + + +StripValueRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.filter +
            +Class StripValueRowFilter

            +
            +java.lang.Object
+  extended by org.kiji.schema.filter.KijiRowFilter
+      extended by org.kiji.schema.filter.StripValueRowFilter
+
            +
            +
            +
            @ApiAudience.Public
+public final class StripValueRowFilter
            extends KijiRowFilter
            + + +

            +A KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest. This strips out + all values from all columns and is useful if you just want to retrieve timestamps. Note that + attempting to decode the data (through calls like KijiRowData.getValues()) will + result in an IOException. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.filter.KijiRowFilter
            KijiRowFilter.Context
            +  + + + + + + + + + + + +
            +Constructor Summary
            StripValueRowFilter() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiDataRequestgetDataRequest() + +
            +          Describes the data the filter requires to determine whether a row should be accepted.
            + FiltertoHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +StripValueRowFilter

            +
            +public StripValueRowFilter()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Describes the data the filter requires to determine whether a row should be accepted. +

            +

            +
            Specified by:
            getDataRequest in class KijiRowFilter
            +
            +
            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +toHBaseFilter

            +
            +public Filter toHBaseFilter(KijiRowFilter.Context context)
+                     throws IOException
            +
            +
            Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter. + +

            You must use the given context object when referencing any HBase + table coordinates or values. Using a Kiji row key, column family name, or column + qualifier name when configuring an HBase filter will result in undefined + behavior.

            + +

            For example, when constructing an HBase SingleColumnValueFilter to + inspect the "info:name" column of a Kiji table, use KijiRowFilter.Context.getHBaseColumnName(KijiColumnName) to + retrieve the HBase column family and qualifier. Here's an implementation that + filters out rows where the latest version of the 'info:name' is equal to 'Bob'. + + 

            + KijiCell<CharSequence> bobCellValue = new KijiCell<CharSequence>(
+     Schema.create(Schema.Type.STRING), "Bob");
+ HBaseColumnName hbaseColumn = context.getHBaseColumnName(
+     new KijiColumnName("info", "name"));
+ SingleColumnValueFilter filter = new SingleColumnValueFilter(
+     hbaseColumn.getFamily(),
+     hbaseColumn.getQualifier(),
+     CompareOp.NOT_EQUAL,
+     context.getHBaseCellValue(bobCellValue));
+ filter.setLatestVersionOnly(true);
+ filter.setFilterIfMissing(false);
+ return new SkipFilter(filter);
            +

            +

            +

            +
            Specified by:
            toHBaseFilter in class KijiRowFilter
            +
            +
            +
            Parameters:
            context - A helper object you can use to convert Kiji objects into their HBase + counterparts. +
            Returns:
            The HBase filter the implements the semantics of this KijiRowFilter. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/AndRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/AndRowFilter.html new file mode 100644 index 00000000..487a5898 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/AndRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.AndRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.AndRowFilter

            +
            +No usage of org.kiji.schema.filter.AndRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html new file mode 100644 index 00000000..1c622f94 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/ColumnValueEqualsRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.ColumnValueEqualsRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.ColumnValueEqualsRowFilter

            +
            +No usage of org.kiji.schema.filter.ColumnValueEqualsRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html new file mode 100644 index 00000000..0671ae77 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/HasColumnDataRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.HasColumnDataRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.HasColumnDataRowFilter

            +
            +No usage of org.kiji.schema.filter.HasColumnDataRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html new file mode 100644 index 00000000..319dddbd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiColumnFilter.Context.html @@ -0,0 +1,200 @@ + + + + + + + +Uses of Interface org.kiji.schema.filter.KijiColumnFilter.Context (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.filter.KijiColumnFilter.Context

            +
            + + + + + + + + + +
            +Packages that use KijiColumnFilter.Context
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiColumnFilter.Context in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiColumnFilter.Context
            +abstract  FilterKijiColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            + FilterRegexQualifierColumnFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +          Expresses the KijiColumnFilter in terms an equivalent HBase Filter.
            + FilterKijiPaginationFilter.toHBaseFilter(KijiColumnName kijiColumnName, + KijiColumnFilter.Context context) + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiColumnFilter.html new file mode 100644 index 00000000..423a91ec --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiColumnFilter.html @@ -0,0 +1,251 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiColumnFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiColumnFilter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiColumnFilter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiColumnFilter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiColumnFilter
            + KijiColumnFilterKijiDataRequest.Column.getFilter() + +
            +          Gets the column filter, or null if no filter was specified.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiColumnFilter
            + KijiDataRequestBuilder.ColumnsDefKijiDataRequestBuilder.ColumnsDef.withFilter(KijiColumnFilter filter) + +
            +          Sets a filter to attach to each column specified by this column request builder.
            +  +

            + + + + + +
            +Uses of KijiColumnFilter in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Subclasses of KijiColumnFilter in org.kiji.schema.filter
            + classKijiPaginationFilter + +
            +          A KijiColumnFilter that allows for pagination of results given an offset, limit, and + other filters that are and-ed together.
            + classRegexQualifierColumnFilter + +
            +          A KijiColumnFilter that only allows qualifiers that match a given regular expression.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.filter with parameters of type KijiColumnFilter
            KijiPaginationFilter(int limit, + int offset, + KijiColumnFilter filter) + +
            +          Initialize pagination filter with limit, offset, and other filters to fold in.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiPaginationFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiPaginationFilter.html new file mode 100644 index 00000000..24435287 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiPaginationFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiPaginationFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiPaginationFilter

            +
            +No usage of org.kiji.schema.filter.KijiPaginationFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html new file mode 100644 index 00000000..251220a7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiRowFilter.Context.html @@ -0,0 +1,209 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiRowFilter.Context (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiRowFilter.Context

            +
            + + + + + + + + + +
            +Packages that use KijiRowFilter.Context
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiRowFilter.Context in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiRowFilter.Context
            + FilterStripValueRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +abstract  FilterKijiRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            + FilterColumnValueEqualsRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            + FilterHasColumnDataRowFilter.toHBaseFilter(KijiRowFilter.Context context) + +
            +          Constructs an HBase Filter instance that can be used to instruct the + HBase region server which rows to filter.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiRowFilter.html new file mode 100644 index 00000000..357dc526 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiRowFilter.html @@ -0,0 +1,298 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiRowFilter

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiRowFilter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiRowFilter in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return KijiRowFilter
            + KijiRowFilterKijiTableReader.KijiScannerOptions.getKijiRowFilter() + +
            +          Gets the row filter set in these options.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiRowFilter
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setKijiRowFilter(KijiRowFilter rowFilter) + +
            +          Sets the row filter used by the scanner, + and returns this KijiScannerOptions to allow chaining.
            +  +

            + + + + + +
            +Uses of KijiRowFilter in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of KijiRowFilter in org.kiji.schema.filter
            + classAndRowFilter + +
            +          A KijiRowFilter for a conjunction (AND operator) of other filters.
            + classColumnValueEqualsRowFilter + +
            +          A KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value.
            + classHasColumnDataRowFilter + +
            +          A KijiRowFilter that excludes rows that have no data for some column columnName.
            + classOrRowFilter + +
            +          A KijiRowFilter for a disjunction (OR operator) of other filters.
            + classStripValueRowFilter + +
            +          A KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiRowFilter
            +static KijiRowFilterApplicatorKijiRowFilterApplicator.create(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  +

            + + + + + + + + + + + +
            Constructor parameters in org.kiji.schema.filter with type arguments of type KijiRowFilter
            AndRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new AndRowFilter instance.
            OrRowFilter(List<? extends KijiRowFilter> filters) + +
            +          Creates a new OrRowFilter instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html new file mode 100644 index 00000000..9e39f3a4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/KijiRowFilterApplicator.html @@ -0,0 +1,183 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.KijiRowFilterApplicator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.KijiRowFilterApplicator

            +
            + + + + + + + + + +
            +Packages that use KijiRowFilterApplicator
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + +
            +Uses of KijiRowFilterApplicator in org.kiji.schema.filter
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.filter that return KijiRowFilterApplicator
            +static KijiRowFilterApplicatorKijiRowFilterApplicator.create(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/OrRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/OrRowFilter.html new file mode 100644 index 00000000..e740897f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/OrRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.OrRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.OrRowFilter

            +
            +No usage of org.kiji.schema.filter.OrRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html new file mode 100644 index 00000000..549cdbea --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/RegexQualifierColumnFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.RegexQualifierColumnFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.RegexQualifierColumnFilter

            +
            +No usage of org.kiji.schema.filter.RegexQualifierColumnFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/StripValueRowFilter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/StripValueRowFilter.html new file mode 100644 index 00000000..f9c8d648 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/class-use/StripValueRowFilter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.filter.StripValueRowFilter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.filter.StripValueRowFilter

            +
            +No usage of org.kiji.schema.filter.StripValueRowFilter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-frame.html new file mode 100644 index 00000000..bcfecf5a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-frame.html @@ -0,0 +1,64 @@ + + + + + + + +org.kiji.schema.filter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema.filter + + + + +
            +Interfaces  + +
            +KijiColumnFilter.Context
            + + + + + + +
            +Classes  + +
            +AndRowFilter +
            +ColumnValueEqualsRowFilter +
            +HasColumnDataRowFilter +
            +KijiColumnFilter +
            +KijiPaginationFilter +
            +KijiRowFilter +
            +KijiRowFilter.Context +
            +KijiRowFilterApplicator +
            +OrRowFilter +
            +RegexQualifierColumnFilter +
            +StripValueRowFilter
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-summary.html new file mode 100644 index 00000000..035162be --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-summary.html @@ -0,0 +1,240 @@ + + + + + + + +org.kiji.schema.filter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.filter +

            +Row level filters used when reading data from Kiji tables. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            KijiColumnFilter.ContextAn object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AndRowFilterA KijiRowFilter for a conjunction (AND operator) of other filters.
            ColumnValueEqualsRowFilterA KijiRowFilter that only includes rows where a specific column's most recent value + equals a specified value.
            HasColumnDataRowFilterA KijiRowFilter that excludes rows that have no data for some column columnName.
            KijiColumnFilterA column filter provides a means of filtering cells from a column on the server side.
            KijiPaginationFilterA KijiColumnFilter that allows for pagination of results given an offset, limit, and + other filters that are and-ed together.
            KijiRowFilterThe abstract base class for filters that exclude data from KijiRows.
            KijiRowFilter.ContextA helper class for converting between Kiji objects and their HBase counterparts.
            KijiRowFilterApplicatorApplies a KijiRowFilter to various row-savvy objects.
            OrRowFilterA KijiRowFilter for a disjunction (OR operator) of other filters.
            RegexQualifierColumnFilterA KijiColumnFilter that only allows qualifiers that match a given regular expression.
            StripValueRowFilterA KijiRowFilter that applies HBase's KeyOnly filter to the KijiDataRequest.
            +  + +

            +

            +Package org.kiji.schema.filter Description +

            + +

            +Row level filters used when reading data from Kiji tables. + +

            + Provides row level filters which are applied to data read from + KijiTable. Only one filter can be used + at a time, but a single filter can be composed as a + combination of multiple filters using the operator filters: + AndRowFilter and + OrRowFilter. Filters are applied to + KijiDataRequest objects. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-tree.html new file mode 100644 index 00000000..ea8eb831 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-tree.html @@ -0,0 +1,164 @@ + + + + + + + +org.kiji.schema.filter Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.filter +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-use.html new file mode 100644 index 00000000..aac045f7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/filter/package-use.html @@ -0,0 +1,221 @@ + + + + + + + +Uses of Package org.kiji.schema.filter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.filter

            +
            + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.filter
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.filter used by org.kiji.schema
            KijiColumnFilter + +
            +          A column filter provides a means of filtering cells from a column on the server side.
            KijiRowFilter + +
            +          The abstract base class for filters that exclude data from KijiRows.
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.filter used by org.kiji.schema.filter
            KijiColumnFilter + +
            +          A column filter provides a means of filtering cells from a column on the server side.
            KijiColumnFilter.Context + +
            +          An object available to KijiColumnFilters that can be used to help implement the + toHBaseFilter() method.
            KijiRowFilter + +
            +          The abstract base class for filters that exclude data from KijiRows.
            KijiRowFilter.Context + +
            +          A helper class for converting between Kiji objects and their HBase counterparts.
            KijiRowFilterApplicator + +
            +          Applies a KijiRowFilter to various row-savvy objects.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseColumnName.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseColumnName.html new file mode 100644 index 00000000..2566082f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseColumnName.html @@ -0,0 +1,405 @@ + + + + + + + +HBaseColumnName (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.hbase +
            +Class HBaseColumnName

            +
            +java.lang.Object
+  extended by org.kiji.schema.hbase.HBaseColumnName
+
            +
            +
            +
            @ApiAudience.Public
+public final class HBaseColumnName
            extends Object
            + + +

            +An HBase column name. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseColumnName(byte[] family, + byte[] qualifier) + +
            +          Creates a new HBaseColumnName instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            + byte[]getFamily() + +
            +          Gets the HBase column family.
            + StringgetFamilyAsString() + +
            +          Gets the HBase column family as a string.
            + byte[]getQualifier() + +
            +          Gets the HBase column qualifier.
            + StringgetQualifierAsString() + +
            +          Gets the HBase column qualifier as a string.
            + inthashCode() + +
            +          
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +HBaseColumnName

            +
            +public HBaseColumnName(byte[] family,
+                       byte[] qualifier)
            +
            +
            Creates a new HBaseColumnName instance. +

            +

            +
            Parameters:
            family - The column family.
            qualifier - The column qualifier.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getFamily

            +
            +public byte[] getFamily()
            +
            +
            Gets the HBase column family. +

            +

            + +
            Returns:
            The family.
            +
            +
            +
            + +

            +getFamilyAsString

            +
            +public String getFamilyAsString()
            +
            +
            Gets the HBase column family as a string. +

            +

            + +
            Returns:
            The family as a string.
            +
            +
            +
            + +

            +getQualifier

            +
            +public byte[] getQualifier()
            +
            +
            Gets the HBase column qualifier. +

            +

            + +
            Returns:
            The qualifier.
            +
            +
            +
            + +

            +getQualifierAsString

            +
            +public String getQualifierAsString()
            +
            +
            Gets the HBase column qualifier as a string. +

            +

            + +
            Returns:
            The qualifier as a string.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseFactory.Provider.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseFactory.Provider.html new file mode 100644 index 00000000..7cb41e66 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseFactory.Provider.html @@ -0,0 +1,230 @@ + + + + + + + +HBaseFactory.Provider (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.hbase +
            +Class HBaseFactory.Provider

            +
            +java.lang.Object
+  extended by org.kiji.schema.hbase.HBaseFactory.Provider
+
            +
            +
            Enclosing interface:
            HBaseFactory
            +
            +
            +
            +
            public static final class HBaseFactory.Provider
            extends Object
            + + +

            +Provider for the default HBaseFactory. + + Ensures that there is only one HBaseFactory instance. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static HBaseFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static HBaseFactory get()
            +
            +
            + +
            Returns:
            the default HBaseFactory.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseFactory.html new file mode 100644 index 00000000..477d6868 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseFactory.html @@ -0,0 +1,306 @@ + + + + + + + +HBaseFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.hbase +
            +Interface HBaseFactory

            +
            +
            All Superinterfaces:
            org.kiji.delegation.PriorityProvider
            +
            +
            +
            All Known Implementing Classes:
            DefaultHBaseFactory
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface HBaseFactory
            extends org.kiji.delegation.PriorityProvider
            + + +

            +Factory for HBase instances based on URIs. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classHBaseFactory.Provider + +
            +          Provider for the default HBaseFactory.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdminFactorygetHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactorygetHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactorygetLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  + + + + + + + +
            Methods inherited from interface org.kiji.delegation.PriorityProvider
            getPriority
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getHTableInterfaceFactory

            +
            +HTableInterfaceFactory getHTableInterfaceFactory(KijiURI uri)
            +
            +
            Reports a factory for HTableInterface for a given HBase instance. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HTableInterface for the specified HBase instance.
            +
            +
            +
            + +

            +getHBaseAdminFactory

            +
            +HBaseAdminFactory getHBaseAdminFactory(KijiURI uri)
            +
            +
            Reports a factory for HBaseAdmin for a given HBase instance. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HBaseAdmin for the specified HBase instance.
            +
            +
            +
            + +

            +getLockFactory

            +
            +LockFactory getLockFactory(KijiURI uri,
+                           Configuration conf)
+                           throws IOException
            +
            +
            Creates a lock factory for a given Kiji instance. +

            +

            +
            +
            +
            +
            Parameters:
            uri - URI of the Kiji instance to create a lock factory for.
            conf - Hadoop configuration. +
            Returns:
            a factory for locks for the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseScanOptions.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseScanOptions.html new file mode 100644 index 00000000..349d26e0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/HBaseScanOptions.html @@ -0,0 +1,382 @@ + + + + + + + +HBaseScanOptions (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.hbase +
            +Class HBaseScanOptions

            +
            +java.lang.Object
+  extended by org.kiji.schema.hbase.HBaseScanOptions
+
            +
            +
            +
            @ApiAudience.Public
+public final class HBaseScanOptions
            extends Object
            + + +

            +Customizable parameters for KijiRowScanners backed by an HBase scan. + Any parameters that are not set will default to HBase values. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseScanOptions() + +
            +          Creates a new HBaseScanOptions where all parameters will default to HBase values.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + BooleangetCacheBlocks() + +
            +          Returns whether requested rows are cached server-side, + or null if using the HBase default.
            + IntegergetClientBufferSize() + +
            +          Returns the number of rows to request with each RPC, + or null if using the HBase default.
            + IntegergetServerPrefetchSize() + +
            +          Returns the number of rows for servers to prefetch, + or null if using the HBase default.
            + voidsetCacheBlocks(Boolean cacheBlocks) + +
            +          Sets whether rows requested are cached server-side for future use.
            + voidsetClientBufferSize(Integer bufferSize) + +
            +          Sets the number of rows that will be returned with each RPC when iterating + through a KijiRowScanner.
            + voidsetServerPrefetchSize(Integer prefetchSize) + +
            +          Sets the number of rows for servers to prefetch.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseScanOptions

            +
            +public HBaseScanOptions()
            +
            +
            Creates a new HBaseScanOptions where all parameters will default to HBase values. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +setClientBufferSize

            +
            +public void setClientBufferSize(Integer bufferSize)
            +
            +
            Sets the number of rows that will be returned with each RPC when iterating + through a KijiRowScanner. If null, uses HBase default. +

            +

            +
            Parameters:
            bufferSize - The number of rows to request with each RPC.
            +
            +
            +
            + +

            +getClientBufferSize

            +
            +public Integer getClientBufferSize()
            +
            +
            Returns the number of rows to request with each RPC, + or null if using the HBase default. +

            +

            + +
            Returns:
            The number of rows to request with each RPC.
            +
            +
            +
            + +

            +setServerPrefetchSize

            +
            +public void setServerPrefetchSize(Integer prefetchSize)
            +
            +
            Sets the number of rows for servers to prefetch. If null, use HBase default. + Increasing this number should improve amortized scan time, although individual requests + may take longer to complete while the server is prefetching the following rows. + It is important that the scanner timeout be long enough to allow these longer fetches. +

            +

            +
            Parameters:
            prefetchSize - The number of rows to read into memory at a time.
            +
            +
            +
            + +

            +getServerPrefetchSize

            +
            +public Integer getServerPrefetchSize()
            +
            +
            Returns the number of rows for servers to prefetch, + or null if using the HBase default. +

            +

            + +
            Returns:
            The number of rows for servers to prefetch.
            +
            +
            +
            + +

            +setCacheBlocks

            +
            +public void setCacheBlocks(Boolean cacheBlocks)
            +
            +
            Sets whether rows requested are cached server-side for future use. If null, use HBase default. +

            +

            +
            Parameters:
            cacheBlocks - Whether rows are cached server-side.
            +
            +
            +
            + +

            +getCacheBlocks

            +
            +public Boolean getCacheBlocks()
            +
            +
            Returns whether requested rows are cached server-side, + or null if using the HBase default. +

            +

            + +
            Returns:
            Whether requested rows are cached server-side.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/KijiManagedHBaseTableName.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/KijiManagedHBaseTableName.html new file mode 100644 index 00000000..f7c94379 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/KijiManagedHBaseTableName.html @@ -0,0 +1,608 @@ + + + + + + + +KijiManagedHBaseTableName (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.hbase +
            +Class KijiManagedHBaseTableName

            +
            +java.lang.Object
+  extended by org.kiji.schema.hbase.KijiManagedHBaseTableName
+
            +
            +
            +
            @ApiAudience.Framework
+public final class KijiManagedHBaseTableName
            extends Object
            + + +

            +

            Multiple instances of Kiji can be installed on a single HBase + cluster. Within a Kiji instance, several HBase tables are created + to manage system, metadata, schemas, and user-space tables. This + class represents the name of one of those HBase tables that are + created and managed by Kiji.

            + +

            + The names of tables in HBase created and managed by Kiji are + made of a list of delimited components. There are at least 3 + components of a name: + +

              +
            1. + Prefix: a literal string "kiji" used to mark that this table + is managed by Kiji. +
              2. +
            2. + KijiInstance: the name of kiji instance managing this table. +
              3. +
            3. + Type: the type of table (system, schema, meta, table). +
              4. +
            + + If the type of the table is "table", then it's name (the name users + of Kiji would use to refer to it) is the fourth and final component. +

            + +

            + For example, an HBase cluster might have the following tables: + 

            + devices
+ kiji.default.meta
+ kiji.default.schema
+ kiji.default.schema_hash
+ kiji.default.schema_id
+ kiji.default.system
+ kiji.default.table.foo
+ kiji.default.table.bar
+ kiji.experimental.meta
+ kiji.experimental.schema
+ kiji.experimental.schema_hash
+ kiji.experimental.schema_id
+ kiji.experimental.system
+ kiji.experimental.table.baz
+
            + + In this example, there is an HBase table completely unrelated to + kiji called "devices." There are two kiji installations, once + called "default" and another called "experimental." Within the + "default" installation, there are two Kiji tables, "foo" and + "bar." Within the "experimental" installation, there is a single + Kiji table "baz." +

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringKIJI_COMPONENT + +
            +          The first component of all HBase table names managed by Kiji.
            +static PatternKIJI_SYSTEM_TABLES_REGEX + +
            +          Regexp matching Kiji system tables.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +           
            +static KijiManagedHBaseTableNameget(String hbaseTableName) + +
            +          Constructs using an HBase HTable name.
            + StringgetKijiInstanceName() + +
            +          Gets the name of the Kiji instance this named table belongs to.
            + StringgetKijiTableName() + +
            +          Gets the name of the Kiji table.
            +static KijiManagedHBaseTableNamegetKijiTableName(String kijiInstanceName, + String kijiTableName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table.
            +static KijiManagedHBaseTableNamegetMetaTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table.
            +static KijiManagedHBaseTableNamegetSchemaHashTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table.
            +static KijiManagedHBaseTableNamegetSchemaIdTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table.
            +static KijiManagedHBaseTableNamegetSchemaV5TableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table.
            +static KijiManagedHBaseTableNamegetSystemTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table.
            + inthashCode() + +
            +           
            + byte[]toBytes() + +
            +          Gets the name of the HBase table that stores the data for this Kiji table.
            + StringtoString() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +KIJI_COMPONENT

            +
            +public static final String KIJI_COMPONENT
            +
            +
            The first component of all HBase table names managed by Kiji. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_SYSTEM_TABLES_REGEX

            +
            +public static final Pattern KIJI_SYSTEM_TABLES_REGEX
            +
            +
            Regexp matching Kiji system tables. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static KijiManagedHBaseTableName get(String hbaseTableName)
+                                     throws NotAKijiManagedTableException
            +
            +
            Constructs using an HBase HTable name. +

            +

            +
            Parameters:
            hbaseTableName - The HBase HTable name. +
            Returns:
            A new kiji-managed HBase table name. +
            Throws: +
            NotAKijiManagedTableException - If the HBase table is not managed by kiji.
            +
            +
            +
            + +

            +getMetaTableName

            +
            +public static KijiManagedHBaseTableName getMetaTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji meta table.
            +
            +
            +
            + +

            +getSchemaV5TableName

            +
            +public static KijiManagedHBaseTableName getSchemaV5TableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji schema table up until layout v5.
            +
            +
            +
            + +

            +getSchemaHashTableName

            +
            +public static KijiManagedHBaseTableName getSchemaHashTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji schema hash table.
            +
            +
            +
            + +

            +getSchemaIdTableName

            +
            +public static KijiManagedHBaseTableName getSchemaIdTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji schema IDs table.
            +
            +
            +
            + +

            +getSystemTableName

            +
            +public static KijiManagedHBaseTableName getSystemTableName(String kijiInstanceName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance. +
            Returns:
            The name of the HBase table used to store the Kiji system table.
            +
            +
            +
            + +

            +getKijiTableName

            +
            +public static KijiManagedHBaseTableName getKijiTableName(String kijiInstanceName,
+                                                         String kijiTableName)
            +
            +
            Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance.
            kijiTableName - The name of the user-space Kiji table. +
            Returns:
            The name of the HBase table used to store the user-space Kiji table.
            +
            +
            +
            + +

            +getKijiInstanceName

            +
            +public String getKijiInstanceName()
            +
            +
            Gets the name of the Kiji instance this named table belongs to. +

            +

            + +
            Returns:
            The name of the kiji instance.
            +
            +
            +
            + +

            +getKijiTableName

            +
            +public String getKijiTableName()
            +
            +
            Gets the name of the Kiji table. +

            +

            + +
            Returns:
            The name of the kiji table, or null if this is not a user-space Kiji table.
            +
            +
            +
            + +

            +toBytes

            +
            +public byte[] toBytes()
            +
            +
            Gets the name of the HBase table that stores the data for this Kiji table. +

            +

            + +
            Returns:
            The HBase table name as a UTF-8 encoded byte array.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseColumnName.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseColumnName.html new file mode 100644 index 00000000..4ea31eb5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseColumnName.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Class org.kiji.schema.hbase.HBaseColumnName (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.hbase.HBaseColumnName

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseColumnName
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of HBaseColumnName in org.kiji.schema.filter
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.filter that return HBaseColumnName
            + HBaseColumnNameKijiColumnFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column name.
            +abstract  HBaseColumnNameKijiRowFilter.Context.getHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Converts a Kiji column name to an HBase column family name.
            +  +

            + + + + + +
            +Uses of HBaseColumnName in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return HBaseColumnName
            + HBaseColumnNameColumnNameTranslator.toHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type HBaseColumnName
            + KijiColumnNameColumnNameTranslator.toKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseFactory.Provider.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseFactory.Provider.html new file mode 100644 index 00000000..e00fc836 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseFactory.Provider.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.hbase.HBaseFactory.Provider (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.hbase.HBaseFactory.Provider

            +
            +No usage of org.kiji.schema.hbase.HBaseFactory.Provider +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseFactory.html new file mode 100644 index 00000000..96be398e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseFactory.html @@ -0,0 +1,251 @@ + + + + + + + +Uses of Interface org.kiji.schema.hbase.HBaseFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.hbase.HBaseFactory

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use HBaseFactory
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseFactory in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type HBaseFactory
            + voidKijiInstaller.install(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Installs a Kiji instance.
            + voidKijiInstaller.uninstall(KijiURI uri, + HBaseFactory hbaseFactory, + Configuration conf) + +
            +          Removes a kiji instance from the HBase cluster including any user tables.
            +  +

            + + + + + +
            +Uses of HBaseFactory in org.kiji.schema.hbase
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.hbase that return HBaseFactory
            +static HBaseFactoryHBaseFactory.Provider.get() + +
            +           
            +  +

            + + + + + +
            +Uses of HBaseFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement HBaseFactory
            + classDefaultHBaseFactory + +
            +          Factory for HBase instances based on URIs.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseScanOptions.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseScanOptions.html new file mode 100644 index 00000000..65da8eeb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/HBaseScanOptions.html @@ -0,0 +1,227 @@ + + + + + + + +Uses of Class org.kiji.schema.hbase.HBaseScanOptions (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.hbase.HBaseScanOptions

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseScanOptions
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseScanOptions in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return HBaseScanOptions
            + HBaseScanOptionsKijiTableReader.KijiScannerOptions.getHBaseScanOptions() + +
            +          Gets the HBaseScanOptions set in these options.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type HBaseScanOptions
            + KijiTableReader.KijiScannerOptionsKijiTableReader.KijiScannerOptions.setHBaseScanOptions(HBaseScanOptions hBaseScanOptions) + +
            +          Sets the HBaseScanOptions used by a HBase backed scanner.
            +  +

            + + + + + +
            +Uses of HBaseScanOptions in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HBaseScanOptions
            + ScanHBaseDataRequestAdapter.toScan(KijiTableLayout tableLayout, + HBaseScanOptions scanOptions) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/KijiManagedHBaseTableName.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/KijiManagedHBaseTableName.html new file mode 100644 index 00000000..b9dc7221 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/class-use/KijiManagedHBaseTableName.html @@ -0,0 +1,260 @@ + + + + + + + +Uses of Class org.kiji.schema.hbase.KijiManagedHBaseTableName (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.hbase.KijiManagedHBaseTableName

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiManagedHBaseTableName
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiManagedHBaseTableName in org.kiji.schema.hbase
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.hbase that return KijiManagedHBaseTableName
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.get(String hbaseTableName) + +
            +          Constructs using an HBase HTable name.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getKijiTableName(String kijiInstanceName, + String kijiTableName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds a user-space Kiji table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getMetaTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji meta table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSchemaHashTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema hash table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSchemaIdTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema IDs table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSchemaV5TableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji schema v5 table.
            +static KijiManagedHBaseTableNameKijiManagedHBaseTableName.getSystemTableName(String kijiInstanceName) + +
            +          Gets a new instance of a Kiji-managed HBase table that holds the Kiji system table.
            +  +

            + + + + + +
            +Uses of KijiManagedHBaseTableName in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiManagedHBaseTableName
            +static HTableDescriptorHTableDescriptorComparator.makeEmptyTableDescriptor(KijiManagedHBaseTableName hbaseTableName) + +
            +          Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout().
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-frame.html new file mode 100644 index 00000000..56395ba2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-frame.html @@ -0,0 +1,50 @@ + + + + + + + +org.kiji.schema.hbase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema.hbase + + + + +
            +Interfaces  + +
            +HBaseFactory
            + + + + + + +
            +Classes  + +
            +HBaseColumnName +
            +HBaseFactory.Provider +
            +HBaseScanOptions +
            +KijiManagedHBaseTableName
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-summary.html new file mode 100644 index 00000000..c743de52 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-summary.html @@ -0,0 +1,206 @@ + + + + + + + +org.kiji.schema.hbase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.hbase +

            +HBase-specific KijiSchema behavior. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            HBaseFactoryFactory for HBase instances based on URIs.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            HBaseColumnNameAn HBase column name.
            HBaseFactory.ProviderProvider for the default HBaseFactory.
            HBaseScanOptionsCustomizable parameters for KijiRowScanners backed by an HBase scan.
            KijiManagedHBaseTableNameMultiple instances of Kiji can be installed on a single HBase + cluster.
            +  + +

            +

            +Package org.kiji.schema.hbase Description +

            + +

            +HBase-specific KijiSchema behavior. + +

            Most of KijiSchema implements an abstract key-value store database on top of + some underlying physical storage medium. In practice this is built on top of + Apache HBase. HBase-specific options and mechanisms that are part of KijiSchema's API + reside in this package. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-tree.html new file mode 100644 index 00000000..f7b835ae --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-tree.html @@ -0,0 +1,161 @@ + + + + + + + +org.kiji.schema.hbase Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.hbase +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            +
              +
            • org.kiji.delegation.PriorityProvider +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-use.html new file mode 100644 index 00000000..a95a40c8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/hbase/package-use.html @@ -0,0 +1,273 @@ + + + + + + + +Uses of Package org.kiji.schema.hbase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.hbase

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.hbase
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.hbase used by org.kiji.schema
            HBaseFactory + +
            +          Factory for HBase instances based on URIs.
            HBaseScanOptions + +
            +          Customizable parameters for KijiRowScanners backed by an HBase scan.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.hbase used by org.kiji.schema.filter
            HBaseColumnName + +
            +          An HBase column name.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.hbase used by org.kiji.schema.hbase
            HBaseFactory + +
            +          Factory for HBase instances based on URIs.
            KijiManagedHBaseTableName + +
            +          Multiple instances of Kiji can be installed on a single HBase + cluster.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.hbase used by org.kiji.schema.impl
            HBaseFactory + +
            +          Factory for HBase instances based on URIs.
            HBaseScanOptions + +
            +          Customizable parameters for KijiRowScanners backed by an HBase scan.
            KijiManagedHBaseTableName + +
            +          Multiple instances of Kiji can be installed on a single HBase + cluster.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.hbase used by org.kiji.schema.layout
            HBaseColumnName + +
            +          An HBase column name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/AbstractKijiTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/AbstractKijiTable.html new file mode 100644 index 00000000..a0a08791 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/AbstractKijiTable.html @@ -0,0 +1,482 @@ + + + + + + + +AbstractKijiTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class AbstractKijiTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AbstractKijiTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTable
            +
            +
            +
            Direct Known Subclasses:
            HBaseKijiTable
            +
            +
            +
            +
            @ApiAudience.Private
+public abstract class AbstractKijiTable
            extends Object
            implements KijiTable
            + + +

            +Main handle for a Kiji table with basic functionality. + + A KijiTable has all the data about an entity. + Entity data is keyed by the entityId. + Each row in the table represents one entity. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected AbstractKijiTable(Kiji kiji, + String name) + +
            +          Creates a new KijiTable instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + booleanequals(Object obj) + +
            +          
            +protected  voidfinalize() + +
            +          
            +abstract  EntityIdgetEntityId(Object... kijiRowKey) + +
            +          Creates an entity id from a list of components.
            + KijigetKiji() + +
            +          
            + StringgetName() + +
            +          
            + KijiURIgetURI() + +
            +          
            + inthashCode() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, getClass, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.KijiTable
            getLayout, getRegions, openTableReader, openTableWriter
            +  +

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

            +AbstractKijiTable

            +
            +protected AbstractKijiTable(Kiji kiji,
+                            String name)
+                     throws IOException
            +
            +
            Creates a new KijiTable instance. +

            +

            +
            Parameters:
            kiji - The kiji instance.
            name - The name of the kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getKiji

            +
            +public Kiji getKiji()
            +
            +
            +

            +

            +
            Specified by:
            getKiji in interface KijiTable
            +
            +
            + +
            Returns:
            the Kiji instance this table belongs to.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            Specified by:
            getName in interface KijiTable
            +
            +
            + +
            Returns:
            the name of this table.
            +
            +
            +
            + +

            +getURI

            +
            +public KijiURI getURI()
            +
            +
            +

            +

            +
            Specified by:
            getURI in interface KijiTable
            +
            +
            + +
            Returns:
            the URI for this table, trimmed at the table path component.
            +
            +
            +
            + +

            +getEntityId

            +
            +public abstract EntityId getEntityId(Object... kijiRowKey)
            +
            +
            Creates an entity id from a list of components. +

            +

            +
            Specified by:
            getEntityId in interface KijiTable
            +
            +
            +
            Parameters:
            kijiRowKey - This can be one of the following depending on row key encoding: +
              +
            • + Raw, Hash, Hash-Prefix EntityId: A single String or byte array + component. +
              • +
            • + Formatted EntityId: The primitive row key components (string, int, + long) either passed in their expected order in the key or as an ordered + list of components. +
              • +
            +
            Returns:
            a new EntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object obj)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/AvroCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/AvroCellDecoder.html new file mode 100644 index 00000000..5550b213 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/AvroCellDecoder.html @@ -0,0 +1,410 @@ + + + + + + + +AvroCellDecoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class AvroCellDecoder<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellDecoder<T>
+
            +
            +
            Type Parameters:
            T - The type of the decoded cell data.
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<T>
            +
            +
            +
            Direct Known Subclasses:
            GenericCellDecoder, SpecificCellDecoder
            +
            +
            +
            +
            @ApiAudience.Private
+public abstract class AvroCellDecoder<T>
            extends Object
            implements KijiCellDecoder<T>
            + + +

            +Base class for decoders that read Kiji cells encoded using Avro. + + Kiji cells are encoded as Extension records, although for efficiency reasons, this class + provides a custom decoder that avoid copying bytes unnecessarily. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected AvroCellDecoder(CellSpec cellSpec) + +
            +          Initializes an abstract KijiAvroCellDecoder.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected abstract  org.apache.avro.io.DatumReader<T>createDatumReader(org.apache.avro.Schema writer, + org.apache.avro.Schema reader) + +
            +          Factory for DatumReader instances.
            +protected  TdecodeAvro(ByteBuffer encodedData, + org.apache.avro.Schema writerSchema, + org.apache.avro.Schema readerSchema, + T reuse) + +
            +          Decodes the data payload given the reader and writer schema.
            + DecodedCell<T>decodeCell(byte[] encodedBytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + TdecodeValue(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + ByteBuffergetPayload(byte[] bytes) + +
            +          Gets the portion of the encoded byte array from an HBase table cell that has the avro-encoded + data payload.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroCellDecoder

            +
            +protected AvroCellDecoder(CellSpec cellSpec)
+                   throws IOException
            +
            +
            Initializes an abstract KijiAvroCellDecoder. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createDatumReader

            +
            +protected abstract org.apache.avro.io.DatumReader<T> createDatumReader(org.apache.avro.Schema writer,
+                                                                       org.apache.avro.Schema reader)
            +
            +
            Factory for DatumReader instances. + + Sub-classes must create DatumReader implementations for specific or generic records. +

            +

            +
            +
            +
            +
            Parameters:
            writer - Writer schema.
            reader - Reader schema. +
            Returns:
            a new DatumReader instance for the specified writer/reader schema combination.
            +
            +
            +
            + +

            +decodeCell

            +
            +public DecodedCell<T> decodeCell(byte[] encodedBytes)
+                          throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeCell in interface KijiCellDecoder<T>
            +
            +
            +
            Parameters:
            encodedBytes - Binary encoded Kiji cell. +
            Returns:
            the decoded KijiCell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeValue

            +
            +public T decodeValue(byte[] bytes)
+              throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeValue in interface KijiCellDecoder<T>
            +
            +
            +
            Parameters:
            bytes - Binary encoded Kiji cell value. +
            Returns:
            the decoded cell value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getPayload

            +
            +public ByteBuffer getPayload(byte[] bytes)
+                      throws IOException
            +
            +
            Gets the portion of the encoded byte array from an HBase table cell that has the avro-encoded + data payload. +

            +

            +
            +
            +
            +
            Parameters:
            bytes - The bytes from an HBase table cell. +
            Returns:
            the portion of the encoded byte array that contains the binary-encoded avro message. +
            Throws: +
            IOException - on I/O error (eg. decoding error).
            +
            +
            +
            + +

            +decodeAvro

            +
            +protected T decodeAvro(ByteBuffer encodedData,
+                       org.apache.avro.Schema writerSchema,
+                       org.apache.avro.Schema readerSchema,
+                       T reuse)
+                throws IOException
            +
            +
            Decodes the data payload given the reader and writer schema. If reuse is non-null, the + implementation may fill it and return that object. +

            +

            +
            +
            +
            +
            Parameters:
            encodedData - The avro-encoded bytes of the data payload.
            writerSchema - The schema that was used to encode the data.
            readerSchema - The schema that is expected by the reader.
            reuse - An optional object to be filled and returned to save on object construction + (may be null). +
            Returns:
            The decoded avro object. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/AvroCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/AvroCellEncoder.html new file mode 100644 index 00000000..8782254e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/AvroCellEncoder.html @@ -0,0 +1,315 @@ + + + + + + + +AvroCellEncoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class AvroCellEncoder

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellEncoder
+
            +
            +
            All Implemented Interfaces:
            KijiCellEncoder
            +
            +
            +
            +
            @ApiAudience.Private
+public final class AvroCellEncoder
            extends Object
            implements KijiCellEncoder
            + + +

            +Serializes a KijiCell. + + A Kiji cell is encoded as an Extension record, although this class implements the encoder + in a specific way for efficiency. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            AvroCellEncoder(CellSpec cellSpec) + +
            +          Creates a new KijiCellEncoder instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]encode(DecodedCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + + + + + +
            +<T> byte[]
            +            		encode(T cellValue) + +
            +          Encodes the specified value.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +AvroCellEncoder

            +
            +public AvroCellEncoder(CellSpec cellSpec)
+                throws IOException
            +
            +
            Creates a new KijiCellEncoder instance. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell to encode. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +encode

            +
            +public byte[] encode(DecodedCell<?> cell)
+              throws IOException
            +
            +
            Encodes the specified Kiji cell. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Parameters:
            cell - Kiji cell to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encode

            +
            +public <T> byte[] encode(T cellValue)
+              throws IOException
            +
            +
            Encodes the specified value. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Type Parameters:
            T - type of the value to encode.
            Parameters:
            cellValue - value to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/CounterCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/CounterCellDecoder.html new file mode 100644 index 00000000..9560dbec --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/CounterCellDecoder.html @@ -0,0 +1,288 @@ + + + + + + + +CounterCellDecoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class CounterCellDecoder

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.CounterCellDecoder
+
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<Long>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class CounterCellDecoder
            extends Object
            implements KijiCellDecoder<Long>
            + + +

            +Cell decoder for counters. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + DecodedCell<Long>decodeCell(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            + LongdecodeValue(byte[] bytes) + +
            +          Decodes a Kiji cell from its binary-encoded form.
            +static CounterCellDecoderget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static CounterCellDecoder get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the counter cell decoder singleton.
            +
            +
            +
            + +

            +decodeCell

            +
            +public DecodedCell<Long> decodeCell(byte[] bytes)
+                             throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeCell in interface KijiCellDecoder<Long>
            +
            +
            +
            Parameters:
            bytes - Binary encoded Kiji cell. +
            Returns:
            the decoded KijiCell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeValue

            +
            +public Long decodeValue(byte[] bytes)
+                 throws IOException
            +
            +
            Decodes a Kiji cell from its binary-encoded form. +

            +

            +
            Specified by:
            decodeValue in interface KijiCellDecoder<Long>
            +
            +
            +
            Parameters:
            bytes - Binary encoded Kiji cell value. +
            Returns:
            the decoded cell value. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/CounterCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/CounterCellEncoder.html new file mode 100644 index 00000000..578f6c0a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/CounterCellEncoder.html @@ -0,0 +1,295 @@ + + + + + + + +CounterCellEncoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class CounterCellEncoder

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.CounterCellEncoder
+
            +
            +
            All Implemented Interfaces:
            KijiCellEncoder
            +
            +
            +
            +
            @ApiAudience.Private
+public final class CounterCellEncoder
            extends Object
            implements KijiCellEncoder
            + + +

            +Encoder for Kiji counters. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]encode(DecodedCell<?> cell) + +
            +          Encodes the specified Kiji cell.
            + + + + + +
            +<T> byte[]
            +            		encode(T cellValue) + +
            +          Encodes the specified value.
            +static CounterCellEncoderget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static CounterCellEncoder get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the singleton encoder for counters.
            +
            +
            +
            + +

            +encode

            +
            +public byte[] encode(DecodedCell<?> cell)
+              throws IOException
            +
            +
            Encodes the specified Kiji cell. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Parameters:
            cell - Kiji cell to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encode

            +
            +public <T> byte[] encode(T cellValue)
+              throws IOException
            +
            +
            Encodes the specified value. +

            +

            +
            Specified by:
            encode in interface KijiCellEncoder
            +
            +
            +
            Type Parameters:
            T - type of the value to encode.
            Parameters:
            cellValue - value to encode. +
            Returns:
            the binary encoding of the cell. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultHBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultHBaseAdminFactory.html new file mode 100644 index 00000000..cb3e72bd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultHBaseAdminFactory.html @@ -0,0 +1,260 @@ + + + + + + + +DefaultHBaseAdminFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultHBaseAdminFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultHBaseAdminFactory
+
            +
            +
            All Implemented Interfaces:
            HBaseAdminFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultHBaseAdminFactory
            extends Object
            implements HBaseAdminFactory
            + + +

            +Factory for HBaseAdmin that creates concrete HBaseAdmin instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdmincreate(Configuration conf) + +
            +          Creates a new HBaseAdmin instance.
            +static HBaseAdminFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static HBaseAdminFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            an instance of the default factory.
            +
            +
            +
            + +

            +create

            +
            +public HBaseAdmin create(Configuration conf)
+                  throws IOException
            +
            +
            Creates a new HBaseAdmin instance. +

            +

            +
            Specified by:
            create in interface HBaseAdminFactory
            +
            +
            +
            Parameters:
            conf - Configuration. +
            Returns:
            a new HBaseAdmin. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultHBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultHBaseFactory.html new file mode 100644 index 00000000..095450f3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultHBaseFactory.html @@ -0,0 +1,368 @@ + + + + + + + +DefaultHBaseFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultHBaseFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultHBaseFactory
+
            +
            +
            All Implemented Interfaces:
            org.kiji.delegation.PriorityProvider, HBaseFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultHBaseFactory
            extends Object
            implements HBaseFactory
            + + +

            +Factory for HBase instances based on URIs. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.schema.hbase.HBaseFactory
            HBaseFactory.Provider
            +  + + + + + + + + + + + +
            +Constructor Summary
            DefaultHBaseFactory() + +
            +          Public constructor for use by the service loader.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdminFactorygetHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            + HTableInterfaceFactorygetHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            + LockFactorygetLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            + intgetPriority(Map<String,String> runtimeHints) + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DefaultHBaseFactory

            +
            +public DefaultHBaseFactory()
            +
            +
            Public constructor for use by the service loader. Clients should use + HBaseFactory.Provider.get(), which maintains a singleton instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +getHTableInterfaceFactory

            +
            +public HTableInterfaceFactory getHTableInterfaceFactory(KijiURI uri)
            +
            +
            Reports a factory for HTableInterface for a given HBase instance. +

            +

            +
            Specified by:
            getHTableInterfaceFactory in interface HBaseFactory
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HTableInterface for the specified HBase instance.
            +
            +
            +
            + +

            +getHBaseAdminFactory

            +
            +public HBaseAdminFactory getHBaseAdminFactory(KijiURI uri)
            +
            +
            Reports a factory for HBaseAdmin for a given HBase instance. +

            +

            +
            Specified by:
            getHBaseAdminFactory in interface HBaseFactory
            +
            +
            +
            Parameters:
            uri - URI of the HBase instance to work with. +
            Returns:
            a factory for HBaseAdmin for the specified HBase instance.
            +
            +
            +
            + +

            +getLockFactory

            +
            +public LockFactory getLockFactory(KijiURI uri,
+                                  Configuration conf)
+                           throws IOException
            +
            +
            Creates a lock factory for a given Kiji instance. +

            +

            +
            Specified by:
            getLockFactory in interface HBaseFactory
            +
            +
            +
            Parameters:
            uri - URI of the Kiji instance to create a lock factory for.
            conf - Hadoop configuration. +
            Returns:
            a factory for locks for the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getPriority

            +
            +public int getPriority(Map<String,String> runtimeHints)
            +
            +
            +

            +

            +
            Specified by:
            getPriority in interface org.kiji.delegation.PriorityProvider
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultHTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultHTableInterfaceFactory.html new file mode 100644 index 00000000..7a597e06 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultHTableInterfaceFactory.html @@ -0,0 +1,262 @@ + + + + + + + +DefaultHTableInterfaceFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultHTableInterfaceFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultHTableInterfaceFactory
+
            +
            +
            All Implemented Interfaces:
            HTableInterfaceFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultHTableInterfaceFactory
            extends Object
            implements HTableInterfaceFactory
            + + +

            +Factory for HTableInterface that creates concrete HTable instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + HTableInterfacecreate(Configuration conf, + String hbaseTableName) + +
            +          Creates a new HTableInterface instance.
            +static HTableInterfaceFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static HTableInterfaceFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the default factory singleton.
            +
            +
            +
            + +

            +create

            +
            +public HTableInterface create(Configuration conf,
+                              String hbaseTableName)
+                       throws IOException
            +
            +
            Creates a new HTableInterface instance. +

            +

            +
            Specified by:
            create in interface HTableInterfaceFactory
            +
            +
            +
            Parameters:
            conf - The configuration for the HBase cluster.
            hbaseTableName - The name of the HBase table to create a connection to. +
            Returns:
            a new HTableInterface for the specified table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultKijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultKijiCellEncoderFactory.html new file mode 100644 index 00000000..aaefb94e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultKijiCellEncoderFactory.html @@ -0,0 +1,260 @@ + + + + + + + +DefaultKijiCellEncoderFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultKijiCellEncoderFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultKijiCellEncoderFactory
+
            +
            +
            All Implemented Interfaces:
            KijiCellEncoderFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DefaultKijiCellEncoderFactory
            extends Object
            implements KijiCellEncoderFactory
            + + +

            +Factory for cell encoders. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellEncodercreate(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +static DefaultKijiCellEncoderFactoryget() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public static DefaultKijiCellEncoderFactory get()
            +
            +
            +
            +
            +
            + +
            Returns:
            the default factory for cell encoders.
            +
            +
            +
            + +

            +create

            +
            +public KijiCellEncoder create(CellSpec cellSpec)
+                       throws IOException
            +
            +
            Creates a new Kiji cell encoder. +

            +

            +
            Specified by:
            create in interface KijiCellEncoderFactory
            +
            +
            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Returns:
            a new Kiji cell encoder. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultKijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultKijiTableFactory.html new file mode 100644 index 00000000..f7c69b52 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/DefaultKijiTableFactory.html @@ -0,0 +1,276 @@ + + + + + + + +DefaultKijiTableFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class DefaultKijiTableFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.DefaultKijiTableFactory
+
            +
            +
            All Implemented Interfaces:
            KijiTableFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public class DefaultKijiTableFactory
            extends Object
            implements KijiTableFactory
            + + +

            +The default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open(). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DefaultKijiTableFactory(Kiji kiji) + +
            +          Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + KijiTableopenTable(String tableName) + +
            +          Opens a KijiTable by name.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DefaultKijiTableFactory

            +
            +public DefaultKijiTableFactory(Kiji kiji)
            +
            +
            Constructs a KijiTableFactory that opens KijiTables from within a Kiji instance. +

            +

            +
            Parameters:
            kiji - The kiji instance containing the tables to open.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +openTable

            +
            +public KijiTable openTable(String tableName)
+                    throws IOException
            +
            +
            Opens a KijiTable by name. + +

            Clients must take care to close the KijiTable instance when finished.

            +

            +

            +
            Specified by:
            openTable in interface KijiTableFactory
            +
            +
            +
            Parameters:
            tableName - Name of the table to open. +
            Returns:
            the opened Kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/FormattedEntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/FormattedEntityId.html new file mode 100644 index 00000000..13806484 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/FormattedEntityId.html @@ -0,0 +1,377 @@ + + + + + + + +FormattedEntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class FormattedEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.FormattedEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public final class FormattedEntityId
            extends EntityId
            + + +

            +Implements the Formatted Entity Id row key. This allows users to specify keys composed + of either the primitive types of string, integer or long with some flexibility to specify + hash prefixing. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static FormattedEntityIdfromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat2 format) + +
            +          Creates a FormattedEntityId from the specified HBase row key.
            + + + + + +
            +<T> T
            +            		getComponentByIndex(int idx) + +
            +          Get the individual components of the kiji Row Key representation.
            + List<Object>getComponents() + +
            +          Get the components of the row key as a List of Objects.
            +static FormattedEntityIdgetEntityId(List<Object> kijiRowKey, + RowKeyFormat2 format) + +
            +          Creates a FormattedEntityId from the specified Kiji row key.
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEntityId

            +
            +public static FormattedEntityId getEntityId(List<Object> kijiRowKey,
+                                            RowKeyFormat2 format)
            +
            +
            Creates a FormattedEntityId from the specified Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - An ordered list of objects of row key components.
            format - The RowKeyFormat2 as specified in the layout file. +
            Returns:
            a new FormattedEntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public static FormattedEntityId fromHBaseRowKey(byte[] hbaseRowKey,
+                                                RowKeyFormat2 format)
            +
            +
            Creates a FormattedEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - A byte[] containing the HBase row key.
            format - The RowKeyFormat as specified in the layout file. +
            Returns:
            a new FormattedEntityId with the specified HBase row key.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Description copied from class: EntityId
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            +
            + +

            +getComponentByIndex

            +
            +public <T> T getComponentByIndex(int idx)
            +
            +
            Get the individual components of the kiji Row Key representation. This excludes hash + prefixes and only includes user-addressible components. + E.g. If the key is composed of a String followed by an Int, getComponentByIndex(0) + returns the String component. Zero based indexing. +

            +

            +
            Specified by:
            getComponentByIndex in class EntityId
            +
            +
            +
            Type Parameters:
            T - The type of the row key component.
            Parameters:
            idx - The index of the component. An integer between 0 and numComponents - 1. +
            Returns:
            The specific component of the row key.
            +
            +
            +
            + +

            +getComponents

            +
            +public List<Object> getComponents()
            +
            +
            Get the components of the row key as a List of Objects. This excludes hash + prefixes and only includes user-addressible components. +

            +

            +
            Specified by:
            getComponents in class EntityId
            +
            +
            + +
            Returns:
            List of Objects representing the individual components of a row key.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/GenericCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/GenericCellDecoder.html new file mode 100644 index 00000000..3a258997 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/GenericCellDecoder.html @@ -0,0 +1,290 @@ + + + + + + + +GenericCellDecoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class GenericCellDecoder<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellDecoder<T>
+      extended by org.kiji.schema.impl.GenericCellDecoder<T>
+
            +
            +
            Type Parameters:
            T - The type of the decoded data.
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<T>
            +
            +
            +
            +
            @ApiAudience.Private
+public class GenericCellDecoder<T>
            extends AvroCellDecoder<T>
            + + +

            +Decodes cells encoded using Avro into generic types. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            GenericCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates generic Avro types.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  org.apache.avro.io.DatumReader<T>createDatumReader(org.apache.avro.Schema writer, + org.apache.avro.Schema reader) + +
            +          Factory for DatumReader instances.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.impl.AvroCellDecoder
            decodeAvro, decodeCell, decodeValue, getPayload
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +GenericCellDecoder

            +
            +public GenericCellDecoder(CellSpec cellSpec)
+                   throws IOException
            +
            +
            Initializes a cell decoder that creates generic Avro types. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createDatumReader

            +
            +protected org.apache.avro.io.DatumReader<T> createDatumReader(org.apache.avro.Schema writer,
+                                                              org.apache.avro.Schema reader)
            +
            +
            Factory for DatumReader instances. + + Sub-classes must create DatumReader implementations for specific or generic records. +

            +

            +
            Specified by:
            createDatumReader in class AvroCellDecoder<T>
            +
            +
            +
            Parameters:
            writer - Writer schema.
            reader - Reader schema. +
            Returns:
            a new DatumReader instance for the specified writer/reader schema combination.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseAdminFactory.html new file mode 100644 index 00000000..20b1274d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseAdminFactory.html @@ -0,0 +1,222 @@ + + + + + + + +HBaseAdminFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Interface HBaseAdminFactory

            +
            +
            All Known Implementing Classes:
            DefaultHBaseAdminFactory
            +
            +
            +
            +
            public interface HBaseAdminFactory
            + + +

            +Factory for HBaseAdmin. + + Note: there is no interface for HBaseAdmin :( +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + HBaseAdmincreate(Configuration conf) + +
            +          Creates a new HBaseAdmin instance.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +HBaseAdmin create(Configuration conf)
+                  throws IOException
            +
            +
            Creates a new HBaseAdmin instance. +

            +

            +
            Parameters:
            conf - Configuration. +
            Returns:
            a new HBaseAdmin. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseDataRequestAdapter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseDataRequestAdapter.html new file mode 100644 index 00000000..77b16fb1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseDataRequestAdapter.html @@ -0,0 +1,358 @@ + + + + + + + +HBaseDataRequestAdapter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseDataRequestAdapter

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseDataRequestAdapter
+
            +
            +
            +
            @ApiAudience.Private
+public class HBaseDataRequestAdapter
            extends Object
            + + +

            +Wraps a KijiDataRequest to expose methods that generate meaningful objects in HBase + land, like Puts and Gets. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseDataRequestAdapter(KijiDataRequest kijiDataRequest) + +
            +          Wraps a KijiDataRequest.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidapplyToScan(Scan scan, + KijiTableLayout tableLayout) + +
            +          Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one.
            + GettoGet(EntityId entityId, + KijiTableLayout tableLayout) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + ScantoScan(KijiTableLayout tableLayout) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            + ScantoScan(KijiTableLayout tableLayout, + HBaseScanOptions scanOptions) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseDataRequestAdapter

            +
            +public HBaseDataRequestAdapter(KijiDataRequest kijiDataRequest)
            +
            +
            Wraps a KijiDataRequest. +

            +

            +
            Parameters:
            kijiDataRequest - The Kiji data request to wrap.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toScan

            +
            +public Scan toScan(KijiTableLayout tableLayout)
+            throws IOException
            +
            +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +

            +

            +
            Parameters:
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns. +
            Returns:
            An HBase Scan descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toScan

            +
            +public Scan toScan(KijiTableLayout tableLayout,
+                   HBaseScanOptions scanOptions)
+            throws IOException
            +
            +
            Constructs an HBase Scan that describes the data requested in the KijiDataRequest. +

            +

            +
            Parameters:
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns.
            scanOptions - Custom options for this scan. +
            Returns:
            An HBase Scan descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +applyToScan

            +
            +public void applyToScan(Scan scan,
+                        KijiTableLayout tableLayout)
+                 throws IOException
            +
            +
            Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one. + +

            Any existing request settings in the Scan object will be preserved.

            +

            +

            +
            Parameters:
            scan - The existing scan object to apply the data request to.
            tableLayout - The layout of the Kiji table the scan will read from. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toGet

            +
            +public Get toGet(EntityId entityId,
+                 KijiTableLayout tableLayout)
+          throws IOException
            +
            +
            Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row. +

            +

            +
            Parameters:
            entityId - The row to build an HBase Get request for.
            tableLayout - The layout of the Kiji table to read from. This is required for + determining the mapping between Kiji columns and HBase columns. +
            Returns:
            An HBase Get descriptor, or null if no data was requested. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseEntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseEntityId.html new file mode 100644 index 00000000..6c372d69 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseEntityId.html @@ -0,0 +1,364 @@ + + + + + + + +HBaseEntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.HBaseEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public class HBaseEntityId
            extends EntityId
            + + +

            +Entity ID encapsulating an HBase row key. This literally + represents a byte[] containing an hbase row key. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseEntityId(byte[] hbaseRowKey) + +
            +          Creates an HBaseEntityId from the specified HBase row key.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + + + + + +
            +<T> T
            +            		getComponentByIndex(int idx) + +
            +          Get the individual components of the kiji Row Key representation.
            + List<Object>getComponents() + +
            +          Get the components of the row key as a List of Objects.
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +HBaseEntityId

            +
            +public HBaseEntityId(byte[] hbaseRowKey)
            +
            +
            Creates an HBaseEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            +
            + +

            +getComponentByIndex

            +
            +public <T> T getComponentByIndex(int idx)
            +
            +
            Get the individual components of the kiji Row Key representation. This excludes hash + prefixes and only includes user-addressible components. + E.g. If the key is composed of a String followed by an Int, getComponentByIndex(0) + returns the String component. Zero based indexing. +

            +

            +
            Specified by:
            getComponentByIndex in class EntityId
            +
            +
            +
            Type Parameters:
            T - The type of the row key component.
            Parameters:
            idx - The index of the component. An integer between 0 and numComponents - 1. +
            Returns:
            The specific component of the row key.
            +
            +
            +
            + +

            +getComponents

            +
            +public List<Object> getComponents()
            +
            +
            Get the components of the row key as a List of Objects. This excludes hash + prefixes and only includes user-addressible components. +

            +

            +
            Specified by:
            getComponents in class EntityId
            +
            +
            + +
            Returns:
            List of Objects representing the individual components of a row key.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKiji.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKiji.html new file mode 100644 index 00000000..1f221630 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKiji.html @@ -0,0 +1,721 @@ + + + + + + + +HBaseKiji (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKiji

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKiji
+
            +
            +
            All Implemented Interfaces:
            Kiji, KijiTableFactory, ReferenceCountable<Kiji>
            +
            +
            +
            +
            @ApiAudience.Public
+public final class HBaseKiji
            extends Object
            implements Kiji
            + + +

            +Kiji instance class that contains configuration and table + information. Multiple instances of Kiji can be installed onto a + single HBase cluster. This class represents a single one of those + instances. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.schema.Kiji
            Kiji.Factory
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout) + +
            +          Creates a Kiji table in an HBase instance.
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + byte[][] splitKeys) + +
            +          Creates a Kiji table in an HBase instance.
            + voidcreateTable(String tableName, + KijiTableLayout tableLayout, + int numRegions) + +
            +          Creates a Kiji table in an HBase instance.
            + voiddeleteTable(String tableName) + +
            +          Deletes a Kiji table.
            +protected  voidfinalize() + +
            +          
            + ConfigurationgetConf() + +
            +          
            + HBaseAdmingetHBaseAdmin() + +
            +          Gets the current HBaseAdmin instance for this Kiji.
            + KijiMetaTablegetMetaTable() + +
            +          Gets the meta table for this Kiji instance.
            + KijiSchemaTablegetSchemaTable() + +
            +          Gets the schema table for this Kiji instance.
            + KijiSystemTablegetSystemTable() + +
            +          Gets the system table for this Kiji instance.
            + List<String>getTableNames() + +
            +          Gets the list of Kiji table names.
            + KijiURIgetURI() + +
            +          
            + KijiTableLayoutmodifyTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutmodifyTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            + KijiTableopenTable(String tableName) + +
            +          Opens a KijiTable by name.
            + voidrelease() + +
            +          Notifies this resource that we are no longer interested in it.
            + Kijiretain() + +
            +          Expresses interest in retaining this resource.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getConf

            +
            +public Configuration getConf()
            +
            +
            +

            +

            +
            Specified by:
            getConf in interface Kiji
            +
            +
            + +
            Returns:
            The hadoop configuration.
            +
            +
            +
            + +

            +getURI

            +
            +public KijiURI getURI()
            +
            +
            +

            +

            +
            Specified by:
            getURI in interface Kiji
            +
            +
            + +
            Returns:
            The address of this kiji instance, trimmed to the Kiji instance path component.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public KijiSchemaTable getSchemaTable()
+                               throws IOException
            +
            +
            Gets the schema table for this Kiji instance. +

            +

            +
            Specified by:
            getSchemaTable in interface Kiji
            +
            +
            + +
            Returns:
            The kiji schema table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getSystemTable

            +
            +public KijiSystemTable getSystemTable()
+                               throws IOException
            +
            +
            Gets the system table for this Kiji instance. +

            +

            +
            Specified by:
            getSystemTable in interface Kiji
            +
            +
            + +
            Returns:
            The kiji system table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMetaTable

            +
            +public KijiMetaTable getMetaTable()
+                           throws IOException
            +
            +
            Gets the meta table for this Kiji instance. +

            +

            +
            Specified by:
            getMetaTable in interface Kiji
            +
            +
            + +
            Returns:
            The kiji meta table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getHBaseAdmin

            +
            +public HBaseAdmin getHBaseAdmin()
+                         throws IOException
            +
            +
            Gets the current HBaseAdmin instance for this Kiji. This method will open a new + HBaseAdmin if one doesn't exist already. +

            +

            +
            +
            +
            + +
            Returns:
            The current HBaseAdmin instance for this Kiji. +
            Throws: +
            IOException - If there is an error opening the HBaseAdmin.
            +
            +
            +
            + +

            +openTable

            +
            +public KijiTable openTable(String tableName)
+                    throws IOException
            +
            +
            Opens a KijiTable by name. + +

            Clients must take care to close the KijiTable instance when finished.

            +

            +

            +
            Specified by:
            openTable in interface KijiTableFactory
            +
            +
            +
            Parameters:
            tableName - Name of the table to open. +
            Returns:
            the opened Kiji table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +createTable

            +
            +public void createTable(String tableName,
+                        KijiTableLayout tableLayout)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Specified by:
            createTable in interface Kiji
            +
            +
            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +createTable

            +
            +public void createTable(String tableName,
+                        KijiTableLayout tableLayout,
+                        int numRegions)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Specified by:
            createTable in interface Kiji
            +
            +
            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            numRegions - The initial number of regions to create. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +createTable

            +
            +public void createTable(String tableName,
+                        KijiTableLayout tableLayout,
+                        byte[][] splitKeys)
+                 throws IOException
            +
            +
            Creates a Kiji table in an HBase instance. +

            +

            +
            Specified by:
            createTable in interface Kiji
            +
            +
            +
            Parameters:
            tableName - The name of the table to create.
            tableLayout - The initial layout of the table (with unassigned column ids).
            splitKeys - The initial key boundaries between regions. There will be splitKeys + + 1 regions created. Pass null to specify the default single region. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +modifyTableLayout

            +
            +public KijiTableLayout modifyTableLayout(String tableName,
+                                         TableLayoutDesc update)
+                                  throws IOException
            +
            +
            Sets the layout of a table. +

            +

            +
            Specified by:
            modifyTableLayout in interface Kiji
            +
            +
            +
            Parameters:
            tableName - The name of the Kiji table to change the layout of.
            update - The new layout for the table. +
            Returns:
            the updated layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +modifyTableLayout

            +
            +public KijiTableLayout modifyTableLayout(String tableName,
+                                         TableLayoutDesc update,
+                                         boolean dryRun,
+                                         PrintStream printStream)
+                                  throws IOException
            +
            +
            Sets the layout of a table, or print the results of setting the table layout if + dryRun is true. +

            +

            +
            Specified by:
            modifyTableLayout in interface Kiji
            +
            +
            +
            Parameters:
            tableName - The name of the Kiji table to affect.
            update - The new layout for the table.
            dryRun - true if this is a 'dry run', false if changes should be made.
            printStream - the print stream to use for information if dryRun is true. + If null, stdout will be used. +
            Returns:
            the updated layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +deleteTable

            +
            +public void deleteTable(String tableName)
+                 throws IOException
            +
            +
            Deletes a Kiji table. Removes it from HBase. +

            +

            +
            Specified by:
            deleteTable in interface Kiji
            +
            +
            +
            Parameters:
            tableName - The name of the Kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableNames

            +
            +public List<String> getTableNames()
+                           throws IOException
            +
            +
            Gets the list of Kiji table names. +

            +

            +
            Specified by:
            getTableNames in interface Kiji
            +
            +
            + +
            Returns:
            A list of the names of Kiji tables installed in the Kiji instance. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +retain

            +
            +public Kiji retain()
            +
            +
            Expresses interest in retaining this resource. + + The resource will not be disposed until a call to release() happens +

            +

            +
            Specified by:
            retain in interface ReferenceCountable<Kiji>
            +
            +
            + +
            Returns:
            the retained resource.
            +
            +
            +
            + +

            +release

            +
            +public void release()
+             throws IOException
            +
            +
            Notifies this resource that we are no longer interested in it. + + This resource may be disposed if no other entity has expressed interest in using it. +

            +

            +
            Specified by:
            release in interface ReferenceCountable<Kiji>
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiFactory.html new file mode 100644 index 00000000..327503dd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiFactory.html @@ -0,0 +1,324 @@ + + + + + + + +HBaseKijiFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiFactory
+
            +
            +
            All Implemented Interfaces:
            org.kiji.delegation.PriorityProvider, KijiFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseKijiFactory
            extends Object
            implements KijiFactory
            + + +

            +Factory for constructing instances of HBaseKiji. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiFactory() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + intgetPriority(Map<String,String> runtimeHints) + +
            +          
            + Kijiopen(KijiURI uri) + +
            +          Opens a Kiji instance by URI.
            + Kijiopen(KijiURI uri, + Configuration conf) + +
            +          Opens a Kiji instance by URI.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiFactory

            +
            +public HBaseKijiFactory()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +open

            +
            +public Kiji open(KijiURI uri)
+          throws IOException
            +
            +
            Opens a Kiji instance by URI. +

            +

            +
            Specified by:
            open in interface KijiFactory
            +
            +
            +
            Parameters:
            uri - URI specifying the Kiji instance to open. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +open

            +
            +public Kiji open(KijiURI uri,
+                 Configuration conf)
+          throws IOException
            +
            +
            Opens a Kiji instance by URI. +

            +

            +
            Specified by:
            open in interface KijiFactory
            +
            +
            +
            Parameters:
            uri - URI specifying the Kiji instance to open.
            conf - Hadoop configuration. +
            Returns:
            the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getPriority

            +
            +public int getPriority(Map<String,String> runtimeHints)
            +
            +
            +

            +

            +
            Specified by:
            getPriority in interface org.kiji.delegation.PriorityProvider
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiPager.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiPager.html new file mode 100644 index 00000000..1a7847c0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiPager.html @@ -0,0 +1,387 @@ + + + + + + + +HBaseKijiPager (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiPager

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiPager
+
            +
            +
            All Implemented Interfaces:
            Closeable, Iterator<KijiRowData>, KijiPager
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseKijiPager
            extends Object
            implements KijiPager
            + + +

            +

            Implementation of a KijiPager for HBase.

            +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Constructor Summary
            +protected HBaseKijiPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HBaseKijiTable table, + KijiColumnName colName) + +
            +          Initializes a HBaseKijiPager.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + booleanhasNext() + +
            +          
            + KijiRowDatanext() + +
            +          
            + KijiRowDatanext(int pageSize) + +
            +          Gets the next page of results, with specified page size, for a column or family.
            + voidremove() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiPager

            +
            +protected HBaseKijiPager(EntityId entityId,
+                         KijiDataRequest dataRequest,
+                         KijiTableLayout tableLayout,
+                         HBaseKijiTable table,
+                         KijiColumnName colName)
+                  throws KijiColumnPagingNotEnabledException
            +
            +
            Initializes a HBaseKijiPager. To get a pager for a column with paging enabled, use the + .getPager() method on a KijiRowData. +

            +

            +
            Parameters:
            entityId - The entityId of the row.
            dataRequest - The requested data.
            tableLayout - Layout of the table the row belongs to.
            table - The Kiji table that this row belongs to.
            colName - Name of the paged column. +
            Throws: +
            KijiColumnPagingNotEnabledException - If paging is not enabled for the specified column.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +hasNext

            +
            +public boolean hasNext()
            +
            +
            +

            +

            +
            Specified by:
            hasNext in interface Iterator<KijiRowData>
            +
            +
            +
            +
            +
            +
            + +

            +next

            +
            +public KijiRowData next()
            +
            +
            +

            +

            +
            Specified by:
            next in interface Iterator<KijiRowData>
            +
            +
            +
            +
            +
            +
            + +

            +next

            +
            +public KijiRowData next(int pageSize)
            +
            +
            Gets the next page of results, with specified page size, for a column or family. The + KijiRowData returned may potentially have no values. This method does not throw a + NoSuchElementException. +

            +

            +
            Specified by:
            next in interface KijiPager
            +
            +
            +
            Parameters:
            pageSize - The number of cells to retrieve for this page. +
            Returns:
            The HBase result containing the next page of data, or an empty KijiRowData + if there is no more data.
            +
            +
            +
            + +

            +remove

            +
            +public void remove()
            +
            +
            +

            +

            +
            Specified by:
            remove in interface Iterator<KijiRowData>
            +
            +
            +
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiRowData.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiRowData.html new file mode 100644 index 00000000..89552f5c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiRowData.html @@ -0,0 +1,1150 @@ + + + + + + + +HBaseKijiRowData (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiRowData

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiRowData
+
            +
            +
            All Implemented Interfaces:
            KijiRowData
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseKijiRowData
            extends Object
            implements KijiRowData
            + + +

            +An implementation of KijiRowData that wraps an HBase Result object. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleancontainsCell(String family, + String qualifier, + long timestamp) + +
            +          Determines whether a particular column has data in this row with the specified timestamp.
            + booleancontainsColumn(String family) + +
            +          Determines whether a particular column family has data in this row.
            + booleancontainsColumn(String family, + String qualifier) + +
            +          Determines whether a particular column has data in this row.
            + + + + + +
            +<T> KijiCell<T>
            +            		getCell(String family, + String qualifier, + long timestamp) + +
            +          Gets the specified cell.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>>
            +            		getCells(String family) + +
            +          Gets all cells stored within the specified column family.
            + + + + + +
            +<T> NavigableMap<Long,KijiCell<T>>
            +            		getCells(String family, + String qualifier) + +
            +          Gets all cells stored within the specified column.
            + EntityIdgetEntityId() + +
            +          Gets the entity id for this row.
            + ResultgetHBaseResult() + +
            +          Gets the HBase result backing this KijiRowData.
            + NavigableMap<String,NavigableMap<String,NavigableMap<Long,byte[]>>>getMap() + +
            +          Gets a map from kiji family to qualifier to timestamp to raw kiji-encoded bytes of a cell.
            + + + + + +
            +<T> KijiCell<T>
            +            		getMostRecentCell(String family, + String qualifier) + +
            +          Gets the cell in the specified column with the latest timestamp.
            + + + + + +
            +<T> NavigableMap<String,KijiCell<T>>
            +            		getMostRecentCells(String family) + +
            +          Gets the cells in the specified column family flattened to contain only the cells with + the latest timestamp in each column.
            + + + + + +
            +<T> T
            +            		getMostRecentValue(String family, + String qualifier) + +
            +          Gets the data stored within the specified column with the latest timestamp.
            + + + + + +
            +<T> NavigableMap<String,T>
            +            		getMostRecentValues(String family) + +
            +          Gets all data stored within the specified column family flattened to contain only + the data with the latest timestamps in each column.
            + KijiPagergetPager(String family) + +
            +          Gets a KijiPager for the specified column family.
            + KijiPagergetPager(String family, + String qualifier) + +
            +          Gets a KijiPager for the specified column.
            + NavigableSet<String>getQualifiers(String family) + +
            +          Gets the set of column qualifiers that exist in a column family in this row.
            + org.apache.avro.SchemagetReaderSchema(String family, + String qualifier) + +
            +          Gets the reader schema for a column as declared in the layout of the table this row + comes from.
            + KijiSchemaTablegetSchemaTable() + +
            +          Gets the schema table this kiji row data uses for decoding.
            + KijiTableLayoutgetTableLayout() + +
            +          Gets the layout of the table this row data belongs to.
            + NavigableSet<Long>getTimestamps(String family, + String qualifier) + +
            +          Gets the set of timestamps on cells that exist in a column.
            + + + + + +
            +<T> T
            +            		getValue(String family, + String qualifier, + long timestamp) + +
            +          Gets the data stored within the specified column with the specified timestamp.
            + + + + + +
            +<T> NavigableMap<String,NavigableMap<Long,T>>
            +            		getValues(String family) + +
            +          Gets all data stored within the specified column family.
            + + + + + +
            +<T> NavigableMap<Long,T>
            +            		getValues(String family, + String qualifier) + +
            +          Gets all data stored within the specified column.
            + voidmerge(Collection<KeyValue> keyValues) + +
            +          Merges in the data from a collection of KeyValues.
            + voidmerge(HBaseKijiRowData kijiRowData) + +
            +          Merges in the data from another HBaseKijiRowData instance.
            + voidmerge(Put put) + +
            +          Merges in the data an HBase Put object.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiRowData

            +
            +@Deprecated
+public HBaseKijiRowData(EntityId entityId,
+                                   KijiDataRequest request,
+                                   KijiCellDecoderFactory decoderFactory,
+                                   KijiTableLayout layout,
+                                   Result result,
+                                   KijiSchemaTable schemaTable)
            +
            +
            Deprecated.  +

            +

            Initializes a row data. +

            +

            +
            Parameters:
            entityId - Entity ID of the row.
            request - Data request to build the row.
            decoderFactory - Factory for cell decoders.
            layout - Layout of the table the row belongs to.
            result - HTable result with the encoded row content.
            schemaTable - Schema table.
            +
            +
            + +

            +HBaseKijiRowData

            +
            +@Deprecated
+public HBaseKijiRowData(KijiDataRequest request,
+                                   KijiCellDecoderFactory decoderFactory,
+                                   KijiTableLayout layout,
+                                   Result result,
+                                   KijiSchemaTable schemaTable)
            +
            +
            Deprecated.  +

            +

            Initializes a row data. + + The entity ID is constructed from the HTable encoded result. + This may fail if the table uses hashed row keys. +

            +

            +
            Parameters:
            request - Data request to build the row.
            decoderFactory - Factory for cell decoders.
            layout - Layout of the table the row belongs to.
            result - HTable result with the encoded row content.
            schemaTable - Schema table.
            +
            +
            + +

            +HBaseKijiRowData

            +
            +public HBaseKijiRowData(EntityId entityId,
+                        KijiDataRequest request,
+                        HBaseKijiTable table,
+                        Result result)
            +
            +
            Initializes a row data. +

            +

            +
            Parameters:
            entityId - The entityId of the row.
            request - The requested data.
            table - The Kiji table that this row belongs to.
            result - The HBase result containing the row data.
            +
            +
            + +

            +HBaseKijiRowData

            +
            +public HBaseKijiRowData(KijiDataRequest request,
+                        HBaseKijiTable table,
+                        Result result)
+                 throws IOException
            +
            +
            Initializes a row data. + + The entity ID is constructed from the HTable encoded result. + This may fail if the table uses hashed row keys. +

            +

            +
            Parameters:
            request - The requested data.
            table - The Kiji table that this row belongs to.
            result - The HBase result containing the row data. +
            Throws: +
            IOException - If there is an error reading the entityId from the hbase result.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getHBaseResult

            +
            +public Result getHBaseResult()
            +
            +
            Gets the HBase result backing this KijiRowData. +

            +

            +
            +
            +
            + +
            Returns:
            The HBase result.
            +
            +
            +
            + +

            +getEntityId

            +
            +public EntityId getEntityId()
            +
            +
            Gets the entity id for this row. +

            +

            +
            Specified by:
            getEntityId in interface KijiRowData
            +
            +
            + +
            Returns:
            The row key.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout()
            +
            +
            Gets the layout of the table this row data belongs to. +

            +

            +
            +
            +
            + +
            Returns:
            The table layout.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public KijiSchemaTable getSchemaTable()
            +
            +
            Gets the schema table this kiji row data uses for decoding. +

            +

            +
            +
            +
            + +
            Returns:
            The schema table.
            +
            +
            +
            + +

            +merge

            +
            +public void merge(HBaseKijiRowData kijiRowData)
            +
            +
            Merges in the data from another HBaseKijiRowData instance. +

            +

            +
            +
            +
            +
            Parameters:
            kijiRowData - The data to merge in.
            +
            +
            +
            + +

            +merge

            +
            +public void merge(Put put)
            +
            +
            Merges in the data an HBase Put object. +

            +

            +
            +
            +
            +
            Parameters:
            put - The data to merge in.
            +
            +
            +
            + +

            +merge

            +
            +public void merge(Collection<KeyValue> keyValues)
            +
            +
            Merges in the data from a collection of KeyValues. +

            +

            +
            +
            +
            +
            Parameters:
            keyValues - The data to merge in.
            +
            +
            +
            + +

            +getMap

            +
            +public NavigableMap<String,NavigableMap<String,NavigableMap<Long,byte[]>>> getMap()
            +
            +
            Gets a map from kiji family to qualifier to timestamp to raw kiji-encoded bytes of a cell. +

            +

            +
            +
            +
            + +
            Returns:
            The map.
            +
            +
            +
            + +

            +containsColumn

            +
            +public boolean containsColumn(String family,
+                              String qualifier)
            +
            +
            Determines whether a particular column has data in this row. +

            +

            +
            Specified by:
            containsColumn in interface KijiRowData
            +
            +
            +
            Parameters:
            family - Column family of the column to check for.
            qualifier - Column qualifier of the column to check for. +
            Returns:
            Whether the specified column has data in this row.
            +
            +
            +
            + +

            +containsColumn

            +
            +public boolean containsColumn(String family)
            +
            +
            Determines whether a particular column family has data in this row. +

            +

            +
            Specified by:
            containsColumn in interface KijiRowData
            +
            +
            +
            Parameters:
            family - Column family to check for. +
            Returns:
            Whether the specified column family has data in this row.
            +
            +
            +
            + +

            +containsCell

            +
            +public boolean containsCell(String family,
+                            String qualifier,
+                            long timestamp)
            +
            +
            Determines whether a particular column has data in this row with the specified timestamp. +

            +

            +
            Specified by:
            containsCell in interface KijiRowData
            +
            +
            +
            Parameters:
            family - Column family of the column to check for.
            qualifier - Column qualifier of the column to check for.
            timestamp - Timestamp of the value to check for. +
            Returns:
            Whether the specified column has data in this row with the specified timestamp.
            +
            +
            +
            + +

            +getQualifiers

            +
            +public NavigableSet<String> getQualifiers(String family)
            +
            +
            Gets the set of column qualifiers that exist in a column family in this row. +

            +

            +
            Specified by:
            getQualifiers in interface KijiRowData
            +
            +
            +
            Parameters:
            family - Column family to get column qualifiers from. +
            Returns:
            Set of column qualifiers that exist in the family column family.
            +
            +
            +
            + +

            +getTimestamps

            +
            +public NavigableSet<Long> getTimestamps(String family,
+                                        String qualifier)
            +
            +
            Gets the set of timestamps on cells that exist in a column. + +

            + If iterating over the set, you will get timestamps in descending order. +

            +

            +

            +
            Specified by:
            getTimestamps in interface KijiRowData
            +
            +
            +
            Parameters:
            family - Column family of the column to get timestamps from.
            qualifier - Column qualifier of the column to get timestamps from. +
            Returns:
            Set of all timestamps of cells in the family:qualifier column + in this row in descending order.
            +
            +
            +
            + +

            +getReaderSchema

            +
            +public org.apache.avro.Schema getReaderSchema(String family,
+                                              String qualifier)
+                                       throws IOException
            +
            +
            Gets the reader schema for a column as declared in the layout of the table this row + comes from. +

            +

            +
            Specified by:
            getReaderSchema in interface KijiRowData
            +
            +
            +
            Parameters:
            family - Column family of the desired column schema.
            qualifier - Column qualifier of the desired column schema. +
            Returns:
            Avro reader schema for the column. +
            Throws: +
            IOException - If there is an error or the column does not exist.
            See Also:
            KijiTableLayout
            +
            +
            +
            + +

            +getValue

            +
            +public <T> T getValue(String family,
+                      String qualifier,
+                      long timestamp)
+           throws IOException
            +
            +
            Gets the data stored within the specified column with the specified timestamp. +

            +

            +
            Specified by:
            getValue in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - Type of the data stored at the specified coordinates.
            Parameters:
            family - Column family of the desired data.
            qualifier - Column qualifier of the desired data.
            timestamp - Timestamp of the desired data. +
            Returns:
            Data contained in the specified column with the specified timestamp, or null + if the column or timestamp does not exist in this row. Note: this method does not + distinguish between Avro encoded nulls and non-existant cells. Use + KijiRowData.containsColumn(String, String) to distinguish between these scenarios. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCell

            +
            +public <T> KijiCell<T> getCell(String family,
+                               String qualifier,
+                               long timestamp)
+                    throws IOException
            +
            +
            Gets the specified cell. +

            +

            +
            Specified by:
            getCell in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - Type of the cell stored at the specified coordinates.
            Parameters:
            family - Column family of the desired cell.
            qualifier - Column qualifier of the desired cell.
            timestamp - Timestamp of the desired cell. +
            Returns:
            Specified cell, or null if the cell does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValue

            +
            +public <T> T getMostRecentValue(String family,
+                                String qualifier)
+                     throws IOException
            +
            +
            Gets the data stored within the specified column with the latest timestamp. +

            +

            +
            Specified by:
            getMostRecentValue in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - Type of the data stored at the specified coordinates.
            Parameters:
            family - Column family of the desired data.
            qualifier - Column qualifier of the desired data. +
            Returns:
            Data contained in the specified column with the latest timestamp, or null + if the column does not exist in this row. Note: this method does not distinguish + between Avro encoded nulls and non-existant cells. Use + KijiRowData.containsColumn(String, String) to distinguish between these scenarios. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentValues

            +
            +public <T> NavigableMap<String,T> getMostRecentValues(String family)
+                                           throws IOException
            +
            +
            Gets all data stored within the specified column family flattened to contain only + the data with the latest timestamps in each column. +

            +

            +
            Specified by:
            getMostRecentValues in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - Type of the data stored at the specified coordinates.
            Parameters:
            family - Column family of the desired data. +
            Returns:
            Data contained in the specified column family flattened to contain only the + data with the latest timestamps in each column. Note: this method does not distinguish + between Avro encoded nulls and non-existant cells. Use + KijiRowData.containsColumn(String, String) to distinguish between these scenarios. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public <T> NavigableMap<Long,T> getValues(String family,
+                                          String qualifier)
+                               throws IOException
            +
            +
            Gets all data stored within the specified column. +

            +

            +
            Specified by:
            getValues in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - Type of the data stored at the specified coordinates.
            Parameters:
            family - Column family of the desired data.
            qualifier - Column qualifier of the desired data. +
            Returns:
            A sorted map containing the data stored in the specified column. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public <T> NavigableMap<String,NavigableMap<Long,T>> getValues(String family)
+                                                    throws IOException
            +
            +
            Gets all data stored within the specified column family. +

            +

            +
            Specified by:
            getValues in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - Type of the data stored at the specified coordinates.
            Parameters:
            family - Column family of the desired data. +
            Returns:
            A sorted map containing the data stored in the specified column family. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCell

            +
            +public <T> KijiCell<T> getMostRecentCell(String family,
+                                         String qualifier)
+                              throws IOException
            +
            +
            Gets the cell in the specified column with the latest timestamp. +

            +

            +
            Specified by:
            getMostRecentCell in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - Type of the cell stored at the specified coordinates.
            Parameters:
            family - Column family of the desired cell.
            qualifier - Column qualifier of the desired cell. +
            Returns:
            Cell in the specified column with the latest timestamp, or null if the cell + does not exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getMostRecentCells

            +
            +public <T> NavigableMap<String,KijiCell<T>> getMostRecentCells(String family)
+                                                    throws IOException
            +
            +
            Gets the cells in the specified column family flattened to contain only the cells with + the latest timestamp in each column. +

            +

            +
            Specified by:
            getMostRecentCells in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - Type of the cells stored at the specified coordinates.
            Parameters:
            family - Column family of the desired cells. +
            Returns:
            Map from column qualifier to the most recent versions of the cells. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +public <T> NavigableMap<Long,KijiCell<T>> getCells(String family,
+                                                   String qualifier)
+                                        throws IOException
            +
            +
            Gets all cells stored within the specified column. +

            +

            +
            Specified by:
            getCells in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - Type of the cells stored at the specified coordinates.
            Parameters:
            family - Column family of the desired cells.
            qualifier - Column qualifier of the desired cells. +
            Returns:
            A sorted map containing the cells stored in the specified column. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getCells

            +
            +public <T> NavigableMap<String,NavigableMap<Long,KijiCell<T>>> getCells(String family)
+                                                             throws IOException
            +
            +
            Gets all cells stored within the specified column family. +

            +

            +
            Specified by:
            getCells in interface KijiRowData
            +
            +
            +
            Type Parameters:
            T - Type of the cells stored at the specified coordinates.
            Parameters:
            family - Column family of the desired cells. +
            Returns:
            Sorted map versions of the specified cell. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getPager

            +
            +public KijiPager getPager(String family,
+                          String qualifier)
+                   throws KijiColumnPagingNotEnabledException
            +
            +
            Gets a KijiPager for the specified column. +

            +

            +
            Specified by:
            getPager in interface KijiRowData
            +
            +
            +
            Parameters:
            family - Desired column family.
            qualifier - Desired column qualifier. +
            Returns:
            A pager for the specified column. +
            Throws: +
            KijiColumnPagingNotEnabledException - If paging is not enabled for the + specified column.
            See Also:
            For more information about paging.
            +
            +
            +
            + +

            +getPager

            +
            +public KijiPager getPager(String family)
+                   throws KijiColumnPagingNotEnabledException
            +
            +
            Gets a KijiPager for the specified column family. +

            +

            +
            Specified by:
            getPager in interface KijiRowData
            +
            +
            +
            Parameters:
            family - Desired column family. +
            Returns:
            A pager for the specified column. +
            Throws: +
            KijiColumnPagingNotEnabledException - If paging is not enabled for the + specified column family.
            See Also:
            For more information about paging.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html new file mode 100644 index 00000000..c0c7eabb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiRowScanner.Options.html @@ -0,0 +1,417 @@ + + + + + + + +HBaseKijiRowScanner.Options (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiRowScanner.Options

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiRowScanner.Options
+
            +
            +
            Enclosing class:
            HBaseKijiRowScanner
            +
            +
            +
            +
            public static class HBaseKijiRowScanner.Options
            extends Object
            + + +

            +A class to encapsulate the various options the HBaseKijiRowScanner constructor requires. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiRowScanner.Options() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiCellDecoderFactorygetCellDecoderFactory() + +
            +          Gets the cell decoder factory.
            + KijiDataRequestgetDataRequest() + +
            +          Gets the data request.
            + ResultScannergetHBaseResultScanner() + +
            +          Gets the HBase result scanner.
            + HBaseKijiTablegetTable() + +
            +          Gets the table being scanned.
            + HBaseKijiRowScanner.OptionswithCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory) + +
            +          Sets the cell decoder factory to use when reading cells from the scanner.
            + HBaseKijiRowScanner.OptionswithDataRequest(KijiDataRequest dataRequest) + +
            +          Sets the data request used to generate the KijiRowScanner.
            + HBaseKijiRowScanner.OptionswithHBaseResultScanner(ResultScanner hbaseResultScanner) + +
            +          Sets the HBase result scanner the KijiRowScanner will wrap.
            + HBaseKijiRowScanner.OptionswithTable(HBaseKijiTable table) + +
            +          Sets the table being scanned.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiRowScanner.Options

            +
            +public HBaseKijiRowScanner.Options()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +withHBaseResultScanner

            +
            +public HBaseKijiRowScanner.Options withHBaseResultScanner(ResultScanner hbaseResultScanner)
            +
            +
            Sets the HBase result scanner the KijiRowScanner will wrap. +

            +

            +
            Parameters:
            hbaseResultScanner - An HBase result scanner. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +withDataRequest

            +
            +public HBaseKijiRowScanner.Options withDataRequest(KijiDataRequest dataRequest)
            +
            +
            Sets the data request used to generate the KijiRowScanner. +

            +

            +
            Parameters:
            dataRequest - A data request. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +withTable

            +
            +public HBaseKijiRowScanner.Options withTable(HBaseKijiTable table)
            +
            +
            Sets the table being scanned. +

            +

            +
            Parameters:
            table - The table being scanned. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +withCellDecoderFactory

            +
            +public HBaseKijiRowScanner.Options withCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory)
            +
            +
            Sets the cell decoder factory to use when reading cells from the scanner. +

            +

            +
            Parameters:
            cellDecoderFactory - A cell decoder factory. +
            Returns:
            This options instance.
            +
            +
            +
            + +

            +getHBaseResultScanner

            +
            +public ResultScanner getHBaseResultScanner()
            +
            +
            Gets the HBase result scanner. +

            +

            + +
            Returns:
            The HBase result scanner.
            +
            +
            +
            + +

            +getDataRequest

            +
            +public KijiDataRequest getDataRequest()
            +
            +
            Gets the data request. +

            +

            + +
            Returns:
            The data request.
            +
            +
            +
            + +

            +getTable

            +
            +public HBaseKijiTable getTable()
            +
            +
            Gets the table being scanned. +

            +

            + +
            Returns:
            The Kiji table.
            +
            +
            +
            + +

            +getCellDecoderFactory

            +
            +public KijiCellDecoderFactory getCellDecoderFactory()
            +
            +
            Gets the cell decoder factory. +

            +

            + +
            Returns:
            The cell decoder factory.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiRowScanner.html new file mode 100644 index 00000000..cafa2c67 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiRowScanner.html @@ -0,0 +1,341 @@ + + + + + + + +HBaseKijiRowScanner (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiRowScanner

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiRowScanner
+
            +
            +
            All Implemented Interfaces:
            Closeable, Iterable<KijiRowData>, KijiRowScanner
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseKijiRowScanner
            extends Object
            implements KijiRowScanner
            + + +

            +The internal implementation of KijiRowScanner that reads from HTables. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classHBaseKijiRowScanner.Options + +
            +          A class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            +  + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiRowScanner(HBaseKijiRowScanner.Options options) + +
            +          Creates a new KijiRowScanner instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Closes this scanner and releases any system resources associated with it.
            +protected  voidfinalize() + +
            +          
            + org.kiji.schema.impl.HBaseKijiRowScanner.KijiRowIteratoriterator() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiRowScanner

            +
            +public HBaseKijiRowScanner(HBaseKijiRowScanner.Options options)
            +
            +
            Creates a new KijiRowScanner instance. +

            +

            +
            Parameters:
            options - The options for this scanner.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +iterator

            +
            +public org.kiji.schema.impl.HBaseKijiRowScanner.KijiRowIterator iterator()
            +
            +
            +

            +

            +
            Specified by:
            iterator in interface Iterable<KijiRowData>
            +
            +
            +
            +
            +
            +
            + +

            +close

            +
            +public void close()
            +
            +
            Closes this scanner and releases any system resources associated with it. + +

            Calling this method when you are finished with the scanner is important. + See http://hbase.apache.org/book.html#perf.hbase.client.scannerclose for details.

            +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in interface KijiRowScanner
            +
            +
            +
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiTable.html new file mode 100644 index 00000000..ea3fcec1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiTable.html @@ -0,0 +1,430 @@ + + + + + + + +HBaseKijiTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AbstractKijiTable
+      extended by org.kiji.schema.impl.HBaseKijiTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseKijiTable
            extends AbstractKijiTable
            + + +

            +

            A KijiTable that exposes the underlying HBase implementation.

            + +

            Within the internal Kiji code, we use this class so that we have + access to the HTable interface. Methods that Kiji clients should + have access to should be added to org.kiji.schema.KijiTable.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +static HBaseKijiTabledowncast(KijiTable kijiTable) + +
            +          We know that all KijiTables are really HBaseKijiTables + instances.
            + EntityIdgetEntityId(Object... kijiRowKey) + +
            +          Creates an entity id from a list of components.
            + HTableInterfacegetHTable() + +
            +           
            + KijiTableLayoutgetLayout() + +
            +          
            + List<KijiRegion>getRegions() + +
            +          Return the regions in this table as a list.
            + KijiTableReaderopenTableReader() + +
            +          Opens a KijiTableReader for this table.
            + KijiTableWriteropenTableWriter() + +
            +          Opens a KijiTableWriter for this table.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.impl.AbstractKijiTable
            equals, finalize, getKiji, getName, getURI, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, getClass, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEntityId

            +
            +public EntityId getEntityId(Object... kijiRowKey)
            +
            +
            Creates an entity id from a list of components. +

            +

            +
            Specified by:
            getEntityId in interface KijiTable
            Specified by:
            getEntityId in class AbstractKijiTable
            +
            +
            +
            Parameters:
            kijiRowKey - This can be one of the following depending on row key encoding: +
              +
            • + Raw, Hash, Hash-Prefix EntityId: A single String or byte array + component. +
              • +
            • + Formatted EntityId: The primitive row key components (string, int, + long) either passed in their expected order in the key or as an ordered + list of components. +
              • +
            +
            Returns:
            a new EntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +downcast

            +
            +public static HBaseKijiTable downcast(KijiTable kijiTable)
            +
            +
            We know that all KijiTables are really HBaseKijiTables + instances. This is a convenience method for downcasting, which + is common within the internals of Kiji code. +

            +

            +
            Parameters:
            kijiTable - The Kiji table to downcast to an HBaseKijiTable. +
            Returns:
            The given Kiji table as an HBaseKijiTable.
            +
            +
            +
            + +

            +getHTable

            +
            +public HTableInterface getHTable()
            +
            +
            + +
            Returns:
            The underlying HTable instance.
            +
            +
            +
            + +

            +getLayout

            +
            +public KijiTableLayout getLayout()
            +
            +
            +

            +

            + +
            Returns:
            the layout of this table.
            +
            +
            +
            + +

            +openTableReader

            +
            +public KijiTableReader openTableReader()
            +
            +
            Opens a KijiTableReader for this table. The caller of this method is responsible + for closing the returned reader. +

            +

            + +
            Returns:
            A KijiTableReader for this table.
            +
            +
            +
            + +

            +openTableWriter

            +
            +public KijiTableWriter openTableWriter()
+                                throws IOException
            +
            +
            Opens a KijiTableWriter for this table. The caller of this method is responsible + for closing the returned writer. +

            +

            + +
            Returns:
            A KijiTableWriter for this table. +
            Throws: +
            IOException - If there is an error opening the writer.
            +
            +
            +
            + +

            +getRegions

            +
            +public List<KijiRegion> getRegions()
+                            throws IOException
            +
            +
            Return the regions in this table as a list. + +

            This method was copied from HFileOutputFormat of 0.90.1-cdh3u0 and modified to + return KijiRegion instead of ImmutableBytesWritable.

            +

            +

            + +
            Returns:
            An ordered list of the table regions. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Overrides:
            close in class AbstractKijiTable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiTableReader.html new file mode 100644 index 00000000..6e68291a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiTableReader.html @@ -0,0 +1,413 @@ + + + + + + + +HBaseKijiTableReader (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiTableReader

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiTableReader
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTableReader
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseKijiTableReader
            extends Object
            implements KijiTableReader
            + + +

            +Reads from a kiji table by sending the requests directly to the HBase tables. +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from interface org.kiji.schema.KijiTableReader
            KijiTableReader.KijiScannerOptions
            +  + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiTableReader(HBaseKijiTable table) + +
            +          Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + List<KijiRowData>bulkGet(List<EntityId> entityIds, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a list of rows in the kiji table.
            + voidclose() + +
            +          
            + KijiRowDataget(EntityId entityId, + KijiDataRequest dataRequest) + +
            +          Retrieves data from a single row in the kiji table.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest) + +
            +          Gets a KijiRowScanner with the specified data request.
            + KijiRowScannergetScanner(KijiDataRequest dataRequest, + KijiTableReader.KijiScannerOptions kijiScannerOptions) + +
            +          Gets a KijiRowScanner using the specified data request and options.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiTableReader

            +
            +public HBaseKijiTableReader(HBaseKijiTable table)
            +
            +
            Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase. +

            +

            +
            Parameters:
            table - The kiji table to read from.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +get

            +
            +public KijiRowData get(EntityId entityId,
+                       KijiDataRequest dataRequest)
+                throws IOException
            +
            +
            Retrieves data from a single row in the kiji table. +

            +

            +
            Specified by:
            get in interface KijiTableReader
            +
            +
            +
            Parameters:
            entityId - The entity id for the row to get data from.
            dataRequest - Specifies the columns of data to retrieve. +
            Returns:
            The requested data. If there is no row for the specified entityId, this + will return an empty KijiRowData. (containsColumn() will return false for all + columns.) +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +bulkGet

            +
            +public List<KijiRowData> bulkGet(List<EntityId> entityIds,
+                                 KijiDataRequest dataRequest)
+                          throws IOException
            +
            +
            Retrieves data from a list of rows in the kiji table. +

            +

            +
            Specified by:
            bulkGet in interface KijiTableReader
            +
            +
            +
            Parameters:
            entityIds - The list of entity ids to collect data for.
            dataRequest - Specifies constraints on the data to retrieve for each entity id. +
            Returns:
            The requested data. If an EntityId specified in entityIds + does not exist, then the corresponding KijiRowData will be empty. + If a get fails, then the corresponding KijiRowData will be null (instead of empty). +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +getScanner

            +
            +public KijiRowScanner getScanner(KijiDataRequest dataRequest)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner with the specified data request. +

            +

            +
            Specified by:
            getScanner in interface KijiTableReader
            +
            +
            +
            Parameters:
            dataRequest - The data request to scan for. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +getScanner

            +
            +public KijiRowScanner getScanner(KijiDataRequest dataRequest,
+                                 KijiTableReader.KijiScannerOptions kijiScannerOptions)
+                          throws IOException
            +
            +
            Gets a KijiRowScanner using the specified data request and options. +

            +

            +
            Specified by:
            getScanner in interface KijiTableReader
            +
            +
            +
            Parameters:
            dataRequest - The data request to scan for.
            kijiScannerOptions - Other options for the scanner. +
            Returns:
            The KijiRowScanner. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiTableWriter.html new file mode 100644 index 00000000..350304b4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseKijiTableWriter.html @@ -0,0 +1,662 @@ + + + + + + + +HBaseKijiTableWriter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseKijiTableWriter

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseKijiTableWriter
+
            +
            +
            All Implemented Interfaces:
            Closeable, Flushable, KijiDeleter, KijiIncrementer, KijiPutter, KijiTableWriter
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseKijiTableWriter
            extends Object
            implements KijiTableWriter
            + + +

            +Makes modifications to a Kiji table by sending requests directly to HBase from the local client. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HBaseKijiTableWriter(KijiTable table) + +
            +          Creates a non-buffered kiji table writer that sends modifications directly to Kiji.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +           
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes the most recent version of the cell in a column.
            + voiddeleteCell(EntityId entityId, + String family, + String qualifier, + long timestamp) + +
            +          Deletes a single cell with a specified timestamp.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier) + +
            +          Deletes all versions of all cells in a column.
            + voiddeleteColumn(EntityId entityId, + String family, + String qualifier, + long upToTimestamp) + +
            +          Deletes all cells with a timestamp less than or equal to the specified timestamp.
            + voiddeleteFamily(EntityId entityId, + String family) + +
            +          Deletes all versions of all cells in a family.
            + voiddeleteFamily(EntityId entityId, + String family, + long upToTimestamp) + +
            +          Deletes all cells from a family with a timestamp less than or equal to the specified timestamp.
            + voiddeleteRow(EntityId entityId) + +
            +          Deletes an entire row.
            + voiddeleteRow(EntityId entityId, + long upToTimestamp) + +
            +          Delete all cells from a row with a timestamp less than or equal to the specified timestamp.
            + voidflush() + +
            +           
            + KijiCell<Long>increment(EntityId entityId, + String family, + String qualifier, + long amount) + +
            +          Atomically increments a counter in a kiji table.
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + long timestamp, + T value) + +
            +          Puts data into a kiji table.
            + + + + + +
            +<T> void
            +            		put(EntityId entityId, + String family, + String qualifier, + T value) + +
            +          Puts data into a kiji table.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseKijiTableWriter

            +
            +public HBaseKijiTableWriter(KijiTable table)
+                     throws IOException
            +
            +
            Creates a non-buffered kiji table writer that sends modifications directly to Kiji. +

            +

            +
            Parameters:
            table - A kiji table. +
            Throws: +
            IOException - If there is an error creating the writer.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +put

            +
            +public <T> void put(EntityId entityId,
+                    String family,
+                    String qualifier,
+                    T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            Specified by:
            put in interface KijiPutter
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +put

            +
            +public <T> void put(EntityId entityId,
+                    String family,
+                    String qualifier,
+                    long timestamp,
+                    T value)
+         throws IOException
            +
            +
            Puts data into a kiji table. +

            +

            +
            Specified by:
            put in interface KijiPutter
            +
            +
            +
            Type Parameters:
            T - The type of the value being written.
            Parameters:
            entityId - The entity (row) to put data into.
            family - A column family.
            qualifier - A column qualifier.
            timestamp - Timestamp, in millisecond since the Epoch.
            value - The data to write. +
            Throws: +
            IOException - If there is an IO error.
            +
            +
            +
            + +

            +increment

            +
            +public KijiCell<Long> increment(EntityId entityId,
+                                String family,
+                                String qualifier,
+                                long amount)
+                         throws IOException
            +
            +
            Atomically increments a counter in a kiji table. + +

            Throws an exception if the specified column is not a counter.

            +

            +

            +
            Specified by:
            increment in interface KijiIncrementer
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row containing the counter.
            family - Column family.
            qualifier - Column qualifier.
            amount - Amount to increment the counter (may be negative). +
            Returns:
            the new counter value, post increment. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteRow

            +
            +public void deleteRow(EntityId entityId)
+               throws IOException
            +
            +
            Deletes an entire row. +

            +

            +
            Specified by:
            deleteRow in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteRow

            +
            +public void deleteRow(EntityId entityId,
+                      long upToTimestamp)
+               throws IOException
            +
            +
            Delete all cells from a row with a timestamp less than or equal to the specified timestamp. +

            +

            +
            Specified by:
            deleteRow in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +public void deleteFamily(EntityId entityId,
+                         String family)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a family. +

            +

            +
            Specified by:
            deleteFamily in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteFamily

            +
            +public void deleteFamily(EntityId entityId,
+                         String family,
+                         long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells from a family with a timestamp less than or equal to the specified timestamp. +

            +

            +
            Specified by:
            deleteFamily in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +public void deleteColumn(EntityId entityId,
+                         String family,
+                         String qualifier)
+                  throws IOException
            +
            +
            Deletes all versions of all cells in a column. +

            +

            +
            Specified by:
            deleteColumn in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteColumn

            +
            +public void deleteColumn(EntityId entityId,
+                         String family,
+                         String qualifier,
+                         long upToTimestamp)
+                  throws IOException
            +
            +
            Deletes all cells with a timestamp less than or equal to the specified timestamp. +

            +

            +
            Specified by:
            deleteColumn in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            upToTimestamp - Delete cells with a timestamp older or equal to this parameter. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +public void deleteCell(EntityId entityId,
+                       String family,
+                       String qualifier)
+                throws IOException
            +
            +
            Deletes the most recent version of the cell in a column. +

            +

            +
            Specified by:
            deleteCell in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteCell

            +
            +public void deleteCell(EntityId entityId,
+                       String family,
+                       String qualifier,
+                       long timestamp)
+                throws IOException
            +
            +
            Deletes a single cell with a specified timestamp. +

            +

            +
            Specified by:
            deleteCell in interface KijiDeleter
            +
            +
            +
            Parameters:
            entityId - Entity ID of the row to delete data from.
            family - Column family.
            qualifier - Column qualifier.
            timestamp - The timestamp of the cell to delete (use HConstants.LATEST_TIMESTAMP + to delete the most recent cell in the column). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            +
            Specified by:
            flush in interface Flushable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseMetaTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseMetaTable.html new file mode 100644 index 00000000..43c7a6a2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseMetaTable.html @@ -0,0 +1,1020 @@ + + + + + + + +HBaseMetaTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseMetaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiMetaTable
+      extended by org.kiji.schema.impl.HBaseMetaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable, KijiTableKeyValueDatabase, KijiTableLayoutDatabase
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseMetaTable
            extends KijiMetaTable
            + + +

            +An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseMetaTable(HTableInterface htable, + KijiSchemaTable schemaTable) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseMetaTable(HTableInterface htable, + KijiTableLayoutDatabase tableLayoutDatabase, + KijiTableKeyValueDatabase tableKeyValueDatabase) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseMetaTable(KijiURI kijiURI, + Configuration conf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + voiddeleteTable(String table) + +
            +          Remove all metadata, including layouts, for a particular table.
            + voidfromBackup(Map<String,TableBackup> backup) + +
            +          Restores metadata from a backup record.
            + KijiTableLayoutgetTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + List<KijiTableLayout>getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            + NavigableMap<Long,byte[]>getTimedValues(String table, + String key, + int numVersions) + +
            +          Returns a map of values associated with the specified table and key.
            + byte[]getValue(String table, + String key) + +
            +          Returns the most recent value associated with the specified table and key.
            + List<byte[]>getValues(String table, + String key, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key.
            +static voidinstall(HBaseAdmin admin, + KijiURI uri) + +
            +          Install the meta table into a Kiji instance.
            + Set<String>keySet(String table) + +
            +          Returns a set view of keys contained in the map for the specified table.
            + voidkeyValuesFromBackup(String table, + List<KeyValueBackupEntry> tableBackup) + +
            +          Restores all table's key value history from a backup.
            + List<KeyValueBackupEntry>keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + voidlayoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +          Restores a table layout history from a backup.
            + List<TableLayoutBackupEntry>layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            + List<String>listTables() + +
            +          Lists the tables in this Kiji instance.
            +static HTableInterfacenewMetaTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTableInterface for the specified table.
            + KijiTableKeyValueDatabaseputValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + voidremoveAllTableLayoutVersions(String table) + +
            +          Removes all layout information for a particular table.
            + voidremoveAllValues(String table) + +
            +          Deletes all key-value pairs associated with the specified table.
            + voidremoveRecentTableLayoutVersions(String table, + int numVersions) + +
            +          Removes the most recent layout information for a given table.
            + voidremoveValues(String table, + String key) + +
            +          Removes all values associated with the specified table and key.
            + Set<String>tableSet() + +
            +          Returns a set view of the tables that have key-value pairs defined.
            + Map<String,TableBackup>toBackup() + +
            +          Returns metadata backup information in a form that can be directly written to a MetadataBackup + record.
            +static voiduninstall(HBaseAdmin admin, + KijiURI uri) + +
            +          Removes the meta table from HBase.
            + KijiTableLayoutupdateTableLayout(String table, + TableLayoutDesc layoutUpdate) + +
            +          Sets a table's layout.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.KijiMetaTable
            finalize
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HBaseMetaTable

            +
            +public HBaseMetaTable(KijiURI kijiURI,
+                      Configuration conf,
+                      KijiSchemaTable schemaTable,
+                      HTableInterfaceFactory factory)
+               throws IOException
            +
            +
            Create a connection to a Kiji meta table backed by an HTable within HBase. +

            +

            +
            Parameters:
            kijiURI - The KijiURI.
            conf - The Hadoop configuration.
            schemaTable - The Kiji schema table.
            factory - HTableInterface factory. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +

            +HBaseMetaTable

            +
            +public HBaseMetaTable(HTableInterface htable,
+                      KijiSchemaTable schemaTable)
+               throws IOException
            +
            +
            Create a connection to a Kiji meta table backed by an HTable within HBase. + +

            This class takes ownership of the HTable. It will be closed when this instance is + closed.

            +

            +

            +
            Parameters:
            htable - The HTable to use for storing Kiji meta data.
            schemaTable - The Kiji schema table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +

            +HBaseMetaTable

            +
            +public HBaseMetaTable(HTableInterface htable,
+                      KijiTableLayoutDatabase tableLayoutDatabase,
+                      KijiTableKeyValueDatabase tableKeyValueDatabase)
            +
            +
            Create a connection to a Kiji meta table backed by an HTable within HBase. + +

            This class takes ownership of the HTable. It will be closed when this instance is + closed.

            +

            +

            +
            Parameters:
            htable - The HTable to use for storing Kiji meta data.
            tableLayoutDatabase - A database of table layouts to delegate layout storage to.
            tableKeyValueDatabase - A database of key-value pairs to delegate metadata storage to.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newMetaTable

            +
            +public static HTableInterface newMetaTable(KijiURI kijiURI,
+                                           Configuration conf,
+                                           HTableInterfaceFactory factory)
+                                    throws IOException
            +
            +
            Creates an HTableInterface for the specified table. +

            +

            +
            Parameters:
            kijiURI - the KijiURI.
            conf - Hadoop configuration.
            factory - HTableInterface factory to use. +
            Returns:
            a new HTableInterface for the specified table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +deleteTable

            +
            +public void deleteTable(String table)
+                 throws IOException
            +
            +
            Remove all metadata, including layouts, for a particular table. +

            +

            +
            Specified by:
            deleteTable in class KijiMetaTable
            +
            +
            +
            Parameters:
            table - The name of the kiji table to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +updateTableLayout

            +
            +public KijiTableLayout updateTableLayout(String table,
+                                         TableLayoutDesc layoutUpdate)
+                                  throws IOException
            +
            +
            Sets a table's layout. Also calls validateAndAssignLayout(). +

            +

            +
            Parameters:
            table - The name of the Kiji table to affect.
            layoutUpdate - Descriptor for the layout update. +
            Returns:
            the new effective layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout(String table)
+                               throws IOException
            +
            +
            Gets the most recent versions of the layout for a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            The table's layout. +
            Throws: +
            IOException - If there is an error or no such table.
            +
            +
            +
            + +

            +getTableLayoutVersions

            +
            +public List<KijiTableLayout> getTableLayoutVersions(String table,
+                                                    int numVersions)
+                                             throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the table layout. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the layout for the table, sorted by + most-recent-first. If there are no layouts, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedTableLayoutVersions

            +
            +public NavigableMap<Long,KijiTableLayout> getTimedTableLayoutVersions(String table,
+                                                                      int numVersions)
+                                                               throws IOException
            +
            +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values the most recent versions of the layout for the table, and + keys the corresponding timestamps, ordered from most recent first to least recent last. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllTableLayoutVersions

            +
            +public void removeAllTableLayoutVersions(String table)
+                                  throws IOException
            +
            +
            Removes all layout information for a particular table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeRecentTableLayoutVersions

            +
            +public void removeRecentTableLayoutVersions(String table,
+                                            int numVersions)
+                                     throws IOException
            +
            +
            Removes the most recent layout information for a given table. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +listTables

            +
            +public List<String> listTables()
+                        throws IOException
            +
            +
            Lists the tables in this Kiji instance. +

            +

            + +
            Returns:
            The list of table names. +
            Throws: +
            IOException - If the list of tables cannot be retrieved.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Overrides:
            close in class KijiMetaTable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getValue

            +
            +public byte[] getValue(String table,
+                       String key)
+                throws IOException
            +
            +
            Returns the most recent value associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for. +
            Returns:
            The value in the meta table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public KijiTableKeyValueDatabase putValue(String table,
+                                          String key,
+                                          byte[] value)
+                                   throws IOException
            +
            +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +

            +

            +
            Parameters:
            table - The kiji table that this key-value pair will be set with.
            key - The key to associate with the specified value.
            value - The value to associate with the specified key. +
            Returns:
            The same KijiTableKeyValueDatabase. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeValues

            +
            +public void removeValues(String table,
+                         String key)
+                  throws IOException
            +
            +
            Removes all values associated with the specified table and key. +

            +

            +
            Parameters:
            table - The kiji table associated with the metadata.
            key - The metadata key to look up. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +tableSet

            +
            +public Set<String> tableSet()
+                     throws IOException
            +
            +
            Returns a set view of the tables that have key-value pairs defined. +

            +

            + +
            Returns:
            A set of tables that have key-value pairs defined. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keySet

            +
            +public Set<String> keySet(String table)
+                   throws IOException
            +
            +
            Returns a set view of keys contained in the map for the specified table. +

            +

            +
            Parameters:
            table - The table to look up in use keys for. +
            Returns:
            A navigable set of keys used to store meta information for a given table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllValues

            +
            +public void removeAllValues(String table)
+                     throws IOException
            +
            +
            Deletes all key-value pairs associated with the specified table. +

            +

            +
            Parameters:
            table - The table to delete remove key-value pairs for. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +install

            +
            +public static void install(HBaseAdmin admin,
+                           KijiURI uri)
+                    throws IOException
            +
            +
            Install the meta table into a Kiji instance. +

            +

            +
            Parameters:
            admin - The HBase Admin interface for the HBase cluster to install into.
            uri - The uri of the Kiji instance to install. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(HBaseAdmin admin,
+                             KijiURI uri)
+                      throws IOException
            +
            +
            Removes the meta table from HBase. +

            +

            +
            Parameters:
            admin - The HBase admin object.
            uri - The uri of the Kiji instance to uninstall. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toBackup

            +
            +public Map<String,TableBackup> toBackup()
+                                 throws IOException
            +
            +
            Returns metadata backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            Specified by:
            toBackup in class KijiMetaTable
            +
            +
            + +
            Returns:
            A map from table names to TableBackup records. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public void fromBackup(Map<String,TableBackup> backup)
+                throws IOException
            +
            +
            Restores metadata from a backup record. This consists of table layouts, schemas, and user + defined key-value pairs. +

            +

            +
            Specified by:
            fromBackup in class KijiMetaTable
            +
            +
            +
            Parameters:
            backup - A map from table name to table backup record. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +layoutsToBackup

            +
            +public List<TableLayoutBackupEntry> layoutsToBackup(String table)
+                                             throws IOException
            +
            +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableLayoutBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public List<byte[]> getValues(String table,
+                              String key,
+                              int numVersions)
+                       throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +

            +

            +
            Parameters:
            table - The Kiji table.
            key - The key to look up associated values for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the values for the specified table and key, + sorted by most-recent-first. If there are no values, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedValues

            +
            +public NavigableMap<Long,byte[]> getTimedValues(String table,
+                                                String key,
+                                                int numVersions)
+                                         throws IOException
            +
            +
            Returns a map of values associated with the specified table and key. The Map + is keyed by timestamp. +

            +

            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values that are the user defined values for the specified key + and table, and keys that correspond to timestamps, ordered from newest to oldest. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesToBackup

            +
            +public List<KeyValueBackupEntry> keyValuesToBackup(String table)
+                                            throws IOException
            +
            +
            Gets a list of the TableKeyValueBackupEntries. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableKeyValueBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesFromBackup

            +
            +public void keyValuesFromBackup(String table,
+                                List<KeyValueBackupEntry> tableBackup)
+                         throws IOException
            +
            +
            Restores all table's key value history from a backup. +

            +

            +
            Parameters:
            table - The name of the kiji table.
            tableBackup - The key values associated with the table to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +layoutsFromBackup

            +
            +public void layoutsFromBackup(String tableName,
+                              List<TableLayoutBackupEntry> tableBackup)
+                       throws IOException
            +
            +
            Description copied from interface: KijiTableLayoutDatabase
            +
            Restores a table layout history from a backup. +

            +

            +
            Parameters:
            tableName - The name of the table to restore layouts for.
            tableBackup - Table layout backup entries to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseSchemaTable.html new file mode 100644 index 00000000..61e9f72e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseSchemaTable.html @@ -0,0 +1,942 @@ + + + + + + + +HBaseSchemaTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseSchemaTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSchemaTable
+      extended by org.kiji.schema.impl.HBaseSchemaTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseSchemaTable
            extends KijiSchemaTable
            + + +

            +

            + Mapping between schema IDs, hashes and Avro schema objects. + This class is thread-safe. +

            + +

            + Schemas are stored in two tables with a single column family named "schema" and that contains + SchemaTableEntry records. One table is indexed by schema hashes (128-bit MD5 hashes of the + schema JSON representation). Other table is indexed by schema IDs (integers >= 0). + + There may be multiple schema IDs for a single schema. +

            +

            + +

            +

            + +

            + + + + + + + +
            +Nested Class Summary
            +  + + + + + + + +
            Nested classes/interfaces inherited from class org.kiji.schema.KijiSchemaTable
            KijiSchemaTable.SchemaEntry
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static intPRE_REGISTERED_SCHEMA_COUNT + +
            +          Number of pre-allocated schemas.
            +static StringSCHEMA_COLUMN_FAMILY + +
            +          The column family in HBase used to store schema entries.
            +static StringSCHEMA_COLUMN_QUALIFIER + +
            +          The column qualifier in HBase used to store schema entries.
            +static StringSCHEMA_COUNTER_ROW_NAME + +
            +          Schema IDs are generated using a counter.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseSchemaTable(HTableInterface hashTable, + HTableInterface idTable, + Lock zkLock) + +
            +          Wrap an existing HBase table assumed to be where the schema data is stored.
            HBaseSchemaTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          Flushes and closes the KijiSchemaTable.
            +static SchemaTableEntrydecodeSchemaEntry(byte[] bytes) + +
            +          Decodes a binary-encoded Avro schema entry.
            +static byte[]encodeSchemaEntry(SchemaTableEntry avroEntry) + +
            +          Encodes an Avro schema entry into binary.
            +protected  voidfinalize() + +
            +          
            + voidflush() + +
            +          Commits any pending additions to the schema table.
            +static KijiSchemaTable.SchemaEntryfromAvroEntry(SchemaTableEntry avroEntry) + +
            +          Converts an Avro SchemaTableEntry into a SchemaEntry.
            + voidfromBackup(List<SchemaTableEntry> backup) + +
            +          Restores the schema entries from the specified backup record.
            + BytesKeygetOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            + longgetOrCreateSchemaId(org.apache.avro.Schema schema) + +
            +          Looks up a schema ID given an Avro schema object.
            + org.apache.avro.SchemagetSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            + org.apache.avro.SchemagetSchema(long schemaId) + +
            +          Looks up a schema given an ID.
            +static voidinstall(HBaseAdmin admin, + KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static LocknewLock(KijiURI kijiURI, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +static HTableInterfacenewSchemaHashTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema hash table.
            +static HTableInterfacenewSchemaIdTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema ID table.
            +static HTableInterfacenewSchemaV5Table(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema V5 table.
            +static SchemaTableEntrytoAvroEntry(KijiSchemaTable.SchemaEntry entry) + +
            +          Converts a SchemaEntry into an Avro SchemaTableEntry.
            + List<SchemaTableEntry>toBackup() + +
            +          Returns schema backup information in a form that can be directly written to a MetadataBackup + record.
            +static voiduninstall(HBaseAdmin admin, + KijiURI kijiURI) + +
            +          Disables and removes the schema table from HBase.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.KijiSchemaTable
            getSchemaHash, hashSchema
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SCHEMA_COLUMN_FAMILY

            +
            +public static final String SCHEMA_COLUMN_FAMILY
            +
            +
            The column family in HBase used to store schema entries. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +SCHEMA_COLUMN_QUALIFIER

            +
            +public static final String SCHEMA_COLUMN_QUALIFIER
            +
            +
            The column qualifier in HBase used to store schema entries. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +SCHEMA_COUNTER_ROW_NAME

            +
            +public static final String SCHEMA_COUNTER_ROW_NAME
            +
            +
            Schema IDs are generated using a counter. The counter is stored in the schema ID table. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +PRE_REGISTERED_SCHEMA_COUNT

            +
            +public static final int PRE_REGISTERED_SCHEMA_COUNT
            +
            +
            Number of pre-allocated schemas. +

            +

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

            +HBaseSchemaTable

            +
            +public HBaseSchemaTable(KijiURI kijiURI,
+                        Configuration conf,
+                        HTableInterfaceFactory tableFactory,
+                        LockFactory lockFactory)
+                 throws IOException
            +
            +
            Open a connection to the HBase schema table for a Kiji instance. +

            +

            +
            Parameters:
            kijiURI - the KijiURI
            conf - The Hadoop configuration.
            tableFactory - HTableInterface factory.
            lockFactory - Factory for locks. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +

            +HBaseSchemaTable

            +
            +public HBaseSchemaTable(HTableInterface hashTable,
+                        HTableInterface idTable,
+                        Lock zkLock)
+                 throws IOException
            +
            +
            Wrap an existing HBase table assumed to be where the schema data is stored. +

            +

            +
            Parameters:
            hashTable - The HTable that maps schema hashes to schema entries.
            idTable - The HTable that maps schema IDs to schema entries.
            zkLock - Lock protecting the schema tables. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newSchemaV5Table

            +
            +public static HTableInterface newSchemaV5Table(KijiURI kijiURI,
+                                               Configuration conf,
+                                               HTableInterfaceFactory factory)
+                                        throws IOException
            +
            +
            Creates an HTable handle to the schema V5 table. +

            +

            +
            Parameters:
            kijiURI - the KijiURI.
            conf - the Hadoop configuration.
            factory - HTableInterface factory. +
            Returns:
            a new interface for the table storing the schemas up until data layout v5. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +newSchemaHashTable

            +
            +public static HTableInterface newSchemaHashTable(KijiURI kijiURI,
+                                                 Configuration conf,
+                                                 HTableInterfaceFactory factory)
+                                          throws IOException
            +
            +
            Creates an HTable handle to the schema hash table. +

            +

            +
            Parameters:
            kijiURI - the KijiURI.
            conf - the Hadoop configuration.
            factory - HTableInterface factory. +
            Returns:
            a new interface for the table storing the mapping from schema hash to schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +newSchemaIdTable

            +
            +public static HTableInterface newSchemaIdTable(KijiURI kijiURI,
+                                               Configuration conf,
+                                               HTableInterfaceFactory factory)
+                                        throws IOException
            +
            +
            Creates an HTable handle to the schema ID table. +

            +

            +
            Parameters:
            kijiURI - the KijiURI.
            conf - the Hadoop configuration.
            factory - HTableInterface factory. +
            Returns:
            a new interface for the table storing the mapping from schema ID to schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +newLock

            +
            +public static Lock newLock(KijiURI kijiURI,
+                           LockFactory factory)
+                    throws IOException
            +
            +
            Creates a lock for a given Kiji instance. +

            +

            +
            Parameters:
            kijiURI - URI of the Kiji instance.
            factory - Factory for locks. +
            Returns:
            a lock for the specified Kiji instance. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeSchemaEntry

            +
            +public static SchemaTableEntry decodeSchemaEntry(byte[] bytes)
+                                          throws IOException
            +
            +
            Decodes a binary-encoded Avro schema entry. +

            +

            +
            Parameters:
            bytes - Binary-encoded Avro schema entry. +
            Returns:
            Decoded Avro schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +encodeSchemaEntry

            +
            +public static byte[] encodeSchemaEntry(SchemaTableEntry avroEntry)
+                                throws IOException
            +
            +
            Encodes an Avro schema entry into binary. +

            +

            +
            Parameters:
            avroEntry - Avro schema entry to encode. +
            Returns:
            Binary-encoded Avro schema entry. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getOrCreateSchemaId

            +
            +public long getOrCreateSchemaId(org.apache.avro.Schema schema)
+                         throws IOException
            +
            +
            Looks up a schema ID given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            Specified by:
            getOrCreateSchemaId in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schema - The full schema to store in the table. +
            Returns:
            The schema ID. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getOrCreateSchemaHash

            +
            +public BytesKey getOrCreateSchemaHash(org.apache.avro.Schema schema)
+                               throws IOException
            +
            +
            Looks up a schema hash given an Avro schema object. + + If the schema is unknown, allocates a new ID and stores the new schema mapping. +

            +

            +
            Specified by:
            getOrCreateSchemaHash in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schema - Avro schema to look up. +
            Returns:
            The schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +fromAvroEntry

            +
            +public static KijiSchemaTable.SchemaEntry fromAvroEntry(SchemaTableEntry avroEntry)
            +
            +
            Converts an Avro SchemaTableEntry into a SchemaEntry. +

            +

            +
            Parameters:
            avroEntry - Avro SchemaTableEntry +
            Returns:
            an equivalent SchemaEntry
            +
            +
            +
            + +

            +toAvroEntry

            +
            +public static SchemaTableEntry toAvroEntry(KijiSchemaTable.SchemaEntry entry)
            +
            +
            Converts a SchemaEntry into an Avro SchemaTableEntry. +

            +

            +
            Parameters:
            entry - a SchemaEntry. +
            Returns:
            an equivalent Avro SchemaTableEntry.
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema(long schemaId)
+                                 throws IOException
            +
            +
            Looks up a schema given an ID. +

            +

            +
            Specified by:
            getSchema in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schemaId - Schema ID to look up. +
            Returns:
            Avro schema, or null if the schema ID is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema(BytesKey schemaHash)
+                                 throws IOException
            +
            +
            Looks up a schema given a hash. +

            +

            +
            Specified by:
            getSchema in class KijiSchemaTable
            +
            +
            +
            Parameters:
            schemaHash - Schema hash to look up. +
            Returns:
            Avro schema, or null if the schema hash is unknown. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +flush

            +
            +public void flush()
+           throws IOException
            +
            +
            Commits any pending additions to the schema table. + + Default implementation is blank as flushing is not generally a vital operation +

            +

            +
            Overrides:
            flush in class KijiSchemaTable
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            Flushes and closes the KijiSchemaTable. No other methods may be called after this. +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in class KijiSchemaTable
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +install

            +
            +public static void install(HBaseAdmin admin,
+                           KijiURI kijiURI,
+                           Configuration conf,
+                           HTableInterfaceFactory tableFactory,
+                           LockFactory lockFactory)
+                    throws IOException
            +
            +
            Install the schema table into a Kiji instance. +

            +

            +
            Parameters:
            admin - The HBase Admin interface for the HBase cluster to install into.
            kijiURI - the KijiURI.
            conf - The Hadoop configuration.
            tableFactory - HTableInterface factory.
            lockFactory - Factory for locks. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(HBaseAdmin admin,
+                             KijiURI kijiURI)
+                      throws IOException
            +
            +
            Disables and removes the schema table from HBase. +

            +

            +
            Parameters:
            admin - The HBase Admin object.
            kijiURI - The KijiURI for the instance to remove. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +toBackup

            +
            +public List<SchemaTableEntry> toBackup()
+                                throws IOException
            +
            +
            Returns schema backup information in a form that can be directly written to a MetadataBackup + record. To read more about the avro type that has been specified to store this info, see + Layout.avdl +

            +

            +
            Specified by:
            toBackup in class KijiSchemaTable
            +
            +
            + +
            Returns:
            A list of schema table entries. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +fromBackup

            +
            +public void fromBackup(List<SchemaTableEntry> backup)
+                throws IOException
            +
            +
            Restores the schema entries from the specified backup record. +

            +

            +
            Specified by:
            fromBackup in class KijiSchemaTable
            +
            +
            +
            Parameters:
            backup - The schema entries from a MetadataBackup record. This consist of the schema + definition, schema id, and schema hash. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseSystemTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseSystemTable.html new file mode 100644 index 00000000..ed8ca949 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseSystemTable.html @@ -0,0 +1,636 @@ + + + + + + + +HBaseSystemTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseSystemTable

            +
            +java.lang.Object
+  extended by org.kiji.schema.KijiSystemTable
+      extended by org.kiji.schema.impl.HBaseSystemTable
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseSystemTable
            extends KijiSystemTable
            + + +

            +

            The Kiji system table that is stored in HBase.

            + +

            The system table (a Kiji system table) is a simple key-value store for system-wide + properties of a Kiji installation. There is a single column family "value". For a + key-value property (K,V), the key K is stored as the row key in the HTable, + and the value V is stored in the "value:" column.

            import org.kiji.schema.KijiURI; +i +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringDEFAULTS_PROPERTIES_FILE + +
            +          The name of the file that stores the current system table defaults that are loaded + at installation time.
            +static StringKEY_DATA_VERSION + +
            +          The HBase row key that stores the installed Kiji data format version.
            +static StringVALUE_COLUMN_FAMILY + +
            +          The HBase column family that stores the value of the properties.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            HBaseSystemTable(HTableInterface htable) + +
            +          Wrap an existing HTable connection that is assumed to be the table that stores the + Kiji instance properties.
            HBaseSystemTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Connect to the HBase system table inside a Kiji instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            +protected  voidfinalize() + +
            +          
            + ProtocolVersiongetDataVersion() + +
            +          Gets the version of kiji installed.
            + byte[]getValue(String key) + +
            +          Gets the value associated with a property key.
            +static voidinstall(HBaseAdmin admin, + KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Installs a Kiji system table into a running HBase instance.
            +protected  voidloadDefaults(String resource) + +
            +          Load the system table with the key/value pairs from the properties file named by resource.
            +static HTableInterfacenewSystemTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates a new HTableInterface for the Kiji system table.
            + voidputValue(String key, + byte[] value) + +
            +          Sets a value for a property key, which creates it if it doesn't exist.
            + voidsetDataVersion(ProtocolVersion version) + +
            +          Sets the version of kiji installed.
            +static voiduninstall(HBaseAdmin admin, + KijiURI kijiURI) + +
            +          Disables and delete the system table from HBase.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +VALUE_COLUMN_FAMILY

            +
            +public static final String VALUE_COLUMN_FAMILY
            +
            +
            The HBase column family that stores the value of the properties. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KEY_DATA_VERSION

            +
            +public static final String KEY_DATA_VERSION
            +
            +
            The HBase row key that stores the installed Kiji data format version. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +DEFAULTS_PROPERTIES_FILE

            +
            +public static final String DEFAULTS_PROPERTIES_FILE
            +
            +
            The name of the file that stores the current system table defaults that are loaded + at installation time. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +HBaseSystemTable

            +
            +public HBaseSystemTable(KijiURI kijiURI,
+                        Configuration conf,
+                        HTableInterfaceFactory factory)
+                 throws IOException
            +
            +
            Connect to the HBase system table inside a Kiji instance. +

            +

            +
            Parameters:
            kijiURI - The KijiURI.
            conf - the Hadoop configuration.
            factory - HTableInterface factory. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +

            +HBaseSystemTable

            +
            +public HBaseSystemTable(HTableInterface htable)
            +
            +
            Wrap an existing HTable connection that is assumed to be the table that stores the + Kiji instance properties. +

            +

            +
            Parameters:
            htable - An HTable to wrap.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newSystemTable

            +
            +public static HTableInterface newSystemTable(KijiURI kijiURI,
+                                             Configuration conf,
+                                             HTableInterfaceFactory factory)
+                                      throws IOException
            +
            +
            Creates a new HTableInterface for the Kiji system table. +

            +

            +
            Parameters:
            kijiURI - The KijiURI.
            conf - The Hadoop configuration.
            factory - HTableInterface factory. +
            Returns:
            a new HTableInterface for the Kiji system table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getDataVersion

            +
            +public ProtocolVersion getDataVersion()
+                               throws IOException
            +
            +
            Gets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            Specified by:
            getDataVersion in class KijiSystemTable
            +
            +
            + +
            Returns:
            the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +setDataVersion

            +
            +public void setDataVersion(ProtocolVersion version)
+                    throws IOException
            +
            +
            Sets the version of kiji installed. This refers to the version of + the meta tables and other administrative kiji info installed, not + the client code. +

            +

            +
            Specified by:
            setDataVersion in class KijiSystemTable
            +
            +
            +
            Parameters:
            version - the version string. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +finalize

            +
            +protected void finalize()
+                 throws Throwable
            +
            +
            +

            +

            +
            Overrides:
            finalize in class Object
            +
            +
            + +
            Throws: +
            Throwable
            +
            +
            +
            + +

            +getValue

            +
            +public byte[] getValue(String key)
+                throws IOException
            +
            +
            Gets the value associated with a property key. +

            +

            +
            Specified by:
            getValue in class KijiSystemTable
            +
            +
            +
            Parameters:
            key - The property key to look up. +
            Returns:
            The value in the system table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public void putValue(String key,
+                     byte[] value)
+              throws IOException
            +
            +
            Sets a value for a property key, which creates it if it doesn't exist. +

            +

            +
            Specified by:
            putValue in class KijiSystemTable
            +
            +
            +
            Parameters:
            key - The property key to set.
            value - The value of the property. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +loadDefaults

            +
            +protected void loadDefaults(String resource)
+                     throws IOException
            +
            +
            Load the system table with the key/value pairs from the properties file named by resource. +

            +

            +
            Parameters:
            resource - The name of the properties resource holding the defaults. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +install

            +
            +public static void install(HBaseAdmin admin,
+                           KijiURI kijiURI,
+                           Configuration conf,
+                           HTableInterfaceFactory factory)
+                    throws IOException
            +
            +
            Installs a Kiji system table into a running HBase instance. +

            +

            +
            Parameters:
            admin - The HBase cluster to install into.
            kijiURI - The KijiURI.
            conf - The Hadoop configuration.
            factory - HTableInterface factory. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +uninstall

            +
            +public static void uninstall(HBaseAdmin admin,
+                             KijiURI kijiURI)
+                      throws IOException
            +
            +
            Disables and delete the system table from HBase. +

            +

            +
            Parameters:
            admin - The HBase admin object.
            kijiURI - The URI for the kiji instance to remove. +
            Throws: +
            IOException - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html new file mode 100644 index 00000000..8ecfd4d7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HBaseTableKeyValueDatabase.html @@ -0,0 +1,590 @@ + + + + + + + +HBaseTableKeyValueDatabase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HBaseTableKeyValueDatabase

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HBaseTableKeyValueDatabase
+
            +
            +
            All Implemented Interfaces:
            KijiTableKeyValueDatabase
            +
            +
            +
            +
            @ApiAudience.Private
+public class HBaseTableKeyValueDatabase
            extends Object
            implements KijiTableKeyValueDatabase
            + + +

            +Manages key-value pairs on a per table basis. Storage of these key-value pairs is provided by + a column family of an HTable. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static org.slf4j.LoggerLOG + +
            +           
            +  + + + + + + + + + + +
            +Constructor Summary
            HBaseTableKeyValueDatabase(HTableInterface hTable, + String metaFamily) + +
            +          This class manages the storage and retrieval of key-value pairs on a per table basis.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + NavigableMap<Long,byte[]>getTimedValues(String table, + String key, + int numVersions) + +
            +          Returns a map of values associated with the specified table and key.
            + byte[]getValue(String table, + String key) + +
            +          Returns the most recent value associated with the specified table and key.
            + List<byte[]>getValues(String table, + String key, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key.
            + Set<String>keySet(String table) + +
            +          Returns a set view of keys contained in the map for the specified table.
            + voidkeyValuesFromBackup(String tableName, + List<KeyValueBackupEntry> keyValues) + +
            +          Restores all table's key value history from a backup.
            + List<KeyValueBackupEntry>keyValuesToBackup(String table) + +
            +          Gets a list of the TableKeyValueBackupEntries.
            + KijiTableKeyValueDatabaseputValue(String table, + String key, + byte[] value) + +
            +          Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table.
            + voidremoveAllValues(String table) + +
            +          Deletes all key-value pairs associated with the specified table.
            + voidremoveValues(String table, + String key) + +
            +          Removes all values associated with the specified table and key.
            + Set<String>tableSet() + +
            +          Returns a set view of the tables that have key-value pairs defined.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +LOG

            +
            +public static final org.slf4j.Logger LOG
            +
            +
            +
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +HBaseTableKeyValueDatabase

            +
            +public HBaseTableKeyValueDatabase(HTableInterface hTable,
+                                  String metaFamily)
            +
            +
            This class manages the storage and retrieval of key-value pairs on a per table basis. It is + backed by a column family in HBase specified by metaFamily, in the table specified by table. +

            +

            +
            Parameters:
            hTable - The table to store the key-value information in.
            metaFamily - the name of the column family to use.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getValue

            +
            +public byte[] getValue(String table,
+                       String key)
+                throws IOException
            +
            +
            Returns the most recent value associated with the specified table and key. +

            +

            +
            Specified by:
            getValue in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for. +
            Returns:
            The value in the meta table with the given key, or null if the key doesn't exist. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getValues

            +
            +public List<byte[]> getValues(String table,
+                              String key,
+                              int numVersions)
+                       throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the value corresponding to the + specified table and key. +

            +

            +
            Specified by:
            getValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The Kiji table.
            key - The key to look up associated values for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the values for the specified table and key, + sorted by most-recent-first. If there are no values, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedValues

            +
            +public NavigableMap<Long,byte[]> getTimedValues(String table,
+                                                String key,
+                                                int numVersions)
+                                         throws IOException
            +
            +
            Returns a map of values associated with the specified table and key. The Map + is keyed by timestamp. +

            +

            +
            Specified by:
            getTimedValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table.
            key - The key to look up the associated value for.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values that are the user defined values for the specified key + and table, and keys that correspond to timestamps, ordered from newest to oldest. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +putValue

            +
            +public KijiTableKeyValueDatabase putValue(String table,
+                                          String key,
+                                          byte[] value)
+                                   throws IOException
            +
            +
            Associates the specified value with the specified table and key + + The specified key and value are associated with each other in the map for the specified table. +

            +

            +
            Specified by:
            putValue in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table that this key-value pair will be set with.
            key - The key to associate with the specified value.
            value - The value to associate with the specified key. +
            Returns:
            The same KijiTableKeyValueDatabase. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeValues

            +
            +public void removeValues(String table,
+                         String key)
+                  throws IOException
            +
            +
            Removes all values associated with the specified table and key. +

            +

            +
            Specified by:
            removeValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The kiji table associated with the metadata.
            key - The metadata key to look up. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keySet

            +
            +public Set<String> keySet(String table)
+                   throws IOException
            +
            +
            Returns a set view of keys contained in the map for the specified table. +

            +

            +
            Specified by:
            keySet in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The table to look up in use keys for. +
            Returns:
            A navigable set of keys used to store meta information for a given table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +tableSet

            +
            +public Set<String> tableSet()
+                     throws IOException
            +
            +
            Returns a set view of the tables that have key-value pairs defined. +

            +

            +
            Specified by:
            tableSet in interface KijiTableKeyValueDatabase
            +
            +
            + +
            Returns:
            A set of tables that have key-value pairs defined. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllValues

            +
            +public void removeAllValues(String table)
+                     throws IOException
            +
            +
            Deletes all key-value pairs associated with the specified table. +

            +

            +
            Specified by:
            removeAllValues in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The table to delete remove key-value pairs for. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesToBackup

            +
            +public List<KeyValueBackupEntry> keyValuesToBackup(String table)
+                                            throws IOException
            +
            +
            Gets a list of the TableKeyValueBackupEntries. +

            +

            +
            Specified by:
            keyValuesToBackup in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableKeyValueBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +keyValuesFromBackup

            +
            +public void keyValuesFromBackup(String tableName,
+                                List<KeyValueBackupEntry> keyValues)
+                         throws IOException
            +
            +
            Restores all table's key value history from a backup. +

            +

            +
            Specified by:
            keyValuesFromBackup in interface KijiTableKeyValueDatabase
            +
            +
            +
            Parameters:
            tableName - The name of the kiji table.
            keyValues - The key values associated with the table to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HColumnDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HColumnDescriptorComparator.html new file mode 100644 index 00000000..9e3de9e3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HColumnDescriptorComparator.html @@ -0,0 +1,276 @@ + + + + + + + +HColumnDescriptorComparator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HColumnDescriptorComparator

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HColumnDescriptorComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator<HColumnDescriptor>
            +
            +
            +
            +
            @ApiAudience.Private
+public class HColumnDescriptorComparator
            extends Object
            implements Comparator<HColumnDescriptor>
            + + +

            +Comparator for HColumnDescriptors. They are sorted by name, then + by max versions, ttl, and whether it is in memory. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HColumnDescriptorComparator() + +
            +           
            +  + + + + + + + + + + + +
            +Method Summary
            + intcompare(HColumnDescriptor o1, + HColumnDescriptor o2) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

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

            +HColumnDescriptorComparator

            +
            +public HColumnDescriptorComparator()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(HColumnDescriptor o1,
+                   HColumnDescriptor o2)
            +
            +
            +
            Specified by:
            compare in interface Comparator<HColumnDescriptor>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HTableDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HTableDescriptorComparator.html new file mode 100644 index 00000000..814c2ab5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HTableDescriptorComparator.html @@ -0,0 +1,304 @@ + + + + + + + +HTableDescriptorComparator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HTableDescriptorComparator

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.HTableDescriptorComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator<HTableDescriptor>
            +
            +
            +
            +
            @ApiAudience.Private
+public class HTableDescriptorComparator
            extends Object
            implements Comparator<HTableDescriptor>
            + + +

            +Compares HTableDescriptors. They + are equal if they have the same HTable name with the same column + families. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HTableDescriptorComparator() + +
            +           
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + intcompare(HTableDescriptor o1, + HTableDescriptor o2) + +
            +           
            +static HTableDescriptormakeEmptyTableDescriptor(KijiManagedHBaseTableName hbaseTableName) + +
            +          Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout().
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

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

            +HTableDescriptorComparator

            +
            +public HTableDescriptorComparator()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(HTableDescriptor o1,
+                   HTableDescriptor o2)
            +
            +
            +
            Specified by:
            compare in interface Comparator<HTableDescriptor>
            +
            +
            +
            +
            +
            +
            + +

            +makeEmptyTableDescriptor

            +
            +public static HTableDescriptor makeEmptyTableDescriptor(KijiManagedHBaseTableName hbaseTableName)
            +
            +
            Creates an HTableDescriptor that looks "empty" from the perspective of + HTableDescriptorComparator and KijiAdmin.setTableLayout(). +

            +

            +
            +
            +
            +
            Parameters:
            hbaseTableName - the HBase table name being represented by this "empty table." +
            Returns:
            an HTableDescriptor that represents a table with no column families.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HTableInterfaceFactory.html new file mode 100644 index 00000000..97e9ba66 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HTableInterfaceFactory.html @@ -0,0 +1,225 @@ + + + + + + + +HTableInterfaceFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Interface HTableInterfaceFactory

            +
            +
            All Known Implementing Classes:
            DefaultHTableInterfaceFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public interface HTableInterfaceFactory
            + + +

            +Factory for HTableInterface instances. + + This interface exists because the HBase HTableInstanceFactory doesn't throw IOException. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + HTableInterfacecreate(Configuration conf, + String hbaseTableName) + +
            +          Creates a new HTableInterface instance.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +HTableInterface create(Configuration conf,
+                       String hbaseTableName)
+                       throws IOException
            +
            +
            Creates a new HTableInterface instance. +

            +

            +
            Parameters:
            conf - The configuration for the HBase cluster.
            hbaseTableName - The name of the HBase table to create a connection to. +
            Returns:
            a new HTableInterface for the specified table. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HashPrefixedEntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HashPrefixedEntityId.html new file mode 100644 index 00000000..a05a5a3f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HashPrefixedEntityId.html @@ -0,0 +1,418 @@ + + + + + + + +HashPrefixedEntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HashPrefixedEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.HashPrefixedEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public final class HashPrefixedEntityId
            extends EntityId
            + + +

            +Implements the hash-prefixed row key format. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static HashPrefixedEntityIdfromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified HBase row key.
            + + + + + +
            +<T> T
            +            		getComponentByIndex(int idx) + +
            +          Get the individual components of the kiji Row Key representation.
            + List<Object>getComponents() + +
            +          Get the components of the row key as a List of Objects.
            +static HashPrefixedEntityIdgetEntityId(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified Kiji row key.
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + byte[]getKijiRowKey() + +
            +           
            +static byte[]hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEntityId

            +
            +public static HashPrefixedEntityId getEntityId(byte[] kijiRowKey,
+                                               RowKeyFormat format)
            +
            +
            Creates a HashPrefixedEntityId from the specified Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key.
            format - Row key hashing specification. +
            Returns:
            a new HashPrefixedEntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public static HashPrefixedEntityId fromHBaseRowKey(byte[] hbaseRowKey,
+                                                   RowKeyFormat format)
            +
            +
            Creates a HashPrefixedEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key.
            format - Row key hashing specification. +
            Returns:
            a new HashedEntityId with the specified HBase row key.
            +
            +
            +
            + +

            +hashKijiRowKey

            +
            +public static byte[] hashKijiRowKey(RowKeyFormat format,
+                                    byte[] kijiRowKey)
            +
            +
            Hashes a Kiji row key. +

            +

            +
            Parameters:
            format - Hashing specification.
            kijiRowKey - Kiji row key. +
            Returns:
            a hash of the Kiji row key.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            +
            + +

            +getComponentByIndex

            +
            +public <T> T getComponentByIndex(int idx)
            +
            +
            Get the individual components of the kiji Row Key representation. This excludes hash + prefixes and only includes user-addressible components. + E.g. If the key is composed of a String followed by an Int, getComponentByIndex(0) + returns the String component. Zero based indexing. +

            +

            +
            Specified by:
            getComponentByIndex in class EntityId
            +
            +
            +
            Type Parameters:
            T - The type of the row key component.
            Parameters:
            idx - The index of the component. An integer between 0 and numComponents - 1. +
            Returns:
            The specific component of the row key.
            +
            +
            +
            + +

            +getComponents

            +
            +public List<Object> getComponents()
            +
            +
            Get the components of the row key as a List of Objects. This excludes hash + prefixes and only includes user-addressible components. +

            +

            +
            Specified by:
            getComponents in class EntityId
            +
            +
            + +
            Returns:
            List of Objects representing the individual components of a row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public byte[] getKijiRowKey()
            +
            +
            + +
            Returns:
            the Kiji row key, or null.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HashedEntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HashedEntityId.html new file mode 100644 index 00000000..7f68fcde --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/HashedEntityId.html @@ -0,0 +1,418 @@ + + + + + + + +HashedEntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class HashedEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.HashedEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public final class HashedEntityId
            extends EntityId
            + + +

            +Implements the hashed row key format. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static HashedEntityIdfromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified HBase row key.
            + + + + + +
            +<T> T
            +            		getComponentByIndex(int idx) + +
            +          Get the individual components of the kiji Row Key representation.
            + List<Object>getComponents() + +
            +          Get the components of the row key as a List of Objects.
            +static HashedEntityIdgetEntityId(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified Kiji row key.
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + byte[]getKijiRowKey() + +
            +           
            +static byte[]hashKijiRowKey(RowKeyFormat format, + byte[] kijiRowKey) + +
            +          Hashes a Kiji row key.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEntityId

            +
            +public static HashedEntityId getEntityId(byte[] kijiRowKey,
+                                         RowKeyFormat format)
            +
            +
            Creates a HashedEntityId from the specified Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key.
            format - Row key hashing specification. +
            Returns:
            a new HashedEntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public static HashedEntityId fromHBaseRowKey(byte[] hbaseRowKey,
+                                             RowKeyFormat format)
            +
            +
            Creates a HashedEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key.
            format - Row key hashing specification. +
            Returns:
            a new HashedEntityId with the specified HBase row key.
            +
            +
            +
            + +

            +hashKijiRowKey

            +
            +public static byte[] hashKijiRowKey(RowKeyFormat format,
+                                    byte[] kijiRowKey)
            +
            +
            Hashes a Kiji row key. +

            +

            +
            Parameters:
            format - Hashing specification.
            kijiRowKey - Kiji row key to hash. +
            Returns:
            a hash of the given Kiji row key.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            +
            + +

            +getComponentByIndex

            +
            +public <T> T getComponentByIndex(int idx)
            +
            +
            Get the individual components of the kiji Row Key representation. This excludes hash + prefixes and only includes user-addressible components. + E.g. If the key is composed of a String followed by an Int, getComponentByIndex(0) + returns the String component. Zero based indexing. +

            +

            +
            Specified by:
            getComponentByIndex in class EntityId
            +
            +
            +
            Type Parameters:
            T - The type of the row key component.
            Parameters:
            idx - The index of the component. An integer between 0 and numComponents - 1. +
            Returns:
            The specific component of the row key.
            +
            +
            +
            + +

            +getComponents

            +
            +public List<Object> getComponents()
            +
            +
            Get the components of the row key as a List of Objects. This excludes hash + prefixes and only includes user-addressible components. +

            +

            +
            Specified by:
            getComponents in class EntityId
            +
            +
            + +
            Returns:
            List of Objects representing the individual components of a row key.
            +
            +
            +
            + +

            +getKijiRowKey

            +
            +public byte[] getKijiRowKey()
            +
            +
            + +
            Returns:
            the Kiji row key, or null.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/InvalidColumnNameException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/InvalidColumnNameException.html new file mode 100644 index 00000000..5ce11a30 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/InvalidColumnNameException.html @@ -0,0 +1,251 @@ + + + + + + + +InvalidColumnNameException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class InvalidColumnNameException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.lang.RuntimeException
+              extended by org.kiji.schema.impl.InvalidColumnNameException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Private
+public final class InvalidColumnNameException
            extends RuntimeException
            + + +

            +Thrown when kiji encounters a column name that is not valid. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            InvalidColumnNameException(String message) + +
            +          Creates a new InvalidColumnNameException with the specified detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +InvalidColumnNameException

            +
            +public InvalidColumnNameException(String message)
            +
            +
            Creates a new InvalidColumnNameException with the specified detail message. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/KijiColumnPagingNotEnabledException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/KijiColumnPagingNotEnabledException.html new file mode 100644 index 00000000..a4fd5875 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/KijiColumnPagingNotEnabledException.html @@ -0,0 +1,258 @@ + + + + + + + +KijiColumnPagingNotEnabledException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class KijiColumnPagingNotEnabledException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.impl.KijiColumnPagingNotEnabledException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiColumnPagingNotEnabledException
            extends IOException
            + + +

            +Thrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column. + +

            To enable paging on a column, use the + KijiDataRequestBuilder.ColumnsDef.withPageSize(int) + method in your KijiDataRequestBuilder.

            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiColumnPagingNotEnabledException(String message) + +
            +          Creates a new KijiColumnPagingNotEnabledException with the specified + detail message.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +KijiColumnPagingNotEnabledException

            +
            +public KijiColumnPagingNotEnabledException(String message)
            +
            +
            Creates a new KijiColumnPagingNotEnabledException with the specified + detail message. +

            +

            +
            Parameters:
            message - An error message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/MetadataRestorer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/MetadataRestorer.html new file mode 100644 index 00000000..b463f1ce --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/MetadataRestorer.html @@ -0,0 +1,317 @@ + + + + + + + +MetadataRestorer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class MetadataRestorer

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.MetadataRestorer
+
            +
            +
            +
            public class MetadataRestorer
            extends Object
            + + +

            +Metadata restorer backups up meta info to MetadataBackup records and can restore metadata to the + meta and schema tables. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            MetadataRestorer() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidexportMetadata(String outputFile, + Kiji kiji) + +
            +          Exports all Kiji metadata to an Avro file with the specified filename.
            + voidrestoreSchemas(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all SchemaTable entries from the metadata backup.
            + voidrestoreTables(MetadataBackup backup, + Kiji kiji) + +
            +          Restores all tables from the metadata backup into the running Kiji instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +MetadataRestorer

            +
            +public MetadataRestorer()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +exportMetadata

            +
            +public void exportMetadata(String outputFile,
+                           Kiji kiji)
+                    throws IOException
            +
            +
            Exports all Kiji metadata to an Avro file with the specified filename. +

            +

            +
            Parameters:
            outputFile - the output filename. This file must not exist.
            kiji - the Kiji instance to backup. +
            Throws: +
            IOException - when an error communicating with HBase or the filesystem occurs.
            +
            +
            +
            + +

            +restoreTables

            +
            +public void restoreTables(MetadataBackup backup,
+                          Kiji kiji)
+                   throws IOException
            +
            +
            Restores all tables from the metadata backup into the running Kiji instance. +

            +

            +
            Parameters:
            backup - the deserialized backup of the metadata.
            kiji - the connected Kiji instance. +
            Throws: +
            IOException - if there is an error communicating with HBase.
            +
            +
            +
            + +

            +restoreSchemas

            +
            +public void restoreSchemas(MetadataBackup backup,
+                           Kiji kiji)
+                    throws IOException
            +
            +
            Restores all SchemaTable entries from the metadata backup. +

            +

            +
            Parameters:
            backup - the deserialized backup of the metadata.
            kiji - the connected Kiji instance. +
            Throws: +
            IOException - if there is an error communicating with HBase.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/RawEntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/RawEntityId.html new file mode 100644 index 00000000..3e69159b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/RawEntityId.html @@ -0,0 +1,370 @@ + + + + + + + +RawEntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class RawEntityId

            +
            +java.lang.Object
+  extended by org.kiji.schema.EntityId
+      extended by org.kiji.schema.impl.RawEntityId
+
            +
            +
            +
            @ApiAudience.Private
+public final class RawEntityId
            extends EntityId
            + + +

            +Implements the raw row key format. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static RawEntityIdfromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates a RawEntityId from the specified HBase row key.
            + + + + + +
            +<T> T
            +            		getComponentByIndex(int idx) + +
            +          Get the individual components of the kiji Row Key representation.
            + List<Object>getComponents() + +
            +          Get the components of the row key as a List of Objects.
            +static RawEntityIdgetEntityId(byte[] kijiRowKey) + +
            +          Creates a RawEntityId from the specified Kiji row key.
            + byte[]getHBaseRowKey() + +
            +          Translates this Kiji row key into an HBase row key.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.EntityId
            equals, hashCode
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getEntityId

            +
            +public static RawEntityId getEntityId(byte[] kijiRowKey)
            +
            +
            Creates a RawEntityId from the specified Kiji row key. +

            +

            +
            Parameters:
            kijiRowKey - Kiji row key. +
            Returns:
            a new RawEntityId with the specified Kiji row key.
            +
            +
            +
            + +

            +fromHBaseRowKey

            +
            +public static RawEntityId fromHBaseRowKey(byte[] hbaseRowKey)
            +
            +
            Creates a RawEntityId from the specified HBase row key. +

            +

            +
            Parameters:
            hbaseRowKey - HBase row key. +
            Returns:
            a new RawEntityId with the specified HBase row key.
            +
            +
            +
            + +

            +getHBaseRowKey

            +
            +public byte[] getHBaseRowKey()
            +
            +
            Translates this Kiji row key into an HBase row key. +

            +

            +
            Specified by:
            getHBaseRowKey in class EntityId
            +
            +
            + +
            Returns:
            the HBase row key.
            +
            +
            +
            + +

            +getComponentByIndex

            +
            +public <T> T getComponentByIndex(int idx)
            +
            +
            Get the individual components of the kiji Row Key representation. This excludes hash + prefixes and only includes user-addressible components. + E.g. If the key is composed of a String followed by an Int, getComponentByIndex(0) + returns the String component. Zero based indexing. +

            +

            +
            Specified by:
            getComponentByIndex in class EntityId
            +
            +
            +
            Type Parameters:
            T - The type of the row key component.
            Parameters:
            idx - The index of the component. An integer between 0 and numComponents - 1. +
            Returns:
            The specific component of the row key.
            +
            +
            +
            + +

            +getComponents

            +
            +public List<Object> getComponents()
            +
            +
            Get the components of the row key as a List of Objects. This excludes hash + prefixes and only includes user-addressible components. +

            +

            +
            Specified by:
            getComponents in class EntityId
            +
            +
            + +
            Returns:
            List of Objects representing the individual components of a row key.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/SpecificCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/SpecificCellDecoder.html new file mode 100644 index 00000000..cd916772 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/SpecificCellDecoder.html @@ -0,0 +1,290 @@ + + + + + + + +SpecificCellDecoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.impl +
            +Class SpecificCellDecoder<T>

            +
            +java.lang.Object
+  extended by org.kiji.schema.impl.AvroCellDecoder<T>
+      extended by org.kiji.schema.impl.SpecificCellDecoder<T>
+
            +
            +
            Type Parameters:
            T - The type of the decoded data.
            +
            +
            All Implemented Interfaces:
            KijiCellDecoder<T>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class SpecificCellDecoder<T>
            extends AvroCellDecoder<T>
            + + +

            +Decodes cells encoded using Avro into specific types. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            SpecificCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates specific Avro types.
            +  + + + + + + + + + + + +
            +Method Summary
            +protected  org.apache.avro.io.DatumReader<T>createDatumReader(org.apache.avro.Schema writer, + org.apache.avro.Schema reader) + +
            +          Factory for DatumReader instances.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.impl.AvroCellDecoder
            decodeAvro, decodeCell, decodeValue, getPayload
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +SpecificCellDecoder

            +
            +public SpecificCellDecoder(CellSpec cellSpec)
+                    throws IOException
            +
            +
            Initializes a cell decoder that creates specific Avro types. +

            +

            +
            Parameters:
            cellSpec - Specification of the cell encoding. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createDatumReader

            +
            +protected org.apache.avro.io.DatumReader<T> createDatumReader(org.apache.avro.Schema writer,
+                                                              org.apache.avro.Schema reader)
            +
            +
            Factory for DatumReader instances. + + Sub-classes must create DatumReader implementations for specific or generic records. +

            +

            +
            Specified by:
            createDatumReader in class AvroCellDecoder<T>
            +
            +
            +
            Parameters:
            writer - Writer schema.
            reader - Reader schema. +
            Returns:
            a new DatumReader instance for the specified writer/reader schema combination.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/AbstractKijiTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/AbstractKijiTable.html new file mode 100644 index 00000000..b4b498f5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/AbstractKijiTable.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.AbstractKijiTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.AbstractKijiTable

            +
            + + + + + + + + + +
            +Packages that use AbstractKijiTable
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of AbstractKijiTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Subclasses of AbstractKijiTable in org.kiji.schema.impl
            + classHBaseKijiTable + +
            +          A KijiTable that exposes the underlying HBase implementation.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/AvroCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/AvroCellDecoder.html new file mode 100644 index 00000000..74431456 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/AvroCellDecoder.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.AvroCellDecoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.AvroCellDecoder

            +
            + + + + + + + + + +
            +Packages that use AvroCellDecoder
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of AvroCellDecoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Subclasses of AvroCellDecoder in org.kiji.schema.impl
            + classGenericCellDecoder<T> + +
            +          Decodes cells encoded using Avro into generic types.
            + classSpecificCellDecoder<T> + +
            +          Decodes cells encoded using Avro into specific types.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/AvroCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/AvroCellEncoder.html new file mode 100644 index 00000000..9d44f0cb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/AvroCellEncoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.AvroCellEncoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.AvroCellEncoder

            +
            +No usage of org.kiji.schema.impl.AvroCellEncoder +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/CounterCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/CounterCellDecoder.html new file mode 100644 index 00000000..f0eb2fcb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/CounterCellDecoder.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.CounterCellDecoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.CounterCellDecoder

            +
            + + + + + + + + + +
            +Packages that use CounterCellDecoder
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of CounterCellDecoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return CounterCellDecoder
            +static CounterCellDecoderCounterCellDecoder.get() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/CounterCellEncoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/CounterCellEncoder.html new file mode 100644 index 00000000..bfd5183c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/CounterCellEncoder.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.CounterCellEncoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.CounterCellEncoder

            +
            + + + + + + + + + +
            +Packages that use CounterCellEncoder
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of CounterCellEncoder in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return CounterCellEncoder
            +static CounterCellEncoderCounterCellEncoder.get() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultHBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultHBaseAdminFactory.html new file mode 100644 index 00000000..156e17cd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultHBaseAdminFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultHBaseAdminFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultHBaseAdminFactory

            +
            +No usage of org.kiji.schema.impl.DefaultHBaseAdminFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultHBaseFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultHBaseFactory.html new file mode 100644 index 00000000..78fcf48b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultHBaseFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultHBaseFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultHBaseFactory

            +
            +No usage of org.kiji.schema.impl.DefaultHBaseFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultHTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultHTableInterfaceFactory.html new file mode 100644 index 00000000..7bf63720 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultHTableInterfaceFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultHTableInterfaceFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultHTableInterfaceFactory

            +
            +No usage of org.kiji.schema.impl.DefaultHTableInterfaceFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultKijiCellEncoderFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultKijiCellEncoderFactory.html new file mode 100644 index 00000000..e65143e4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultKijiCellEncoderFactory.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultKijiCellEncoderFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultKijiCellEncoderFactory

            +
            + + + + + + + + + +
            +Packages that use DefaultKijiCellEncoderFactory
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of DefaultKijiCellEncoderFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return DefaultKijiCellEncoderFactory
            +static DefaultKijiCellEncoderFactoryDefaultKijiCellEncoderFactory.get() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html new file mode 100644 index 00000000..2aa56888 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/DefaultKijiTableFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.DefaultKijiTableFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.DefaultKijiTableFactory

            +
            +No usage of org.kiji.schema.impl.DefaultKijiTableFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/FormattedEntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/FormattedEntityId.html new file mode 100644 index 00000000..5c1806ad --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/FormattedEntityId.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.FormattedEntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.FormattedEntityId

            +
            + + + + + + + + + +
            +Packages that use FormattedEntityId
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of FormattedEntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return FormattedEntityId
            +static FormattedEntityIdFormattedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat2 format) + +
            +          Creates a FormattedEntityId from the specified HBase row key.
            +static FormattedEntityIdFormattedEntityId.getEntityId(List<Object> kijiRowKey, + RowKeyFormat2 format) + +
            +          Creates a FormattedEntityId from the specified Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/GenericCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/GenericCellDecoder.html new file mode 100644 index 00000000..d0d810be --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/GenericCellDecoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.GenericCellDecoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.GenericCellDecoder

            +
            +No usage of org.kiji.schema.impl.GenericCellDecoder +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseAdminFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseAdminFactory.html new file mode 100644 index 00000000..54312664 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseAdminFactory.html @@ -0,0 +1,234 @@ + + + + + + + +Uses of Interface org.kiji.schema.impl.HBaseAdminFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.impl.HBaseAdminFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use HBaseAdminFactory
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseAdminFactory in org.kiji.schema.hbase
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.hbase that return HBaseAdminFactory
            + HBaseAdminFactoryHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            +  +

            + + + + + +
            +Uses of HBaseAdminFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement HBaseAdminFactory
            + classDefaultHBaseAdminFactory + +
            +          Factory for HBaseAdmin that creates concrete HBaseAdmin instances.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HBaseAdminFactory
            +static HBaseAdminFactoryDefaultHBaseAdminFactory.get() + +
            +           
            + HBaseAdminFactoryDefaultHBaseFactory.getHBaseAdminFactory(KijiURI uri) + +
            +          Reports a factory for HBaseAdmin for a given HBase instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html new file mode 100644 index 00000000..4b2db448 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseDataRequestAdapter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseDataRequestAdapter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseDataRequestAdapter

            +
            +No usage of org.kiji.schema.impl.HBaseDataRequestAdapter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseEntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseEntityId.html new file mode 100644 index 00000000..4f730c57 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseEntityId.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseEntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseEntityId

            +
            +No usage of org.kiji.schema.impl.HBaseEntityId +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKiji.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKiji.html new file mode 100644 index 00000000..ac48daf1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKiji.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKiji (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKiji

            +
            +No usage of org.kiji.schema.impl.HBaseKiji +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiFactory.html new file mode 100644 index 00000000..c7d20325 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiFactory

            +
            +No usage of org.kiji.schema.impl.HBaseKijiFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiPager.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiPager.html new file mode 100644 index 00000000..f80cdd33 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiPager.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiPager (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiPager

            +
            +No usage of org.kiji.schema.impl.HBaseKijiPager +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiRowData.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiRowData.html new file mode 100644 index 00000000..e069cf7d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiRowData.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiRowData (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiRowData

            +
            + + + + + + + + + +
            +Packages that use HBaseKijiRowData
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseKijiRowData in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HBaseKijiRowData
            + voidHBaseKijiRowData.merge(HBaseKijiRowData kijiRowData) + +
            +          Merges in the data from another HBaseKijiRowData instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html new file mode 100644 index 00000000..48d787ff --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.Options.html @@ -0,0 +1,219 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiRowScanner.Options (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiRowScanner.Options

            +
            + + + + + + + + + +
            +Packages that use HBaseKijiRowScanner.Options
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseKijiRowScanner.Options in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HBaseKijiRowScanner.Options
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withCellDecoderFactory(KijiCellDecoderFactory cellDecoderFactory) + +
            +          Sets the cell decoder factory to use when reading cells from the scanner.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withDataRequest(KijiDataRequest dataRequest) + +
            +          Sets the data request used to generate the KijiRowScanner.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withHBaseResultScanner(ResultScanner hbaseResultScanner) + +
            +          Sets the HBase result scanner the KijiRowScanner will wrap.
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withTable(HBaseKijiTable table) + +
            +          Sets the table being scanned.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type HBaseKijiRowScanner.Options
            HBaseKijiRowScanner(HBaseKijiRowScanner.Options options) + +
            +          Creates a new KijiRowScanner instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html new file mode 100644 index 00000000..9a4f32c4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiRowScanner.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiRowScanner (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiRowScanner

            +
            +No usage of org.kiji.schema.impl.HBaseKijiRowScanner +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiTable.html new file mode 100644 index 00000000..eeec2556 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiTable.html @@ -0,0 +1,248 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiTable

            +
            + + + + + + + + + +
            +Packages that use HBaseKijiTable
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HBaseKijiTable in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HBaseKijiTable
            +static HBaseKijiTableHBaseKijiTable.downcast(KijiTable kijiTable) + +
            +          We know that all KijiTables are really HBaseKijiTables + instances.
            + HBaseKijiTableHBaseKijiRowScanner.Options.getTable() + +
            +          Gets the table being scanned.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HBaseKijiTable
            + HBaseKijiRowScanner.OptionsHBaseKijiRowScanner.Options.withTable(HBaseKijiTable table) + +
            +          Sets the table being scanned.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type HBaseKijiTable
            HBaseKijiPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HBaseKijiTable table, + KijiColumnName colName) + +
            +          Initializes a HBaseKijiPager.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiRowData(KijiDataRequest request, + HBaseKijiTable table, + Result result) + +
            +          Initializes a row data.
            HBaseKijiTableReader(HBaseKijiTable table) + +
            +          Creates a new HBaseKijiTableReader instance that sends the read requests + directly to HBase.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html new file mode 100644 index 00000000..0031224b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiTableReader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiTableReader (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiTableReader

            +
            +No usage of org.kiji.schema.impl.HBaseKijiTableReader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html new file mode 100644 index 00000000..a0f4ed98 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseKijiTableWriter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseKijiTableWriter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseKijiTableWriter

            +
            +No usage of org.kiji.schema.impl.HBaseKijiTableWriter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseMetaTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseMetaTable.html new file mode 100644 index 00000000..ab7a0a8e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseMetaTable.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseMetaTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseMetaTable

            +
            +No usage of org.kiji.schema.impl.HBaseMetaTable +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseSchemaTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseSchemaTable.html new file mode 100644 index 00000000..ab6d1f8b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseSchemaTable.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseSchemaTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseSchemaTable

            +
            +No usage of org.kiji.schema.impl.HBaseSchemaTable +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseSystemTable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseSystemTable.html new file mode 100644 index 00000000..692a9172 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseSystemTable.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseSystemTable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseSystemTable

            +
            +No usage of org.kiji.schema.impl.HBaseSystemTable +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html new file mode 100644 index 00000000..04602193 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HBaseTableKeyValueDatabase.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HBaseTableKeyValueDatabase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HBaseTableKeyValueDatabase

            +
            +No usage of org.kiji.schema.impl.HBaseTableKeyValueDatabase +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html new file mode 100644 index 00000000..4e28f9d7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HColumnDescriptorComparator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HColumnDescriptorComparator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HColumnDescriptorComparator

            +
            +No usage of org.kiji.schema.impl.HColumnDescriptorComparator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html new file mode 100644 index 00000000..a3f3d5b2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HTableDescriptorComparator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HTableDescriptorComparator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HTableDescriptorComparator

            +
            +No usage of org.kiji.schema.impl.HTableDescriptorComparator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HTableInterfaceFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HTableInterfaceFactory.html new file mode 100644 index 00000000..23485be0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HTableInterfaceFactory.html @@ -0,0 +1,349 @@ + + + + + + + +Uses of Interface org.kiji.schema.impl.HTableInterfaceFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.impl.HTableInterfaceFactory

            +
            + + + + + + + + + + + + + +
            +Packages that use HTableInterfaceFactory
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HTableInterfaceFactory in org.kiji.schema.hbase
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.hbase that return HTableInterfaceFactory
            + HTableInterfaceFactoryHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            +  +

            + + + + + +
            +Uses of HTableInterfaceFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement HTableInterfaceFactory
            + classDefaultHTableInterfaceFactory + +
            +          Factory for HTableInterface that creates concrete HTable instances.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HTableInterfaceFactory
            +static HTableInterfaceFactoryDefaultHTableInterfaceFactory.get() + +
            +           
            + HTableInterfaceFactoryDefaultHBaseFactory.getHTableInterfaceFactory(KijiURI uri) + +
            +          Reports a factory for HTableInterface for a given HBase instance.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type HTableInterfaceFactory
            +static voidHBaseSystemTable.install(HBaseAdmin admin, + KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Installs a Kiji system table into a running HBase instance.
            +static voidHBaseSchemaTable.install(HBaseAdmin admin, + KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static HTableInterfaceHBaseMetaTable.newMetaTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTableInterface for the specified table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaHashTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema hash table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaIdTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema ID table.
            +static HTableInterfaceHBaseSchemaTable.newSchemaV5Table(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates an HTable handle to the schema V5 table.
            +static HTableInterfaceHBaseSystemTable.newSystemTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Creates a new HTableInterface for the Kiji system table.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type HTableInterfaceFactory
            HBaseMetaTable(KijiURI kijiURI, + Configuration conf, + KijiSchemaTable schemaTable, + HTableInterfaceFactory factory) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            HBaseSchemaTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            HBaseSystemTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory factory) + +
            +          Connect to the HBase system table inside a Kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html new file mode 100644 index 00000000..f1f8c717 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HashPrefixedEntityId.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HashPrefixedEntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HashPrefixedEntityId

            +
            + + + + + + + + + +
            +Packages that use HashPrefixedEntityId
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HashPrefixedEntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HashPrefixedEntityId
            +static HashPrefixedEntityIdHashPrefixedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified HBase row key.
            +static HashPrefixedEntityIdHashPrefixedEntityId.getEntityId(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashPrefixedEntityId from the specified Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HashedEntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HashedEntityId.html new file mode 100644 index 00000000..c51f1360 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/HashedEntityId.html @@ -0,0 +1,191 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.HashedEntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.HashedEntityId

            +
            + + + + + + + + + +
            +Packages that use HashedEntityId
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of HashedEntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return HashedEntityId
            +static HashedEntityIdHashedEntityId.fromHBaseRowKey(byte[] hbaseRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified HBase row key.
            +static HashedEntityIdHashedEntityId.getEntityId(byte[] kijiRowKey, + RowKeyFormat format) + +
            +          Creates a HashedEntityId from the specified Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/InvalidColumnNameException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/InvalidColumnNameException.html new file mode 100644 index 00000000..42fb135b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/InvalidColumnNameException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.InvalidColumnNameException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.InvalidColumnNameException

            +
            +No usage of org.kiji.schema.impl.InvalidColumnNameException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/KijiColumnPagingNotEnabledException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/KijiColumnPagingNotEnabledException.html new file mode 100644 index 00000000..02d7a491 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/KijiColumnPagingNotEnabledException.html @@ -0,0 +1,246 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.KijiColumnPagingNotEnabledException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.KijiColumnPagingNotEnabledException

            +
            + + + + + + + + + + + + + +
            +Packages that use KijiColumnPagingNotEnabledException
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of KijiColumnPagingNotEnabledException in org.kiji.schema
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema that throw KijiColumnPagingNotEnabledException
            + KijiPagerKijiRowData.getPager(String family) + +
            +          Gets a KijiPager for the specified column family.
            + KijiPagerKijiRowData.getPager(String family, + String qualifier) + +
            +          Gets a KijiPager for the specified column.
            +  +

            + + + + + +
            +Uses of KijiColumnPagingNotEnabledException in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that throw KijiColumnPagingNotEnabledException
            + KijiPagerHBaseKijiRowData.getPager(String family) + +
            +          Gets a KijiPager for the specified column family.
            + KijiPagerHBaseKijiRowData.getPager(String family, + String qualifier) + +
            +          Gets a KijiPager for the specified column.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl that throw KijiColumnPagingNotEnabledException
            HBaseKijiPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HBaseKijiTable table, + KijiColumnName colName) + +
            +          Initializes a HBaseKijiPager.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/MetadataRestorer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/MetadataRestorer.html new file mode 100644 index 00000000..64a6a6c7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/MetadataRestorer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.MetadataRestorer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.MetadataRestorer

            +
            +No usage of org.kiji.schema.impl.MetadataRestorer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/RawEntityId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/RawEntityId.html new file mode 100644 index 00000000..feb2a15b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/RawEntityId.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.RawEntityId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.RawEntityId

            +
            + + + + + + + + + +
            +Packages that use RawEntityId
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of RawEntityId in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return RawEntityId
            +static RawEntityIdRawEntityId.fromHBaseRowKey(byte[] hbaseRowKey) + +
            +          Creates a RawEntityId from the specified HBase row key.
            +static RawEntityIdRawEntityId.getEntityId(byte[] kijiRowKey) + +
            +          Creates a RawEntityId from the specified Kiji row key.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/SpecificCellDecoder.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/SpecificCellDecoder.html new file mode 100644 index 00000000..29e34879 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/class-use/SpecificCellDecoder.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.impl.SpecificCellDecoder (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.impl.SpecificCellDecoder

            +
            +No usage of org.kiji.schema.impl.SpecificCellDecoder +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-frame.html new file mode 100644 index 00000000..844f6150 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-frame.html @@ -0,0 +1,125 @@ + + + + + + + +org.kiji.schema.impl (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema.impl + + + + +
            +Interfaces  + +
            +HBaseAdminFactory +
            +HTableInterfaceFactory
            + + + + + + +
            +Classes  + +
            +AbstractKijiTable +
            +AvroCellDecoder +
            +AvroCellEncoder +
            +CounterCellDecoder +
            +CounterCellEncoder +
            +DefaultHBaseAdminFactory +
            +DefaultHBaseFactory +
            +DefaultHTableInterfaceFactory +
            +DefaultKijiCellEncoderFactory +
            +DefaultKijiTableFactory +
            +FormattedEntityId +
            +GenericCellDecoder +
            +HashedEntityId +
            +HashPrefixedEntityId +
            +HBaseDataRequestAdapter +
            +HBaseEntityId +
            +HBaseKiji +
            +HBaseKijiFactory +
            +HBaseKijiPager +
            +HBaseKijiRowData +
            +HBaseKijiRowScanner +
            +HBaseKijiRowScanner.Options +
            +HBaseKijiTable +
            +HBaseKijiTableReader +
            +HBaseKijiTableWriter +
            +HBaseMetaTable +
            +HBaseSchemaTable +
            +HBaseSystemTable +
            +HBaseTableKeyValueDatabase +
            +HColumnDescriptorComparator +
            +HTableDescriptorComparator +
            +MetadataRestorer +
            +RawEntityId +
            +SpecificCellDecoder
            + + + + + + +
            +Exceptions  + +
            +InvalidColumnNameException +
            +KijiColumnPagingNotEnabledException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-summary.html new file mode 100644 index 00000000..829edbda --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-summary.html @@ -0,0 +1,352 @@ + + + + + + + +org.kiji.schema.impl (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.impl +

            +Implementations for the main KijiSchema classes and interfaces. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + +
            +Interface Summary
            HBaseAdminFactoryFactory for HBaseAdmin.
            HTableInterfaceFactoryFactory for HTableInterface instances.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AbstractKijiTableMain handle for a Kiji table with basic functionality.
            AvroCellDecoder<T>Base class for decoders that read Kiji cells encoded using Avro.
            AvroCellEncoderSerializes a KijiCell.
            CounterCellDecoderCell decoder for counters.
            CounterCellEncoderEncoder for Kiji counters.
            DefaultHBaseAdminFactoryFactory for HBaseAdmin that creates concrete HBaseAdmin instances.
            DefaultHBaseFactoryFactory for HBase instances based on URIs.
            DefaultHTableInterfaceFactoryFactory for HTableInterface that creates concrete HTable instances.
            DefaultKijiCellEncoderFactoryFactory for cell encoders.
            DefaultKijiTableFactoryThe default implementation of a KijiTableFactory that creates KijiTables via KijiTable.open().
            FormattedEntityIdImplements the Formatted Entity Id row key.
            GenericCellDecoder<T>Decodes cells encoded using Avro into generic types.
            HashedEntityIdImplements the hashed row key format.
            HashPrefixedEntityIdImplements the hash-prefixed row key format.
            HBaseDataRequestAdapterWraps a KijiDataRequest to expose methods that generate meaningful objects in HBase + land, like Puts and Gets.
            HBaseEntityIdEntity ID encapsulating an HBase row key.
            HBaseKijiKiji instance class that contains configuration and table + information.
            HBaseKijiFactoryFactory for constructing instances of HBaseKiji.
            HBaseKijiPagerImplementation of a KijiPager for HBase.
            HBaseKijiRowDataAn implementation of KijiRowData that wraps an HBase Result object.
            HBaseKijiRowScannerThe internal implementation of KijiRowScanner that reads from HTables.
            HBaseKijiRowScanner.OptionsA class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            HBaseKijiTableA KijiTable that exposes the underlying HBase implementation.
            HBaseKijiTableReaderReads from a kiji table by sending the requests directly to the HBase tables.
            HBaseKijiTableWriterMakes modifications to a Kiji table by sending requests directly to HBase from the local client.
            HBaseMetaTableAn implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            HBaseSchemaTable + Mapping between schema IDs, hashes and Avro schema objects.
            HBaseSystemTableThe Kiji system table that is stored in HBase.
            HBaseTableKeyValueDatabaseManages key-value pairs on a per table basis.
            HColumnDescriptorComparatorComparator for HColumnDescriptors.
            HTableDescriptorComparatorCompares HTableDescriptors.
            MetadataRestorerMetadata restorer backups up meta info to MetadataBackup records and can restore metadata to the + meta and schema tables.
            RawEntityIdImplements the raw row key format.
            SpecificCellDecoder<T>Decodes cells encoded using Avro into specific types.
            +  + +

            + + + + + + + + + + + + + +
            +Exception Summary
            InvalidColumnNameExceptionThrown when kiji encounters a column name that is not valid.
            KijiColumnPagingNotEnabledExceptionThrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column.
            +  + +

            +

            +Package org.kiji.schema.impl Description +

            + +

            +Implementations for the main KijiSchema classes and interfaces. + +

            + Users generally shouldn't need to reference any of these classes directly, but rather use the + classes presented by the org.kiji.schema package. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-tree.html new file mode 100644 index 00000000..34314dbf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-tree.html @@ -0,0 +1,203 @@ + + + + + + + +org.kiji.schema.impl Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-use.html new file mode 100644 index 00000000..0d777d0b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/impl/package-use.html @@ -0,0 +1,301 @@ + + + + + + + +Uses of Package org.kiji.schema.impl (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.impl

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.impl
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.impl used by org.kiji.schema
            KijiColumnPagingNotEnabledException + +
            +          Thrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.impl used by org.kiji.schema.hbase
            HBaseAdminFactory + +
            +          Factory for HBaseAdmin.
            HTableInterfaceFactory + +
            +          Factory for HTableInterface instances.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.impl used by org.kiji.schema.impl
            AbstractKijiTable + +
            +          Main handle for a Kiji table with basic functionality.
            AvroCellDecoder + +
            +          Base class for decoders that read Kiji cells encoded using Avro.
            CounterCellDecoder + +
            +          Cell decoder for counters.
            CounterCellEncoder + +
            +          Encoder for Kiji counters.
            DefaultKijiCellEncoderFactory + +
            +          Factory for cell encoders.
            FormattedEntityId + +
            +          Implements the Formatted Entity Id row key.
            HashedEntityId + +
            +          Implements the hashed row key format.
            HashPrefixedEntityId + +
            +          Implements the hash-prefixed row key format.
            HBaseAdminFactory + +
            +          Factory for HBaseAdmin.
            HBaseKijiRowData + +
            +          An implementation of KijiRowData that wraps an HBase Result object.
            HBaseKijiRowScanner.Options + +
            +          A class to encapsulate the various options the HBaseKijiRowScanner constructor requires.
            HBaseKijiTable + +
            +          A KijiTable that exposes the underlying HBase implementation.
            HTableInterfaceFactory + +
            +          Factory for HTableInterface instances.
            KijiColumnPagingNotEnabledException + +
            +          Thrown when a client attempts to fetch the next page of data from a Kiji column, but paging is + not enabled on the column.
            RawEntityId + +
            +          Implements the raw row key format.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/ColumnNameTranslator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/ColumnNameTranslator.html new file mode 100644 index 00000000..2f04cf09 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/ColumnNameTranslator.html @@ -0,0 +1,354 @@ + + + + + + + +ColumnNameTranslator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class ColumnNameTranslator

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.ColumnNameTranslator
+
            +
            +
            +
            @ApiAudience.Public
+public final class ColumnNameTranslator
            extends Object
            + + +

            +Translates between HTable and Kiji table column names. + +

            This class defines a mapping between names of HBase HTable families/qualifiers and + Kiji table family/qualifiers.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static StringSEPARATOR + +
            +          Used to separate the Kiji family from the Kiji qualifier in an HBase qualifier.
            +  + + + + + + + + + + +
            +Constructor Summary
            ColumnNameTranslator(KijiTableLayout tableLayout) + +
            +          Creates a new ColumnNameTranslator instance.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiTableLayoutgetTableLayout() + +
            +           
            + HBaseColumnNametoHBaseColumnName(KijiColumnName kijiColumnName) + +
            +          Translates a Kiji column name into an HBase column name.
            + KijiColumnNametoKijiColumnName(HBaseColumnName hbaseColumnName) + +
            +          Translates an HBase column name to a Kiji column name.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SEPARATOR

            +
            +public static final String SEPARATOR
            +
            +
            Used to separate the Kiji family from the Kiji qualifier in an HBase qualifier. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +ColumnNameTranslator

            +
            +public ColumnNameTranslator(KijiTableLayout tableLayout)
            +
            +
            Creates a new ColumnNameTranslator instance. +

            +

            +
            Parameters:
            tableLayout - The layout of the table to translate column names for.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +toKijiColumnName

            +
            +public KijiColumnName toKijiColumnName(HBaseColumnName hbaseColumnName)
+                                throws NoSuchColumnException
            +
            +
            Translates an HBase column name to a Kiji column name. +

            +

            +
            Parameters:
            hbaseColumnName - The HBase column name. +
            Returns:
            The Kiji column name. +
            Throws: +
            NoSuchColumnException - If the column name cannot be found.
            +
            +
            +
            + +

            +toHBaseColumnName

            +
            +public HBaseColumnName toHBaseColumnName(KijiColumnName kijiColumnName)
+                                  throws NoSuchColumnException
            +
            +
            Translates a Kiji column name into an HBase column name. +

            +

            +
            Parameters:
            kijiColumnName - The Kiji column name. +
            Returns:
            The HBase column name. +
            Throws: +
            NoSuchColumnException - If the column name cannot be found.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout()
            +
            +
            + +
            Returns:
            the table layout.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/InvalidLayoutException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/InvalidLayoutException.html new file mode 100644 index 00000000..90f043e6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/InvalidLayoutException.html @@ -0,0 +1,283 @@ + + + + + + + +InvalidLayoutException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class InvalidLayoutException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.layout.InvalidLayoutException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Direct Known Subclasses:
            SchemaClassNotFoundException
            +
            +
            +
            +
            @ApiAudience.Public
+public class InvalidLayoutException
            extends IOException
            + + +

            +Thrown when an invalid Kiji layout is encountered. Possible reasons why a layout may be + invalid include: +

              +
            • Invalid data schemas.
              • +
            • Missing family or column names.
              • +
            • The family or column ids were not assigned.
              • +
            • The update layout is inconsistent with respect to a reference layout. See + KijiTableLayout + for a description of update layouts.
              • +
            +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            InvalidLayoutException(KijiTableLayout tableLayout, + String reason) + +
            +          Constructs an exception indicated a table layout is invalid.
            InvalidLayoutException(String reason) + +
            +          Creates a new InvalidLayoutException with the specified reason.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +InvalidLayoutException

            +
            +public InvalidLayoutException(String reason)
            +
            +
            Creates a new InvalidLayoutException with the specified reason. +

            +

            +
            Parameters:
            reason - A message describing the reason the layout is invalid.
            +
            +
            + +

            +InvalidLayoutException

            +
            +public InvalidLayoutException(KijiTableLayout tableLayout,
+                              String reason)
            +
            +
            Constructs an exception indicated a table layout is invalid. +

            +

            +
            Parameters:
            tableLayout - The table layout that is invalid.
            reason - A message describing the reason the layout is invalid.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html new file mode 100644 index 00000000..425a009e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html @@ -0,0 +1,309 @@ + + + + + + + +KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
+
            +
            +
            Enclosing class:
            KijiTableLayout.LocalityGroupLayout.FamilyLayout
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            extends Object
            + + +

            +Concrete layout of a column. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + ColumnDescgetDesc() + +
            +           
            + KijiTableLayout.LocalityGroupLayout.FamilyLayoutgetFamily() + +
            +           
            + ColumnIdgetId() + +
            +           
            + StringgetName() + +
            +           
            + Set<String>getNames() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getDesc

            +
            +public ColumnDesc getDesc()
            +
            +
            + +
            Returns:
            A copy of the Avro descriptor for this column.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the primary name for the column.
            +
            +
            +
            + +

            +getNames

            +
            +public Set<String> getNames()
            +
            +
            + +
            Returns:
            the name and aliases for the column.
            +
            +
            +
            + +

            +getId

            +
            +public ColumnId getId()
            +
            +
            + +
            Returns:
            the ID associated to this column.
            +
            +
            +
            + +

            +getFamily

            +
            +public KijiTableLayout.LocalityGroupLayout.FamilyLayout getFamily()
            +
            +
            + +
            Returns:
            the family this column belongs to.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html new file mode 100644 index 00000000..5825deec --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html @@ -0,0 +1,426 @@ + + + + + + + +KijiTableLayout.LocalityGroupLayout.FamilyLayout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout.LocalityGroupLayout.FamilyLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout
+
            +
            +
            Enclosing class:
            KijiTableLayout.LocalityGroupLayout
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout.LocalityGroupLayout.FamilyLayout
            extends Object
            + + +

            +Concrete layout of a family. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            + classKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout + +
            +          Concrete layout of a column.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + com.google.common.collect.BiMap<ColumnId,String>getColumnIdNameMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>getColumnMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>getColumns() + +
            +           
            + FamilyDescgetDesc() + +
            +           
            + ColumnIdgetId() + +
            +           
            + KijiTableLayout.LocalityGroupLayoutgetLocalityGroup() + +
            +           
            + StringgetName() + +
            +           
            + Set<String>getNames() + +
            +           
            + booleanisGroupType() + +
            +           
            + booleanisMapType() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getDesc

            +
            +public FamilyDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this family.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the primary name for the family.
            +
            +
            +
            + +

            +getNames

            +
            +public Set<String> getNames()
            +
            +
            + +
            Returns:
            the family name and aliases.
            +
            +
            +
            + +

            +getId

            +
            +public ColumnId getId()
            +
            +
            + +
            Returns:
            the column ID assigned to this family.
            +
            +
            +
            + +

            +getColumns

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout> getColumns()
            +
            +
            + +
            Returns:
            the columns in this family.
            +
            +
            +
            + +

            +getColumnMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout> getColumnMap()
            +
            +
            + +
            Returns:
            the mapping from column names (no aliases) to column layouts.
            +
            +
            +
            + +

            +getColumnIdNameMap

            +
            +public com.google.common.collect.BiMap<ColumnId,String> getColumnIdNameMap()
            +
            +
            + +
            Returns:
            the bidirectional mapping between column names (no aliases) and IDs.
            +
            +
            +
            + +

            +getLocalityGroup

            +
            +public KijiTableLayout.LocalityGroupLayout getLocalityGroup()
            +
            +
            + +
            Returns:
            the locality group this family belongs to.
            +
            +
            +
            + +

            +isGroupType

            +
            +public boolean isGroupType()
            +
            +
            + +
            Returns:
            whether this is a group-type family.
            +
            +
            +
            + +

            +isMapType

            +
            +public boolean isMapType()
            +
            +
            + +
            Returns:
            whether this is a map-type family.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html new file mode 100644 index 00000000..12fcc3e9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.LocalityGroupLayout.html @@ -0,0 +1,386 @@ + + + + + + + +KijiTableLayout.LocalityGroupLayout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout.LocalityGroupLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout
+
            +
            +
            Enclosing class:
            KijiTableLayout
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout.LocalityGroupLayout
            extends Object
            + + +

            +Concrete layout of a locality group. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            + classKijiTableLayout.LocalityGroupLayout.FamilyLayout + +
            +          Concrete layout of a family.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + LocalityGroupDescgetDesc() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilies() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>getFamilyIdNameMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilyMap() + +
            +           
            + ColumnIdgetId() + +
            +           
            + StringgetName() + +
            +           
            + Set<String>getNames() + +
            +           
            + KijiTableLayoutgetTableLayout() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout()
            +
            +
            + +
            Returns:
            the table layout this locality group belongs to.
            +
            +
            +
            + +

            +getDesc

            +
            +public LocalityGroupDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this locality group.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the locality group primary name.
            +
            +
            +
            + +

            +getNames

            +
            +public Set<String> getNames()
            +
            +
            + +
            Returns:
            the locality group name and aliases.
            +
            +
            +
            + +

            +getId

            +
            +public ColumnId getId()
            +
            +
            + +
            Returns:
            the ID associated to this locality group.
            +
            +
            +
            + +

            +getFamilies

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilies()
            +
            +
            + +
            Returns:
            the families in this locality group, in no particular order.
            +
            +
            +
            + +

            +getFamilyMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilyMap()
            +
            +
            + +
            Returns:
            the mapping from family names and aliases to family layouts.
            +
            +
            +
            + +

            +getFamilyIdNameMap

            +
            +public com.google.common.collect.BiMap<ColumnId,String> getFamilyIdNameMap()
            +
            +
            + +
            Returns:
            the bidirectional mapping between family names (no alias) and IDs.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.html new file mode 100644 index 00000000..7ee5eb8d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayout.html @@ -0,0 +1,1005 @@ + + + + + + + +KijiTableLayout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class KijiTableLayout

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.KijiTableLayout
+
            +
            +
            +
            @ApiAudience.Public
+public final class KijiTableLayout
            extends Object
            + + +

            +Layout of a Kiji table. + +

            + Kiji uses the term layout to describe the structure of a table. + Kiji does not use the term schema to avoid confusion with Avro schemas or XML schemas. +

            + +

            + KijiTableLayout wraps a layout descriptor represented as a + TableLayoutDesc Avro record. + KijiTableLayout provides strict validation and accessors to navigate through the layout. +

            + +

            + KijiTableLayouts can be created via one of two methods: from a concrete layout with + newLayout(TableLayoutDesc), or as a layout update from a preexisting + KijiTableLayout, with createUpdatedLayout(TableLayoutDesc,KijiTableLayout). + For the format requirements of layout descriptors for these methods, see the + "Layout descriptors" section below. +

            + +

            Overall structure

            +

            At the top-level, a table contains: +

              +
            • the table name and description;
              • +
            • how row keys are encoded;
              • +
            • the table locality groups.
              • +
            +

            + +

            Each locality group has: +

              +
            • a primary name, unique within the table, a description and some name aliases;
              • +
            • whether the data is to be stored in memory or on disk;
              • +
            • data retention lifetime;
              • +
            • maximum number of versions to keep;
              • +
            • type of compression;
              • +
            • column families stored in this locality group
              • +
            +

            + +

            Each column family has: +

              +
            • a primary name, globally unique within the table, + a description and some name aliases;
              • +
            • for map-type families, the Avro schema of the cell values;
              • +
            • for group-type families, the collection of columns in the group.
              • +
            +

            + +

            Each column in a group-type family has: +

              +
            • a primary name, unique within the family, a description and some name aliases;
              • +
            • an Avro schema.
              • +
            +

            + +

            Layout descriptors

            + + Layout descriptors are represented using + TableLayoutDesc Avro records. + Layout descriptors come in two flavors: concrete layouts and layout updates. + +

            Concrete layout descriptors

            + A concrete layout descriptors is an absolute, standalone description of a table layout, which + does not reference or build upon any previous version of the table layout. Column IDs have + been assigned to all locality groups, families and columns. + +

            Names of tables, locality groups, families and column qualifiers must be valid identifiers. + Name validation occurs in KijiNameValidator. + +

            Validation rules

            + +
              +
            • Table names, locality group names, family names, and column names in a group-type family + must be valid identifiers (no punctuation or symbols). + Note: map-type family qualifiers are free-form, but do never appear in a table layout. +
            • Locality group names and aliases must be unique within the table. +
            • Family names and aliases must be unique within the table. +
            • Group-type family qualifiers must be unique within the family. +
            + +

            Layout update descriptors

            + A table layout update descriptor builds on a reference table layout, and describes layout + modification to apply on the reference layout. + The reference table layout is specified by writing the ID of the reference layout + (TableLayoutDesc.layout_id) into the TableLayoutDesc.reference_layout. + This mechanism prevents race conditions when updating the layout of a table. + The first layout of a newly created table has no reference layout. + +

            During a layout update, the user may delete or declare new locality groups, families and/or + columns, or modify existing entities, by specifying the new layout. Update validation rules + are enforced to ensure compatibility (see Validation rules for updates below). + +

            Entities may also be renamed, as long as uniqueness requirements are met. + Primary name updates must be explicitly annotated by setting the renamedFrom field of + the entity being renamed. + The name of a table cannot be changed. + +

            For example, suppose the reference layout contained one family Info, containing a + column Name, and the user wishes to add a new Address column to the + Info family. + To perform this update, the user would create a layout update by starting with the existing + layout, setting the reference_layout field to the layout_id of the + current layout, and adding a new ColumnDesc record describing the Address + column to the the columns field of the FamilyDesc for the Info family. + +

            The result of applying a layout update on top of a concrete reference layout is a new + concrete layout. + +

            Validation rules for updates

            + +

            Updates are subject to the same restrictions as concrete layout descriptors. + In addition:

            + +
              +
            • The type of a family (map-type or group-type) cannot be changed. +
            • A family cannot be moved into a different locality group. +
            • The encoding of Kiji cells (hash, UID, final) cannot be modified. +
            • The schema of a Kiji cell can only be changed to a schema that is compatible with + all the former schemas of the column. Schema compatibility requires that the new schema + allows decoding all former schemas associated to the column or the map-type family. +
            + +

            Row keys encoding

            + + A row in a Kiji table is identified by its Kiji row key. Kiji row keys are converted into HBase + row keys according to the row key encoding specified in the table layout: +
              +
            • Raw encoding: the user has direct control over the encoding of row keys in the HBase + table. In other words, the HBase row key is exactly the Kiji row key. These are used + when the user would like to use arrays of bytes as row keys. +
              • +
            • Hashed: Deprecated! The HBase row key is computed as a hash of a single String or + byte array component. +
              • +
            • Hash-prefixed: the HBase row key is computed as the concatenation of the hash of a + single String or byte array component. +
              • +
            • Formatted: the row key is comprised of one or more components. Each component can be + a string, a number or a hash of another component. The user will specify the size + of this hash. The user also specifies the actual order of the components in the key. +
              • +
            + + Hashing allows to spread the rows evenly across all the regions in the table. Specifying the size + of the hash gives the user fine grained control of how the data will be distributed. + +

            Cell schema

            + + Kiji cells are encoded according to a schema specified via + CellSchema Avro records. + Kiji provides various cell encoding schemes: +
              +
            • Hash: each Kiji cell is encoded as a hash of the Avro schema, followed by the binary + encoding of the Avro value. +
              • +
            • UID: each Kiji cell is encoded as the unique ID of the Avro schema, followed by the + binary encoding of the Avro value. +
              • +
            • Final: each Kiji cell is encoded as the binary encoding of the Avro value. +
              • +
            + See KijiCellEncoder + and KijiCellDecoder + for more implementation details. + +

            Column IDs

            + + For storage efficiency purposes, Kiji family and column names are translated into short + HBase column names. + The translation happens in + ColumnNameTranslator + and relies on + ColumnId. + Column IDs are assigned automatically by KijiTableLayout. + The user may specify column IDs manually. KijiTableLayout checks the consistency of column IDs. + +

            Column IDs cannot be changed (a column ID change is equivalent to deleting the existing column + and then re-creating it as a new empty column). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            + classKijiTableLayout.LocalityGroupLayout + +
            +          Concrete layout of a locality group.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static KijiTableLayoutcreateFromEffectiveJson(InputStream istream) + +
            +          Loads a table layout from the specified JSON text.
            +static KijiTableLayoutcreateFromEffectiveJsonResource(String resource) + +
            +          Loads a table layout from the specified resource as JSON.
            +static KijiTableLayoutcreateUpdatedLayout(TableLayoutDesc updateLayoutDesc, + KijiTableLayout oldLayout) + +
            +          Creates and returns a new KijiTableLayout instance as specified by composing updates described + by a TableLayoutDesc with the original + KijiTableLayout.
            + booleanequals(Object other) + +
            +          
            + booleanexists(KijiColumnName column) + +
            +          Reports whether a column exists.
            + SchemaStoragegetCellFormat(KijiColumnName column) + +
            +          Reports the cell format for the specified column.
            + CellSchemagetCellSchema(KijiColumnName columnName) + +
            +          Gets the schema for a column.
            + CellSpecgetCellSpec(KijiColumnName column) + +
            +           
            + Set<KijiColumnName>getColumnNames() + +
            +           
            + TableLayoutDescgetDesc() + +
            +           
            +static RowKeyEncodinggetEncoding(Object rowKeyFormat) + +
            +          Find the encoding of the row key given the format.
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilies() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>getFamilyMap() + +
            +           
            +static intgetHashSize(Object rowKeyFormat) + +
            +          Get the hash size for a given row key format.
            + com.google.common.collect.BiMap<ColumnId,String>getLocalityGroupIdNameMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout>getLocalityGroupMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout>getLocalityGroups() + +
            +           
            +static ProtocolVersiongetMaxSupportedLayoutVersion() + +
            +          Returns the maximum layout version supported.
            +static ProtocolVersiongetMinSupportedLayoutVersion() + +
            +          Returns the minimum layout version supported.
            + StringgetName() + +
            +           
            + org.apache.avro.SchemagetSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            + inthashCode() + +
            +          
            +static KijiTableLayoutnewLayout(TableLayoutDesc layout) + +
            +          Creates and returns a new KijiTableLayout instance as specified by an Avro TableLayoutDesc + description record.
            +static org.apache.avro.SchemareadAvroSchema(CellSchema avro) + +
            +          Reads the Avro schema from the table layout.
            +static TableLayoutDescreadTableLayoutDescFromJSON(InputStream istream) + +
            +          Reads a table layout descriptor from its JSON serialized form.
            + StringtoString() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getMaxSupportedLayoutVersion

            +
            +public static ProtocolVersion getMaxSupportedLayoutVersion()
            +
            +
            Returns the maximum layout version supported. +

            +

            + +
            Returns:
            the maximum layout version recognized by this version of Kiji.
            +
            +
            +
            + +

            +getMinSupportedLayoutVersion

            +
            +public static ProtocolVersion getMinSupportedLayoutVersion()
            +
            +
            Returns the minimum layout version supported. +

            +

            + +
            Returns:
            the minimum layout version recognized by this version of Kiji.
            +
            +
            +
            + +

            +getDesc

            +
            +public TableLayoutDesc getDesc()
            +
            +
            + +
            Returns:
            the Avro descriptor for this table layout.
            +
            +
            +
            + +

            +getName

            +
            +public String getName()
            +
            +
            + +
            Returns:
            the table name.
            +
            +
            +
            + +

            +getLocalityGroups

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout> getLocalityGroups()
            +
            +
            + +
            Returns:
            the locality groups in the table, in no particular order.
            +
            +
            +
            + +

            +getLocalityGroupIdNameMap

            +
            +public com.google.common.collect.BiMap<ColumnId,String> getLocalityGroupIdNameMap()
            +
            +
            + +
            Returns:
            the bidirectional mapping between locality group names (no alias) and IDs.
            +
            +
            +
            + +

            +getLocalityGroupMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout> getLocalityGroupMap()
            +
            +
            + +
            Returns:
            the map from locality group names and aliases to layouts.
            +
            +
            +
            + +

            +getFamilyMap

            +
            +public Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilyMap()
            +
            +
            + +
            Returns:
            the mapping from family names and aliases to family layouts in the table.
            +
            +
            +
            + +

            +getFamilies

            +
            +public Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout> getFamilies()
            +
            +
            + +
            Returns:
            all the families in the table, in no particular order.
            +
            +
            +
            + +

            +getColumnNames

            +
            +public Set<KijiColumnName> getColumnNames()
            +
            +
            + +
            Returns:
            all the primary column names in the table, including map-type families.
            +
            +
            +
            + +

            +getCellSchema

            +
            +public CellSchema getCellSchema(KijiColumnName columnName)
+                         throws NoSuchColumnException
            +
            +
            Gets the schema for a column. +

            +

            +
            Parameters:
            columnName - The name of the column to get the schema for. +
            Returns:
            the schema of the specified column. +
            Throws: +
            NoSuchColumnException - if the column does not exist.
            +
            +
            +
            + +

            +getSchema

            +
            +public org.apache.avro.Schema getSchema(KijiColumnName columnName)
+                                 throws InvalidLayoutException,
+                                        NoSuchColumnException
            +
            +
            Reports the schema of the specified column. +

            +

            +
            Parameters:
            columnName - Column name. +
            Returns:
            the schema of the column. +
            Throws: +
            InvalidLayoutException - if the layout is invalid. +
            NoSuchColumnException - if the column does not exist.
            +
            +
            +
            + +

            +getCellFormat

            +
            +public SchemaStorage getCellFormat(KijiColumnName column)
+                            throws NoSuchColumnException
            +
            +
            Reports the cell format for the specified column. +

            +

            +
            Parameters:
            column - Column name. +
            Returns:
            the cell format for the column. +
            Throws: +
            NoSuchColumnException - if the column does not exist.
            +
            +
            +
            + +

            +getCellSpec

            +
            +public CellSpec getCellSpec(KijiColumnName column)
+                     throws IOException
            +
            +
            +
            Parameters:
            column - Column to look up. +
            Returns:
            the cell specification for a given column. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +exists

            +
            +public boolean exists(KijiColumnName column)
            +
            +
            Reports whether a column exists. +

            +

            +
            Parameters:
            column - Column name. +
            Returns:
            whether the specified column exists.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +readAvroSchema

            +
            +public static org.apache.avro.Schema readAvroSchema(CellSchema avro)
+                                             throws InvalidLayoutException
            +
            +
            Reads the Avro schema from the table layout. +

            +

            +
            Parameters:
            avro - The portion of the table layout record to read from. +
            Returns:
            The avro schema, or null if the schema is type "counter". +
            Throws: +
            InvalidLayoutException - if the table layout is invalid and the schema can't be read.
            +
            +
            +
            + +

            +createFromEffectiveJsonResource

            +
            +public static KijiTableLayout createFromEffectiveJsonResource(String resource)
+                                                       throws IOException
            +
            +
            Loads a table layout from the specified resource as JSON. +

            +

            +
            Parameters:
            resource - Path of the resource containing the JSON layout description. +
            Returns:
            the parsed table layout. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +createFromEffectiveJson

            +
            +public static KijiTableLayout createFromEffectiveJson(InputStream istream)
+                                               throws IOException
            +
            +
            Loads a table layout from the specified JSON text. +

            +

            +
            Parameters:
            istream - Input stream containing the JSON text. +
            Returns:
            the parsed table layout. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +newLayout

            +
            +public static KijiTableLayout newLayout(TableLayoutDesc layout)
+                                 throws InvalidLayoutException
            +
            +
            Creates and returns a new KijiTableLayout instance as specified by an Avro TableLayoutDesc + description record. +

            +

            +
            Parameters:
            layout - The Avro TableLayoutDesc descriptor record that describes the actual layout. + of the table. +
            Returns:
            A new table layout. +
            Throws: +
            InvalidLayoutException - If the descriptor is invalid.
            +
            +
            +
            + +

            +createUpdatedLayout

            +
            +public static KijiTableLayout createUpdatedLayout(TableLayoutDesc updateLayoutDesc,
+                                                  KijiTableLayout oldLayout)
+                                           throws InvalidLayoutException
            +
            +
            Creates and returns a new KijiTableLayout instance as specified by composing updates described + by a TableLayoutDesc with the original + KijiTableLayout. See KijiTableLayout + for what can and cannot be updated. +

            +

            +
            Parameters:
            updateLayoutDesc - The Avro TableLayoutDesc descriptor record that describes + the layout update.
            oldLayout - The old table layout. +
            Returns:
            A new table layout. +
            Throws: +
            InvalidLayoutException - If the descriptor is invalid or inconsistent wrt reference.
            +
            +
            +
            + +

            +readTableLayoutDescFromJSON

            +
            +public static TableLayoutDesc readTableLayoutDescFromJSON(InputStream istream)
+                                                   throws IOException
            +
            +
            Reads a table layout descriptor from its JSON serialized form. +

            +

            +
            Parameters:
            istream - JSON input stream. +
            Returns:
            the decoded table layout descriptor. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getEncoding

            +
            +public static RowKeyEncoding getEncoding(Object rowKeyFormat)
            +
            +
            Find the encoding of the row key given the format. +

            +

            +
            Parameters:
            rowKeyFormat - Format of row keys of type RowKeyFormat or RowKeyFormat2. +
            Returns:
            The specific row key encoding, e.g. RAW, HASH, etc.
            +
            +
            +
            + +

            +getHashSize

            +
            +public static int getHashSize(Object rowKeyFormat)
            +
            +
            Get the hash size for a given row key format. +

            +

            +
            Parameters:
            rowKeyFormat - Format of row keys of type RowKeyFormat or RowKeyFormat2. +
            Returns:
            The size of the hash prefix.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayoutDatabase.html new file mode 100644 index 00000000..058a4fed --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/KijiTableLayoutDatabase.html @@ -0,0 +1,431 @@ + + + + + + + +KijiTableLayoutDatabase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Interface KijiTableLayoutDatabase

            +
            +
            All Known Implementing Classes:
            HBaseMetaTable, HBaseTableLayoutDatabase, KijiMetaTable
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Sealed
+public interface KijiTableLayoutDatabase
            + + +

            +A database of Kiji table layouts. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + KijiTableLayoutgetTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + List<KijiTableLayout>getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            + voidlayoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> tableBackup) + +
            +          Restores a table layout history from a backup.
            + List<TableLayoutBackupEntry>layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            + List<String>listTables() + +
            +          Lists the tables in this Kiji instance.
            + voidremoveAllTableLayoutVersions(String table) + +
            +          Removes all layout information for a particular table.
            + voidremoveRecentTableLayoutVersions(String table, + int numVersions) + +
            +          Removes the most recent layout information for a given table.
            + KijiTableLayoutupdateTableLayout(String table, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +listTables

            +
            +List<String> listTables()
+                        throws IOException
            +
            +
            Lists the tables in this Kiji instance. +

            +

            + +
            Returns:
            The list of table names. +
            Throws: +
            IOException - If the list of tables cannot be retrieved.
            +
            +
            +
            + +

            +updateTableLayout

            +
            +KijiTableLayout updateTableLayout(String table,
+                                  TableLayoutDesc update)
+                                  throws IOException
            +
            +
            Sets a table's layout. Also calls validateAndAssignLayout(). +

            +

            +
            Parameters:
            table - The name of the Kiji table to affect.
            update - Descriptor for the layout update. +
            Returns:
            the new effective layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableLayout

            +
            +KijiTableLayout getTableLayout(String table)
+                               throws IOException
            +
            +
            Gets the most recent versions of the layout for a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            The table's layout. +
            Throws: +
            IOException - If there is an error or no such table.
            +
            +
            +
            + +

            +getTableLayoutVersions

            +
            +List<KijiTableLayout> getTableLayoutVersions(String table,
+                                             int numVersions)
+                                             throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the table layout. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the layout for the table, sorted by + most-recent-first. If there are no layouts, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedTableLayoutVersions

            +
            +NavigableMap<Long,KijiTableLayout> getTimedTableLayoutVersions(String table,
+                                                               int numVersions)
+                                                               throws IOException
            +
            +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values the most recent versions of the layout for the table, and + keys the corresponding timestamps, ordered from most recent first to least recent last. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +layoutsToBackup

            +
            +List<TableLayoutBackupEntry> layoutsToBackup(String table)
+                                             throws IOException
            +
            +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableLayoutBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllTableLayoutVersions

            +
            +void removeAllTableLayoutVersions(String table)
+                                  throws IOException
            +
            +
            Removes all layout information for a particular table. +

            +

            +
            Parameters:
            table - The name of the Kiji table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeRecentTableLayoutVersions

            +
            +void removeRecentTableLayoutVersions(String table,
+                                     int numVersions)
+                                     throws IOException
            +
            +
            Removes the most recent layout information for a given table. +

            +

            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +layoutsFromBackup

            +
            +void layoutsFromBackup(String tableName,
+                       List<TableLayoutBackupEntry> tableBackup)
+                       throws IOException
            +
            +
            Restores a table layout history from a backup. +

            +

            +
            Parameters:
            tableName - The name of the table to restore layouts for.
            tableBackup - Table layout backup entries to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/SchemaClassNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/SchemaClassNotFoundException.html new file mode 100644 index 00000000..de3595aa --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/SchemaClassNotFoundException.html @@ -0,0 +1,253 @@ + + + + + + + +SchemaClassNotFoundException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout +
            +Class SchemaClassNotFoundException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.layout.InvalidLayoutException
+                  extended by org.kiji.schema.layout.SchemaClassNotFoundException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class SchemaClassNotFoundException
            extends InvalidLayoutException
            + + +

            +Thrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path). +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            SchemaClassNotFoundException(String message) + +
            +          Creates a new SchemaClassNotFoundException with the specified detail message..
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +SchemaClassNotFoundException

            +
            +public SchemaClassNotFoundException(String message)
            +
            +
            Creates a new SchemaClassNotFoundException with the specified detail message.. +

            +

            +
            Parameters:
            message - The exception message.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/ColumnNameTranslator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/ColumnNameTranslator.html new file mode 100644 index 00000000..af6018e2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/ColumnNameTranslator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.ColumnNameTranslator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.ColumnNameTranslator

            +
            +No usage of org.kiji.schema.layout.ColumnNameTranslator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/InvalidLayoutException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/InvalidLayoutException.html new file mode 100644 index 00000000..865257fe --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/InvalidLayoutException.html @@ -0,0 +1,280 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.InvalidLayoutException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.InvalidLayoutException

            +
            + + + + + + + + + + + + + +
            +Packages that use InvalidLayoutException
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of InvalidLayoutException in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Subclasses of InvalidLayoutException in org.kiji.schema.layout
            + classSchemaClassNotFoundException + +
            +          Thrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path).
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that throw InvalidLayoutException
            +static KijiTableLayoutKijiTableLayout.createUpdatedLayout(TableLayoutDesc updateLayoutDesc, + KijiTableLayout oldLayout) + +
            +          Creates and returns a new KijiTableLayout instance as specified by composing updates described + by a TableLayoutDesc with the original + KijiTableLayout.
            + org.apache.avro.SchemaKijiTableLayout.getSchema(KijiColumnName columnName) + +
            +          Reports the schema of the specified column.
            +static KijiTableLayoutKijiTableLayout.newLayout(TableLayoutDesc layout) + +
            +          Creates and returns a new KijiTableLayout instance as specified by an Avro TableLayoutDesc + description record.
            +static org.apache.avro.SchemaKijiTableLayout.readAvroSchema(CellSchema avro) + +
            +          Reads the Avro schema from the table layout.
            +  +

            + + + + + +
            +Uses of InvalidLayoutException in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that throw InvalidLayoutException
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            +static org.apache.avro.SchemaCellSpec.readAvroSchema(CellSchema cellSchema) + +
            +          Reads the Avro schema from the table layout.
            + CellSpecCellSpec.setCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html new file mode 100644 index 00000000..08dd254e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>KijiTableLayout.LocalityGroupLayout.FamilyLayout.getColumnMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout>KijiTableLayout.LocalityGroupLayout.FamilyLayout.getColumns() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html new file mode 100644 index 00000000..881e833d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.FamilyLayout.html @@ -0,0 +1,221 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout.FamilyLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayout.LocalityGroupLayout.FamilyLayout
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout.LocalityGroupLayout.FamilyLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiTableLayout.LocalityGroupLayout.FamilyLayout
            + KijiTableLayout.LocalityGroupLayout.FamilyLayoutKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.getFamily() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout.LocalityGroupLayout.FamilyLayout
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.getFamilies() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.LocalityGroupLayout.getFamilies() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.getFamilyMap() + +
            +           
            + Map<String,KijiTableLayout.LocalityGroupLayout.FamilyLayout>KijiTableLayout.LocalityGroupLayout.getFamilyMap() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html new file mode 100644 index 00000000..b04ba567 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.LocalityGroupLayout.html @@ -0,0 +1,205 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout.LocalityGroupLayout

            +
            + + + + + + + + + +
            +Packages that use KijiTableLayout.LocalityGroupLayout
            org.kiji.schema.layoutKiji table layouts. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout.LocalityGroupLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiTableLayout.LocalityGroupLayout
            + KijiTableLayout.LocalityGroupLayoutKijiTableLayout.LocalityGroupLayout.FamilyLayout.getLocalityGroup() + +
            +           
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout.LocalityGroupLayout
            + Map<String,KijiTableLayout.LocalityGroupLayout>KijiTableLayout.getLocalityGroupMap() + +
            +           
            + Collection<KijiTableLayout.LocalityGroupLayout>KijiTableLayout.getLocalityGroups() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.html new file mode 100644 index 00000000..9331a272 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayout.html @@ -0,0 +1,779 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.KijiTableLayout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.KijiTableLayout

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use KijiTableLayout
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return KijiTableLayout
            + KijiTableLayoutKijiTable.getLayout() + +
            +           
            + KijiTableLayoutKiji.modifyTableLayout(String name, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutKiji.modifyTableLayout(String name, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type KijiTableLayout
            + voidKiji.createTable(String name, + KijiTableLayout layout) + +
            +          Creates a Kiji table in an HBase instance.
            + voidKiji.createTable(String name, + KijiTableLayout layout, + byte[][] splitKeys) + +
            +          Creates a Kiji table in an HBase instance.
            + voidKiji.createTable(String name, + KijiTableLayout layout, + int numRegions) + +
            +          Creates a Kiji table in an HBase instance.
            +static EntityIdFactoryEntityIdFactory.getFactory(KijiTableLayout kijiTableLayout) + +
            +          Creates an entity ID factory for the row key format given by the specified + table layout.
            + voidKijiDataRequestValidator.validate(KijiTableLayout tableLayout) + +
            +          Validates the data request against the given table layout.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.filter
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.filter with parameters of type KijiTableLayout
            +static KijiRowFilterApplicatorKijiRowFilterApplicator.create(KijiRowFilter rowFilter, + KijiTableLayout tableLayout, + KijiSchemaTable schemaTable) + +
            +          Creates a new KijiRowFilterApplicator instance.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return KijiTableLayout
            + KijiTableLayoutHBaseKijiTable.getLayout() + +
            +          
            + KijiTableLayoutHBaseKijiRowData.getTableLayout() + +
            +          Gets the layout of the table this row data belongs to.
            + KijiTableLayoutHBaseMetaTable.getTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + KijiTableLayoutHBaseKiji.modifyTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets the layout of a table.
            + KijiTableLayoutHBaseKiji.modifyTableLayout(String tableName, + TableLayoutDesc update, + boolean dryRun, + PrintStream printStream) + +
            +          Sets the layout of a table, or print the results of setting the table layout if + dryRun is true.
            + KijiTableLayoutHBaseMetaTable.updateTableLayout(String table, + TableLayoutDesc layoutUpdate) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl that return types with arguments of type KijiTableLayout
            + List<KijiTableLayout>HBaseMetaTable.getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>HBaseMetaTable.getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type KijiTableLayout
            + voidHBaseDataRequestAdapter.applyToScan(Scan scan, + KijiTableLayout tableLayout) + +
            +          Like toScan(), but mutates a given Scan object to include everything in the data + request instead of returning a new one.
            + voidHBaseKiji.createTable(String tableName, + KijiTableLayout tableLayout) + +
            +          Creates a Kiji table in an HBase instance.
            + voidHBaseKiji.createTable(String tableName, + KijiTableLayout tableLayout, + byte[][] splitKeys) + +
            +          Creates a Kiji table in an HBase instance.
            + voidHBaseKiji.createTable(String tableName, + KijiTableLayout tableLayout, + int numRegions) + +
            +          Creates a Kiji table in an HBase instance.
            + GetHBaseDataRequestAdapter.toGet(EntityId entityId, + KijiTableLayout tableLayout) + +
            +          Constructs an HBase Get that describes the data requested in the KijiDataRequest for + a particular entity/row.
            + ScanHBaseDataRequestAdapter.toScan(KijiTableLayout tableLayout) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            + ScanHBaseDataRequestAdapter.toScan(KijiTableLayout tableLayout, + HBaseScanOptions scanOptions) + +
            +          Constructs an HBase Scan that describes the data requested in the KijiDataRequest.
            +  +

            + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTableLayout
            HBaseKijiPager(EntityId entityId, + KijiDataRequest dataRequest, + KijiTableLayout tableLayout, + HBaseKijiTable table, + KijiColumnName colName) + +
            +          Initializes a HBaseKijiPager.
            HBaseKijiRowData(EntityId entityId, + KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            HBaseKijiRowData(KijiDataRequest request, + KijiCellDecoderFactory decoderFactory, + KijiTableLayout layout, + Result result, + KijiSchemaTable schemaTable) + +
            +          Deprecated. 
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return KijiTableLayout
            +static KijiTableLayoutKijiTableLayout.createFromEffectiveJson(InputStream istream) + +
            +          Loads a table layout from the specified JSON text.
            +static KijiTableLayoutKijiTableLayout.createFromEffectiveJsonResource(String resource) + +
            +          Loads a table layout from the specified resource as JSON.
            +static KijiTableLayoutKijiTableLayout.createUpdatedLayout(TableLayoutDesc updateLayoutDesc, + KijiTableLayout oldLayout) + +
            +          Creates and returns a new KijiTableLayout instance as specified by composing updates described + by a TableLayoutDesc with the original + KijiTableLayout.
            + KijiTableLayoutColumnNameTranslator.getTableLayout() + +
            +           
            + KijiTableLayoutKijiTableLayout.LocalityGroupLayout.getTableLayout() + +
            +           
            + KijiTableLayoutKijiTableLayoutDatabase.getTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            +static KijiTableLayoutKijiTableLayout.newLayout(TableLayoutDesc layout) + +
            +          Creates and returns a new KijiTableLayout instance as specified by an Avro TableLayoutDesc + description record.
            + KijiTableLayoutKijiTableLayoutDatabase.updateTableLayout(String table, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type KijiTableLayout
            + List<KijiTableLayout>KijiTableLayoutDatabase.getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>KijiTableLayoutDatabase.getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout with parameters of type KijiTableLayout
            +static KijiTableLayoutKijiTableLayout.createUpdatedLayout(TableLayoutDesc updateLayoutDesc, + KijiTableLayout oldLayout) + +
            +          Creates and returns a new KijiTableLayout instance as specified by composing updates described + by a TableLayoutDesc with the original + KijiTableLayout.
            +  +

            + + + + + + + + + + + +
            Constructors in org.kiji.schema.layout with parameters of type KijiTableLayout
            ColumnNameTranslator(KijiTableLayout tableLayout) + +
            +          Creates a new ColumnNameTranslator instance.
            InvalidLayoutException(KijiTableLayout tableLayout, + String reason) + +
            +          Constructs an exception indicated a table layout is invalid.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return KijiTableLayout
            + KijiTableLayoutHBaseTableLayoutDatabase.getTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + KijiTableLayoutHBaseTableLayoutDatabase.updateTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return types with arguments of type KijiTableLayout
            + List<KijiTableLayout>HBaseTableLayoutDatabase.getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>HBaseTableLayoutDatabase.getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl with parameters of type KijiTableLayout
            + HTableDescriptorHTableSchemaTranslator.toHTableDescriptor(String kijiInstanceName, + KijiTableLayout tableLayout) + +
            +          Translates a Kiji table layout into an HColumnDescriptor.
            +  +

            + + + + + +
            +Uses of KijiTableLayout in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type KijiTableLayout
            +static EntityIdToolUtils.createEntityIdFromUserInputs(String entityFlag, + KijiTableLayout layout) + +
            +          Parses a command-line flag specifying an entity ID.
            +static EntityIdToolUtils.parseKijiRowKey(String rowKeySpec, + EntityIdFactory factory, + KijiTableLayout layout) + +
            +          Parses a Kiji row key specification from a command-line flag.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html new file mode 100644 index 00000000..9d1a3e58 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/KijiTableLayoutDatabase.html @@ -0,0 +1,257 @@ + + + + + + + +Uses of Interface org.kiji.schema.layout.KijiTableLayoutDatabase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.layout.KijiTableLayoutDatabase

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use KijiTableLayoutDatabase
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of KijiTableLayoutDatabase in org.kiji.schema
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema that implement KijiTableLayoutDatabase
            + classKijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            +  +

            + + + + + +
            +Uses of KijiTableLayoutDatabase in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement KijiTableLayoutDatabase
            + classHBaseMetaTable + +
            +          An implementation of the KijiMetaTable that uses the 'kiji-meta' HBase table as the backing + store.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type KijiTableLayoutDatabase
            HBaseMetaTable(HTableInterface htable, + KijiTableLayoutDatabase tableLayoutDatabase, + KijiTableKeyValueDatabase tableKeyValueDatabase) + +
            +          Create a connection to a Kiji meta table backed by an HTable within HBase.
            +  +

            + + + + + +
            +Uses of KijiTableLayoutDatabase in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.layout.impl that implement KijiTableLayoutDatabase
            + classHBaseTableLayoutDatabase + +
            +          Manages Kiji table layouts using a column family in an HBase table as a backing store.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html new file mode 100644 index 00000000..9f98e47b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/class-use/SchemaClassNotFoundException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.SchemaClassNotFoundException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.SchemaClassNotFoundException

            +
            +No usage of org.kiji.schema.layout.SchemaClassNotFoundException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/CellSpec.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/CellSpec.html new file mode 100644 index 00000000..5676de79 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/CellSpec.html @@ -0,0 +1,557 @@ + + + + + + + +CellSpec (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class CellSpec

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.CellSpec
+
            +
            +
            +
            @ApiAudience.Private
+public final class CellSpec
            extends Object
            + + +

            +Specification of a Kiji cell. + + Contains everything needed to encode or decode a given column. + Wraps a CellSchema Avro record to avoid re-parsing JSON Avro schemas every time, and + associate it with a schema table to resolve schema IDs or hashes. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            CellSpec() + +
            +          Initializes a new, unspecified CellSpec.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static CellSpecfromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecfromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            + org.apache.avro.SchemagetAvroSchema() + +
            +           
            + CellSchemagetCellSchema() + +
            +           
            + KijiSchemaTablegetSchemaTable() + +
            +           
            + booleanisAvro() + +
            +           
            + booleanisCounter() + +
            +           
            +static CellSpecnewCounter() + +
            +           
            +static org.apache.avro.SchemareadAvroSchema(CellSchema cellSchema) + +
            +          Reads the Avro schema from the table layout.
            + CellSpecsetCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            + CellSpecsetReaderSchema(org.apache.avro.Schema readerSchema) + +
            +          Sets the Avro reader schema.
            + CellSpecsetSchemaStorage(SchemaStorage schemaStorage) + +
            +          Sets the schema storage.
            + CellSpecsetSchemaTable(KijiSchemaTable schemaTable) + +
            +          Sets the schema table.
            + CellSpecsetType(SchemaType schemaType) + +
            +          Sets the cell type.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +CellSpec

            +
            +public CellSpec()
            +
            +
            Initializes a new, unspecified CellSpec. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +newCounter

            +
            +public static CellSpec newCounter()
            +
            +
            + +
            Returns:
            a new CellSpec for a counter cell.
            +
            +
            +
            + +

            +fromCellSchema

            +
            +public static CellSpec fromCellSchema(CellSchema cellSchema,
+                                      KijiSchemaTable schemaTable)
+                               throws InvalidLayoutException
            +
            +
            +
            Parameters:
            cellSchema - CellSchema record to initialize the CellSpec from.
            schemaTable - Schema table to resolve schema hashes or UIDs. +
            Returns:
            a new CellSpec initialized from a CellSchema Avro descriptor. +
            Throws: +
            InvalidLayoutException - if the cell specification is invalid.
            +
            +
            +
            + +

            +fromCellSchema

            +
            +public static CellSpec fromCellSchema(CellSchema cellSchema)
+                               throws InvalidLayoutException
            +
            +
            Creates a CellSpec from a CellSchema record. +

            +

            +
            Parameters:
            cellSchema - CellSchema record. +
            Returns:
            a new CellSpec initialized from the given CellSchema. +
            Throws: +
            InvalidLayoutException - on layout error.
            +
            +
            +
            + +

            +setCellSchema

            +
            +public CellSpec setCellSchema(CellSchema cellSchema)
+                       throws InvalidLayoutException
            +
            +
            Sets the cell schema. +

            +

            +
            Parameters:
            cellSchema - CellSchema to initialize the CellSpec from. +
            Returns:
            this. +
            Throws: +
            InvalidLayoutException - on layout error.
            +
            +
            +
            + +

            +setSchemaStorage

            +
            +public CellSpec setSchemaStorage(SchemaStorage schemaStorage)
            +
            +
            Sets the schema storage. + + Does not make sense for counter cells. +

            +

            +
            Parameters:
            schemaStorage - Schema storage (hash, UID or final). +
            Returns:
            this.
            +
            +
            +
            + +

            +setType

            +
            +public CellSpec setType(SchemaType schemaType)
            +
            +
            Sets the cell type. +

            +

            +
            Parameters:
            schemaType - Cell type (counter, inline Avro or Avro class). +
            Returns:
            this.
            +
            +
            +
            + +

            +setReaderSchema

            +
            +public CellSpec setReaderSchema(org.apache.avro.Schema readerSchema)
            +
            +
            Sets the Avro reader schema. + + Does not make sense for counter cells. +

            +

            +
            Parameters:
            readerSchema - Avro reader schema. +
            Returns:
            this.
            +
            +
            +
            + +

            +setSchemaTable

            +
            +public CellSpec setSchemaTable(KijiSchemaTable schemaTable)
            +
            +
            Sets the schema table. +

            +

            +
            Parameters:
            schemaTable - Schema table. +
            Returns:
            this.
            +
            +
            +
            + +

            +getSchemaTable

            +
            +public KijiSchemaTable getSchemaTable()
            +
            +
            + +
            Returns:
            the schema table to resolve schema hashes or IDs.
            +
            +
            +
            + +

            +isCounter

            +
            +public boolean isCounter()
            +
            +
            + +
            Returns:
            whether this cell is a counter.
            +
            +
            +
            + +

            +isAvro

            +
            +public boolean isAvro()
            +
            +
            + +
            Returns:
            whether this cell is encoded with Avro.
            +
            +
            +
            + +

            +getCellSchema

            +
            +public CellSchema getCellSchema()
            +
            +
            + +
            Returns:
            the underlying CellSchema Avro record. May be null.
            +
            +
            +
            + +

            +getAvroSchema

            +
            +public org.apache.avro.Schema getAvroSchema()
            +
            +
            + +
            Returns:
            the cell Avro schema. Valid for Avro cells only.
            +
            +
            +
            + +

            +readAvroSchema

            +
            +public static org.apache.avro.Schema readAvroSchema(CellSchema cellSchema)
+                                             throws InvalidLayoutException
            +
            +
            Reads the Avro schema from the table layout. +

            +

            +
            Parameters:
            cellSchema - The portion of the table layout record to read from. +
            Returns:
            the Avro schema, or null for a counter. +
            Throws: +
            InvalidLayoutException - if the specification or the schema is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/ColumnId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/ColumnId.html new file mode 100644 index 00000000..5b11a5be --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/ColumnId.html @@ -0,0 +1,559 @@ + + + + + + + +ColumnId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class ColumnId

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.ColumnId
+
            +
            +
            +
            @ApiAudience.Private
+public final class ColumnId
            extends Object
            + + +

            +

            A very short physical identifier for a column family or qualifier to be used in HBase.

            + +

            Since HBase is a sparse storage system, every cell's data must be stored along with + its full address: its row key, family name, column qualifier, and timestamp. Because + of this, it is important to keep the names of families and qualifiers as short as + possible.

            + +

            A ColumnId is the physical byte[] that is used as a family or qualifier name in + HBase. It is an encoded number using a 64-character alphabet with the more significant + digits to the right. This class allows you to convert between the integers and the + UTF-8 encoded physical names. For example:

            + + + + + + + + + + + + + + + + + +
            idname
            1B
            1BA
            1BAA
            2C
            25Z
            26a
            51z
            520
            619
            62+
            63/
            64AB
            65BB
            66CB
            + +

            The benefit here is that until a user has defined at least 64 column names in their + layout, all of the names used in HBase will only be one byte. The next 64 names will + only be two bytes, and so on. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringALPHABET + +
            +          The alphabet used to generate the short physical names.
            +static intBITS_PER_DIGIT + +
            +          The base 2 logarithm of the size of the alphabet (64), which is the number of bits + we can encode with a single digit.
            +static intRADIX + +
            +          The size of the alphabet for a digit, which is the radix of our printed number.
            +static intUNASSIGNED + +
            +          The special value reserved to mean that a symbolic name has not been assigned a column id.
            +static Map<Character,Integer>VALUE_MAP + +
            +          A map from characters in the alphabet to the integer it represents.
            +  + + + + + + + + + + +
            +Constructor Summary
            ColumnId(int id) + +
            +          Constructs a column id that encodes the given integer.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +          
            +static ColumnIdfromByteArray(byte[] encoded) + +
            +          Translates HBase column names to ColumnIds.
            +static ColumnIdfromString(String encoded) + +
            +          Translates HBase column names to ColumnIds.
            + intgetId() + +
            +           
            + inthashCode() + +
            +          
            + byte[]toByteArray() + +
            +          Translates ColumnIds to HBase column names.
            + StringtoString() + +
            +          Gets the id as a string of digits from our alphabet.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +UNASSIGNED

            +
            +public static final int UNASSIGNED
            +
            +
            The special value reserved to mean that a symbolic name has not been assigned a column id. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +ALPHABET

            +
            +public static final String ALPHABET
            +
            +
            The alphabet used to generate the short physical names. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +RADIX

            +
            +public static final int RADIX
            +
            +
            The size of the alphabet for a digit, which is the radix of our printed number. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +BITS_PER_DIGIT

            +
            +public static final int BITS_PER_DIGIT
            +
            +
            The base 2 logarithm of the size of the alphabet (64), which is the number of bits + we can encode with a single digit. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +VALUE_MAP

            +
            +public static final Map<Character,Integer> VALUE_MAP
            +
            +
            A map from characters in the alphabet to the integer it represents. +

            +

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

            +ColumnId

            +
            +public ColumnId(int id)
            +
            +
            Constructs a column id that encodes the given integer. +

            +

            +
            Parameters:
            id - The integer identifier for this column.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +fromByteArray

            +
            +public static ColumnId fromByteArray(byte[] encoded)
            +
            +
            Translates HBase column names to ColumnIds. The HBase byte arrays are UTF-8 encoded + numbers from our base-64 alphabet. +

            +

            +
            Parameters:
            encoded - The family or qualifier bytes from HBase. +
            Returns:
            A ColumnId from the byte array.
            +
            +
            +
            + +

            +fromString

            +
            +public static ColumnId fromString(String encoded)
            +
            +
            Translates HBase column names to ColumnIds. The HBase names are UTF-8 encoded + numbers from our base-64 alphabet. +

            +

            +
            Parameters:
            encoded - The family or qualifier bytes from HBase. +
            Returns:
            A ColumnId from the encoded name.
            +
            +
            +
            + +

            +getId

            +
            +public int getId()
            +
            +
            + +
            Returns:
            the column id.
            +
            +
            +
            + +

            +toByteArray

            +
            +public byte[] toByteArray()
            +
            +

            Translates ColumnIds to HBase column names.

            + +

            Encodes to a byte array making it as short as possible. We use characters that + HBase allows (no control characters and no colon).

            +

            +

            + +
            Returns:
            The column id encoded as an HBase-friendly byte array.
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            Gets the id as a string of digits from our alphabet. +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            + +
            Returns:
            The digit string, with the significant digits on the right.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html new file mode 100644 index 00000000..dcbf5e88 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/HBaseTableLayoutDatabase.html @@ -0,0 +1,638 @@ + + + + + + + +HBaseTableLayoutDatabase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class HBaseTableLayoutDatabase

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.HBaseTableLayoutDatabase
+
            +
            +
            All Implemented Interfaces:
            KijiTableLayoutDatabase
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HBaseTableLayoutDatabase
            extends Object
            implements KijiTableLayoutDatabase
            + + +

            +

            Manages Kiji table layouts using a column family in an HBase table as a backing store.

            + +

            + The HTable row key is the name of the table, and the row has 3 columns: +

          • the layout update, as specified by the user/submitter;
            • +
          • the effective layout after applying the update;
            • +
          • a hash of the effective layout.
            • +

            + +

            + Layouts and layout updates are encoded as Kiji cells, using Avro schema hashes, and as + TableLayoutDesc Avro records. +

            + +

            A static method, getHColumnDescriptor returns the description of an + HColumn that should be used to construct the HTable for the backing store.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringQUALIFIER_LAYOUT + +
            +          HBase column qualifier used to store absolute layouts.
            +static StringQUALIFIER_LAYOUT_ID + +
            +          HBase column qualifier used to store layout IDs.
            +static StringQUALIFIER_UPDATE + +
            +          HBase column qualifier used to store layout updates.
            +  + + + + + + + + + + +
            +Constructor Summary
            HBaseTableLayoutDatabase(HTableInterface htable, + String family, + KijiSchemaTable schemaTable) + +
            +          Creates a new HBaseTableLayoutDatabase instance.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static HColumnDescriptorgetHColumnDescriptor(String family) + +
            +          Gets the description of an HColumn suitable for storing the table layout database.
            + KijiTableLayoutgetTableLayout(String table) + +
            +          Gets the most recent versions of the layout for a table.
            + List<KijiTableLayout>getTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a list of the most recent specified number of versions of the table layout.
            + NavigableMap<Long,KijiTableLayout>getTimedTableLayoutVersions(String table, + int numVersions) + +
            +          Gets a map of the most recent versions of the layout for a table, keyed by timestamp.
            + voidlayoutsFromBackup(String tableName, + List<TableLayoutBackupEntry> layoutBackup) + +
            +          Restores a table layout history from a backup.
            + List<TableLayoutBackupEntry>layoutsToBackup(String table) + +
            +          Gets a list of the TableLayoutBackupEntries which can be used to restore a table.
            + List<String>listTables() + +
            +          Lists the tables in this Kiji instance.
            + voidremoveAllTableLayoutVersions(String table) + +
            +          Removes all layout information for a particular table.
            + voidremoveRecentTableLayoutVersions(String table, + int numVersions) + +
            +          Removes the most recent layout information for a given table.
            + KijiTableLayoutupdateTableLayout(String tableName, + TableLayoutDesc update) + +
            +          Sets a table's layout.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +QUALIFIER_UPDATE

            +
            +public static final String QUALIFIER_UPDATE
            +
            +
            HBase column qualifier used to store layout updates. + Layout updates are binary encoded TableLayoutDesc records. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +QUALIFIER_LAYOUT

            +
            +public static final String QUALIFIER_LAYOUT
            +
            +
            HBase column qualifier used to store absolute layouts. + Table layouts are binary encoded TableLayoutDesc records. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +QUALIFIER_LAYOUT_ID

            +
            +public static final String QUALIFIER_LAYOUT_ID
            +
            +
            HBase column qualifier used to store layout IDs. + Currently, IDs are assigned using a long counter starting at 1, and encoded as a string. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +HBaseTableLayoutDatabase

            +
            +public HBaseTableLayoutDatabase(HTableInterface htable,
+                                String family,
+                                KijiSchemaTable schemaTable)
+                         throws IOException
            +
            +
            Creates a new HBaseTableLayoutDatabase instance. + +

            This class does not take ownership of the HTable. The caller should close it when + it is no longer needed.

            +

            +

            +
            Parameters:
            htable - The HTable used to store the layout data.
            family - The name of the column family within the HTable used to store layout data.
            schemaTable - The Kiji schema table. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +updateTableLayout

            +
            +public KijiTableLayout updateTableLayout(String tableName,
+                                         TableLayoutDesc update)
+                                  throws IOException
            +
            +
            Sets a table's layout. Also calls validateAndAssignLayout(). +

            +

            +
            Specified by:
            updateTableLayout in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            tableName - The name of the Kiji table to affect.
            update - Descriptor for the layout update. +
            Returns:
            the new effective layout. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTableLayout

            +
            +public KijiTableLayout getTableLayout(String table)
+                               throws IOException
            +
            +
            Gets the most recent versions of the layout for a table. +

            +

            +
            Specified by:
            getTableLayout in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            The table's layout. +
            Throws: +
            IOException - If there is an error or no such table.
            +
            +
            +
            + +

            +getTableLayoutVersions

            +
            +public List<KijiTableLayout> getTableLayoutVersions(String table,
+                                                    int numVersions)
+                                             throws IOException
            +
            +
            Gets a list of the most recent specified number of versions of the table layout. +

            +

            +
            Specified by:
            getTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A list of the most recent versions of the layout for the table, sorted by + most-recent-first. If there are no layouts, returns an empty list. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +getTimedTableLayoutVersions

            +
            +public NavigableMap<Long,KijiTableLayout> getTimedTableLayoutVersions(String table,
+                                                                      int numVersions)
+                                                               throws IOException
            +
            +
            Gets a map of the most recent versions of the layout for a table, keyed by timestamp. +

            +

            +
            Specified by:
            getTimedTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to retrieve. +
            Returns:
            A navigable map with values the most recent versions of the layout for the table, and + keys the corresponding timestamps, ordered from most recent first to least recent last. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeAllTableLayoutVersions

            +
            +public void removeAllTableLayoutVersions(String table)
+                                  throws IOException
            +
            +
            Removes all layout information for a particular table. +

            +

            +
            Specified by:
            removeAllTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +removeRecentTableLayoutVersions

            +
            +public void removeRecentTableLayoutVersions(String table,
+                                            int numVersions)
+                                     throws IOException
            +
            +
            Removes the most recent layout information for a given table. +

            +

            +
            Specified by:
            removeRecentTableLayoutVersions in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table.
            numVersions - The maximum number of the most recent versions to delete. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +listTables

            +
            +public List<String> listTables()
+                        throws IOException
            +
            +
            Lists the tables in this Kiji instance. +

            +

            +
            Specified by:
            listTables in interface KijiTableLayoutDatabase
            +
            +
            + +
            Returns:
            The list of table names. +
            Throws: +
            IOException - If the list of tables cannot be retrieved.
            +
            +
            +
            + +

            +getHColumnDescriptor

            +
            +public static HColumnDescriptor getHColumnDescriptor(String family)
            +
            +
            Gets the description of an HColumn suitable for storing the table layout database. +

            +

            +
            +
            +
            +
            Parameters:
            family - The family within the HTable used to store layout data. +
            Returns:
            The HColumn descriptor.
            +
            +
            +
            + +

            +layoutsToBackup

            +
            +public List<TableLayoutBackupEntry> layoutsToBackup(String table)
+                                             throws IOException
            +
            +
            Gets a list of the TableLayoutBackupEntries which can be used to restore a table. +

            +

            +
            Specified by:
            layoutsToBackup in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            table - The name of the Kiji table. +
            Returns:
            A list of TableLayoutBackupEntries. +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +layoutsFromBackup

            +
            +public void layoutsFromBackup(String tableName,
+                              List<TableLayoutBackupEntry> layoutBackup)
+                       throws IOException
            +
            +
            Restores a table layout history from a backup. +

            +

            +
            Specified by:
            layoutsFromBackup in interface KijiTableLayoutDatabase
            +
            +
            +
            Parameters:
            tableName - The name of the table to restore layouts for.
            layoutBackup - Table layout backup entries to restore. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/HTableSchemaTranslator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/HTableSchemaTranslator.html new file mode 100644 index 00000000..2c4219bc --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/HTableSchemaTranslator.html @@ -0,0 +1,269 @@ + + + + + + + +HTableSchemaTranslator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.layout.impl +
            +Class HTableSchemaTranslator

            +
            +java.lang.Object
+  extended by org.kiji.schema.layout.impl.HTableSchemaTranslator
+
            +
            +
            +
            @ApiAudience.Private
+public final class HTableSchemaTranslator
            extends Object
            + + +

            +Translates between KijiTableLayouts and HTableDescriptors. + +

            A Kiji table has a layout with locality groups, families, and columns. An HTable + only has HColumns. This classes maps between the Kiji layout components and the HTable + schema components, which ultimately determines how we map Kiji data onto an HTable.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HTableSchemaTranslator() + +
            +          Creates a new HTableSchemaTranslator instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + HTableDescriptortoHTableDescriptor(String kijiInstanceName, + KijiTableLayout tableLayout) + +
            +          Translates a Kiji table layout into an HColumnDescriptor.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +HTableSchemaTranslator

            +
            +public HTableSchemaTranslator()
            +
            +
            Creates a new HTableSchemaTranslator instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +toHTableDescriptor

            +
            +public HTableDescriptor toHTableDescriptor(String kijiInstanceName,
+                                           KijiTableLayout tableLayout)
            +
            +
            Translates a Kiji table layout into an HColumnDescriptor. +

            +

            +
            Parameters:
            kijiInstanceName - The name of the Kiji instance the table lives in.
            tableLayout - The Kiji table layout. +
            Returns:
            The HTableDescriptor to use for storing the Kiji table data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/CellSpec.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/CellSpec.html new file mode 100644 index 00000000..f28cc51c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/CellSpec.html @@ -0,0 +1,388 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.CellSpec (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.CellSpec

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use CellSpec
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type CellSpec
            + KijiCellDecoder<?>GenericCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + KijiCellEncoderKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            + KijiCellDecoder<?>SpecificCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            + + + + + +
            +<T> KijiCellDecoder<T>
            +            		KijiCellDecoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell decoder.
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type CellSpec
            + KijiCellEncoderDefaultKijiCellEncoderFactory.create(CellSpec cellSpec) + +
            +          Creates a new Kiji cell encoder.
            +  +

            + + + + + + + + + + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type CellSpec
            AvroCellDecoder(CellSpec cellSpec) + +
            +          Initializes an abstract KijiAvroCellDecoder.
            AvroCellEncoder(CellSpec cellSpec) + +
            +          Creates a new KijiCellEncoder instance.
            GenericCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates generic Avro types.
            SpecificCellDecoder(CellSpec cellSpec) + +
            +          Initializes a cell decoder that creates specific Avro types.
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema.layout
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.layout that return CellSpec
            + CellSpecKijiTableLayout.getCellSpec(KijiColumnName column) + +
            +           
            +  +

            + + + + + +
            +Uses of CellSpec in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return CellSpec
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema) + +
            +          Creates a CellSpec from a CellSchema record.
            +static CellSpecCellSpec.fromCellSchema(CellSchema cellSchema, + KijiSchemaTable schemaTable) + +
            +           
            +static CellSpecCellSpec.newCounter() + +
            +           
            + CellSpecCellSpec.setCellSchema(CellSchema cellSchema) + +
            +          Sets the cell schema.
            + CellSpecCellSpec.setReaderSchema(org.apache.avro.Schema readerSchema) + +
            +          Sets the Avro reader schema.
            + CellSpecCellSpec.setSchemaStorage(SchemaStorage schemaStorage) + +
            +          Sets the schema storage.
            + CellSpecCellSpec.setSchemaTable(KijiSchemaTable schemaTable) + +
            +          Sets the schema table.
            + CellSpecCellSpec.setType(SchemaType schemaType) + +
            +          Sets the cell type.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/ColumnId.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/ColumnId.html new file mode 100644 index 00000000..05630907 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/ColumnId.html @@ -0,0 +1,266 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.ColumnId (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.ColumnId

            +
            + + + + + + + + + + + + + +
            +Packages that use ColumnId
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + +
            +Uses of ColumnId in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return ColumnId
            + ColumnIdKijiTableLayout.LocalityGroupLayout.getId() + +
            +           
            + ColumnIdKijiTableLayout.LocalityGroupLayout.FamilyLayout.getId() + +
            +           
            + ColumnIdKijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout.getId() + +
            +           
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return types with arguments of type ColumnId
            + com.google.common.collect.BiMap<ColumnId,String>KijiTableLayout.LocalityGroupLayout.FamilyLayout.getColumnIdNameMap() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>KijiTableLayout.LocalityGroupLayout.getFamilyIdNameMap() + +
            +           
            + com.google.common.collect.BiMap<ColumnId,String>KijiTableLayout.getLocalityGroupIdNameMap() + +
            +           
            +  +

            + + + + + +
            +Uses of ColumnId in org.kiji.schema.layout.impl
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout.impl that return ColumnId
            +static ColumnIdColumnId.fromByteArray(byte[] encoded) + +
            +          Translates HBase column names to ColumnIds.
            +static ColumnIdColumnId.fromString(String encoded) + +
            +          Translates HBase column names to ColumnIds.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html new file mode 100644 index 00000000..3a3e7e12 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/HBaseTableLayoutDatabase.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.HBaseTableLayoutDatabase (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.HBaseTableLayoutDatabase

            +
            +No usage of org.kiji.schema.layout.impl.HBaseTableLayoutDatabase +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html new file mode 100644 index 00000000..abe4f8d5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/class-use/HTableSchemaTranslator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.layout.impl.HTableSchemaTranslator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.layout.impl.HTableSchemaTranslator

            +
            +No usage of org.kiji.schema.layout.impl.HTableSchemaTranslator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-frame.html new file mode 100644 index 00000000..434af482 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-frame.html @@ -0,0 +1,39 @@ + + + + + + + +org.kiji.schema.layout.impl (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema.layout.impl + + + + +
            +Classes  + +
            +CellSpec +
            +ColumnId +
            +HBaseTableLayoutDatabase +
            +HTableSchemaTranslator
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-summary.html new file mode 100644 index 00000000..b0515530 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-summary.html @@ -0,0 +1,190 @@ + + + + + + + +org.kiji.schema.layout.impl (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.layout.impl +

            +Implementation for Kiji table layout management. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            CellSpecSpecification of a Kiji cell.
            ColumnIdA very short physical identifier for a column family or qualifier to be used in HBase.
            HBaseTableLayoutDatabaseManages Kiji table layouts using a column family in an HBase table as a backing store.
            HTableSchemaTranslatorTranslates between KijiTableLayouts and HTableDescriptors.
            +  + +

            +

            +Package org.kiji.schema.layout.impl Description +

            + +

            +Implementation for Kiji table layout management. + +

            + Users generally shouldn't need to reference any of these classes directly, but rather use the + classes presented by the org.kiji.schema package. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-tree.html new file mode 100644 index 00000000..82aa0b64 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-tree.html @@ -0,0 +1,155 @@ + + + + + + + +org.kiji.schema.layout.impl Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.layout.impl +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-use.html new file mode 100644 index 00000000..be2a99f2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/impl/package-use.html @@ -0,0 +1,240 @@ + + + + + + + +Uses of Package org.kiji.schema.layout.impl (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.layout.impl

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.layout.impl
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema
            CellSpec + +
            +          Specification of a Kiji cell.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema.impl
            CellSpec + +
            +          Specification of a Kiji cell.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema.layout
            CellSpec + +
            +          Specification of a Kiji cell.
            ColumnId + +
            +          A very short physical identifier for a column family or qualifier to be used in HBase.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout.impl used by org.kiji.schema.layout.impl
            CellSpec + +
            +          Specification of a Kiji cell.
            ColumnId + +
            +          A very short physical identifier for a column family or qualifier to be used in HBase.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-frame.html new file mode 100644 index 00000000..a444d6f0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-frame.html @@ -0,0 +1,59 @@ + + + + + + + +org.kiji.schema.layout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema.layout + + + + +
            +Interfaces  + +
            +KijiTableLayoutDatabase
            + + + + + + +
            +Classes  + +
            +ColumnNameTranslator +
            +KijiTableLayout
            + + + + + + +
            +Exceptions  + +
            +InvalidLayoutException +
            +SchemaClassNotFoundException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-summary.html new file mode 100644 index 00000000..135c983c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-summary.html @@ -0,0 +1,230 @@ + + + + + + + +org.kiji.schema.layout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.layout +

            +Kiji table layouts. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            KijiTableLayoutDatabaseA database of Kiji table layouts.
            +  + +

            + + + + + + + + + + + + + +
            +Class Summary
            ColumnNameTranslatorTranslates between HTable and Kiji table column names.
            KijiTableLayoutLayout of a Kiji table.
            +  + +

            + + + + + + + + + + + + + +
            +Exception Summary
            InvalidLayoutExceptionThrown when an invalid Kiji layout is encountered.
            SchemaClassNotFoundExceptionThrown when a Kiji table layout has a schema class reference that cannot be loaded + (probably because it is not on the class path).
            +  + +

            +

            +Package org.kiji.schema.layout Description +

            + +

            +Kiji table layouts. + +

            + A Kiji table has a layout that describes the locality groups, families, and + columns it contains. + + This package contains code for serializing the layout metadata to and from JSON or binary Avro + records, and persisting it into the Kiji system tables in HBase. + + Kiji table layouts are persisted in the KijiMetaTable. + Kiji records the history of the layouts of each table. + When updating the layout of a table, Kiji validates the new layout against the current layout + of the table. + + Kiji table layouts are serialized to descriptors as TableLayoutDesc + Avro records (see the Avro record definitions in src/main/avro/Layout.avdl). + + Kiji table layouts are internally represented as KijiTableLayout + instances. KijiTableLayout wraps layout + descriptors, validate layout updates, assigns column IDs and provides convenience accessors. +

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-tree.html new file mode 100644 index 00000000..c93d85d3 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-tree.html @@ -0,0 +1,168 @@ + + + + + + + +org.kiji.schema.layout Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.layout +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-use.html new file mode 100644 index 00000000..1deb8006 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/layout/package-use.html @@ -0,0 +1,315 @@ + + + + + + + +Uses of Package org.kiji.schema.layout (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.layout

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.layout
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayoutDatabase + +
            +          A database of Kiji table layouts.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.filter
            KijiTableLayout + +
            +          Layout of a Kiji table.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.impl
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayoutDatabase + +
            +          A database of Kiji table layouts.
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.layout
            InvalidLayoutException + +
            +          Thrown when an invalid Kiji layout is encountered.
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayout.LocalityGroupLayout + +
            +          Concrete layout of a locality group.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout + +
            +          Concrete layout of a family.
            KijiTableLayout.LocalityGroupLayout.FamilyLayout.ColumnLayout + +
            +          Concrete layout of a column.
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.layout.impl
            InvalidLayoutException + +
            +          Thrown when an invalid Kiji layout is encountered.
            KijiTableLayout + +
            +          Layout of a Kiji table.
            KijiTableLayoutDatabase + +
            +          A database of Kiji table layouts.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.layout used by org.kiji.schema.tools
            KijiTableLayout + +
            +          Layout of a Kiji table.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/DistributedCacheJars.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/DistributedCacheJars.html new file mode 100644 index 00000000..d2fec739 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/DistributedCacheJars.html @@ -0,0 +1,330 @@ + + + + + + + +DistributedCacheJars (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class DistributedCacheJars

            +
            +java.lang.Object
+  extended by org.kiji.schema.mapreduce.DistributedCacheJars
+
            +
            +Deprecated. +

            +

            +
            @ApiAudience.Public
+@Deprecated
+public final class DistributedCacheJars
            extends Object
            + + +

            +Utility class for dealing with Java JAR files and the hadoop distributed cache. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidaddJarsToDistributedCache(Job job, + File jarDirectory) + +
            +          Deprecated. Adds the jars from a directory into the distributed cache of a job.
            +static voidaddJarsToDistributedCache(Job job, + String jarDirectory) + +
            +          Deprecated. Adds the jars from a directory into the distributed cache of a job.
            +static List<String>deDuplicateJarNames(List<String> jarList) + +
            +          Deprecated. Takes a list of paths and returns a list of paths with unique filenames.
            +static List<String>getJarsFromConfiguration(Configuration conf) + +
            +          Deprecated. Lists all jars in the variable tmpjars of this Configuration.
            +static List<String>getJarsFromDirectory(Configuration conf, + File jarDirectory) + +
            +          Deprecated.  
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +addJarsToDistributedCache

            +
            +public static void addJarsToDistributedCache(Job job,
+                                             String jarDirectory)
+                                      throws IOException
            +
            +
            Deprecated. 
            Adds the jars from a directory into the distributed cache of a job. +

            +

            +
            Parameters:
            job - The job to configure.
            jarDirectory - A path to a directory of jar files. +
            Throws: +
            IOException - If there is a problem reading from the file system.
            +
            +
            +
            + +

            +addJarsToDistributedCache

            +
            +public static void addJarsToDistributedCache(Job job,
+                                             File jarDirectory)
+                                      throws IOException
            +
            +
            Deprecated. 
            Adds the jars from a directory into the distributed cache of a job. +

            +

            +
            Parameters:
            job - The job to configure.
            jarDirectory - A path to a directory of jar files. +
            Throws: +
            IOException - If there is a problem reading from the file system.
            +
            +
            +
            + +

            +getJarsFromConfiguration

            +
            +public static List<String> getJarsFromConfiguration(Configuration conf)
            +
            +
            Deprecated. 
            Lists all jars in the variable tmpjars of this Configuration. +

            +

            +
            Parameters:
            conf - The Configuration to get jar names from +
            Returns:
            A list of jars.
            +
            +
            +
            + +

            +getJarsFromDirectory

            +
            +public static List<String> getJarsFromDirectory(Configuration conf,
+                                                File jarDirectory)
+                                         throws IOException
            +
            +
            Deprecated. 
            +
            Parameters:
            conf - Configuration to get FileSystem from
            jarDirectory - The directory of jars to get. +
            Returns:
            A list of qualified paths to the jars in jarDirectory. +
            Throws: +
            IOException - if there's a problem.
            +
            +
            +
            + +

            +deDuplicateJarNames

            +
            +public static List<String> deDuplicateJarNames(List<String> jarList)
            +
            +
            Deprecated. 
            Takes a list of paths and returns a list of paths with unique filenames. +

            +

            +
            Parameters:
            jarList - A list of jars to de-dupe. +
            Returns:
            A de-duplicated list of jars.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/KijiConfKeys.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/KijiConfKeys.html new file mode 100644 index 00000000..dedca8e2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/KijiConfKeys.html @@ -0,0 +1,277 @@ + + + + + + + +KijiConfKeys (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class KijiConfKeys

            +
            +java.lang.Object
+  extended by org.kiji.schema.mapreduce.KijiConfKeys
+
            +
            +Deprecated. +

            +

            +
            @Deprecated
+public final class KijiConfKeys
            extends Object
            + + +

            +Configuration keys used by KijiMR in Hadoop Configuration objects. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringINPUT_DATA_REQUEST + +
            +          Deprecated. Serialized input data request.
            +static StringINPUT_TABLE_URI + +
            +          Deprecated. URI of the input table to read from.
            +static StringOUTPUT_KIJI_TABLE_URI + +
            +          Deprecated. URI of the output Kiji table to write to.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +INPUT_TABLE_URI

            +
            +public static final String INPUT_TABLE_URI
            +
            +
            Deprecated. 
            URI of the input table to read from. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +OUTPUT_KIJI_TABLE_URI

            +
            +public static final String OUTPUT_KIJI_TABLE_URI
            +
            +
            Deprecated. 
            URI of the output Kiji table to write to. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +INPUT_DATA_REQUEST

            +
            +public static final String INPUT_DATA_REQUEST
            +
            +
            Deprecated. 
            Serialized input data request. +

            +

            +
            See Also:
            Constant Field Values
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html new file mode 100644 index 00000000..8f6db880 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/KijiTableInputFormat.KijiTableRecordReader.html @@ -0,0 +1,472 @@ + + + + + + + +KijiTableInputFormat.KijiTableRecordReader (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class KijiTableInputFormat.KijiTableRecordReader

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.RecordReader<EntityId,KijiRowData>
+      extended by org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader
+
            +
            +
            All Implemented Interfaces:
            Closeable
            +
            +
            +
            Enclosing class:
            KijiTableInputFormat
            +
            +
            +
            +
            public static class KijiTableInputFormat.KijiTableRecordReader
            extends RecordReader<EntityId,KijiRowData>
            + + +

            +Hadoop record reader for Kiji table rows. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +protected  ConfigurationmConf + +
            +          Hadoop Configuration object containing settings.
            +protected  KijiDataRequestmDataRequest + +
            +          Data request.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableInputFormat.KijiTableRecordReader(Configuration conf) + +
            +          Creates a new RecordReader for this input format.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + EntityIdgetCurrentKey() + +
            +          
            + KijiRowDatagetCurrentValue() + +
            +          
            + floatgetProgress() + +
            +          
            + voidinitialize(InputSplit split, + TaskAttemptContext context) + +
            +          
            + booleannextKeyValue() + +
            +          
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +mDataRequest

            +
            +protected final KijiDataRequest mDataRequest
            +
            +
            Data request. +

            +

            +
            +
            +
            + +

            +mConf

            +
            +protected final Configuration mConf
            +
            +
            Hadoop Configuration object containing settings. +

            +

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

            +KijiTableInputFormat.KijiTableRecordReader

            +
            +public KijiTableInputFormat.KijiTableRecordReader(Configuration conf)
            +
            +
            Creates a new RecordReader for this input format. This RecordReader will perform the actual + reads from Kiji. +

            +

            +
            Parameters:
            conf - The configuration object for this Kiji.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +initialize

            +
            +public void initialize(InputSplit split,
+                       TaskAttemptContext context)
+                throws IOException
            +
            +
            +

            +

            +
            Specified by:
            initialize in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getCurrentKey

            +
            +public EntityId getCurrentKey()
+                       throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getCurrentKey in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getCurrentValue

            +
            +public KijiRowData getCurrentValue()
+                            throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getCurrentValue in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getProgress

            +
            +public float getProgress()
+                  throws IOException
            +
            +
            +

            +

            +
            Specified by:
            getProgress in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +nextKeyValue

            +
            +public boolean nextKeyValue()
+                     throws IOException
            +
            +
            +

            +

            +
            Specified by:
            nextKeyValue in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            Specified by:
            close in class RecordReader<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/KijiTableInputFormat.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/KijiTableInputFormat.html new file mode 100644 index 00000000..d9e34920 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/KijiTableInputFormat.html @@ -0,0 +1,401 @@ + + + + + + + +KijiTableInputFormat (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.mapreduce +
            +Class KijiTableInputFormat

            +
            +java.lang.Object
+  extended by org.apache.hadoop.mapreduce.InputFormat<EntityId,KijiRowData>
+      extended by org.kiji.schema.mapreduce.KijiTableInputFormat
+
            +
            +
            All Implemented Interfaces:
            Configurable
            +
            +
            +Deprecated. +

            +

            +
            @Deprecated
+public class KijiTableInputFormat
            extends InputFormat<EntityId,KijiRowData>
            implements Configurable
            + + +

            +InputFormat for Hadoop MapReduce jobs reading from a Kiji table. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classKijiTableInputFormat.KijiTableRecordReader + +
            +          Deprecated. Hadoop record reader for Kiji table rows.
            +  + + + + + + + + + + +
            +Constructor Summary
            KijiTableInputFormat() + +
            +          Deprecated.  
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidconfigureJob(Job job, + KijiURI tableURI, + KijiDataRequest dataRequest, + String startRow, + String endRow) + +
            +          Deprecated. Configures a Hadoop M/R job to read from a given table.
            + RecordReader<EntityId,KijiRowData>createRecordReader(InputSplit split, + TaskAttemptContext context) + +
            +          Deprecated. 
            + ConfigurationgetConf() + +
            +          Deprecated. 
            + List<InputSplit>getSplits(JobContext context) + +
            +          Deprecated. 
            + voidsetConf(Configuration conf) + +
            +          Deprecated. 
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiTableInputFormat

            +
            +public KijiTableInputFormat()
            +
            +
            Deprecated. 
            + + + + + + + + +
            +Method Detail
            + +

            +setConf

            +
            +public void setConf(Configuration conf)
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            setConf in interface Configurable
            +
            +
            +
            +
            +
            +
            + +

            +getConf

            +
            +public Configuration getConf()
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            getConf in interface Configurable
            +
            +
            +
            +
            +
            +
            + +

            +createRecordReader

            +
            +public RecordReader<EntityId,KijiRowData> createRecordReader(InputSplit split,
+                                                             TaskAttemptContext context)
+                                                      throws IOException
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            createRecordReader in class InputFormat<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +getSplits

            +
            +public List<InputSplit> getSplits(JobContext context)
+                           throws IOException
            +
            +
            Deprecated. 
            +

            +

            +
            Specified by:
            getSplits in class InputFormat<EntityId,KijiRowData>
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +configureJob

            +
            +public static void configureJob(Job job,
+                                KijiURI tableURI,
+                                KijiDataRequest dataRequest,
+                                String startRow,
+                                String endRow)
+                         throws IOException
            +
            +
            Deprecated. 
            Configures a Hadoop M/R job to read from a given table. +

            +

            +
            +
            +
            +
            Parameters:
            job - Job to configure.
            tableURI - URI of the table to read from.
            dataRequest - Data request.
            startRow - Minimum row key to process.
            endRow - Maximum row Key to process. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html new file mode 100644 index 00000000..a37dc9f7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/DistributedCacheJars.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.DistributedCacheJars (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.DistributedCacheJars

            +
            +No usage of org.kiji.schema.mapreduce.DistributedCacheJars +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/KijiConfKeys.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/KijiConfKeys.html new file mode 100644 index 00000000..d407bec6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/KijiConfKeys.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.KijiConfKeys (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.KijiConfKeys

            +
            +No usage of org.kiji.schema.mapreduce.KijiConfKeys +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html new file mode 100644 index 00000000..245f1e68 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.KijiTableRecordReader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader

            +
            +No usage of org.kiji.schema.mapreduce.KijiTableInputFormat.KijiTableRecordReader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html new file mode 100644 index 00000000..94e934d9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/class-use/KijiTableInputFormat.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.mapreduce.KijiTableInputFormat (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.mapreduce.KijiTableInputFormat

            +
            +No usage of org.kiji.schema.mapreduce.KijiTableInputFormat +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-frame.html new file mode 100644 index 00000000..4c211c36 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-frame.html @@ -0,0 +1,39 @@ + + + + + + + +org.kiji.schema.mapreduce (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema.mapreduce + + + + +
            +Classes  + +
            +DistributedCacheJars +
            +KijiConfKeys +
            +KijiTableInputFormat +
            +KijiTableInputFormat.KijiTableRecordReader
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-summary.html new file mode 100644 index 00000000..f0cb3665 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-summary.html @@ -0,0 +1,196 @@ + + + + + + + +org.kiji.schema.mapreduce (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +@Deprecated +

            +Package org.kiji.schema.mapreduce +

            +Kiji MapReduce utilities. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            DistributedCacheJarsDeprecated.
            KijiConfKeysDeprecated.
            KijiTableInputFormatDeprecated.
            KijiTableInputFormat.KijiTableRecordReaderHadoop record reader for Kiji table rows.
            +  + +

            +

            +Package org.kiji.schema.mapreduce Description +

            + +

            +Kiji MapReduce utilities. + +

            This package provides support for building MapReduce jobs that read from and/or write to + a Kiji table. For reading from Kiji, use KijiTableInputFormat.

            + +

            December 20, 2012: Note that this package is deprecated; the KijiMapReduce framework + (https://github.com/kijiproject/kiji-mapreduce) will contain revamped versions of these + and additional MapReduce integration points. Users investing heavily in MapReduce + should pay attention to development on this new project at https://jira.kiji.org and the + user and developer mailing lists user@ and dev@kiji.org. After KijiMapReduce is released, + this package will disappear.

            +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-tree.html new file mode 100644 index 00000000..1c18769d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-tree.html @@ -0,0 +1,160 @@ + + + + + + + +org.kiji.schema.mapreduce Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.mapreduce +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-use.html new file mode 100644 index 00000000..73cce84d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/mapreduce/package-use.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Package org.kiji.schema.mapreduce (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.mapreduce

            +
            +No usage of org.kiji.schema.mapreduce +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-frame.html new file mode 100644 index 00000000..1ccffc40 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-frame.html @@ -0,0 +1,185 @@ + + + + + + + +org.kiji.schema (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema + + + + +
            +Interfaces  + +
            +Kiji +
            +KijiCellDecoder +
            +KijiCellDecoderFactory +
            +KijiCellEncoder +
            +KijiCellEncoderFactory +
            +KijiDeleter +
            +KijiFactory +
            +KijiIncrementer +
            +KijiPager +
            +KijiPutter +
            +KijiRegion +
            +KijiRowData +
            +KijiRowScanner +
            +KijiTable +
            +KijiTableFactory +
            +KijiTableKeyValueDatabase +
            +KijiTableReader +
            +KijiTableWriter
            + + + + + + +
            +Classes  + +
            +DecodedCell +
            +EntityId +
            +EntityIdFactory +
            +GenericCellDecoderFactory +
            +KConstants +
            +Kiji.Factory +
            +KijiCell +
            +KijiColumnName +
            +KijiDataRequest +
            +KijiDataRequest.Column +
            +KijiDataRequestBuilder +
            +KijiDataRequestBuilder.ColumnsDef +
            +KijiDataRequestValidator +
            +KijiInstaller +
            +KijiMetaTable +
            +KijiRowKeySplitter +
            +KijiSchemaTable +
            +KijiSchemaTable.SchemaEntry +
            +KijiSystemTable +
            +KijiTablePool +
            +KijiTablePool.Options +
            +KijiTableReader.KijiScannerOptions +
            +KijiURI +
            +KijiURI.KijiURIBuilder +
            +SpecificCellDecoderFactory
            + + + + + + +
            +Enums  + +
            +KijiCell.CellType
            + + + + + + +
            +Exceptions  + +
            +EntityIdException +
            +IncompatibleKijiVersionException +
            +KijiAlreadyExistsException +
            +KijiDataRequestException +
            +KijiEncodingException +
            +KijiInvalidNameException +
            +KijiNotInstalledException +
            +KijiTableNotFoundException +
            +KijiTablePool.NoCapacityException +
            +KijiURIException +
            +NoCellDataException +
            +NoSuchColumnException +
            +NotAKijiManagedTableException +
            +TableKeyNotFoundException
            + + + + + + +
            +Errors  + +
            +InternalKijiError
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-summary.html new file mode 100644 index 00000000..0535c7d8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-summary.html @@ -0,0 +1,488 @@ + + + + + + + +org.kiji.schema (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema +

            +The main package for users of KijiSchema. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Interface Summary
            KijiProvides a handle to a Kiji instance that contains table information and access to + Kiji administrative functionality.
            KijiCellDecoder<T>Interface for Kiji cell decoders.
            KijiCellDecoderFactoryInterface for factories of KijiCellDecoder instances.
            KijiCellEncoderInterface for Kiji cell encoders.
            KijiCellEncoderFactoryInterface for factories of KijiCellEncoder instances.
            KijiDeleterInterface for performing deletes on a Kiji table.
            KijiFactoryFactory for Kiji instances.
            KijiIncrementerInterface for performing increments on a Kiji table.
            KijiPager Manages retrieving pages of values from a column in a Kiji table.
            KijiPutterInterface for performing puts on a Kiji table.
            KijiRegionA KijiRegion specifies a logical region in a Kiji Table, bounded by + a start key (inclusive) and an end key (exclusive).
            KijiRowDataKijiRowData provides a way for applications to access data read from a Kiji table.
            KijiRowScannerInterface for scanning over rows read from a Kiji table.
            KijiTableThe KijiTable interface provides operations on KijiTables.
            KijiTableFactoryFactory for KijiTable instances.
            KijiTableKeyValueDatabaseA database of per table key-value pairs.
            KijiTableReaderInterface for reading data from a Kiji table.
            KijiTableWriter + Interface for modifying a Kiji table.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            DecodedCell<T>Content of a Kiji cell.
            EntityIdEntityId is used to identify a particular row in a Kiji table.
            EntityIdFactoryFactory class for creating EntityIds.
            GenericCellDecoderFactoryFactory for Kiji cell decoders using GenericCellDecoder to handle record-based schemas.
            KConstantsConstants used by Kiji.
            Kiji.FactoryProvider for the default Kiji factory.
            KijiCell<T>KijiCell represents a cell in a Kiji table.
            KijiColumnNameA Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiDataRequestDescribes a request for columns of data to read from a Kiji table.
            KijiDataRequest.ColumnDescribes a request for a Kiji Table column.
            KijiDataRequestBuilderBuilds a request for columns of data to read from a Kiji table.
            KijiDataRequestBuilder.ColumnsDefDefines properties associated with one or more columns in a request for Kiji table columns.
            KijiDataRequestValidatorThis class validates a KijiDataRequest against the layout + of a Kiji table to make sure it contains all of the columns requested.
            KijiInstallerInstalls or uninstalls Kiji instances from an HBase cluster.
            KijiMetaTableThe kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiRowKeySplitterUtility class for splitting the Kiji row key space.
            KijiSchemaTableThe Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSchemaTable.SchemaEntryAssociation between a schema and its ID.
            KijiSystemTableThe Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiTablePoolMaintains a pool of opened KijiTables.
            KijiTablePool.OptionsDescribes the options that can be configured on the KijiTablePool.
            KijiTableReader.KijiScannerOptionsOptions for KijiRowScanners.
            KijiURIURI that uniquely identifies a Kiji instance, table, column(s).
            KijiURI.KijiURIBuilderBuilder class for constructing KijiURIs.
            SpecificCellDecoderFactoryFactory for Kiji cell decoders using SpecificCellDecoder to handle record-based schemas.
            +  + +

            + + + + + + + + + +
            +Enum Summary
            KijiCell.CellTypeType of a Kiji cell.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Exception Summary
            EntityIdExceptionThrown when kiji encounters a row key component name that is not valid.
            IncompatibleKijiVersionExceptionThrown when there is an attempt to operate on a Kiji instance whose data format version + is incompatible with the Kiji client version.
            KijiAlreadyExistsExceptionThrown when installing an instance or creating a table that already exists.
            KijiDataRequestExceptionThrown when there is an error validating a KijiDataRequest against a Kiji table.
            KijiEncodingExceptionRuntime exception thrown when encoding a cell's content fails.
            KijiInvalidNameExceptionThrown when a Kiji instance or table layout name is invalid.
            KijiNotInstalledExceptionThrown when attempting to open a non existing/not installed Kiji instance.
            KijiTableNotFoundExceptionThrown when an attempt to access a table fails because it does not exist.
            KijiTablePool.NoCapacityExceptionThrown when an attempt to get a table connection fails because there is no room in the pool.
            KijiURIExceptionThrown when parsing a bogus Kiji URI.
            NoCellDataExceptionThrown when attempting to read data from a cell that doesn't exist.
            NoSuchColumnExceptionThrown when attempting to access a column that does not exist.
            NotAKijiManagedTableExceptionThrown when Kiji encounters an HBase table that is not managed by Kiji.
            TableKeyNotFoundExceptionThrown when a key is not found in a map-like API implemented by one of the + Kiji tables, the system or meta table for example.
            +  + +

            + + + + + + + + + +
            +Error Summary
            InternalKijiErrorThrown when there is something wrong with the internal Kiji + implementation.
            +  + +

            +

            +Package org.kiji.schema Description +

            + +

            +The main package for users of KijiSchema. + +

            + KijiSchema provides layout and schema management on top of HBase. KijiSchema also allows + for the use of both structured and unstructured data in HBase using Avro serialization. +

            + +

            + Classes of note: +

            + + +

            + Related Documentation: +

            + +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-tree.html new file mode 100644 index 00000000..6f63a72c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-tree.html @@ -0,0 +1,233 @@ + + + + + + + +org.kiji.schema Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-use.html new file mode 100644 index 00000000..782afae7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/package-use.html @@ -0,0 +1,795 @@ + + + + + + + +Uses of Package org.kiji.schema (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables. 
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.layout.implImplementation for Kiji table layout management. 
            org.kiji.schema.mapreduceKiji MapReduce utilities. 
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema
            DecodedCell + +
            +          Content of a Kiji cell.
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            EntityIdFactory + +
            +          Factory class for creating EntityIds.
            Kiji + +
            +          Provides a handle to a Kiji instance that contains table information and access to + Kiji administrative functionality.
            KijiCell + +
            +          KijiCell represents a cell in a Kiji table.
            KijiCell.CellType + +
            +          Type of a Kiji cell.
            KijiCellDecoder + +
            +          Interface for Kiji cell decoders.
            KijiCellDecoderFactory + +
            +          Interface for factories of KijiCellDecoder instances.
            KijiCellEncoder + +
            +          Interface for Kiji cell encoders.
            KijiColumnName + +
            +          A Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiDataRequest.Column + +
            +          Describes a request for a Kiji Table column.
            KijiDataRequestBuilder + +
            +          Builds a request for columns of data to read from a Kiji table.
            KijiDataRequestBuilder.ColumnsDef + +
            +          Defines properties associated with one or more columns in a request for Kiji table columns.
            KijiDeleter + +
            +          Interface for performing deletes on a Kiji table.
            KijiFactory + +
            +          Factory for Kiji instances.
            KijiIncrementer + +
            +          Interface for performing increments on a Kiji table.
            KijiInstaller + +
            +          Installs or uninstalls Kiji instances from an HBase cluster.
            KijiInvalidNameException + +
            +          Thrown when a Kiji instance or table layout name is invalid.
            KijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiPager + +
            +           Manages retrieving pages of values from a column in a Kiji table.
            KijiPutter + +
            +          Interface for performing puts on a Kiji table.
            KijiRegion + +
            +          A KijiRegion specifies a logical region in a Kiji Table, bounded by + a start key (inclusive) and an end key (exclusive).
            KijiRowData + +
            +          KijiRowData provides a way for applications to access data read from a Kiji table.
            KijiRowScanner + +
            +          Interface for scanning over rows read from a Kiji table.
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSystemTable + +
            +          The Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiTable + +
            +          The KijiTable interface provides operations on KijiTables.
            KijiTableFactory + +
            +          Factory for KijiTable instances.
            KijiTableKeyValueDatabase + +
            +          A database of per table key-value pairs.
            KijiTablePool.Options + +
            +          Describes the options that can be configured on the KijiTablePool.
            KijiTableReader + +
            +          Interface for reading data from a Kiji table.
            KijiTableReader.KijiScannerOptions + +
            +          Options for KijiRowScanners.
            KijiTableWriter + +
            +           + Interface for modifying a Kiji table.
            KijiURI + +
            +          URI that uniquely identifies a Kiji instance, table, column(s).
            KijiURI.KijiURIBuilder + +
            +          Builder class for constructing KijiURIs.
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.filter
            DecodedCell + +
            +          Content of a Kiji cell.
            KijiColumnName + +
            +          A Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            NoSuchColumnException + +
            +          Thrown when attempting to access a column that does not exist.
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.hbase
            KijiURI + +
            +          URI that uniquely identifies a Kiji instance, table, column(s).
            NotAKijiManagedTableException + +
            +          Thrown when Kiji encounters an HBase table that is not managed by Kiji.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.impl
            DecodedCell + +
            +          Content of a Kiji cell.
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            Kiji + +
            +          Provides a handle to a Kiji instance that contains table information and access to + Kiji administrative functionality.
            KijiCell + +
            +          KijiCell represents a cell in a Kiji table.
            KijiCellDecoder + +
            +          Interface for Kiji cell decoders.
            KijiCellDecoderFactory + +
            +          Interface for factories of KijiCellDecoder instances.
            KijiCellEncoder + +
            +          Interface for Kiji cell encoders.
            KijiCellEncoderFactory + +
            +          Interface for factories of KijiCellEncoder instances.
            KijiColumnName + +
            +          A Kiji column name is composed of one or two parts: a family and a qualifier.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiDeleter + +
            +          Interface for performing deletes on a Kiji table.
            KijiFactory + +
            +          Factory for Kiji instances.
            KijiIncrementer + +
            +          Interface for performing increments on a Kiji table.
            KijiMetaTable + +
            +          The kiji metadata table, which stores layouts and other user defined meta data on a per-table + basis.
            KijiPager + +
            +           Manages retrieving pages of values from a column in a Kiji table.
            KijiPutter + +
            +          Interface for performing puts on a Kiji table.
            KijiRegion + +
            +          A KijiRegion specifies a logical region in a Kiji Table, bounded by + a start key (inclusive) and an end key (exclusive).
            KijiRowData + +
            +          KijiRowData provides a way for applications to access data read from a Kiji table.
            KijiRowScanner + +
            +          Interface for scanning over rows read from a Kiji table.
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            KijiSchemaTable.SchemaEntry + +
            +          Association between a schema and its ID.
            KijiSystemTable + +
            +          The Kiji system table, which stores system information such as the version, ready state, and + locks.
            KijiTable + +
            +          The KijiTable interface provides operations on KijiTables.
            KijiTableFactory + +
            +          Factory for KijiTable instances.
            KijiTableKeyValueDatabase + +
            +          A database of per table key-value pairs.
            KijiTableReader + +
            +          Interface for reading data from a Kiji table.
            KijiTableReader.KijiScannerOptions + +
            +          Options for KijiRowScanners.
            KijiTableWriter + +
            +           + Interface for modifying a Kiji table.
            KijiURI + +
            +          URI that uniquely identifies a Kiji instance, table, column(s).
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.layout
            KijiColumnName + +
            +          A Kiji column name is composed of one or two parts: a family and a qualifier.
            NoSuchColumnException + +
            +          Thrown when attempting to access a column that does not exist.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.layout.impl
            KijiSchemaTable + +
            +          The Kiji schema table, which contains the lookup table between schema IDs, hashes, and full + schemas.
            +  +

            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.mapreduce
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            KijiDataRequest + +
            +          Describes a request for columns of data to read from a Kiji table.
            KijiRowData + +
            +          KijiRowData provides a way for applications to access data read from a Kiji table.
            KijiURI + +
            +          URI that uniquely identifies a Kiji instance, table, column(s).
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.tools
            EntityId + +
            +          EntityId is used to identify a particular row in a Kiji table.
            EntityIdFactory + +
            +          Factory class for creating EntityIds.
            KijiURI + +
            +          URI that uniquely identifies a Kiji instance, table, column(s).
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema used by org.kiji.schema.util
            Kiji + +
            +          Provides a handle to a Kiji instance that contains table information and access to + Kiji administrative functionality.
            KijiInvalidNameException + +
            +          Thrown when a Kiji instance or table layout name is invalid.
            KijiURI + +
            +          URI that uniquely identifies a Kiji instance, table, column(s).
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/BaseTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/BaseTool.html new file mode 100644 index 00000000..3d454544 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/BaseTool.html @@ -0,0 +1,656 @@ + + + + + + + +BaseTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class BaseTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            Direct Known Subclasses:
            CreateTableTool, DeleteTool, FlushTableTool, IncrementTool, InstallTool, LayoutTool, LsTool, MetadataTool, PutTool, SynthesizeUserDataTool, UninstallTool, VersionTool
            +
            +
            +
            +
            @ApiAudience.Framework
+@Inheritance.Extensible
+public abstract class BaseTool
            extends Configured
            implements KijiTool
            + + +

            +Base class for all Kiji command line tools. + + A command line tool, executed via KijiToolLauncher, will perform these steps when run: +

              +
            1. Parse command-line flags to the tool and set the appropriate fields. Subclasses + wishing to add flags to a tool should use the Flag annotation.
              2. +
            2. Run the validateFlags() method. Subclasses wishing to validate custom + command-line arguments should override this method but take care to call + super.validateFlags()
              3. +
            3. Run the setup() method. Subclasses wishing to implement custom setup logic + should override this method but take care to call super.setup()
              4. +
            4. Run the run(java.util.List) method. Subclasses should implement their main + command logic here. The argument to run is a String list of + arguments passed that were not arguments to the Hadoop framework or flags specified via + Flag annotations.
              5. +
            5. Run the cleanup() method. Subclasses wishing to implement custom cleanup + logic should override this method but take care to call super.cleanup. + cleanup will run even if there is an exception while executing + setup or run. +
            + + Tools needing to prompt the user for a yes/no answer should use the yesNoPrompt(java.lang.String) method. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + +
            +Field Summary
            +static intFAILURE + +
            +          Failure tool exit code.
            +static intSUCCESS + +
            +          Success tool exit code.
            +  + + + + + + + + + + +
            +Constructor Summary
            BaseTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + PrintStreamgetPrintStream() + +
            +          The output print stream the tool should be writing to.
            +protected  booleanhasVerboseDebug() + +
            +          Whether or not this tool is being run with verbose debug messages.
            +protected  booleanisInteractive() + +
            +          Whether or not this tool is being run interactively.
            +protected  booleanmayProceed(String format, + Object... arguments) + +
            +          Checks with the user whether the specified operation may proceed.
            +protected abstract  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            + voidsetPrintStream(PrintStream printStream) + +
            +          Set the output print stream the tool should write to.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            + inttoolMain(List<String> args) + +
            +          Invoke the functionality of this tool, as supplied through its + implementation of the abstract methods of this class.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +protected  booleanyesNoPrompt(String question) + +
            +          Prompts the user for a yes or no answer to the specified question until they provide a valid + response (y/n/yes/no case insensitive) and reports the result.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.kiji.schema.tools.KijiTool
            getCategory, getDescription, getName
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +SUCCESS

            +
            +public static final int SUCCESS
            +
            +
            Success tool exit code. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +FAILURE

            +
            +public static final int FAILURE
            +
            +
            Failure tool exit code. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Constructor Detail
            + +

            +BaseTool

            +
            +public BaseTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +yesNoPrompt

            +
            +protected final boolean yesNoPrompt(String question)
+                             throws IOException
            +
            +
            Prompts the user for a yes or no answer to the specified question until they provide a valid + response (y/n/yes/no case insensitive) and reports the result. If yesNoPrompt is called in + non-interactive mode, an IllegalStateException is thrown. +

            +

            +
            +
            +
            +
            Parameters:
            question - The question to which a yes or no is expected in response. +
            Returns:
            true if the user answer yes, false if the user answered no. +
            Throws: +
            IOException - if there is a problem reading from the terminal.
            +
            +
            +
            + +

            +mayProceed

            +
            +protected boolean mayProceed(String format,
+                             Object... arguments)
+                      throws IOException
            +
            +
            Checks with the user whether the specified operation may proceed. +

            +

            +
            +
            +
            +
            Parameters:
            format - String format with a question describing the operation about to be executed.
            arguments - String format arguments. +
            Returns:
            whether the operation may proceed, or not. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +toolMain

            +
            +public int toolMain(List<String> args)
+             throws Exception
            +
            +
            Invoke the functionality of this tool, as supplied through its + implementation of the abstract methods of this class. +

            +

            +
            Specified by:
            toolMain in interface KijiTool
            +
            +
            +
            Parameters:
            args - the command-line arguments to the tool not including the + tool name itself. +
            Returns:
            0 on success, non-zero on failure. +
            Throws: +
            Exception - if there's an error inside the tool.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. + Note: all subclasses of BaseTool should call super.cleanup() +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected abstract int run(List<String> nonFlagArgs)
+                    throws Exception
            +
            +
            Runs the tool. +

            +

            +
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +getPrintStream

            +
            +public PrintStream getPrintStream()
            +
            +
            The output print stream the tool should be writing to. + If no print stream is set, returns System.out +

            +

            +
            +
            +
            + +
            Returns:
            The print stream the tool should write to.
            +
            +
            +
            + +

            +setPrintStream

            +
            +public void setPrintStream(PrintStream printStream)
            +
            +
            Set the output print stream the tool should write to. If you don't set it, + it will default to STDOUT. +

            +

            +
            +
            +
            +
            Parameters:
            printStream - The output print stream to use.
            +
            +
            +
            + +

            +isInteractive

            +
            +protected final boolean isInteractive()
            +
            +
            Whether or not this tool is being run interactively. +

            +

            +
            +
            +
            + +
            Returns:
            Whether or not this tool is being run interactively.
            +
            +
            +
            + +

            +hasVerboseDebug

            +
            +protected final boolean hasVerboseDebug()
            +
            +
            Whether or not this tool is being run with verbose debug messages. +

            +

            +
            +
            +
            + +
            Returns:
            Whether or not this tool is being run with verbose debug messages.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/CreateTableTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/CreateTableTool.html new file mode 100644 index 00000000..db83fa9c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/CreateTableTool.html @@ -0,0 +1,492 @@ + + + + + + + +CreateTableTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class CreateTableTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.CreateTableTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class CreateTableTool
            extends BaseTool
            + + +

            +Command-line tool for creating kiji tables in kiji instances. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            CreateTableTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +CreateTableTool

            +
            +public CreateTableTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. + Note: all subclasses of BaseTool should call super.cleanup() +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/DeleteTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/DeleteTool.html new file mode 100644 index 00000000..17a339a2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/DeleteTool.html @@ -0,0 +1,457 @@ + + + + + + + +DeleteTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class DeleteTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.DeleteTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class DeleteTool
            extends BaseTool
            + + +

            +Command-line tool to delete Kiji tables, rows, and cells. + +

            Examples:

            + Delete an entire table: + 
            +   kiji delete --target=kiji://my-hbase/my-instance/my-table/
+
            + Delete an entire row: + 
            +   kiji delete --target=kiji://my-hbase/my-instance/my-table/ \
+       --entity-id=my-entity-id --timestamp=all
+
            + Delete a single version of a cell: + 
            +   kiji delete --target=kiji://my-hbase/my-instance/my-table/ \
+       my-column-family:my-column-qualifier/ --entity-id=my-entity-id \
+       --timestamp=123456789
+   kiji delete --target=kiji://my-hbase/my-instance/my-table/ \
+       my-column-family:my-column-qualifier/ --entity-id=my-entity-id \
+       --timestamp=latest
+
            +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            DeleteTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, setup, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +DeleteTool

            +
            +public DeleteTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/FlushTableTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/FlushTableTool.html new file mode 100644 index 00000000..4bda775f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/FlushTableTool.html @@ -0,0 +1,502 @@ + + + + + + + +FlushTableTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class FlushTableTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.FlushTableTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class FlushTableTool
            extends BaseTool
            + + +

            +Command-line tool for flushing Kiji meta and user tables in HBase. + +

            Examples:

            + Flush a Kiji table: + 
            +   kiji flush-table --target=kiji://my-hbase/my-instance/my-table/
+
            + Flush all meta tables in an instance: + 
            +   kiji flush-table --target=kiji://my-hbase/my-instance/ --meta=true
+
            +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            FlushTableTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +FlushTableTool

            +
            +public FlushTableTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. + Note: all subclasses of BaseTool should call super.cleanup() +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/HelpTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/HelpTool.html new file mode 100644 index 00000000..aad9d4cd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/HelpTool.html @@ -0,0 +1,367 @@ + + + + + + + +HelpTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class HelpTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.HelpTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class HelpTool
            extends Configured
            implements KijiTool
            + + +

            +Command-line tool for displaying help on available tools. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            HelpTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            + inttoolMain(List<String> args) + +
            +          The main logic of your tool.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +HelpTool

            +
            +public HelpTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            +
            Specified by:
            getName in interface KijiTool
            +
            +
            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            +
            Specified by:
            getDescription in interface KijiTool
            +
            +
            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            +
            Specified by:
            getCategory in interface KijiTool
            +
            +
            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +toolMain

            +
            +public int toolMain(List<String> args)
+             throws Exception
            +
            +
            The main logic of your tool. +

            +

            +
            Specified by:
            toolMain in interface KijiTool
            +
            +
            +
            Parameters:
            args - the arguments on the command line (excluding the tool name itself). +
            Returns:
            The program exit code. 0 should indicate success. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/IncrementTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/IncrementTool.html new file mode 100644 index 00000000..ac91b31b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/IncrementTool.html @@ -0,0 +1,437 @@ + + + + + + + +IncrementTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class IncrementTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.IncrementTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class IncrementTool
            extends BaseTool
            + + +

            +Command-line tool to increment a counter in a cell of a kiji table. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            IncrementTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, setup, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +IncrementTool

            +
            +public IncrementTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/InstallTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/InstallTool.html new file mode 100644 index 00000000..01b5719a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/InstallTool.html @@ -0,0 +1,437 @@ + + + + + + + +InstallTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class InstallTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.InstallTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class InstallTool
            extends BaseTool
            + + +

            +A command-line tool for installing kiji instances on hbase clusters. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            InstallTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +InstallTool

            +
            +public InstallTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/KijiTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/KijiTool.html new file mode 100644 index 00000000..423b5cea --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/KijiTool.html @@ -0,0 +1,318 @@ + + + + + + + +KijiTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Interface KijiTool

            +
            +
            All Superinterfaces:
            Configurable
            +
            +
            +
            All Known Implementing Classes:
            BaseTool, CreateTableTool, DeleteTool, FlushTableTool, HelpTool, IncrementTool, InstallTool, LayoutTool, LsTool, MetadataTool, PutTool, SynthesizeUserDataTool, UninstallTool, VersionTool
            +
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Extensible
+public interface KijiTool
            extends Configurable
            + + +

            +Base interface to be implemented by command-line tools that are launched through + the bin/kiji script. These tools are instantiated and run by the + KijiToolLauncher. + +

            To register a tool to use with bin/kiji, you must also put the complete + name of the implementing class in a resource in your jar file at: + META-INF/services/org.kiji.schema.tools.KijiTool. You may publish multiple + tools in this way; put each class name on its own line in this file. You can put + this file in src/test/resources/ in your Maven project, and it will be + incorporated into your jar.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +           
            + StringgetDescription() + +
            +           
            + StringgetName() + +
            +           
            + inttoolMain(List<String> args) + +
            +          The main logic of your tool.
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +String getName()
            +
            +
            +
            +
            +
            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +String getDescription()
            +
            +
            +
            +
            +
            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +String getCategory()
            +
            +
            +
            +
            +
            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +toolMain

            +
            +int toolMain(List<String> args)
+             throws Exception
            +
            +
            The main logic of your tool. +

            +

            +
            +
            +
            +
            Parameters:
            args - the arguments on the command line (excluding the tool name itself). +
            Returns:
            The program exit code. 0 should indicate success. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/KijiToolLauncher.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/KijiToolLauncher.html new file mode 100644 index 00000000..c748a278 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/KijiToolLauncher.html @@ -0,0 +1,342 @@ + + + + + + + +KijiToolLauncher (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class KijiToolLauncher

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.KijiToolLauncher
+
            +
            +
            All Implemented Interfaces:
            Configurable
            +
            +
            +
            +
            @ApiAudience.Public
+public final class KijiToolLauncher
            extends Configured
            + + +

            +Main entry point to launch Kiji tools. + +

            All tools launched through bin/kiji <tool> are detected and + instantiated through this module. Tools should implement the KijiTool + interface. In addition, each tool must advertise itself by adding a line to + a resource file contained in its jar at + META-INF/services/org.kiji.schema.tools.KijiTool. + This path can be added to your build by providing it under src/main/resources.

            +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            KijiToolLauncher() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidmain(String[] args) + +
            +          Program entry point.
            + intrun(KijiTool tool, + String[] args) + +
            +          Programmatic entry point to the tool launcher if a tool is already selected.
            + intrun(String[] args) + +
            +          Programmatic entry point to the tool launcher.
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +KijiToolLauncher

            +
            +public KijiToolLauncher()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +run

            +
            +public int run(String[] args)
+        throws Exception
            +
            +
            Programmatic entry point to the tool launcher. Locates a tool to run + based on the name provided as the first argument, then invokes it. + Hadoop property-based arguments will be parsed by KijiToolLauncher.run() + in a manner similar to Hadoop's ToolRunner. +

            +

            +
            Parameters:
            args - The command-line arguments. The first one should be the + name of the tool to run. +
            Returns:
            0 on program success, non-zero on error. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +public int run(KijiTool tool,
+               String[] args)
+        throws Exception
            +
            +
            Programmatic entry point to the tool launcher if a tool is already selected. + Hadoop property-based arguments will be parsed by KijiToolLauncher.run() + in a manner similar to Hadoop's ToolRunner. +

            +

            +
            Parameters:
            tool - The KijiTool to run.
            args - The command-line arguments, excluding the name of the tool to run. +
            Returns:
            0 on program success, non-zero on error. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. This method does not return; it calls System.exit() with the + return code from the called tool. +

            +

            +
            Parameters:
            args - The command-line arguments, starting with the name of the tool to run. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/LayoutTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/LayoutTool.html new file mode 100644 index 00000000..e2a6057d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/LayoutTool.html @@ -0,0 +1,533 @@ + + + + + + + +LayoutTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class LayoutTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.LayoutTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class LayoutTool
            extends BaseTool
            + + +

            +Command-line tool for interacting with table layouts. Actions include reading a layout, + setting a table layout, and viewing a table's layout history. + +

            Examples:

            + Write the recent layout history of a table to a file: + 
            +   kiji layout --table=kiji://my-hbase/my-instance/my-table/ \
+       --do=history --max-version=3 --write-to=my-output-file
+
            + Set a new layout for a table: + 
            +   kiji layout --table=kiji://my-hbase/my-instance/my-table/ \
+       --do=set --layout=my-input-file
+
            + Perform a dry run of setting a table layout: + 
            +   kiji layout --table=kiji://my-hbase/my-instance/my-table/ \
+       --do=set --layout=my-input-file --dry-run=true
+
            +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            LayoutTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            +protected static booleanfileSystemSpecified(Path path) + +
            +          Determines whether a path has its filesystem explicitly specified.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +LayoutTool

            +
            +public LayoutTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. + Note: all subclasses of BaseTool should call super.cleanup() +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +fileSystemSpecified

            +
            +protected static boolean fileSystemSpecified(Path path)
            +
            +
            Determines whether a path has its filesystem explicitly specified. Did it start + with "hdfs://" or "file://"? +

            +

            +
            Parameters:
            path - The path to check. +
            Returns:
            Whether a file system was explicitly specified in the path.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/LsTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/LsTool.html new file mode 100644 index 00000000..5c238f4c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/LsTool.html @@ -0,0 +1,542 @@ + + + + + + + +LsTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class LsTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.LsTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class LsTool
            extends BaseTool
            + + +

            +Command-line tool to explore kiji table data like the 'ls' command of a unix shell. + + List all kiji instances: + 

            +   kiji ls --kiji=kiji://hbase-address/
+
            + + List all kiji tables: + 
            +   kiji ls --kiji=kiji://hbase-address/kiji-instance/
+
            + + List all families in a kiji table foo: + 
            +   kiji ls --kiji=kiji://hbase-address/kiji-instance/table-name/
+
            + + List all data in the info:email and derived:domain columns of a table foo: + 
            +   kiji ls \
+       --kiji=kiji://hbase-address/kiji-instance/table-name/ \
+       --columns=info:email,derived:domain
+
            + + List all data in the info:email and derived:domain columns of a table foo in row bar: + 
            +   kiji ls \
+       --kiji=kiji://hbase-address/kiji-instance/table-name/ \
+       --columns=info:email,derived:domain \
+       --entity-id=bar
+
            +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            LsTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            +protected static Set<String>getInstanceNames(KijiURI hbaseURI) + +
            +          Returns a set of instance names.
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected static StringparseInstanceName(String kijiTableName) + +
            +          Parses a table name for a kiji instance name.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +LsTool

            +
            +public LsTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +getInstanceNames

            +
            +protected static Set<String> getInstanceNames(KijiURI hbaseURI)
+                                       throws IOException
            +
            +
            Returns a set of instance names. +

            +

            +
            Parameters:
            hbaseURI - URI of the HBase instance to list the content of. +
            Returns:
            ordered set of instance names. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +parseInstanceName

            +
            +protected static String parseInstanceName(String kijiTableName)
            +
            +
            Parses a table name for a kiji instance name. +

            +

            +
            Parameters:
            kijiTableName - The table name to parse +
            Returns:
            instance name (or null if none found)
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Description copied from class: BaseTool
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/MetadataTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/MetadataTool.html new file mode 100644 index 00000000..04402966 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/MetadataTool.html @@ -0,0 +1,436 @@ + + + + + + + +MetadataTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class MetadataTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.MetadataTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            public class MetadataTool
            extends BaseTool
            + + +

            +A tool to backup and restore Metadata. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            MetadataTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +MetadataTool

            +
            +public MetadataTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/PutTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/PutTool.html new file mode 100644 index 00000000..07522a5c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/PutTool.html @@ -0,0 +1,439 @@ + + + + + + + +PutTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class PutTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.PutTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class PutTool
            extends BaseTool
            + + +

            +Command-line tool for putting an Avro value into a kiji cell. The value is specified by the + user as a JSON string that matches the Avro-JSON-encoding of a piece of Avro data. The user + must also specify an Avro schema (as a JSON string) when writing a value with this tool. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            PutTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +PutTool

            +
            +public PutTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws IOException
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/RequiredFlagException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/RequiredFlagException.html new file mode 100644 index 00000000..24e798d4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/RequiredFlagException.html @@ -0,0 +1,250 @@ + + + + + + + +RequiredFlagException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class RequiredFlagException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by org.kiji.schema.tools.RequiredFlagException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class RequiredFlagException
            extends Exception
            + + +

            +Thrown to indicate that a flag is required but not supplied. +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            RequiredFlagException(String flagName) + +
            +          Creates a new RequiredFlagException for the specified flag name.
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +RequiredFlagException

            +
            +public RequiredFlagException(String flagName)
            +
            +
            Creates a new RequiredFlagException for the specified flag name. +

            +

            +
            Parameters:
            flagName - The name of the flag without the '--'.
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/SpaceSeparatedMapParser.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/SpaceSeparatedMapParser.html new file mode 100644 index 00000000..6139ce49 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/SpaceSeparatedMapParser.html @@ -0,0 +1,260 @@ + + + + + + + +SpaceSeparatedMapParser (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class SpaceSeparatedMapParser

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.SpaceSeparatedMapParser
+
            +
            +
            +
            public final class SpaceSeparatedMapParser
            extends Object
            + + +

            +Parser for space-separated map arguments. + + Space-separated maps are specified from the command-line shell, as: + 

             kiji tool --flag="key1=value1 key2=value2 key3=value3"
            + + When only one value is needed, this can be shortened as: + 
             kiji tool --flag=key=value
            + +
          • Keys must be unique. +
          • Values may not contain spaces. +
          • Values will typically be URLs or URIs and may include spaces escaped as "%20". +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static SpaceSeparatedMapParsercreate() + +
            +           
            + Map<String,String>parse(String input) + +
            +          Parses a space-separated map into a Java map.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +public static SpaceSeparatedMapParser create()
            +
            +
            + +
            Returns:
            a new parser for space-separated parameter maps.
            +
            +
            +
            + +

            +parse

            +
            +public Map<String,String> parse(String input)
+                         throws IOException
            +
            +
            Parses a space-separated map into a Java map. +

            +

            +
            Parameters:
            input - Space-separated map. +
            Returns:
            the parsed Java map. +
            Throws: +
            IOException - on parse error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/SynthesizeUserDataTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/SynthesizeUserDataTool.html new file mode 100644 index 00000000..71abc28c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/SynthesizeUserDataTool.html @@ -0,0 +1,492 @@ + + + + + + + +SynthesizeUserDataTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class SynthesizeUserDataTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.SynthesizeUserDataTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class SynthesizeUserDataTool
            extends BaseTool
            + + +

            +Synthesize some user data into a kiji table. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            SynthesizeUserDataTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +protected  voidcleanup() + +
            +          Cleans up any open file handles, connections, etc.
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +protected  voidvalidateFlags() + +
            +          Validates the command-line flags.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +SynthesizeUserDataTool

            +
            +public SynthesizeUserDataTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +validateFlags

            +
            +protected void validateFlags()
+                      throws Exception
            +
            +
            Validates the command-line flags. +

            +

            +
            Overrides:
            validateFlags in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an invalid flag.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws IOException
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            +
            + +

            +cleanup

            +
            +protected void cleanup()
+                throws IOException
            +
            +
            Cleans up any open file handles, connections, etc. + Note: all subclasses of BaseTool should call super.cleanup() +

            +

            +
            Overrides:
            cleanup in class BaseTool
            +
            +
            + +
            Throws: +
            IOException - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/ToolUtils.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/ToolUtils.html new file mode 100644 index 00000000..cc67f1a9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/ToolUtils.html @@ -0,0 +1,447 @@ + + + + + + + +ToolUtils (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class ToolUtils

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.ToolUtils
+
            +
            +
            +
            @ApiAudience.Framework
+public final class ToolUtils
            extends Object
            + + +

            +Utility class providing static methods used by command-line tools. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static StringBYTES_SPEC_PREFIX_HEX + +
            +          Prefix to specify a sequence of bytes in hexadecimal, as in: "00dead88beefaa".
            +static StringBYTES_SPEC_PREFIX_URL + +
            +          Prefix to specify a sequence of bytes as a URL, as in: "URL%20encoded".
            +static StringBYTES_SPEC_PREFIX_UTF8 + +
            +          Optional prefix to specify a sequence of bytes in UTF-8, as in: "utf-8 \x00 encoded".
            +static StringHBASE_ROW_KEY_SPEC_PREFIX + +
            +          Prefix to specify an HBase row key from the command-line.
            +static StringKIJI_ROW_KEY_SPEC_PREFIX + +
            +          Optional prefix to specify a Kiji row key from the command-line.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static EntityIdcreateEntityIdFromUserInputs(String entityFlag, + KijiTableLayout layout) + +
            +          Parses a command-line flag specifying an entity ID.
            +static byte[]parseBytesFlag(String flag) + +
            +          Parses a command-line flag specifying a byte array.
            +static EntityIdparseJsonFormattedKeySpec(String json, + RowKeyFormat2 format, + EntityIdFactory factory) + +
            +          Parses a JSON formatted row key specification.
            +static EntityIdparseKijiRowKey(String rowKeySpec, + EntityIdFactory factory, + KijiTableLayout layout) + +
            +          Parses a Kiji row key specification from a command-line flag.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +HBASE_ROW_KEY_SPEC_PREFIX

            +
            +public static final String HBASE_ROW_KEY_SPEC_PREFIX
            +
            +
            Prefix to specify an HBase row key from the command-line. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +KIJI_ROW_KEY_SPEC_PREFIX

            +
            +public static final String KIJI_ROW_KEY_SPEC_PREFIX
            +
            +
            Optional prefix to specify a Kiji row key from the command-line. +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +BYTES_SPEC_PREFIX_HEX

            +
            +public static final String BYTES_SPEC_PREFIX_HEX
            +
            +
            Prefix to specify a sequence of bytes in hexadecimal, as in: "00dead88beefaa". +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +BYTES_SPEC_PREFIX_URL

            +
            +public static final String BYTES_SPEC_PREFIX_URL
            +
            +
            Prefix to specify a sequence of bytes as a URL, as in: "URL%20encoded". +

            +

            +
            See Also:
            Constant Field Values
            +
            +
            + +

            +BYTES_SPEC_PREFIX_UTF8

            +
            +public static final String BYTES_SPEC_PREFIX_UTF8
            +
            +
            Optional prefix to specify a sequence of bytes in UTF-8, as in: "utf-8 \x00 encoded". +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +createEntityIdFromUserInputs

            +
            +public static EntityId createEntityIdFromUserInputs(String entityFlag,
+                                                    KijiTableLayout layout)
+                                             throws IOException
            +
            +
            Parses a command-line flag specifying an entity ID. + +
          • HBase row key specifications must be prefixed with "hbase=..." +
          • Kiji row key specifications may be explicitly prefixed with "kiji=..." if + necessary. The prefix is not always necessary. +

            +

            +
            Parameters:
            entityFlag - Command-line flag specifying an entity ID.
            layout - Layout of the table describing the entity ID format. +
            Returns:
            the entity ID as specified in the flags. +
            Throws: +
            IOException - on I/O error.
            +
            +
            • +
            + +

            +parseKijiRowKey

            +
            +public static EntityId parseKijiRowKey(String rowKeySpec,
+                                       EntityIdFactory factory,
+                                       KijiTableLayout layout)
+                                throws IOException
            +
            +
            Parses a Kiji row key specification from a command-line flag. +

            +

            +
            Parameters:
            rowKeySpec - Kiji row key specification.
            factory - Factory for entity IDs.
            layout - Layout of the table to parse the entity ID of. +
            Returns:
            the parsed entity ID. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +parseJsonFormattedKeySpec

            +
            +public static EntityId parseJsonFormattedKeySpec(String json,
+                                                 RowKeyFormat2 format,
+                                                 EntityIdFactory factory)
+                                          throws IOException
            +
            +
            Parses a JSON formatted row key specification. +

            +

            +
            Parameters:
            json - JSON specification of the formatted row key. + Either a JSON ordered array, a JSON map (object), or an immediate JSON primitive.
            format - Row key format specification from the table layout.
            factory - Entity ID factory. +
            Returns:
            the parsed entity ID. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +parseBytesFlag

            +
            +public static byte[] parseBytesFlag(String flag)
+                             throws IOException
            +
            +
            Parses a command-line flag specifying a byte array. + + Valid specifications are: +
          • UTF-8 encoded strings, as in "utf8:encoded \x00 text". +
          • Hexadecimal sequence, with "hex:00dead88beefaa". +
          • URL encoded strings, as in "url:this%20is%20a%20URL". + + UTF-8 is the default, hence the "utf8:" prefix is optional unless there is an ambiguity with + other prefixes. +

            +

            +
            Parameters:
            flag - Command-line flag specification for a byte array. +
            Returns:
            the decoded byte array. +
            Throws: +
            IOException - on I/O error.
            +
            +
            • + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/UninstallTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/UninstallTool.html new file mode 100644 index 00000000..850c0a9f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/UninstallTool.html @@ -0,0 +1,437 @@ + + + + + + + +UninstallTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class UninstallTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.UninstallTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class UninstallTool
            extends BaseTool
            + + +

            +A command-line tool for uninstalling kiji instances from an hbase cluster. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            UninstallTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +UninstallTool

            +
            +public UninstallTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/VersionTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/VersionTool.html new file mode 100644 index 00000000..242a8dd8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/VersionTool.html @@ -0,0 +1,438 @@ + + + + + + + +VersionTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools +
            +Class VersionTool

            +
            +java.lang.Object
+  extended by org.apache.hadoop.conf.Configured
+      extended by org.kiji.schema.tools.BaseTool
+          extended by org.kiji.schema.tools.VersionTool
+
            +
            +
            All Implemented Interfaces:
            Configurable, KijiTool
            +
            +
            +
            +
            @ApiAudience.Private
+public final class VersionTool
            extends BaseTool
            + + +

            +Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance. +

            + +

            +

            + +

            + + + + + + + +
            +Field Summary
            +  + + + + + + + +
            Fields inherited from class org.kiji.schema.tools.BaseTool
            FAILURE, SUCCESS
            +  + + + + + + + + + + +
            +Constructor Summary
            VersionTool() + +
            +           
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + StringgetCategory() + +
            +          
            + StringgetDescription() + +
            +          
            + StringgetName() + +
            +          
            +static voidmain(String[] args) + +
            +          Program entry point.
            +protected  intrun(List<String> nonFlagArgs) + +
            +          Runs the tool.
            +protected  voidsetup() + +
            +          Called to initialize the tool just before running.
            +  + + + + + + + +
            Methods inherited from class org.kiji.schema.tools.BaseTool
            cleanup, getPrintStream, hasVerboseDebug, isInteractive, mayProceed, setPrintStream, toolMain, validateFlags, yesNoPrompt
            +  + + + + + + + +
            Methods inherited from class org.apache.hadoop.conf.Configured
            getConf, setConf
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface org.apache.hadoop.conf.Configurable
            getConf, setConf
            +  +

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

            +VersionTool

            +
            +public VersionTool()
            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getName

            +
            +public String getName()
            +
            +
            +

            +

            + +
            Returns:
            the name of the tool. This name is used by users to run the tool. + For example, to provide the kiji ls tool, this should return "ls".
            +
            +
            +
            + +

            +getDescription

            +
            +public String getDescription()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly description of the tool to print in help text.
            +
            +
            +
            + +

            +getCategory

            +
            +public String getCategory()
            +
            +
            +

            +

            + +
            Returns:
            a short user-friendly category name to which this tool belongs. + + In the future, help text for tools may be arranged by category.
            +
            +
            +
            + +

            +setup

            +
            +protected void setup()
+              throws Exception
            +
            +
            Called to initialize the tool just before running. +

            +

            +
            Overrides:
            setup in class BaseTool
            +
            +
            + +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +run

            +
            +protected int run(List<String> nonFlagArgs)
+           throws Exception
            +
            +
            Runs the tool. +

            +

            +
            Specified by:
            run in class BaseTool
            +
            +
            +
            Parameters:
            nonFlagArgs - The arguments on the command-line that were not parsed as flags. +
            Returns:
            The program exit code. +
            Throws: +
            Exception - If there is an error.
            +
            +
            +
            + +

            +main

            +
            +public static void main(String[] args)
+                 throws Exception
            +
            +
            Program entry point. +

            +

            +
            Parameters:
            args - The command-line arguments. +
            Throws: +
            Exception - If there is an error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/BaseTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/BaseTool.html new file mode 100644 index 00000000..0350552a --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/BaseTool.html @@ -0,0 +1,271 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.BaseTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.BaseTool

            +
            + + + + + + + + + +
            +Packages that use BaseTool
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of BaseTool in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Subclasses of BaseTool in org.kiji.schema.tools
            + classCreateTableTool + +
            +          Command-line tool for creating kiji tables in kiji instances.
            + classDeleteTool + +
            +          Command-line tool to delete Kiji tables, rows, and cells.
            + classFlushTableTool + +
            +          Command-line tool for flushing Kiji meta and user tables in HBase.
            + classIncrementTool + +
            +          Command-line tool to increment a counter in a cell of a kiji table.
            + classInstallTool + +
            +          A command-line tool for installing kiji instances on hbase clusters.
            + classLayoutTool + +
            +          Command-line tool for interacting with table layouts.
            + classLsTool + +
            +          Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            + classMetadataTool + +
            +          A tool to backup and restore Metadata.
            + classPutTool + +
            +          Command-line tool for putting an Avro value into a kiji cell.
            + classSynthesizeUserDataTool + +
            +          Synthesize some user data into a kiji table.
            + classUninstallTool + +
            +          A command-line tool for uninstalling kiji instances from an hbase cluster.
            + classVersionTool + +
            +          Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/CreateTableTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/CreateTableTool.html new file mode 100644 index 00000000..8a7b3597 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/CreateTableTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.CreateTableTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.CreateTableTool

            +
            +No usage of org.kiji.schema.tools.CreateTableTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/DeleteTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/DeleteTool.html new file mode 100644 index 00000000..66ffbdba --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/DeleteTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.DeleteTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.DeleteTool

            +
            +No usage of org.kiji.schema.tools.DeleteTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/FlushTableTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/FlushTableTool.html new file mode 100644 index 00000000..379ff437 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/FlushTableTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.FlushTableTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.FlushTableTool

            +
            +No usage of org.kiji.schema.tools.FlushTableTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/HelpTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/HelpTool.html new file mode 100644 index 00000000..629c4565 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/HelpTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.HelpTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.HelpTool

            +
            +No usage of org.kiji.schema.tools.HelpTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/IncrementTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/IncrementTool.html new file mode 100644 index 00000000..d3f2fd58 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/IncrementTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.IncrementTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.IncrementTool

            +
            +No usage of org.kiji.schema.tools.IncrementTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/InstallTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/InstallTool.html new file mode 100644 index 00000000..c3423995 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/InstallTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.InstallTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.InstallTool

            +
            +No usage of org.kiji.schema.tools.InstallTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/KijiTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/KijiTool.html new file mode 100644 index 00000000..a6a930e7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/KijiTool.html @@ -0,0 +1,304 @@ + + + + + + + +Uses of Interface org.kiji.schema.tools.KijiTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.tools.KijiTool

            +
            + + + + + + + + + +
            +Packages that use KijiTool
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of KijiTool in org.kiji.schema.tools
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.schema.tools that implement KijiTool
            + classBaseTool + +
            +          Base class for all Kiji command line tools.
            + classCreateTableTool + +
            +          Command-line tool for creating kiji tables in kiji instances.
            + classDeleteTool + +
            +          Command-line tool to delete Kiji tables, rows, and cells.
            + classFlushTableTool + +
            +          Command-line tool for flushing Kiji meta and user tables in HBase.
            + classHelpTool + +
            +          Command-line tool for displaying help on available tools.
            + classIncrementTool + +
            +          Command-line tool to increment a counter in a cell of a kiji table.
            + classInstallTool + +
            +          A command-line tool for installing kiji instances on hbase clusters.
            + classLayoutTool + +
            +          Command-line tool for interacting with table layouts.
            + classLsTool + +
            +          Command-line tool to explore kiji table data like the 'ls' command of a unix shell.
            + classMetadataTool + +
            +          A tool to backup and restore Metadata.
            + classPutTool + +
            +          Command-line tool for putting an Avro value into a kiji cell.
            + classSynthesizeUserDataTool + +
            +          Synthesize some user data into a kiji table.
            + classUninstallTool + +
            +          A command-line tool for uninstalling kiji instances from an hbase cluster.
            + classVersionTool + +
            +          Command-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools with parameters of type KijiTool
            + intKijiToolLauncher.run(KijiTool tool, + String[] args) + +
            +          Programmatic entry point to the tool launcher if a tool is already selected.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/KijiToolLauncher.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/KijiToolLauncher.html new file mode 100644 index 00000000..3cf83365 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/KijiToolLauncher.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.KijiToolLauncher (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.KijiToolLauncher

            +
            +No usage of org.kiji.schema.tools.KijiToolLauncher +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/LayoutTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/LayoutTool.html new file mode 100644 index 00000000..2367f4fe --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/LayoutTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.LayoutTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.LayoutTool

            +
            +No usage of org.kiji.schema.tools.LayoutTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/LsTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/LsTool.html new file mode 100644 index 00000000..0eed46b1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/LsTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.LsTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.LsTool

            +
            +No usage of org.kiji.schema.tools.LsTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/MetadataTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/MetadataTool.html new file mode 100644 index 00000000..38f6d366 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/MetadataTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.MetadataTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.MetadataTool

            +
            +No usage of org.kiji.schema.tools.MetadataTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/PutTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/PutTool.html new file mode 100644 index 00000000..0c61833f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/PutTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.PutTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.PutTool

            +
            +No usage of org.kiji.schema.tools.PutTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/RequiredFlagException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/RequiredFlagException.html new file mode 100644 index 00000000..f7d55cdb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/RequiredFlagException.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.RequiredFlagException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.RequiredFlagException

            +
            +No usage of org.kiji.schema.tools.RequiredFlagException +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/SpaceSeparatedMapParser.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/SpaceSeparatedMapParser.html new file mode 100644 index 00000000..2fd7c0b7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/SpaceSeparatedMapParser.html @@ -0,0 +1,182 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.SpaceSeparatedMapParser (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.SpaceSeparatedMapParser

            +
            + + + + + + + + + +
            +Packages that use SpaceSeparatedMapParser
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + +
            +Uses of SpaceSeparatedMapParser in org.kiji.schema.tools
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.tools that return SpaceSeparatedMapParser
            +static SpaceSeparatedMapParserSpaceSeparatedMapParser.create() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html new file mode 100644 index 00000000..20214d7f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/SynthesizeUserDataTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.SynthesizeUserDataTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.SynthesizeUserDataTool

            +
            +No usage of org.kiji.schema.tools.SynthesizeUserDataTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/ToolUtils.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/ToolUtils.html new file mode 100644 index 00000000..3a05d393 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/ToolUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.ToolUtils (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.ToolUtils

            +
            +No usage of org.kiji.schema.tools.ToolUtils +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/UninstallTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/UninstallTool.html new file mode 100644 index 00000000..38204b7c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/UninstallTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.UninstallTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.UninstallTool

            +
            +No usage of org.kiji.schema.tools.UninstallTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/VersionTool.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/VersionTool.html new file mode 100644 index 00000000..ee2aa79b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/class-use/VersionTool.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.VersionTool (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.VersionTool

            +
            +No usage of org.kiji.schema.tools.VersionTool +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-frame.html new file mode 100644 index 00000000..da0bb81f --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-frame.html @@ -0,0 +1,87 @@ + + + + + + + +org.kiji.schema.tools (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema.tools + + + + +
            +Interfaces  + +
            +KijiTool
            + + + + + + +
            +Classes  + +
            +BaseTool +
            +CreateTableTool +
            +DeleteTool +
            +FlushTableTool +
            +HelpTool +
            +IncrementTool +
            +InstallTool +
            +KijiToolLauncher +
            +LayoutTool +
            +LsTool +
            +MetadataTool +
            +PutTool +
            +SpaceSeparatedMapParser +
            +SynthesizeUserDataTool +
            +ToolUtils +
            +UninstallTool +
            +VersionTool
            + + + + + + +
            +Exceptions  + +
            +RequiredFlagException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-summary.html new file mode 100644 index 00000000..2444d479 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-summary.html @@ -0,0 +1,269 @@ + + + + + + + +org.kiji.schema.tools (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.tools +

            +Package containing implementations, abstract base classes, + and exceptions for kiji command-line tools. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            KijiToolBase interface to be implemented by command-line tools that are launched through + the bin/kiji script.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            BaseToolBase class for all Kiji command line tools.
            CreateTableToolCommand-line tool for creating kiji tables in kiji instances.
            DeleteToolCommand-line tool to delete Kiji tables, rows, and cells.
            FlushTableToolCommand-line tool for flushing Kiji meta and user tables in HBase.
            HelpToolCommand-line tool for displaying help on available tools.
            IncrementToolCommand-line tool to increment a counter in a cell of a kiji table.
            InstallToolA command-line tool for installing kiji instances on hbase clusters.
            KijiToolLauncherMain entry point to launch Kiji tools.
            LayoutToolCommand-line tool for interacting with table layouts.
            LsToolCommand-line tool to explore kiji table data like the 'ls' command of a unix shell.
            MetadataToolA tool to backup and restore Metadata.
            PutToolCommand-line tool for putting an Avro value into a kiji cell.
            SpaceSeparatedMapParserParser for space-separated map arguments.
            SynthesizeUserDataToolSynthesize some user data into a kiji table.
            ToolUtilsUtility class providing static methods used by command-line tools.
            UninstallToolA command-line tool for uninstalling kiji instances from an hbase cluster.
            VersionToolCommand-line tool for displaying the kiji software version running and the kiji data version + in use for a specified kiji instance.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            RequiredFlagExceptionThrown to indicate that a flag is required but not supplied.
            +  + +

            +

            +Package org.kiji.schema.tools Description +

            + +

            +Package containing implementations, abstract base classes, + and exceptions for kiji command-line tools. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-tree.html new file mode 100644 index 00000000..110f2ddd --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-tree.html @@ -0,0 +1,173 @@ + + + + + + + +org.kiji.schema.tools Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.tools +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-use.html new file mode 100644 index 00000000..3ef0c0cf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/package-use.html @@ -0,0 +1,185 @@ + + + + + + + +Uses of Package org.kiji.schema.tools (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.tools

            +
            + + + + + + + + + +
            +Packages that use org.kiji.schema.tools
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools. 
            +  +

            + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.tools used by org.kiji.schema.tools
            BaseTool + +
            +          Base class for all Kiji command line tools.
            KijiTool + +
            +          Base interface to be implemented by command-line tools that are launched through + the bin/kiji script.
            SpaceSeparatedMapParser + +
            +          Parser for space-separated map arguments.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/DictionaryLoader.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/DictionaryLoader.html new file mode 100644 index 00000000..6d259ec0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/DictionaryLoader.html @@ -0,0 +1,291 @@ + + + + + + + +DictionaryLoader (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class DictionaryLoader

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.DictionaryLoader
+
            +
            +
            +
            @ApiAudience.Private
+public final class DictionaryLoader
            extends Object
            + + +

            +Loads a dictionary file, which is simply a list of words, one per line. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            DictionaryLoader() + +
            +          Creates a new DictionaryLoader instance.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            + List<String>load(InputStream inputStream) + +
            +          Loads the dictionary from an input stream.
            + List<String>load(String filename) + +
            +          Loads the dictionary from a file.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +DictionaryLoader

            +
            +public DictionaryLoader()
            +
            +
            Creates a new DictionaryLoader instance. +

            +

            + + + + + + + + +
            +Method Detail
            + +

            +load

            +
            +public List<String> load(String filename)
+                  throws IOException
            +
            +
            Loads the dictionary from a file. +

            +

            +
            Parameters:
            filename - The path to a file of words, one per line. +
            Returns:
            The list of words from the file. +
            Throws: +
            IOException - If there is an error reading the words from the file.
            +
            +
            +
            + +

            +load

            +
            +public List<String> load(InputStream inputStream)
+                  throws IOException
            +
            +
            Loads the dictionary from an input stream. +

            +

            +
            Parameters:
            inputStream - The input stream of words, one per line. +
            Returns:
            The list of words from the stream. +
            Throws: +
            IOException - If there is an error reading the words from the stream.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/EmailSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/EmailSynthesizer.html new file mode 100644 index 00000000..7bca2c6b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/EmailSynthesizer.html @@ -0,0 +1,326 @@ + + + + + + + +EmailSynthesizer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class EmailSynthesizer

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.EmailSynthesizer
+
            +
            +
            All Implemented Interfaces:
            Synthesizer<String>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class EmailSynthesizer
            extends Object
            implements Synthesizer<String>
            + + +

            +Synthesizes a random email address. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            EmailSynthesizer(Random random, + List<String> nameDictionary) + +
            +          Creates a new email synthesizer.
            +  + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static StringformatEmail(String username, + String domain) + +
            +          Construct an email address string.
            + Stringsynthesize() + +
            +          Synthesizes a piece of data.
            + StringsynthesizeDomain() + +
            +          Synthesize a random domain using the market share probabilities.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +EmailSynthesizer

            +
            +public EmailSynthesizer(Random random,
+                        List<String> nameDictionary)
            +
            +
            Creates a new email synthesizer. +

            +

            +
            Parameters:
            random - A random number generator.
            nameDictionary - A dictionary of names for the email addresses.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +public String synthesize()
            +
            +
            Description copied from interface: Synthesizer
            +
            Synthesizes a piece of data. +

            +

            +
            Specified by:
            synthesize in interface Synthesizer<String>
            +
            +
            + +
            Returns:
            The synthesized data.
            +
            +
            +
            + +

            +synthesizeDomain

            +
            +public String synthesizeDomain()
            +
            +
            Synthesize a random domain using the market share probabilities. +

            +

            +
            +
            +
            + +
            Returns:
            A synthesized domain string.
            +
            +
            +
            + +

            +formatEmail

            +
            +public static String formatEmail(String username,
+                                 String domain)
            +
            +
            Construct an email address string. +

            +

            +
            +
            +
            +
            Parameters:
            username - The part before the '@' symbol.
            domain - The part after the '@' symbol. +
            Returns:
            An email address (<username>@<domain>).
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/NGramSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/NGramSynthesizer.html new file mode 100644 index 00000000..c51b7600 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/NGramSynthesizer.html @@ -0,0 +1,274 @@ + + + + + + + +NGramSynthesizer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class NGramSynthesizer

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.NGramSynthesizer
+
            +
            +
            All Implemented Interfaces:
            Synthesizer<String>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class NGramSynthesizer
            extends Object
            implements Synthesizer<String>
            + + +

            +Generates n-grams. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            NGramSynthesizer(WordSynthesizer wordSynthesizer, + int n) + +
            +          Constructs a new n-gram synthesizer.
            +  + + + + + + + + + + + +
            +Method Summary
            + Stringsynthesize() + +
            +          Synthesizes a piece of data.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +NGramSynthesizer

            +
            +public NGramSynthesizer(WordSynthesizer wordSynthesizer,
+                        int n)
            +
            +
            Constructs a new n-gram synthesizer. +

            +

            +
            Parameters:
            wordSynthesizer - A synthesizer to generate the words in the n-grams.
            n - The number of words in the n-gram.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +public String synthesize()
            +
            +
            Description copied from interface: Synthesizer
            +
            Synthesizes a piece of data. +

            +

            +
            Specified by:
            synthesize in interface Synthesizer<String>
            +
            +
            + +
            Returns:
            The synthesized data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/Synthesizer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/Synthesizer.html new file mode 100644 index 00000000..35021a4b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/Synthesizer.html @@ -0,0 +1,221 @@ + + + + + + + +Synthesizer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Interface Synthesizer<T>

            +
            +
            Type Parameters:
            T - The type of data to be synthesized.
            +
            +
            All Known Implementing Classes:
            EmailSynthesizer, NGramSynthesizer, WordSynthesizer
            +
            +
            +
            +
            @ApiAudience.Private
+@Inheritance.Sealed
+public interface Synthesizer<T>
            + + +

            +Synthesizers create objects from nothing. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + Tsynthesize() + +
            +          Synthesizes a piece of data.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +T synthesize()
            +
            +
            Synthesizes a piece of data. +

            +

            + +
            Returns:
            The synthesized data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/WordSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/WordSynthesizer.html new file mode 100644 index 00000000..8911ec03 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/WordSynthesizer.html @@ -0,0 +1,273 @@ + + + + + + + +WordSynthesizer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.tools.synth +
            +Class WordSynthesizer

            +
            +java.lang.Object
+  extended by org.kiji.schema.tools.synth.WordSynthesizer
+
            +
            +
            All Implemented Interfaces:
            Synthesizer<String>
            +
            +
            +
            +
            public class WordSynthesizer
            extends Object
            implements Synthesizer<String>
            + + +

            +Synthesizes random words from a dictionary. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            WordSynthesizer(Random random, + List<String> dictionary) + +
            +          Constructs a word synthesizer.
            +  + + + + + + + + + + + +
            +Method Summary
            + Stringsynthesize() + +
            +          Synthesizes a piece of data.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +WordSynthesizer

            +
            +public WordSynthesizer(Random random,
+                       List<String> dictionary)
            +
            +
            Constructs a word synthesizer. +

            +

            +
            Parameters:
            random - A random number generator.
            dictionary - A vocabulary of words to use when synthesizing.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +synthesize

            +
            +public String synthesize()
            +
            +
            Description copied from interface: Synthesizer
            +
            Synthesizes a piece of data. +

            +

            +
            Specified by:
            synthesize in interface Synthesizer<String>
            +
            +
            + +
            Returns:
            The synthesized data.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html new file mode 100644 index 00000000..f106b287 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/DictionaryLoader.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.DictionaryLoader (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.DictionaryLoader

            +
            +No usage of org.kiji.schema.tools.synth.DictionaryLoader +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html new file mode 100644 index 00000000..00d5c256 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/EmailSynthesizer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.EmailSynthesizer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.EmailSynthesizer

            +
            +No usage of org.kiji.schema.tools.synth.EmailSynthesizer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html new file mode 100644 index 00000000..d36f4ab5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/NGramSynthesizer.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.NGramSynthesizer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.NGramSynthesizer

            +
            +No usage of org.kiji.schema.tools.synth.NGramSynthesizer +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/Synthesizer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/Synthesizer.html new file mode 100644 index 00000000..7279d052 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/Synthesizer.html @@ -0,0 +1,197 @@ + + + + + + + +Uses of Interface org.kiji.schema.tools.synth.Synthesizer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.tools.synth.Synthesizer

            +
            + + + + + + + + + +
            +Packages that use Synthesizer
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables. 
            +  +

            + + + + + +
            +Uses of Synthesizer in org.kiji.schema.tools.synth
            +  +

            + + + + + + + + + + + + + + + + + +
            Classes in org.kiji.schema.tools.synth that implement Synthesizer
            + classEmailSynthesizer + +
            +          Synthesizes a random email address.
            + classNGramSynthesizer + +
            +          Generates n-grams.
            + classWordSynthesizer + +
            +          Synthesizes random words from a dictionary.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html new file mode 100644 index 00000000..7d39c753 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/class-use/WordSynthesizer.html @@ -0,0 +1,180 @@ + + + + + + + +Uses of Class org.kiji.schema.tools.synth.WordSynthesizer (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.tools.synth.WordSynthesizer

            +
            + + + + + + + + + +
            +Packages that use WordSynthesizer
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables. 
            +  +

            + + + + + +
            +Uses of WordSynthesizer in org.kiji.schema.tools.synth
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.tools.synth with parameters of type WordSynthesizer
            NGramSynthesizer(WordSynthesizer wordSynthesizer, + int n) + +
            +          Constructs a new n-gram synthesizer.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-frame.html new file mode 100644 index 00000000..3fe5394d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-frame.html @@ -0,0 +1,50 @@ + + + + + + + +org.kiji.schema.tools.synth (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema.tools.synth + + + + +
            +Interfaces  + +
            +Synthesizer
            + + + + + + +
            +Classes  + +
            +DictionaryLoader +
            +EmailSynthesizer +
            +NGramSynthesizer +
            +WordSynthesizer
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-summary.html new file mode 100644 index 00000000..43e18907 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-summary.html @@ -0,0 +1,199 @@ + + + + + + + +org.kiji.schema.tools.synth (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.tools.synth +

            +Classes to assist when synthesizing sample data for use in kiji tables. +

            +See: +
            +          Description +

            + + + + + + + + + +
            +Interface Summary
            Synthesizer<T>Synthesizers create objects from nothing.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            DictionaryLoaderLoads a dictionary file, which is simply a list of words, one per line.
            EmailSynthesizerSynthesizes a random email address.
            NGramSynthesizerGenerates n-grams.
            WordSynthesizerSynthesizes random words from a dictionary.
            +  + +

            +

            +Package org.kiji.schema.tools.synth Description +

            + +

            +Classes to assist when synthesizing sample data for use in kiji tables. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-tree.html new file mode 100644 index 00000000..a353c5be --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-tree.html @@ -0,0 +1,162 @@ + + + + + + + +org.kiji.schema.tools.synth Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.tools.synth +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-use.html new file mode 100644 index 00000000..45e32716 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/tools/synth/package-use.html @@ -0,0 +1,177 @@ + + + + + + + +Uses of Package org.kiji.schema.tools.synth (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.tools.synth

            +
            + + + + + + + + + +
            +Packages that use org.kiji.schema.tools.synth
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables. 
            +  +

            + + + + + + + + + + + +
            +Classes in org.kiji.schema.tools.synth used by org.kiji.schema.tools.synth
            Synthesizer + +
            +          Synthesizers create objects from nothing.
            WordSynthesizer + +
            +          Synthesizes random words from a dictionary.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/AvroUtils.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/AvroUtils.html new file mode 100644 index 00000000..a5bb0982 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/AvroUtils.html @@ -0,0 +1,228 @@ + + + + + + + +AvroUtils (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class AvroUtils

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.AvroUtils
+
            +
            +
            +
            @ApiAudience.Private
+public final class AvroUtils
            extends Object
            + + +

            +General purpose Avro utilities. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static org.apache.avro.SchemagetOptionalType(org.apache.avro.Schema schema) + +
            +          Reports whether the given schema is an optional type (ie.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getOptionalType

            +
            +public static org.apache.avro.Schema getOptionalType(org.apache.avro.Schema schema)
            +
            +
            Reports whether the given schema is an optional type (ie. a union { null, Type }). +

            +

            +
            Parameters:
            schema - The schema to test. +
            Returns:
            the optional type, if the specified schema describes an optional type, null otherwise.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ByteArrayFormatter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ByteArrayFormatter.html new file mode 100644 index 00000000..240a55ca --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ByteArrayFormatter.html @@ -0,0 +1,326 @@ + + + + + + + +ByteArrayFormatter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ByteArrayFormatter

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ByteArrayFormatter
+
            +
            +
            +
            @ApiAudience.Private
+public final class ByteArrayFormatter
            extends Object
            + + +

            +Utility class to format byte arrays. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static byte[]parseHex(String hex) + +
            +          Parses a string hexadecimal representation of a byte array.
            +static byte[]parseHex(String hex, + char separator) + +
            +          Parses a string hexadecimal representation of a byte array with separator.
            +static StringtoHex(byte[] bytes) + +
            +          Formats a byte array as a sequence of hex-digits with no separator.
            +static StringtoHex(byte[] bytes, + char separator) + +
            +          Formats a byte array as a sequence of 2 hex-digits bytes with the specified separator.
            +static StringtoURL(byte[] bytes) + +
            +          Formats a byte array as a URL.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +toHex

            +
            +public static String toHex(byte[] bytes)
            +
            +
            Formats a byte array as a sequence of hex-digits with no separator. +

            +

            +
            Parameters:
            bytes - Byte array to format. +
            Returns:
            the hex string representation of the byte array.
            +
            +
            +
            + +

            +toHex

            +
            +public static String toHex(byte[] bytes,
+                           char separator)
            +
            +
            Formats a byte array as a sequence of 2 hex-digits bytes with the specified separator. +

            +

            +
            Parameters:
            bytes - Byte array to format.
            separator - Separator used between each byte. +
            Returns:
            string the hex representation of the byte array.
            +
            +
            +
            + +

            +toURL

            +
            +public static String toURL(byte[] bytes)
            +
            +
            Formats a byte array as a URL. +

            +

            +
            Parameters:
            bytes - Byte array to format; +
            Returns:
            the URL encoding of the byte array.
            +
            +
            +
            + +

            +parseHex

            +
            +public static byte[] parseHex(String hex,
+                              char separator)
+                       throws IOException
            +
            +
            Parses a string hexadecimal representation of a byte array with separator. +

            +

            +
            Parameters:
            hex - String hexadecimal representation of the byte array to parse.
            separator - Separator used in the string. +
            Returns:
            the parsed byte array. +
            Throws: +
            IOException - on parse error.
            +
            +
            +
            + +

            +parseHex

            +
            +public static byte[] parseHex(String hex)
+                       throws IOException
            +
            +
            Parses a string hexadecimal representation of a byte array. +

            +

            +
            Parameters:
            hex - String hexadecimal representation of the byte array to parse. +
            Returns:
            the parsed byte array. +
            Throws: +
            IOException - on parse error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ByteStreamArray.EncodingException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ByteStreamArray.EncodingException.html new file mode 100644 index 00000000..57afbcd0 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ByteStreamArray.EncodingException.html @@ -0,0 +1,250 @@ + + + + + + + +ByteStreamArray.EncodingException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ByteStreamArray.EncodingException

            +
            +java.lang.Object
+  extended by java.lang.Throwable
+      extended by java.lang.Exception
+          extended by java.io.IOException
+              extended by org.kiji.schema.util.ByteStreamArray.EncodingException
+
            +
            +
            All Implemented Interfaces:
            Serializable
            +
            +
            +
            Enclosing class:
            ByteStreamArray
            +
            +
            +
            +
            @ApiAudience.Private
+public static final class ByteStreamArray.EncodingException
            extends IOException
            + + +

            +Raised when decoding some data fails (eg. a variable-length integer). +

            + +

            +

            +
            See Also:
            Serialized Form
            +
            + +

            + + + + + + + + + + + +
            +Constructor Summary
            ByteStreamArray.EncodingException() + +
            +           
            +  + + + + + + + +
            +Method Summary
            +  + + + + + + + +
            Methods inherited from class java.lang.Throwable
            fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
            +  +

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

            +ByteStreamArray.EncodingException

            +
            +public ByteStreamArray.EncodingException()
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ByteStreamArray.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ByteStreamArray.html new file mode 100644 index 00000000..bdfb49b8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ByteStreamArray.html @@ -0,0 +1,483 @@ + + + + + + + +ByteStreamArray (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ByteStreamArray

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ByteStreamArray
+
            +
            +
            +
            @ApiAudience.Private
+public final class ByteStreamArray
            extends Object
            + + +

            +Wraps a byte array of binary-encoded data into a byte stream. + + Provides various binary decoding functions. + Heavily inspired from protocol buffer's CodedOutputStream and Avro's BinaryDecoder. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Nested Class Summary
            +static classByteStreamArray.EncodingException + +
            +          Raised when decoding some data fails (eg.
            +  + + + + + + + + + + + + + +
            +Constructor Summary
            ByteStreamArray(byte[] bytes) + +
            +          Constructs a new stream of byte.
            ByteStreamArray(byte[] bytes, + int offset) + +
            +          Constructs a new stream of byte.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + byte[]getBytes() + +
            +           
            + intgetOffset() + +
            +           
            +static byte[]longToVarInt64(long number) + +
            +          Serializes a long integer into bytes using the zig-zag variable-length encoding scheme.
            +static byte[]longToZigZagVarInt64(long number) + +
            +          Serializes a long integer into bytes using the zig-zag variable-length encoding scheme.
            + byte[]readBytes(int nbytes) + +
            +          Reads the specified number of bytes in the stream.
            + longreadVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            + longreadZigZagVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            +static intsizeOfLongAsVarInt64(long number) + +
            +          Reports the size of the zig-zag encoding of the specified long integer.
            + voidskip(int nbytes) + +
            +          Skips some bytes.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ByteStreamArray

            +
            +public ByteStreamArray(byte[] bytes,
+                       int offset)
            +
            +
            Constructs a new stream of byte. +

            +

            +
            Parameters:
            bytes - Array of byte to wrap into a stream.
            offset - Offset of the stream head.
            +
            +
            + +

            +ByteStreamArray

            +
            +public ByteStreamArray(byte[] bytes)
            +
            +
            Constructs a new stream of byte. +

            +

            +
            Parameters:
            bytes - Array of byte to wrap into a stream.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +sizeOfLongAsVarInt64

            +
            +public static int sizeOfLongAsVarInt64(long number)
            +
            +
            Reports the size of the zig-zag encoding of the specified long integer. +

            +

            +
            Parameters:
            number - Long integer to encode. +
            Returns:
            Number of bytes required to encode the long using the zig-zag var-int64 encoding. + Between 1 and 10 bytes.
            +
            +
            +
            + +

            +longToVarInt64

            +
            +public static byte[] longToVarInt64(long number)
            +
            +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +

            +

            +
            Parameters:
            number - Long integer to encode. +
            Returns:
            Zig-zag encoded long, as an array of up to 10 bytes.
            +
            +
            +
            + +

            +longToZigZagVarInt64

            +
            +public static byte[] longToZigZagVarInt64(long number)
            +
            +
            Serializes a long integer into bytes using the zig-zag variable-length encoding scheme. +

            +

            +
            Parameters:
            number - Long integer to encode. +
            Returns:
            Zig-zag encoded long, as an array of up to 10 bytes.
            +
            +
            +
            + +

            +readVarInt64

            +
            +public long readVarInt64()
+                  throws ByteStreamArray.EncodingException
            +
            +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +

            +

            + +
            Returns:
            the read integer as a long. +
            Throws: +
            ByteStreamArray.EncodingException - on decoding error.
            +
            +
            +
            + +

            +readZigZagVarInt64

            +
            +public long readZigZagVarInt64()
+                        throws ByteStreamArray.EncodingException
            +
            +
            Reads a variable-length zig-zag encoded signed integer up to 64 bits. +

            +

            + +
            Returns:
            the read integer as a long. +
            Throws: +
            ByteStreamArray.EncodingException - on decoding error.
            +
            +
            +
            + +

            +skip

            +
            +public void skip(int nbytes)
            +
            +
            Skips some bytes. +

            +

            +
            Parameters:
            nbytes - Number of bytes to skip.
            +
            +
            +
            + +

            +readBytes

            +
            +public byte[] readBytes(int nbytes)
            +
            +
            Reads the specified number of bytes in the stream. +

            +

            +
            Parameters:
            nbytes - Number of bytes to read. +
            Returns:
            Bytes read.
            +
            +
            +
            + +

            +getBytes

            +
            +public byte[] getBytes()
            +
            +
            + +
            Returns:
            a copy of the wrapped byte array.
            +
            +
            +
            + +

            +getOffset

            +
            +public int getOffset()
            +
            +
            + +
            Returns:
            the current offset in the wrapped byte array.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/BytesKey.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/BytesKey.html new file mode 100644 index 00000000..4295a7c6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/BytesKey.html @@ -0,0 +1,330 @@ + + + + + + + +BytesKey (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class BytesKey

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.BytesKey
+
            +
            +
            +
            @ApiAudience.Framework
+public final class BytesKey
            extends Object
            + + +

            +Wraps an array of bytes into an object that can be used as key in a hash map. + The wrapper assumes the byte array is immutable (ie. does not copy the byte array). +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            BytesKey(byte[] bytes) + +
            +          Wraps the given byte array.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + booleanequals(Object other) + +
            +           
            + byte[]getBytes() + +
            +           
            + inthashCode() + +
            +           
            + StringtoString() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

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

            +BytesKey

            +
            +public BytesKey(byte[] bytes)
            +
            +
            Wraps the given byte array. +

            +

            +
            Parameters:
            bytes - Byte array to wrap.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getBytes

            +
            +public byte[] getBytes()
            +
            +
            + +
            Returns:
            The byte array.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Clock.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Clock.html new file mode 100644 index 00000000..d16b0cab --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Clock.html @@ -0,0 +1,249 @@ + + + + + + + +Clock (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Clock

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Clock
+
            +
            +
            +
            @ApiAudience.Public
+@Inheritance.Sealed
+public abstract class Clock
            extends Object
            + + +

            +An interface for a wall clock. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static ClockgetDefaultClock() + +
            +           
            +abstract  longgetTime() + +
            +          Gets the current time.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getTime

            +
            +public abstract long getTime()
            +
            +
            Gets the current time. +

            +

            + +
            Returns:
            The current time.
            +
            +
            +
            + +

            +getDefaultClock

            +
            +public static Clock getDefaultClock()
            +
            +
            + +
            Returns:
            a default clock instance that uses the system clock.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Debug.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Debug.html new file mode 100644 index 00000000..8a87237d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Debug.html @@ -0,0 +1,226 @@ + + + + + + + +Debug (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Debug

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Debug
+
            +
            +
            +
            @ApiAudience.Private
+public final class Debug
            extends Object
            + + +

            +Debugging utilities. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            +static StringgetStackTrace() + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +getStackTrace

            +
            +public static String getStackTrace()
            +
            +
            + +
            Returns:
            a string representation of the current stack trace.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/FromJson.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/FromJson.html new file mode 100644 index 00000000..65516b55 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/FromJson.html @@ -0,0 +1,289 @@ + + + + + + + +FromJson (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class FromJson

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.FromJson
+
            +
            +
            +
            @ApiAudience.Private
+public final class FromJson
            extends Object
            + + +

            +Decode a JSON string into an Avro record. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static ObjectfromAvroJsonString(String json, + org.apache.avro.Schema schema) + +
            +          Standard Avro JSON decoder.
            +static ObjectfromJsonNode(org.codehaus.jackson.JsonNode json, + org.apache.avro.Schema schema) + +
            +          Decodes a JSON node as an Avro value.
            +static ObjectfromJsonString(String json, + org.apache.avro.Schema schema) + +
            +          Decodes a JSON encoded record.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +fromJsonNode

            +
            +public static Object fromJsonNode(org.codehaus.jackson.JsonNode json,
+                                  org.apache.avro.Schema schema)
+                           throws IOException
            +
            +
            Decodes a JSON node as an Avro value. + + Comply with specified default values when decoding records with missing fields. +

            +

            +
            Parameters:
            json - JSON node to decode.
            schema - Avro schema of the value to decode. +
            Returns:
            the decoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +fromJsonString

            +
            +public static Object fromJsonString(String json,
+                                    org.apache.avro.Schema schema)
+                             throws IOException
            +
            +
            Decodes a JSON encoded record. +

            +

            +
            Parameters:
            json - JSON tree to decode, encoded as a string.
            schema - Avro schema of the value to decode. +
            Returns:
            the decoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +fromAvroJsonString

            +
            +public static Object fromAvroJsonString(String json,
+                                        org.apache.avro.Schema schema)
+                                 throws IOException
            +
            +
            Standard Avro JSON decoder. +

            +

            +
            Parameters:
            json - JSON string to decode.
            schema - Schema of the value to decode. +
            Returns:
            the decoded value. +
            Throws: +
            IOException - on error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Hasher.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Hasher.html new file mode 100644 index 00000000..0dd91bb2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Hasher.html @@ -0,0 +1,288 @@ + + + + + + + +Hasher (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Hasher

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Hasher
+
            +
            +
            +
            @ApiAudience.Private
+public final class Hasher
            extends Object
            + + +

            +A thread-safe utility for computing hashes of strings. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static intHASH_SIZE_BYTES + +
            +          The number of bytes in a hash.
            +  + + + + + + + + + + + + + + + +
            +Method Summary
            +static byte[]hash(byte[] input) + +
            +          Hashes the input byte array.
            +static byte[]hash(String input) + +
            +          Hashes the input string.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +HASH_SIZE_BYTES

            +
            +public static final int HASH_SIZE_BYTES
            +
            +
            The number of bytes in a hash. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +hash

            +
            +public static byte[] hash(String input)
            +
            +
            Hashes the input string. +

            +

            +
            Parameters:
            input - The string to hash. +
            Returns:
            The 128-bit MD5 hash of the input.
            +
            +
            +
            + +

            +hash

            +
            +public static byte[] hash(byte[] input)
            +
            +
            Hashes the input byte array. +

            +

            +
            Parameters:
            input - The bytes to hash. +
            Returns:
            The 128-bit MD5 hash of the input.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/JavaIdentifiers.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/JavaIdentifiers.html new file mode 100644 index 00000000..c61b28be --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/JavaIdentifiers.html @@ -0,0 +1,260 @@ + + + + + + + +JavaIdentifiers (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class JavaIdentifiers

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.JavaIdentifiers
+
            +
            +
            +
            @ApiAudience.Private
+public final class JavaIdentifiers
            extends Object
            + + +

            +A utility class for dealing with identifiers in the Java language. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static booleanisValidClassName(String className) + +
            +          Determines whether a string could be the name of a Java class.
            +static booleanisValidIdentifier(String identifier) + +
            +          Determines whether a string is a valid Java identifier.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +isValidIdentifier

            +
            +public static boolean isValidIdentifier(String identifier)
            +
            +
            Determines whether a string is a valid Java identifier. + +

            A valid Java identifier may not start with a number, but may contain any + combination of letters, digits, underscores, or dollar signs.

            + +

            See the + Java Language Specification

            +

            +

            +
            Parameters:
            identifier - The identifier to test for validity. +
            Returns:
            Whether the identifier was valid.
            +
            +
            +
            + +

            +isValidClassName

            +
            +public static boolean isValidClassName(String className)
            +
            +
            Determines whether a string could be the name of a Java class. + +

            If this method returns true, it does not necessarily mean that the Java class with + className exists; it only means that one could write a Java class with + that fully-qualified name.

            +

            +

            +
            Parameters:
            className - A string to test. +
            Returns:
            Whether the class name was valid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/KijiNameValidator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/KijiNameValidator.html new file mode 100644 index 00000000..4bf874a6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/KijiNameValidator.html @@ -0,0 +1,424 @@ + + + + + + + +KijiNameValidator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class KijiNameValidator

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.KijiNameValidator
+
            +
            +
            +
            @ApiAudience.Private
+public final class KijiNameValidator
            extends Object
            + + +

            +A utility class for validating layout names, + (including table names, locality group names, family names, and column names) + and Kiji instance names. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + +
            +Field Summary
            +static PatternVALID_ALIAS_PATTERN + +
            +          Regular expression that defines a valid alias for a layout name.
            +static PatternVALID_INSTANCE_PATTERN + +
            +          Regular expression that defines a valid instance name.
            +static PatternVALID_LAYOUT_NAME_PATTERN + +
            +          Regular expression that defines a valid layout name (family, qualifier, table, etc).
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static booleanisValidAlias(CharSequence name) + +
            +           
            +static booleanisValidKijiName(CharSequence name) + +
            +           
            +static booleanisValidLayoutName(CharSequence name) + +
            +           
            +static voidvalidateAlias(CharSequence name) + +
            +          Validates characters that may be used in an alias for a qualifier, family, or + locality group.
            +static voidvalidateKijiName(CharSequence name) + +
            +          Determines whether a string is a valid Kiji instance name.
            +static voidvalidateLayoutName(CharSequence name) + +
            +          Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +VALID_INSTANCE_PATTERN

            +
            +public static final Pattern VALID_INSTANCE_PATTERN
            +
            +
            Regular expression that defines a valid instance name. +

            +

            +
            +
            +
            + +

            +VALID_LAYOUT_NAME_PATTERN

            +
            +public static final Pattern VALID_LAYOUT_NAME_PATTERN
            +
            +
            Regular expression that defines a valid layout name (family, qualifier, table, etc). +

            +

            +
            +
            +
            + +

            +VALID_ALIAS_PATTERN

            +
            +public static final Pattern VALID_ALIAS_PATTERN
            +
            +
            Regular expression that defines a valid alias for a layout name. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +isValidLayoutName

            +
            +public static boolean isValidLayoutName(CharSequence name)
            +
            +
            +
            Parameters:
            name - the name to check. +
            Returns:
            true if name is a valid name for a table, locality group, family, + or column name, and false otherwise.
            +
            +
            +
            + +

            +validateLayoutName

            +
            +public static void validateLayoutName(CharSequence name)
+                               throws KijiInvalidNameException
            +
            +
            Determines whether a string is a valid layout name, + including table names, locality group names, family names, and column names. +

            +

            +
            Parameters:
            name - The string to validate as a layout name. +
            Throws: +
            KijiInvalidNameException - If the name is invalid.
            +
            +
            +
            + +

            +isValidAlias

            +
            +public static boolean isValidAlias(CharSequence name)
            +
            +
            +
            Parameters:
            name - the name to check. +
            Returns:
            true if name is a valid alias for a table, locality group, family, + or column name, and false otherwise.
            +
            +
            +
            + +

            +validateAlias

            +
            +public static void validateAlias(CharSequence name)
+                          throws KijiInvalidNameException
            +
            +
            Validates characters that may be used in an alias for a qualifier, family, or + locality group. This is a superset of valid characters for a layout name. +

            +

            +
            Parameters:
            name - The string to validate as a layout name alias. +
            Throws: +
            KijiInvalidNameException - If the name is invalid.
            +
            +
            +
            + +

            +isValidKijiName

            +
            +public static boolean isValidKijiName(CharSequence name)
            +
            +
            +
            Parameters:
            name - the name to check. +
            Returns:
            true if name is a valid name for a Kiji instance and false otherwise.
            +
            +
            +
            + +

            +validateKijiName

            +
            +public static void validateKijiName(CharSequence name)
+                             throws KijiInvalidNameException
            +
            +
            Determines whether a string is a valid Kiji instance name. +

            +

            +
            Parameters:
            name - The string to validate as a Kiji instance name. +
            Throws: +
            KijiInvalidNameException - If the name is invalid.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Lock.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Lock.html new file mode 100644 index 00000000..ab80ad59 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Lock.html @@ -0,0 +1,291 @@ + + + + + + + +Lock (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Interface Lock

            +
            +
            All Superinterfaces:
            Closeable
            +
            +
            +
            All Known Implementing Classes:
            ZooKeeperLock
            +
            +
            +
            +
            @ApiAudience.Private
+@Inheritance.Sealed
+public interface Lock
            extends Closeable
            + + +

            +Lock interface. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidlock() + +
            +          Unconditionally acquires the lock.
            + booleanlock(double timeout) + +
            +          Acquires the lock.
            + voidunlock() + +
            +          Releases the lock.
            +  + + + + + + + +
            Methods inherited from interface java.io.Closeable
            close
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +lock

            +
            +void lock()
+          throws IOException
            +
            +
            Unconditionally acquires the lock. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +lock

            +
            +boolean lock(double timeout)
+             throws IOException
            +
            +
            Acquires the lock. +

            +

            +
            +
            +
            +
            Parameters:
            timeout - Deadline, in seconds, to acquire the lock. 0 means no timeout. +
            Returns:
            whether the lock is acquired (ie. false means timeout). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +unlock

            +
            +void unlock()
+            throws IOException
            +
            +
            Releases the lock. +

            +

            +
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/LockFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/LockFactory.html new file mode 100644 index 00000000..ef1bc55c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/LockFactory.html @@ -0,0 +1,222 @@ + + + + + + + +LockFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Interface LockFactory

            +
            +
            All Known Implementing Classes:
            ZooKeeperLockFactory
            +
            +
            +
            +
            @ApiAudience.Private
+@Inheritance.Sealed
+public interface LockFactory
            + + +

            +Factory for Lock instances. +

            + +

            +

            + +

            + + + + + + + + + + + + +
            +Method Summary
            + Lockcreate(String name) + +
            +          Creates a new lock with the specified name.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +create

            +
            +Lock create(String name)
+            throws IOException
            +
            +
            Creates a new lock with the specified name. +

            +

            +
            Parameters:
            name - Lock name (eg. a ZooKeeper node path). +
            Returns:
            the lock with the specified name. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ProtocolVersion.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ProtocolVersion.html new file mode 100644 index 00000000..c58a6ddf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ProtocolVersion.html @@ -0,0 +1,544 @@ + + + + + + + +ProtocolVersion (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ProtocolVersion

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ProtocolVersion
+
            +
            +
            All Implemented Interfaces:
            Comparable<ProtocolVersion>
            +
            +
            +
            +
            @ApiAudience.Framework
+public final class ProtocolVersion
            extends Object
            implements Comparable<ProtocolVersion>
            + + +

            +Parses version information for a file format or wire protocol and provides + comparison / reporting functions. + +

            + This class facilitates the parsing of strings of the form "protocol-x.y.z", + where protocol is a string representing some namespace or qualifier + (i.e., a file format name, like "kiji" in the string "kiji-1.1" representing + a table layout JSON file), and x, y and z are + integers. protocol, y and z are optional. +

            + +

            You can parse a string into a ProtocolVersion using the static parse(java.lang.String) + method. Its javadoc specifies further what strings constitute valid ProtocolVersions.

            + +

            Version numbers are compared numerically starting at the major version number + and moving to the right; each field is treated as a separate integer, not a + decimal value. If minor or revision numbers are omitted, they are treated as zero.

            + +

            The compareTo(ProtocolVersion) function treats identical version numbers + with different protocol names as different; foo-1.0 and + bar-1.0 are not the same version number. ProtocolVersion instances will be + sorted first by protocol name (alphabetically), then by version number.

            + +

            The compareTo(ProtocolVersion), hashCode(), and equals(Object) methods will regard versions omitting trailing .0's as + equal. For example, foo-1, foo-1.0, and + foo-1.0.0 are all equal. The toString() method will return the + exact string that was parsed; so equal objects may have unequal toString() + representations. Use toCanonicalString() to get the same string representation + out of each.

            + +

            ProtocolVersion instances are immutable.

            +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + intcompareTo(ProtocolVersion other) + +
            +          
            + booleanequals(Object other) + +
            +          
            + intgetMajorVersion() + +
            +          Returns the major version (first digit) in this version.
            + intgetMinorVersion() + +
            +          Returns the minor version (second digit) in this version.
            + StringgetProtocolName() + +
            +          Returns the protocol name associated with this version string.
            + intgetRevision() + +
            +          Returns the revision version (third digit) in this version.
            + inthashCode() + +
            +          
            +static ProtocolVersionparse(String verString) + +
            +          Static factory method that creates new ProtocolVersion instances.
            + StringtoCanonicalString() + +
            +          Returns a string representation of this ProtocolVersion that includes any + optional trailing version components.
            + StringtoString() + +
            +          Returns the string representation of this ProtocolVersion that was initially + parsed to create this ProtocolVersion.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, finalize, getClass, notify, notifyAll, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +parse

            +
            +public static ProtocolVersion parse(String verString)
            +
            +
            Static factory method that creates new ProtocolVersion instances. + +

            This method parses its argument as a string of the form: + protocol-maj.min.rev. All fields except the major digit are optional. + maj, min, and rev must be non-negative integers. protocol is a string; the trailing + dash character is not part of the protocol name. The protocol name may not include + a '-' character and must not start with a digit. + If the protocol name is not specified, then the dash must be omitted.

            + +

            The following are examples of legal protocol versions:

            +
              +
            • "data-1.0"
              • +
            • "kiji-1.2.3"
              • +
            • "1.3.1"
              • +
            • "76"
              • +
            • "2.3"
              • +
            • "spec-1"
              • +
            + +

            The following are illegal:

            +
              +
            • "foo" (no version number)
              • +
            • "foo1.2" (no dash after the protocol name)
              • +
            • "-foo-1.2" (protocol may not start with a dash)
              • +
            • "1.2.3.4" (only 3-component version numbers are supported)
              • +
            • "bar-1.2.3.4" (only 3-component version numbers are supported)
              • +
            • "-1.2.3" (version numbers may not be negative)
              • +
            • "1.-2" (version numbers may not be negative)
              • +
            • "1.x" (version numbers must be integers)
              • +
            • "foo-1.x" (version numbers must be integers)
              • +
            • "2foo-1.3" (protocol names may not start with a digit)
              • +
            • "foo-bar-1.x" (protocol names may not contain a dash)
              • +
            • "" (the empty string is not allowed as a version)
              • +
            • null
              • +
            +

            +

            +
            +
            +
            +
            Parameters:
            verString - the version string to parse. +
            Returns:
            a new, parsed ProtocolVersion instance. +
            Throws: +
            IllegalArgumentException - if the version string cannot be parsed according + to the rules above.
            +
            +
            +
            + +

            +getProtocolName

            +
            +public String getProtocolName()
            +
            +
            Returns the protocol name associated with this version string. If + the entire version string is datafmt-1.2.3, then this will + return "datafmt". +

            +

            +
            +
            +
            + +
            Returns:
            a string representing the protocol name; may be null if no + protocol name was specified when constructing this instance.
            +
            +
            +
            + +

            +getMajorVersion

            +
            +public int getMajorVersion()
            +
            +
            Returns the major version (first digit) in this version. If + the entire version string is datafmt-1.2.3, then this will + return 1. +

            +

            +
            +
            +
            + +
            Returns:
            an integer representing the major version number.
            +
            +
            +
            + +

            +getMinorVersion

            +
            +public int getMinorVersion()
            +
            +
            Returns the minor version (second digit) in this version. If + the entire version string is datafmt-1.2.3, then this will + return 2. If the entire version string is datafmt-1, + then this will return 0. +

            +

            +
            +
            +
            + +
            Returns:
            an integer representing the minor version number. This number + will be zero if no minor version was specified during construction.
            +
            +
            +
            + +

            +getRevision

            +
            +public int getRevision()
            +
            +
            Returns the revision version (third digit) in this version. If + the entire version string is datafmt-1.2.3, then this will + return 3. If the entire version string is datafmt-1 + or datafmt-1.2, then this will return 0. +

            +

            +
            +
            +
            + +
            Returns:
            an integer representing the revision number. This number + will be zero if no revision was specified during construction.
            +
            +
            +
            + +

            +equals

            +
            +public boolean equals(Object other)
            +
            +
            +

            +

            +
            Overrides:
            equals in class Object
            +
            +
            +
            +
            +
            +
            + +

            +hashCode

            +
            +public int hashCode()
            +
            +
            +

            +

            +
            Overrides:
            hashCode in class Object
            +
            +
            +
            +
            +
            +
            + +

            +compareTo

            +
            +public int compareTo(ProtocolVersion other)
            +
            +
            +

            +

            +
            Specified by:
            compareTo in interface Comparable<ProtocolVersion>
            +
            +
            +
            +
            +
            +
            + +

            +toString

            +
            +public String toString()
            +
            +
            Returns the string representation of this ProtocolVersion that was initially + parsed to create this ProtocolVersion. Use toCanonicalString() to get + a string representation that preserves the equals() relationship. + + +

            +

            +
            Overrides:
            toString in class Object
            +
            +
            +
            +
            +
            +
            + +

            +toCanonicalString

            +
            +public String toCanonicalString()
            +
            +
            Returns a string representation of this ProtocolVersion that includes any + optional trailing version components. For example "foo-1.0" and "foo-1" + would both have canonical representations of "foo-1.0.0". ProtocolVersions + for which equals() returns true will have equal canonical string representations. +

            +

            +
            +
            +
            + +
            Returns:
            the canonical string representation of this ProtocolVersion.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ReferenceCountable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ReferenceCountable.html new file mode 100644 index 00000000..0f96643e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ReferenceCountable.html @@ -0,0 +1,250 @@ + + + + + + + +ReferenceCountable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Interface ReferenceCountable<T>

            +
            +
            Type Parameters:
            T - Type of the resource.
            +
            +
            All Known Subinterfaces:
            Kiji
            +
            +
            +
            All Known Implementing Classes:
            HBaseKiji
            +
            +
            +
            +
            public interface ReferenceCountable<T>
            + + +

            +Interface for reference-countable resources. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidrelease() + +
            +          Notifies this resource that we are no longer interested in it.
            + Tretain() + +
            +          Expresses interest in retaining this resource.
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +retain

            +
            +T retain()
            +
            +
            Expresses interest in retaining this resource. + + The resource will not be disposed until a call to release() happens +

            +

            + +
            Returns:
            the retained resource.
            +
            +
            +
            + +

            +release

            +
            +void release()
+             throws IOException
            +
            +
            Notifies this resource that we are no longer interested in it. + + This resource may be disposed if no other entity has expressed interest in using it. +

            +

            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ResourceUtils.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ResourceUtils.html new file mode 100644 index 00000000..7431b95e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ResourceUtils.html @@ -0,0 +1,254 @@ + + + + + + + +ResourceUtils (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ResourceUtils

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ResourceUtils
+
            +
            +
            +
            public final class ResourceUtils
            extends Object
            + + +

            +Utilities to work with ReferenceCountable resources. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static voidcloseOrLog(Closeable resource) + +
            +          Closes the specified resource, logging and swallowing I/O errors if needed.
            +static + + + + +
            +<T> void
            +            		releaseOrLog(ReferenceCountable<T> resource) + +
            +          Releases the specified resource, logging and swallowing I/O errors if needed.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +closeOrLog

            +
            +public static void closeOrLog(Closeable resource)
            +
            +
            Closes the specified resource, logging and swallowing I/O errors if needed. +

            +

            +
            Parameters:
            resource - Close this resource.
            +
            +
            +
            + +

            +releaseOrLog

            +
            +public static <T> void releaseOrLog(ReferenceCountable<T> resource)
            +
            +
            Releases the specified resource, logging and swallowing I/O errors if needed. +

            +

            +
            Type Parameters:
            T - Type of the resource to release.
            Parameters:
            resource - Release this resource.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Resources.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Resources.html new file mode 100644 index 00000000..e8246bc8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/Resources.html @@ -0,0 +1,252 @@ + + + + + + + +Resources (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class Resources

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.Resources
+
            +
            +
            +
            @ApiAudience.Private
+public final class Resources
            extends Object
            + + +

            +Utility for getting access to system resources. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static InputStreamopenSystemResource(String resourceFileName) + +
            +          Gets the named resource using the classloader, or null if it can not be found.
            +static BufferedReaderopenSystemTextResource(String resourceFileName) + +
            +          Gets the named resource using the classloader, or null if it can not be found.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +openSystemResource

            +
            +public static InputStream openSystemResource(String resourceFileName)
            +
            +
            Gets the named resource using the classloader, or null if it can not be found. + Clients should close streams returned by this method. +

            +

            +
            Parameters:
            resourceFileName - The resource to load from the classpath. +
            Returns:
            The loaded resource as an InputStream. If not found, returns null.
            +
            +
            +
            + +

            +openSystemTextResource

            +
            +public static BufferedReader openSystemTextResource(String resourceFileName)
            +
            +
            Gets the named resource using the classloader, or null if it can not be found. + Clients should close streams returned by this method. +

            +

            +
            Parameters:
            resourceFileName - The resource to load from the classpath. +
            Returns:
            The loaded resource as a BufferedReader. If not found, returns null.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/SplitKeyFile.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/SplitKeyFile.html new file mode 100644 index 00000000..79de0400 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/SplitKeyFile.html @@ -0,0 +1,267 @@ + + + + + + + +SplitKeyFile (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class SplitKeyFile

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.SplitKeyFile
+
            +
            +
            +
            @ApiAudience.Private
+public final class SplitKeyFile
            extends Object
            + + +

            +Parses region boundaries split files. + +

          • The file contains one row key per line. +
          • Row keys are encoded in ASCII. +
          • Non printable characters must be escaped in hexadecimal "\x??". +
          • Backslash must be escaped (doubled) "\\" + +

            + If a file contains N split keys, N+1 regions will be created, since the first region will contain + everything before the first split key, and the last region will contain everything after the last + split key. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + +
            +Method Summary
            +static List<byte[]>decodeRegionSplitList(InputStream inputStream) + +
            +          Constructs a split key file from an input stream.
            +static byte[]decodeRowKey(String encoded) + +
            +          Decodes a string encoded row key.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +decodeRegionSplitList

            +
            +public static List<byte[]> decodeRegionSplitList(InputStream inputStream)
+                                          throws IOException
            +
            +
            Constructs a split key file from an input stream. This object will take ownership of + the inputStream, which you should clean up by calling close(). +

            +

            +
            Parameters:
            inputStream - The file contents. +
            Returns:
            the region boundaries, as a list of row keys. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +decodeRowKey

            +
            +public static byte[] decodeRowKey(String encoded)
+                           throws IOException
            +
            +
            Decodes a string encoded row key. +

            +

            +
            Parameters:
            encoded - Encoded row key. +
            Returns:
            the row key, as a byte array. +
            Throws: +
            IOException - on I/O error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/TimestampComparator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/TimestampComparator.html new file mode 100644 index 00000000..33dad53d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/TimestampComparator.html @@ -0,0 +1,280 @@ + + + + + + + +TimestampComparator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class TimestampComparator

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.TimestampComparator
+
            +
            +
            All Implemented Interfaces:
            Comparator<Long>
            +
            +
            +
            +
            @ApiAudience.Private
+public final class TimestampComparator
            extends Object
            implements Comparator<Long>
            + + +

            +A comparator that sorts Longs in reverse chronological order. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static TimestampComparatorINSTANCE + +
            +          A singleton instance.
            +  + + + + + + + + + + + +
            +Method Summary
            + intcompare(Long left, + Long right) + +
            +           
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  + + + + + + + +
            Methods inherited from interface java.util.Comparator
            equals
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +INSTANCE

            +
            +public static final TimestampComparator INSTANCE
            +
            +
            A singleton instance. +

            +

            +
            +
            + + + + + + + + +
            +Method Detail
            + +

            +compare

            +
            +public int compare(Long left,
+                   Long right)
            +
            +
            +
            Specified by:
            compare in interface Comparator<Long>
            +
            +
            +
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ToJson.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ToJson.html new file mode 100644 index 00000000..9b084c85 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ToJson.html @@ -0,0 +1,341 @@ + + + + + + + +ToJson (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ToJson

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ToJson
+
            +
            +
            +
            @ApiAudience.Private
+public final class ToJson
            extends Object
            + + +

            +Encode an Avro record into JSON. +

            + +

            +

            + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static StringtoAvroJsonString(org.apache.avro.generic.IndexedRecord record) + +
            +          Standard Avro/JSON encoder.
            +static StringtoAvroJsonString(Object value, + org.apache.avro.Schema schema) + +
            +          Standard Avro/JSON encoder.
            +static org.codehaus.jackson.JsonNodetoJsonNode(Object value, + org.apache.avro.Schema schema) + +
            +          Serializes a Java Avro value into JSON.
            +static StringtoJsonString(org.apache.avro.generic.IndexedRecord record) + +
            +          Encodes an Avro record into JSON.
            +static StringtoJsonString(Object value, + org.apache.avro.Schema schema) + +
            +          Encodes an Avro value into a JSON string.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Method Detail
            + +

            +toJsonNode

            +
            +public static org.codehaus.jackson.JsonNode toJsonNode(Object value,
+                                                       org.apache.avro.Schema schema)
+                                                throws IOException
            +
            +
            Serializes a Java Avro value into JSON. + + When serializing records, fields whose value matches the fields' default value are omitted. +

            +

            +
            Parameters:
            value - the Java value to serialize.
            schema - Avro schema of the value to serialize. +
            Returns:
            the value encoded as a JSON tree. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toJsonString

            +
            +public static String toJsonString(Object value,
+                                  org.apache.avro.Schema schema)
+                           throws IOException
            +
            +
            Encodes an Avro value into a JSON string. + + Fields with default values are omitted. +

            +

            +
            Parameters:
            value - Avro value to encode.
            schema - Avro schema of the value. +
            Returns:
            Pretty string representation of the JSON-encoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toJsonString

            +
            +public static String toJsonString(org.apache.avro.generic.IndexedRecord record)
+                           throws IOException
            +
            +
            Encodes an Avro record into JSON. +

            +

            +
            Parameters:
            record - Avro record to encode. +
            Returns:
            Pretty JSON representation of the record. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toAvroJsonString

            +
            +public static String toAvroJsonString(Object value,
+                                      org.apache.avro.Schema schema)
+                               throws IOException
            +
            +
            Standard Avro/JSON encoder. +

            +

            +
            Parameters:
            value - Avro value to encode.
            schema - Avro schema of the value. +
            Returns:
            JSON-encoded value. +
            Throws: +
            IOException - on error.
            +
            +
            +
            + +

            +toAvroJsonString

            +
            +public static String toAvroJsonString(org.apache.avro.generic.IndexedRecord record)
+                               throws IOException
            +
            +
            Standard Avro/JSON encoder. +

            +

            +
            Parameters:
            record - Avro record to encode. +
            Returns:
            JSON-encoded value. +
            Throws: +
            IOException - on error.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/VersionInfo.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/VersionInfo.html new file mode 100644 index 00000000..ed22d093 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/VersionInfo.html @@ -0,0 +1,391 @@ + + + + + + + +VersionInfo (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class VersionInfo

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.VersionInfo
+
            +
            +
            +
            @ApiAudience.Public
+public final class VersionInfo
            extends Object
            + + +

            +Reports on the version numbers associated with this software bundle + as well as the installed format versions in used in a Kiji instance. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Field Summary
            +static StringDEFAULT_DEVELOPMENT_VERSION + +
            +          Fallback software version ID, in case the properties file is not generated/reachable.
            +  + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            +static ProtocolVersiongetClientDataVersion() + +
            +          Gets the version of the Kiji instance format assumed by the client.
            +static ProtocolVersiongetClusterDataVersion(Kiji kiji) + +
            +          Gets the version of the Kiji instance format installed on the HBase cluster.
            +static StringgetSoftwareVersion() + +
            +          Gets the version of the Kiji client software.
            +static booleanisKijiVersionCompatible(Kiji kiji) + +
            +          Validates that the client instance format version is compatible with the instance + format version installed on a Kiji instance.
            +static voidvalidateVersion(Kiji kiji) + +
            +          Validates that the client instance format version is compatible with the instance + format version installed on a Kiji instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

            + + + + + + + + +
            +Field Detail
            + +

            +DEFAULT_DEVELOPMENT_VERSION

            +
            +public static final String DEFAULT_DEVELOPMENT_VERSION
            +
            +
            Fallback software version ID, in case the properties file is not generated/reachable. +

            +

            +
            See Also:
            Constant Field Values
            +
            + + + + + + + + +
            +Method Detail
            + +

            +getSoftwareVersion

            +
            +public static String getSoftwareVersion()
+                                 throws IOException
            +
            +
            Gets the version of the Kiji client software. +

            +

            + +
            Returns:
            The version string. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +getClientDataVersion

            +
            +public static ProtocolVersion getClientDataVersion()
            +
            +
            Gets the version of the Kiji instance format assumed by the client. + +

            The instance format describes the layout of the global metadata state of + a Kiji instance. This version number specifies which Kiji instances it would + be compatible with. See isKijiVersionCompatible(org.kiji.schema.Kiji) to determine whether + a deployment is compatible with this version. +

            +

            + +
            Returns:
            A parsed version of the instance format protocol version string.
            +
            +
            +
            + +

            +getClusterDataVersion

            +
            +public static ProtocolVersion getClusterDataVersion(Kiji kiji)
+                                             throws IOException
            +
            +
            Gets the version of the Kiji instance format installed on the HBase cluster. + +

            The instance format describes the layout of the global metadata state of + a Kiji instance.

            +

            +

            +
            Parameters:
            kiji - The kiji instance. +
            Returns:
            A parsed version of the storage format protocol version string. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +validateVersion

            +
            +public static void validateVersion(Kiji kiji)
+                            throws IOException
            +
            +
            Validates that the client instance format version is compatible with the instance + format version installed on a Kiji instance. + Throws IncompatibleKijiVersionException if not. + +

            For the definition of compatibility used in this method, see isKijiVersionCompatible(org.kiji.schema.Kiji)

            +

            +

            +
            Parameters:
            kiji - The kiji instance. +
            Throws: +
            IOException - on I/O error reading the data version from the cluster, + or throws IncompatibleKijiVersionException if the installed instance format version + is incompatible with the version supported by the client.
            +
            +
            +
            + +

            +isKijiVersionCompatible

            +
            +public static boolean isKijiVersionCompatible(Kiji kiji)
+                                       throws IOException
            +
            +
            Validates that the client instance format version is compatible with the instance + format version installed on a Kiji instance. + Returns true if they are compatible, false otherwise. + "Compatible" versions have the same major version digit (e.g., system-1.1 + and system-1.0 are compatible; system-2.5 and system-1.0 are not). + +

            Older instances (installed with KijiSchema 1.0.0-rc3 and prior) will use an instance + format version of kiji-1.0. This is treated as an alias for system-1.0. + No other versions associated with the "kiji" protocol are supported.

            +

            +

            +
            Parameters:
            kiji - the kiji instance. +
            Returns:
            true if the installed instance format + version is compatible with this client, false otherwise. +
            Throws: +
            IOException - on I/O error reading the Kiji version from the system.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ZooKeeperLock.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ZooKeeperLock.html new file mode 100644 index 00000000..aeacbdb2 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ZooKeeperLock.html @@ -0,0 +1,357 @@ + + + + + + + +ZooKeeperLock (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ZooKeeperLock

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ZooKeeperLock
+
            +
            +
            All Implemented Interfaces:
            Closeable, Lock
            +
            +
            +
            +
            @ApiAudience.Private
+public final class ZooKeeperLock
            extends Object
            implements Lock, Closeable
            + + +

            +Distributed lock on top of ZooKeeper. +

            + +

            +

            + +

            + + + + + + + + + + + +
            +Constructor Summary
            ZooKeeperLock(org.apache.zookeeper.ZooKeeper zookeeper, + File lockDir) + +
            +          Constructs a ZooKeeper lock object.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + voidclose() + +
            +          
            + voidlock() + +
            +          Unconditionally acquires the lock.
            + booleanlock(double timeout) + +
            +          Acquires the lock.
            + voidunlock() + +
            +          Releases the lock.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ZooKeeperLock

            +
            +public ZooKeeperLock(org.apache.zookeeper.ZooKeeper zookeeper,
+                     File lockDir)
            +
            +
            Constructs a ZooKeeper lock object. +

            +

            +
            Parameters:
            zookeeper - ZooKeeper client.
            lockDir - Path of the directory node to use for the lock.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +lock

            +
            +public void lock()
+          throws IOException
            +
            +
            Unconditionally acquires the lock. +

            +

            +
            Specified by:
            lock in interface Lock
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +lock

            +
            +public boolean lock(double timeout)
+             throws IOException
            +
            +
            Acquires the lock. +

            +

            +
            Specified by:
            lock in interface Lock
            +
            +
            +
            Parameters:
            timeout - Deadline, in seconds, to acquire the lock. 0 means no timeout. +
            Returns:
            whether the lock is acquired (ie. false means timeout). +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +unlock

            +
            +public void unlock()
+            throws IOException
            +
            +
            Releases the lock. +

            +

            +
            Specified by:
            unlock in interface Lock
            +
            +
            + +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +close

            +
            +public void close()
+           throws IOException
            +
            +
            +

            +

            +
            Specified by:
            close in interface Closeable
            +
            +
            + +
            Throws: +
            IOException
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ZooKeeperLockFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ZooKeeperLockFactory.html new file mode 100644 index 00000000..fc89366e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/ZooKeeperLockFactory.html @@ -0,0 +1,370 @@ + + + + + + + +ZooKeeperLockFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            + +

            + +org.kiji.schema.util +
            +Class ZooKeeperLockFactory

            +
            +java.lang.Object
+  extended by org.kiji.schema.util.ZooKeeperLockFactory
+
            +
            +
            All Implemented Interfaces:
            LockFactory
            +
            +
            +
            +
            @ApiAudience.Private
+public final class ZooKeeperLockFactory
            extends Object
            implements LockFactory
            + + +

            +Factory for ZooKeeperLock instances. +

            + +

            +

            + +

            + + + + + + + + + + + + + + +
            +Constructor Summary
            ZooKeeperLockFactory(String zkConnStr) + +
            +          Creates a factory for ZooKeeperLock.
            ZooKeeperLockFactory(org.apache.zookeeper.ZooKeeper zkClient) + +
            +          Creates a factory for ZooKeeperLock.
            +  + + + + + + + + + + + + + + + + + + + + + + + +
            +Method Summary
            + Lockcreate(String name) + +
            +          Creates a new lock with the specified name.
            +static org.apache.zookeeper.ZooKeepernewZooKeeper(String zkConnStr) + +
            +          Creates a ZooKeeper client.
            +static StringzkConnStr(Configuration conf) + +
            +          Creates a ZooKeeper connection string from an HBase configuration.
            +static StringzkConnStr(KijiURI uri) + +
            +          Creates a ZooKeeper connection string from a Kiji URI specifying an HBase instance.
            +  + + + + + + + +
            Methods inherited from class java.lang.Object
            clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
            +  +

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

            +ZooKeeperLockFactory

            +
            +public ZooKeeperLockFactory(org.apache.zookeeper.ZooKeeper zkClient)
            +
            +
            Creates a factory for ZooKeeperLock. +

            +

            +
            Parameters:
            zkClient - ZooKeeper client
            +
            +
            + +

            +ZooKeeperLockFactory

            +
            +public ZooKeeperLockFactory(String zkConnStr)
+                     throws IOException
            +
            +
            Creates a factory for ZooKeeperLock. +

            +

            +
            Parameters:
            zkConnStr - ZooKeeper connection. +
            Throws: +
            IOException - on I/O error.
            +
            + + + + + + + + +
            +Method Detail
            + +

            +newZooKeeper

            +
            +public static org.apache.zookeeper.ZooKeeper newZooKeeper(String zkConnStr)
+                                                   throws IOException
            +
            +
            Creates a ZooKeeper client. +

            +

            +
            +
            +
            +
            Parameters:
            zkConnStr - ZooKeeper quorum, as a comma separated list of ZooKeeper node "host:port". +
            Returns:
            a new ZooKeeper client. +
            Throws: +
            IOException - on I/O error.
            +
            +
            +
            + +

            +zkConnStr

            +
            +public static String zkConnStr(Configuration conf)
            +
            +
            Creates a ZooKeeper connection string from an HBase configuration. +

            +

            +
            +
            +
            +
            Parameters:
            conf - HBase configuration with ZooKeeper quorum and client port set. +
            Returns:
            a ZooKeeper connection string.
            +
            +
            +
            + +

            +zkConnStr

            +
            +public static String zkConnStr(KijiURI uri)
            +
            +
            Creates a ZooKeeper connection string from a Kiji URI specifying an HBase instance. +

            +

            +
            +
            +
            +
            Parameters:
            uri - Kiji URI specifying an HBase instance. +
            Returns:
            a ZooKeeper connection string.
            +
            +
            +
            + +

            +create

            +
            +public Lock create(String name)
            +
            +
            Creates a new lock with the specified name. +

            +

            +
            Specified by:
            create in interface LockFactory
            +
            +
            +
            Parameters:
            name - Lock name (eg. a ZooKeeper node path). +
            Returns:
            the lock with the specified name.
            +
            +
            + +
            + + + + + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
            + SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/AvroUtils.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/AvroUtils.html new file mode 100644 index 00000000..30776cd4 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/AvroUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.AvroUtils (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.AvroUtils

            +
            +No usage of org.kiji.schema.util.AvroUtils +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ByteArrayFormatter.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ByteArrayFormatter.html new file mode 100644 index 00000000..f7f5a567 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ByteArrayFormatter.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ByteArrayFormatter (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ByteArrayFormatter

            +
            +No usage of org.kiji.schema.util.ByteArrayFormatter +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html new file mode 100644 index 00000000..572ad53b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ByteStreamArray.EncodingException.html @@ -0,0 +1,189 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ByteStreamArray.EncodingException (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ByteStreamArray.EncodingException

            +
            + + + + + + + + + +
            +Packages that use ByteStreamArray.EncodingException
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of ByteStreamArray.EncodingException in org.kiji.schema.util
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util that throw ByteStreamArray.EncodingException
            + longByteStreamArray.readVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            + longByteStreamArray.readZigZagVarInt64() + +
            +          Reads a variable-length zig-zag encoded signed integer up to 64 bits.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ByteStreamArray.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ByteStreamArray.html new file mode 100644 index 00000000..6aa690f5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ByteStreamArray.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ByteStreamArray (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ByteStreamArray

            +
            +No usage of org.kiji.schema.util.ByteStreamArray +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/BytesKey.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/BytesKey.html new file mode 100644 index 00000000..a69ea654 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/BytesKey.html @@ -0,0 +1,274 @@ + + + + + + + +Uses of Class org.kiji.schema.util.BytesKey (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.BytesKey

            +
            + + + + + + + + + + + + + +
            +Packages that use BytesKey
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            +  +

            + + + + + +
            +Uses of BytesKey in org.kiji.schema
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema that return BytesKey
            + BytesKeyKijiSchemaTable.SchemaEntry.getHash() + +
            +           
            +abstract  BytesKeyKijiSchemaTable.getOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            + BytesKeyKijiSchemaTable.getSchemaHash(org.apache.avro.Schema schema) + +
            +          Computes a schema hash.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type BytesKey
            +abstract  org.apache.avro.SchemaKijiSchemaTable.getSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema with parameters of type BytesKey
            KijiSchemaTable.SchemaEntry(long id, + BytesKey hash, + org.apache.avro.Schema schema) + +
            +          Creates a new schema entry.
            +  +

            + + + + + +
            +Uses of BytesKey in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return BytesKey
            + BytesKeyHBaseSchemaTable.getOrCreateSchemaHash(org.apache.avro.Schema schema) + +
            +          Looks up a schema hash given an Avro schema object.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type BytesKey
            + org.apache.avro.SchemaHBaseSchemaTable.getSchema(BytesKey schemaHash) + +
            +          Looks up a schema given a hash.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Clock.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Clock.html new file mode 100644 index 00000000..1ce9272d --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Clock.html @@ -0,0 +1,226 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Clock (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Clock

            +
            + + + + + + + + + + + + + +
            +Packages that use Clock
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of Clock in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return Clock
            + ClockKijiTablePool.Options.getClock() + +
            +          Gets a clock.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type Clock
            + KijiTablePool.OptionsKijiTablePool.Options.withClock(Clock clock) + +
            +          Sets a clock.
            +  +

            + + + + + +
            +Uses of Clock in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.util that return Clock
            +static ClockClock.getDefaultClock() + +
            +           
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Debug.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Debug.html new file mode 100644 index 00000000..6ea59438 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Debug.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Debug (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Debug

            +
            +No usage of org.kiji.schema.util.Debug +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/FromJson.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/FromJson.html new file mode 100644 index 00000000..75e0e0b9 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/FromJson.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.FromJson (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.FromJson

            +
            +No usage of org.kiji.schema.util.FromJson +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Hasher.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Hasher.html new file mode 100644 index 00000000..e4d5f169 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Hasher.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Hasher (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Hasher

            +
            +No usage of org.kiji.schema.util.Hasher +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/JavaIdentifiers.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/JavaIdentifiers.html new file mode 100644 index 00000000..2dc14a7b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/JavaIdentifiers.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.JavaIdentifiers (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.JavaIdentifiers

            +
            +No usage of org.kiji.schema.util.JavaIdentifiers +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/KijiNameValidator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/KijiNameValidator.html new file mode 100644 index 00000000..4c91a5ab --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/KijiNameValidator.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.KijiNameValidator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.KijiNameValidator

            +
            +No usage of org.kiji.schema.util.KijiNameValidator +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Lock.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Lock.html new file mode 100644 index 00000000..d0ce01ac --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Lock.html @@ -0,0 +1,251 @@ + + + + + + + +Uses of Interface org.kiji.schema.util.Lock (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.util.Lock

            +
            + + + + + + + + + + + + + +
            +Packages that use Lock
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of Lock in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return Lock
            +static LockHBaseSchemaTable.newLock(KijiURI kijiURI, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type Lock
            HBaseSchemaTable(HTableInterface hashTable, + HTableInterface idTable, + Lock zkLock) + +
            +          Wrap an existing HBase table assumed to be where the schema data is stored.
            +  +

            + + + + + +
            +Uses of Lock in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.util that implement Lock
            + classZooKeeperLock + +
            +          Distributed lock on top of ZooKeeper.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util that return Lock
            + LockZooKeeperLockFactory.create(String name) + +
            +          Creates a new lock with the specified name.
            + LockLockFactory.create(String name) + +
            +          Creates a new lock with the specified name.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/LockFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/LockFactory.html new file mode 100644 index 00000000..a6b8a5cf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/LockFactory.html @@ -0,0 +1,287 @@ + + + + + + + +Uses of Interface org.kiji.schema.util.LockFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.util.LockFactory

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use LockFactory
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of LockFactory in org.kiji.schema.hbase
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.hbase that return LockFactory
            + LockFactoryHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  +

            + + + + + +
            +Uses of LockFactory in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return LockFactory
            + LockFactoryDefaultHBaseFactory.getLockFactory(KijiURI uri, + Configuration conf) + +
            +          Creates a lock factory for a given Kiji instance.
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type LockFactory
            +static voidHBaseSchemaTable.install(HBaseAdmin admin, + KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Install the schema table into a Kiji instance.
            +static LockHBaseSchemaTable.newLock(KijiURI kijiURI, + LockFactory factory) + +
            +          Creates a lock for a given Kiji instance.
            +  +

            + + + + + + + + +
            Constructors in org.kiji.schema.impl with parameters of type LockFactory
            HBaseSchemaTable(KijiURI kijiURI, + Configuration conf, + HTableInterfaceFactory tableFactory, + LockFactory lockFactory) + +
            +          Open a connection to the HBase schema table for a Kiji instance.
            +  +

            + + + + + +
            +Uses of LockFactory in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.util that implement LockFactory
            + classZooKeeperLockFactory + +
            +          Factory for ZooKeeperLock instances.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ProtocolVersion.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ProtocolVersion.html new file mode 100644 index 00000000..c2d5b60b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ProtocolVersion.html @@ -0,0 +1,340 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ProtocolVersion (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ProtocolVersion

            +
            + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use ProtocolVersion
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of ProtocolVersion in org.kiji.schema
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema that return ProtocolVersion
            +abstract  ProtocolVersionKijiSystemTable.getDataVersion() + +
            +          Gets the version of kiji installed.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema with parameters of type ProtocolVersion
            +abstract  voidKijiSystemTable.setDataVersion(ProtocolVersion version) + +
            +          Sets the version of kiji installed.
            +  +

            + + + + + +
            +Uses of ProtocolVersion in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl that return ProtocolVersion
            + ProtocolVersionHBaseSystemTable.getDataVersion() + +
            +          Gets the version of kiji installed.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.impl with parameters of type ProtocolVersion
            + voidHBaseSystemTable.setDataVersion(ProtocolVersion version) + +
            +          Sets the version of kiji installed.
            +  +

            + + + + + +
            +Uses of ProtocolVersion in org.kiji.schema.layout
            +  +

            + + + + + + + + + + + + + +
            Methods in org.kiji.schema.layout that return ProtocolVersion
            +static ProtocolVersionKijiTableLayout.getMaxSupportedLayoutVersion() + +
            +          Returns the maximum layout version supported.
            +static ProtocolVersionKijiTableLayout.getMinSupportedLayoutVersion() + +
            +          Returns the minimum layout version supported.
            +  +

            + + + + + +
            +Uses of ProtocolVersion in org.kiji.schema.util
            +  +

            + + + + + + + + + + + + + + + + + +
            Methods in org.kiji.schema.util that return ProtocolVersion
            +static ProtocolVersionVersionInfo.getClientDataVersion() + +
            +          Gets the version of the Kiji instance format assumed by the client.
            +static ProtocolVersionVersionInfo.getClusterDataVersion(Kiji kiji) + +
            +          Gets the version of the Kiji instance format installed on the HBase cluster.
            +static ProtocolVersionProtocolVersion.parse(String verString) + +
            +          Static factory method that creates new ProtocolVersion instances.
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.util with parameters of type ProtocolVersion
            + intProtocolVersion.compareTo(ProtocolVersion other) + +
            +          
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ReferenceCountable.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ReferenceCountable.html new file mode 100644 index 00000000..65d06709 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ReferenceCountable.html @@ -0,0 +1,248 @@ + + + + + + + +Uses of Interface org.kiji.schema.util.ReferenceCountable (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Interface
            org.kiji.schema.util.ReferenceCountable

            +
            + + + + + + + + + + + + + + + + + +
            +Packages that use ReferenceCountable
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of ReferenceCountable in org.kiji.schema
            +  +

            + + + + + + + + + +
            Subinterfaces of ReferenceCountable in org.kiji.schema
            + interfaceKiji + +
            +          Provides a handle to a Kiji instance that contains table information and access to + Kiji administrative functionality.
            +  +

            + + + + + +
            +Uses of ReferenceCountable in org.kiji.schema.impl
            +  +

            + + + + + + + + + +
            Classes in org.kiji.schema.impl that implement ReferenceCountable
            + classHBaseKiji + +
            +          Kiji instance class that contains configuration and table + information.
            +  +

            + + + + + +
            +Uses of ReferenceCountable in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Methods in org.kiji.schema.util with parameters of type ReferenceCountable
            +static + + + + +
            +<T> void
            +            		ResourceUtils.releaseOrLog(ReferenceCountable<T> resource) + +
            +          Releases the specified resource, logging and swallowing I/O errors if needed.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ResourceUtils.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ResourceUtils.html new file mode 100644 index 00000000..a5b074b7 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ResourceUtils.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ResourceUtils (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ResourceUtils

            +
            +No usage of org.kiji.schema.util.ResourceUtils +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Resources.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Resources.html new file mode 100644 index 00000000..4eec62d5 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/Resources.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.Resources (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.Resources

            +
            +No usage of org.kiji.schema.util.Resources +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/SplitKeyFile.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/SplitKeyFile.html new file mode 100644 index 00000000..efa0b9a1 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/SplitKeyFile.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.SplitKeyFile (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.SplitKeyFile

            +
            +No usage of org.kiji.schema.util.SplitKeyFile +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/TimestampComparator.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/TimestampComparator.html new file mode 100644 index 00000000..30abb22e --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/TimestampComparator.html @@ -0,0 +1,181 @@ + + + + + + + +Uses of Class org.kiji.schema.util.TimestampComparator (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.TimestampComparator

            +
            + + + + + + + + + +
            +Packages that use TimestampComparator
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + +
            +Uses of TimestampComparator in org.kiji.schema.util
            +  +

            + + + + + + + + + +
            Fields in org.kiji.schema.util declared as TimestampComparator
            +static TimestampComparatorTimestampComparator.INSTANCE + +
            +          A singleton instance.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ToJson.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ToJson.html new file mode 100644 index 00000000..e05ab880 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ToJson.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ToJson (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ToJson

            +
            +No usage of org.kiji.schema.util.ToJson +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/VersionInfo.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/VersionInfo.html new file mode 100644 index 00000000..b631588b --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/VersionInfo.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.VersionInfo (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.VersionInfo

            +
            +No usage of org.kiji.schema.util.VersionInfo +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ZooKeeperLock.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ZooKeeperLock.html new file mode 100644 index 00000000..216bdc9c --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ZooKeeperLock.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ZooKeeperLock (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ZooKeeperLock

            +
            +No usage of org.kiji.schema.util.ZooKeeperLock +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ZooKeeperLockFactory.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ZooKeeperLockFactory.html new file mode 100644 index 00000000..bec980a8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/class-use/ZooKeeperLockFactory.html @@ -0,0 +1,145 @@ + + + + + + + +Uses of Class org.kiji.schema.util.ZooKeeperLockFactory (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Class
            org.kiji.schema.util.ZooKeeperLockFactory

            +
            +No usage of org.kiji.schema.util.ZooKeeperLockFactory +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-frame.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-frame.html new file mode 100644 index 00000000..46a1b4f6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-frame.html @@ -0,0 +1,95 @@ + + + + + + + +org.kiji.schema.util (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + +org.kiji.schema.util + + + + +
            +Interfaces  + +
            +Lock +
            +LockFactory +
            +ReferenceCountable
            + + + + + + +
            +Classes  + +
            +AvroUtils +
            +ByteArrayFormatter +
            +BytesKey +
            +ByteStreamArray +
            +Clock +
            +Debug +
            +FromJson +
            +Hasher +
            +JavaIdentifiers +
            +KijiNameValidator +
            +ProtocolVersion +
            +Resources +
            +ResourceUtils +
            +SplitKeyFile +
            +TimestampComparator +
            +ToJson +
            +VersionInfo +
            +ZooKeeperLock +
            +ZooKeeperLockFactory
            + + + + + + +
            +Exceptions  + +
            +ByteStreamArray.EncodingException
            + + + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-summary.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-summary.html new file mode 100644 index 00000000..0081c8bf --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-summary.html @@ -0,0 +1,285 @@ + + + + + + + +org.kiji.schema.util (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +

            +Package org.kiji.schema.util +

            +Package containing utility classes used throughout Kiji. +

            +See: +
            +          Description +

            + + + + + + + + + + + + + + + + + +
            +Interface Summary
            LockLock interface.
            LockFactoryFactory for Lock instances.
            ReferenceCountable<T>Interface for reference-countable resources.
            +  + +

            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Class Summary
            AvroUtilsGeneral purpose Avro utilities.
            ByteArrayFormatterUtility class to format byte arrays.
            BytesKeyWraps an array of bytes into an object that can be used as key in a hash map.
            ByteStreamArrayWraps a byte array of binary-encoded data into a byte stream.
            ClockAn interface for a wall clock.
            DebugDebugging utilities.
            FromJsonDecode a JSON string into an Avro record.
            HasherA thread-safe utility for computing hashes of strings.
            JavaIdentifiersA utility class for dealing with identifiers in the Java language.
            KijiNameValidatorA utility class for validating layout names, + (including table names, locality group names, family names, and column names) + and Kiji instance names.
            ProtocolVersionParses version information for a file format or wire protocol and provides + comparison / reporting functions.
            ResourcesUtility for getting access to system resources.
            ResourceUtilsUtilities to work with ReferenceCountable resources.
            SplitKeyFileParses region boundaries split files.
            TimestampComparatorA comparator that sorts Longs in reverse chronological order.
            ToJsonEncode an Avro record into JSON.
            VersionInfoReports on the version numbers associated with this software bundle + as well as the installed format versions in used in a Kiji instance.
            ZooKeeperLockDistributed lock on top of ZooKeeper.
            ZooKeeperLockFactoryFactory for ZooKeeperLock instances.
            +  + +

            + + + + + + + + + +
            +Exception Summary
            ByteStreamArray.EncodingExceptionRaised when decoding some data fails (eg.
            +  + +

            +

            +Package org.kiji.schema.util Description +

            + +

            +Package containing utility classes used throughout Kiji. +

            + +

            +

            +
            +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview   Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV PACKAGE  + NEXT PACKAGE + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-tree.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-tree.html new file mode 100644 index 00000000..c25d3e93 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-tree.html @@ -0,0 +1,172 @@ + + + + + + + +org.kiji.schema.util Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For Package org.kiji.schema.util +

            +
            +
            +
            Package Hierarchies:
            All Packages
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-use.html b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-use.html new file mode 100644 index 00000000..49d35dc8 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema/util/package-use.html @@ -0,0 +1,329 @@ + + + + + + + +Uses of Package org.kiji.schema.util (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Uses of Package
            org.kiji.schema.util

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages that use org.kiji.schema.util
            org.kiji.schemaThe main package for users of KijiSchema. 
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior. 
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces. 
            org.kiji.schema.layoutKiji table layouts. 
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji. 
            +  +

            + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema
            BytesKey + +
            +          Wraps an array of bytes into an object that can be used as key in a hash map.
            Clock + +
            +          An interface for a wall clock.
            ProtocolVersion + +
            +          Parses version information for a file format or wire protocol and provides + comparison / reporting functions.
            ReferenceCountable + +
            +          Interface for reference-countable resources.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema.hbase
            LockFactory + +
            +          Factory for Lock instances.
            +  +

            + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema.impl
            BytesKey + +
            +          Wraps an array of bytes into an object that can be used as key in a hash map.
            Lock + +
            +          Lock interface.
            LockFactory + +
            +          Factory for Lock instances.
            ProtocolVersion + +
            +          Parses version information for a file format or wire protocol and provides + comparison / reporting functions.
            ReferenceCountable + +
            +          Interface for reference-countable resources.
            +  +

            + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema.layout
            ProtocolVersion + +
            +          Parses version information for a file format or wire protocol and provides + comparison / reporting functions.
            +  +

            + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Classes in org.kiji.schema.util used by org.kiji.schema.util
            ByteStreamArray.EncodingException + +
            +          Raised when decoding some data fails (eg.
            Clock + +
            +          An interface for a wall clock.
            Lock + +
            +          Lock interface.
            LockFactory + +
            +          Factory for Lock instances.
            ProtocolVersion + +
            +          Parses version information for a file format or wire protocol and provides + comparison / reporting functions.
            ReferenceCountable + +
            +          Interface for reference-countable resources.
            TimestampComparator + +
            +          A comparator that sorts Longs in reverse chronological order.
            +  +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class   Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/overview-frame.html b/apidocs/kiji-schema/1.0.0-rc4/overview-frame.html new file mode 100644 index 00000000..37614131 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/overview-frame.html @@ -0,0 +1,65 @@ + + + + + + + +Overview List (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + + + + +
            +
            + + + + + +
            All Classes +

            + +Packages +
            +org.apache.hadoop.hbase.mapreduce +
            +org.kiji.schema +
            +org.kiji.schema.avro +
            +org.kiji.schema.filter +
            +org.kiji.schema.hbase +
            +org.kiji.schema.impl +
            +org.kiji.schema.layout +
            +org.kiji.schema.layout.impl +
            +org.kiji.schema.mapreduce +
            +org.kiji.schema.tools +
            +org.kiji.schema.tools.synth +
            +org.kiji.schema.util +
            +

            + +

            +  + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/overview-summary.html b/apidocs/kiji-schema/1.0.0-rc4/overview-summary.html new file mode 100644 index 00000000..a6ad7542 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/overview-summary.html @@ -0,0 +1,202 @@ + + + + + + + +Overview (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +kiji-schema 1.0.0-rc4 API +

            +
            + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
            +Packages
            org.apache.hadoop.hbase.mapreduce 
            org.kiji.schemaThe main package for users of KijiSchema.
            org.kiji.schema.avro 
            org.kiji.schema.filterRow level filters used when reading data from Kiji tables.
            org.kiji.schema.hbaseHBase-specific KijiSchema behavior.
            org.kiji.schema.implImplementations for the main KijiSchema classes and interfaces.
            org.kiji.schema.layoutKiji table layouts.
            org.kiji.schema.layout.implImplementation for Kiji table layout management.
            org.kiji.schema.mapreduceKiji MapReduce utilities.
            org.kiji.schema.toolsPackage containing implementations, abstract base classes, + and exceptions for kiji command-line tools.
            org.kiji.schema.tools.synthClasses to assist when synthesizing sample data for use in kiji tables.
            org.kiji.schema.utilPackage containing utility classes used throughout Kiji.
            + +

            + 

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
             Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/overview-tree.html b/apidocs/kiji-schema/1.0.0-rc4/overview-tree.html new file mode 100644 index 00000000..311f1aa6 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/overview-tree.html @@ -0,0 +1,341 @@ + + + + + + + +Class Hierarchy (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Hierarchy For All Packages

            +
            +
            +
            Package Hierarchies:
            org.apache.hadoop.hbase.mapreduce, org.kiji.schema, org.kiji.schema.avro, org.kiji.schema.filter, org.kiji.schema.hbase, org.kiji.schema.impl, org.kiji.schema.layout, org.kiji.schema.layout.impl, org.kiji.schema.mapreduce, org.kiji.schema.tools, org.kiji.schema.tools.synth, org.kiji.schema.util
            +
            +

            +Class Hierarchy +

            + +

            +Interface Hierarchy +

            + +

            +Enum Hierarchy +

            + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use   Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/package-list b/apidocs/kiji-schema/1.0.0-rc4/package-list new file mode 100644 index 00000000..9c1adf32 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/package-list @@ -0,0 +1,12 @@ +org.apache.hadoop.hbase.mapreduce +org.kiji.schema +org.kiji.schema.avro +org.kiji.schema.filter +org.kiji.schema.hbase +org.kiji.schema.impl +org.kiji.schema.layout +org.kiji.schema.layout.impl +org.kiji.schema.mapreduce +org.kiji.schema.tools +org.kiji.schema.tools.synth +org.kiji.schema.util diff --git a/apidocs/kiji-schema/1.0.0-rc4/resources/inherit.gif b/apidocs/kiji-schema/1.0.0-rc4/resources/inherit.gif new file mode 100644 index 00000000..c814867a Binary files /dev/null and b/apidocs/kiji-schema/1.0.0-rc4/resources/inherit.gif differ diff --git a/apidocs/kiji-schema/1.0.0-rc4/serialized-form.html b/apidocs/kiji-schema/1.0.0-rc4/serialized-form.html new file mode 100644 index 00000000..5fb08bcb --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/serialized-form.html @@ -0,0 +1,737 @@ + + + + + + + +Serialized Form (kiji-schema 1.0.0-rc4 API) + + + + + + + + + + + + +
            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +
            +

            +Serialized Form

            +
            +
            + + + + + +
            +Package org.apache.hadoop.hbase.mapreduce
            + +

            + + + + + +
            +Class org.apache.hadoop.hbase.mapreduce.ImportTsv.TsvParser.BadTsvLineException extends Exception implements Serializable
            + +

            +serialVersionUID: 1L + +

            +

            + + + + + +
            +Package org.kiji.schema
            + +

            + + + + + +
            +Class org.kiji.schema.EntityIdException extends RuntimeException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.IncompatibleKijiVersionException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.InternalKijiError extends Error implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiAlreadyExistsException extends RuntimeException implements Serializable
            + +

            + + + + + +
            +Serialized Fields
            + +

            +mURI

            +
            +KijiURI mURI
            +
            +
            URI of the entity that already exists. +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiDataRequest extends Object implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mColumns

            +
            +Map<K,V> mColumns
            +
            +
            Unmodifiable map from full column name to Column describing the request. +

            +

            +
            +
            +
            +

            +mMinTimestamp

            +
            +long mMinTimestamp
            +
            +
            The minimum timestamp of cells to be read (inclusive). +

            +

            +
            +
            +
            +

            +mMaxTimestamp

            +
            +long mMaxTimestamp
            +
            +
            The maximum timestamp of cells to be read (exclusive). +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiDataRequest.Column extends Object implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mFamily

            +
            +String mFamily
            +
            +
            The column family requested. +

            +

            +
            +
            +
            +

            +mQualifier

            +
            +String mQualifier
            +
            +
            The column qualifier requested (may be null, which means any qualifier). +

            +

            +
            +
            +
            +

            +mMaxVersions

            +
            +int mMaxVersions
            +
            +
            The maximum number of versions from the column to read (of the most recent). +

            +

            +
            +
            +
            +

            +mFilter

            +
            +KijiColumnFilter mFilter
            +
            +
            A column filter (may be null). +

            +

            +
            +
            +
            +

            +mPageSize

            +
            +int mPageSize
            +
            +
            The number of cells per page (zero means no paging). +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiDataRequestException extends RuntimeException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiEncodingException extends RuntimeException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiInvalidNameException extends Exception implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiNotInstalledException extends RuntimeException implements Serializable
            + +

            + + + + + +
            +Serialized Fields
            + +

            +mInstanceName

            +
            +String mInstanceName
            +
            +
            The instance name of the missing Kiji instance. +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiTableNotFoundException extends IOException implements Serializable
            + +

            + + + + + +
            +Serialized Fields
            + +

            +mTableName

            +
            +String mTableName
            +
            +
            Name of the missing table. +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.KijiTablePool.NoCapacityException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.KijiURIException extends RuntimeException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.NoCellDataException extends Exception implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.NoSuchColumnException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.NotAKijiManagedTableException extends Exception implements Serializable
            + +

            + + + + + +
            +Serialized Fields
            + +

            +mHBaseTableName

            +
            +String mHBaseTableName
            +
            +
            The name of the HBase table. +

            +

            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.TableKeyNotFoundException extends RuntimeException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.filter
            + +

            + + + + + +
            +Class org.kiji.schema.filter.KijiColumnFilter extends Object implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.filter.KijiPaginationFilter extends KijiColumnFilter implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mLimit

            +
            +int mLimit
            +
            +
            +
            +
            +
            +

            +mOffset

            +
            +int mOffset
            +
            +
            +
            +
            +
            +

            +mInputFilter

            +
            +KijiColumnFilter mInputFilter
            +
            +
            +
            +
            + +

            + + + + + +
            +Class org.kiji.schema.filter.RegexQualifierColumnFilter extends KijiColumnFilter implements Serializable
            + +

            +serialVersionUID: 1L + +

            + + + + + +
            +Serialized Fields
            + +

            +mRegularExpression

            +
            +String mRegularExpression
            +
            +
            +
            +
            +
            + + + + + +
            +Package org.kiji.schema.impl
            + +

            + + + + + +
            +Class org.kiji.schema.impl.InvalidColumnNameException extends RuntimeException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.impl.KijiColumnPagingNotEnabledException extends IOException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.layout
            + +

            + + + + + +
            +Class org.kiji.schema.layout.InvalidLayoutException extends IOException implements Serializable
            + +

            + +

            + + + + + +
            +Class org.kiji.schema.layout.SchemaClassNotFoundException extends InvalidLayoutException implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.tools
            + +

            + + + + + +
            +Class org.kiji.schema.tools.RequiredFlagException extends Exception implements Serializable
            + +

            +

            + + + + + +
            +Package org.kiji.schema.util
            + +

            + + + + + +
            +Class org.kiji.schema.util.ByteStreamArray.EncodingException extends IOException implements Serializable
            + +

            + +

            +

            + + + + + + + + + + + + + + + +
            + + + + + + + + + + + + +
            Overview  Package  Class  Use  Tree  Deprecated  Index  Help 
            +            		 + +
            + PREV  + NEXT + FRAMES   + NO FRAMES   +  + + + +
            + + + +
            +Copyright © 2012-2013 WibiData, Inc.. All Rights Reserved. + + diff --git a/apidocs/kiji-schema/1.0.0-rc4/stylesheet.css b/apidocs/kiji-schema/1.0.0-rc4/stylesheet.css new file mode 100644 index 00000000..6ea9e516 --- /dev/null +++ b/apidocs/kiji-schema/1.0.0-rc4/stylesheet.css @@ -0,0 +1,29 @@ +/* Javadoc style sheet */ + +/* Define colors, fonts and other style attributes here to override the defaults */ + +/* Page background color */ +body { background-color: #FFFFFF; color:#000000 } + +/* Headings */ +h1 { font-size: 145% } + +/* Table colors */ +.TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */ +.TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */ +.TableRowColor { background: #FFFFFF; color:#000000 } /* White */ + +/* Font used in left-hand frame lists */ +.FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } +.FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 } + +/* Navigation bar fonts and colors */ +.NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */ +.NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */ +.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;} +.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;} + +.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} +.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000} + diff --git a/assets/images/active-header.gif b/assets/images/active-header.gif new file mode 100644 index 00000000..d19dbffc Binary files /dev/null and b/assets/images/active-header.gif differ diff --git a/assets/images/inactive-header.gif b/assets/images/inactive-header.gif new file mode 100644 index 00000000..d5e85122 Binary files /dev/null and b/assets/images/inactive-header.gif differ diff --git a/assets/themes/twitter/css/vallenato.css b/assets/themes/twitter/css/vallenato.css new file mode 100644 index 00000000..ff615b8a --- /dev/null +++ b/assets/themes/twitter/css/vallenato.css @@ -0,0 +1,63 @@ +#accordion-container { + font-size: 13px; + background: #ffffff; + padding: 5px 10px 10px 10px; + border: 1px solid #cccccc; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; + -moz-box-shadow: 0 5px 15px #cccccc; + -webkit-box-shadow: 0 5px 15px #cccccc; + box-shadow: 0 5px 15px #cccccc; +} + +.accordion-header { + font-size: 16px; + background: #ebebeb; + margin: 5px 0 0 0; + padding: 5px 20px; + border: 1px solid #cccccc; + cursor: pointer; + color: #666666; + -moz-border-radius: 5px; + -webkit-border-radius: 5px; + border-radius: 5px; +} + +.active-header { + -moz-border-radius: 5px 5px 0 0; + -webkit-border-radius: 5px 5px 0 0; + border-radius: 5px 5px 0 0; + background: url(../../../images/active-header.gif) #cef98d; + background-repeat: no-repeat; + background-position: right 50%; +} + +.active-header:hover { + background: url(../../..images/active-header.gif) #c6f089; + background-repeat: no-repeat; + background-position: right 50%; +} + +.inactive-header { + background: url(../../../images/inactive-header.gif) #ebebeb; + background-repeat: no-repeat; + background-position: right 50%; +} + +.inactive-header:hover { + background: url(../../../images/inactive-header.gif) #f5f5f5; + background-repeat: no-repeat; + background-position: right 50%; +} + +.accordion-content { + display: none; + padding: 20px; + background: #ffffff; + border: 1px solid #cccccc; + border-top: 0; + -moz-border-radius: 0 0 5px 5px; + -webkit-border-radius: 0 0 5px 5px; + border-radius: 0 0 5px 5px; +} diff --git a/assets/themes/twitter/vallenato/.DS_Store b/assets/themes/twitter/vallenato/.DS_Store new file mode 100644 index 00000000..47f32a13 Binary files /dev/null and b/assets/themes/twitter/vallenato/.DS_Store differ diff --git a/assets/themes/twitter/vallenato/images/.DS_Store b/assets/themes/twitter/vallenato/images/.DS_Store new file mode 100644 index 00000000..5008ddfc Binary files /dev/null and b/assets/themes/twitter/vallenato/images/.DS_Store differ diff --git a/assets/themes/twitter/vallenato/images/active-header.gif b/assets/themes/twitter/vallenato/images/active-header.gif new file mode 100644 index 00000000..d19dbffc Binary files /dev/null and b/assets/themes/twitter/vallenato/images/active-header.gif differ diff --git a/assets/themes/twitter/vallenato/images/inactive-header.gif b/assets/themes/twitter/vallenato/images/inactive-header.gif new file mode 100644 index 00000000..d5e85122 Binary files /dev/null and b/assets/themes/twitter/vallenato/images/inactive-header.gif differ diff --git a/assets/themes/twitter/vallenato/vallenato.js b/assets/themes/twitter/vallenato/vallenato.js new file mode 100644 index 00000000..7cb5a4a9 --- /dev/null +++ b/assets/themes/twitter/vallenato/vallenato.js @@ -0,0 +1,34 @@ +/*! + * Vallenato 1.0 + * A Simple JQuery Accordion + * + * Designed by Switchroyale + * + * Use Vallenato for whatever you want, enjoy! + */ + +$(document).ready(function() +{ + //Add Inactive Class To All Accordion Headers + $('.accordion-header').toggleClass('inactive-header'); + + //Set The Accordion Content Width + var contentwidth = $('.accordion-header').width(); + $('.accordion-content').css({'width' : contentwidth }); + + // The Accordion Effect + $('.accordion-header').click(function () { + if($(this).is('.inactive-header')) { + $('.active-header').toggleClass('active-header').toggleClass('inactive-header').next().slideToggle().toggleClass('open-content'); + $(this).toggleClass('active-header').toggleClass('inactive-header'); + $(this).next().slideToggle().toggleClass('open-content'); + } + + else { + $(this).toggleClass('active-header').toggleClass('inactive-header'); + $(this).next().slideToggle().toggleClass('open-content'); + } + }); + + return false; +}); diff --git a/index.md b/index.md index 5079d64c..4b678175 100644 --- a/index.md +++ b/index.md @@ -17,12 +17,12 @@ title: Documentation
    • - +
    2
    -
    Phonebook Tutorial
    +
    Tutorials

    - Learn how to use MapReduce with contact info in a Kiji table. + Hands on introductions to using KijiSchema and KijiMR.

    @@ -31,18 +31,18 @@ title: Documentation
    - +
    3
    -
    User Guide
    +
    User Guides

    - Your complete guide to KijiSchema. + Your complete guide to Kiji.

    - +
    4
    API Reference
    diff --git a/jekyll.gems b/jekyll.gems index 20d290a1..a4e2b636 100644 --- a/jekyll.gems +++ b/jekyll.gems @@ -1,12 +1,8 @@ # jekyll.gems generated gem export file. Note that any env variable settings will be missing. Append these after using a ';' field separator -albino -v1.3.3 -classifier -v1.3.3 -directory_watcher -v1.4.1 -fast-stemmer -v1.0.1 -jekyll -v0.11.0 -kramdown -v0.14.0 -liquid -v2.2.2 -maruku -v0.6.1 -posix-spawn -v0.3.6 -syntax -v1.0.0 +maruku -v0.6.0 +liquid -v2.4.1 +jekyll -v0.12.0 +redcarpet -v2.1.1 +rdiscount -v1.6.8 +RedCloth -v4.2.9 diff --git a/markdown_styleguide.md b/markdown_styleguide.md index f7302f89..6c0f6a80 100644 --- a/markdown_styleguide.md +++ b/markdown_styleguide.md @@ -11,19 +11,25 @@ Links Links can be made to the absolute path of a page like this: [text for link](http://url.com/ "Title") - Links to the userguide and tutorial are made more convenient via: - [text for link]({{site.userguide_url}}title-of-page) or - [text for link]({{site.tutorial_url}}title-of-page) or + Links various versions of the userguides and api docs are made more convenient via: + [text for link]({{userguide_schema_rc4}}title-of-page) or [`text for link`]({{site.api_url}}classname.html) - note that in _config.yml these variables are defined as: - userguide_url : http://docs.kiji.org/userguide/schema/1.0.0-rc1/ - tutorial_url : http://docs.kiji.org/tutorial/ - api_url : http://docs.kiji.org/apidocs/org/kiji/schema/ + note that in _config.yml. we have the following variables defined: +production_url : http://docs.kiji.org +userguide_url : /userguides +userguide_schema_rc4 : /userguides/schema/1.0.0-rc4 +userguide_mapreduce_rc4 : /userguides/mapreduce/1.0.0-rc4 + +tutorial_url : /tutorials +api_url : /apidocs +api_schema_rc4 : /apidocs/kiji-schema/1.0.0-rc4/org/kiji/schema +api_mr_rc4 : /apidocs/kiji-mapreduce/1.0.0-rc4/org/kiji/mapreduce +api_mrlib_rc4 : /apidocs/kiji-mapreduce-lib/1.0.0-rc4/org/kiji/mapreduce So, for example, instead of - [Managing Data](http://docs.kiji.org/userguide/schema/1.0.0-rc1/managing-data) + [Managing Data](http://docs.kiji.org/userguide/schema/1.0.0-rc4/managing-data) you could write - [Managing Data]({{site.userguide_url}}managing-data) + [Managing Data]({{site.userguide_schema_rc4}}managing-data) Code ---- @@ -31,7 +37,7 @@ Code {% highlight lang_name %} code goes here {% endhighlight %} - Where lang_name is java, bash, xml or any other valid language from [this + Where lang_name is java, js, bash, xml or any other valid language from [this list](http://pygments.org/languages/). Headers diff --git a/scripts/run-server.sh b/scripts/run-server.sh new file mode 100755 index 00000000..5ad6f14c --- /dev/null +++ b/scripts/run-server.sh @@ -0,0 +1,35 @@ +#!/bin/bash + +# Temp file for the sed work +TMP_FILE=$(mktemp /tmp/config.XXXXXXXXXX) + +# Get the currect directory no matter where we are or how we're called +SOURCE="${BASH_SOURCE[0]}" +# resolve $SOURCE until the file is no longer a symlink +while [ -h "$SOURCE" ]; do + DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )" + SOURCE="$(readlink "$SOURCE")" + # if $SOURCE was a relative symlink, we need to resolve it relative to the + # path where the symlink file was located + [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE" +done +DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )" + + +# run when user hits ctrl-c to bail out of jekyll +control_c() +{ + sed -e's/UA-REMOVED-DONT-COMMIT/UA-35866189-1/' $DIR/../_config.yml > $TMP_FILE + mv $TMP_FILE $DIR/../_config.yml + exit $? +} + +# trap keyboard interrupt (control-c) +trap control_c SIGINT + +# we're using the long route over sed in place because sed in place +# doesn't work the same on linux and macs. +sed -e's/UA-35866189-1/UA-REMOVED-DONT-COMMIT/' $DIR/../_config.yml > $TMP_FILE +mv $TMP_FILE $DIR/../_config.yml + +jekyll --no-auto --server --pygments --no-lsi --safe \ No newline at end of file diff --git a/tutorials.md b/tutorials.md new file mode 100644 index 00000000..a465d815 --- /dev/null +++ b/tutorials.md @@ -0,0 +1,22 @@ +--- +layout: page +title: Kiji Tutorial Index +--- + +Major components of Kiji have tutorials to get you started + +Click a link below to select the version of the tutorial appropriate +to the Kiji version you are using. + +# KijiSchema +Covers the core functionality of Kiji; creating, writing, and reading from tables. + +* [Phone Book Tutorial](tutorials/phonebook-tutorial/1.0.0-rc4/phonebook-tutorial) (latest) + +* [Phone Book Tutorial 1.0.0-rc3](tutorials/phonebook-tutorial/1.0.0-rc3/phonebook-tutorial) + +# KijiMR +Covers how build and run MapReduce jobs that use Kiji tables as input and/or output. This is +the word count of recommendation systems. + +* [Music Recommendation Tutorial](tutorials/music-recommendation/1.0.0-rc4/music-overview) (latest) diff --git a/userguides.md b/userguides.md new file mode 100644 index 00000000..66d95732 --- /dev/null +++ b/userguides.md @@ -0,0 +1,20 @@ +--- +layout: page +title: Kiji User Guide Index +--- + +The Kiji framework comes with a user guide that describes the main +theory and practice behind developing Big Data applications with Kiji. + +Click a link below to select the version of the user guide appropriate +to the Kiji version you are using. + +## KijiSchema +* [KijiSchema 1.0.0-rc4]({{site.userguide_url}}/schema/1.0.0-rc4/kiji-schema-overview/) (latest) +* [KijiSchema 1.0.0-rc3]({{site.userguide_url}}/schema/1.0.0-rc3/kiji-schema-overview/) +* [KijiSchema 1.0.0-rc2]({{site.userguide_url}}/schema/1.0.0-rc2/kiji-schema-overview/) +* [KijiSchema 1.0.0-rc1]({{site.userguide_url}}/schema/1.0.0-rc1/kiji-schema-overview/) + +## KijiMR + +* [KijiMR 1.0.0-rc4]({{site.userguide_url}}/mapreduce/1.0.0-rc4/kiji-mr-overview/)